JUnit Jupiter best practices

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.testing.junit.JupiterBestPractices

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-testing-frameworks:3.43.0

Definition

This recipe runs the following recipes in order.

• Migrate Hamcrest assertions to JUnit Jupiterorg.openrewrite.java.testing.hamcrest.MigrateHamcrestToJUnit5
• Statically import JUnit Jupiter assertionsorg.openrewrite.java.testing.junit5.StaticImports
• Remove JUnit 5 static Assertions imports in Kotlin when wildcard import is presentorg.openrewrite.java.testing.junit5.CleanupKotlinJUnit5AssertionImports
• Clean Up Assertionsorg.openrewrite.java.testing.junit5.CleanupAssertions
• Replace @CsvSource with @ValueSource for single method argumentsorg.openrewrite.java.testing.junit5.CsvSourceToValueSource
• Remove unnecessary assertEquals delta argument for integral typesorg.openrewrite.java.testing.cleanup.AssertEqualsIntegralDeltaToAssertEquals
• Replace JUnit assertTrue(false) and assertFalse(true) with fail()org.openrewrite.java.testing.cleanup.AssertLiteralBooleanToFailRecipes
• Remove JUnit assertTrue(true) and assertFalse(false)org.openrewrite.java.testing.cleanup.AssertLiteralBooleanRemovedRecipe
• Kotlin test methods should have return type Unitorg.openrewrite.java.testing.cleanup.KotlinTestMethodsShouldReturnUnit
• Remove test prefix from JUnit 5 testsorg.openrewrite.java.testing.cleanup.RemoveTestPrefix
• Simplify throws statements of testsorg.openrewrite.java.testing.cleanup.SimplifyTestThrows
• Remove public visibility of JUnit 5 testsorg.openrewrite.java.testing.cleanup.TestsShouldNotBePublic
• Test methods should have void return typeorg.openrewrite.java.testing.cleanup.TestMethodsShouldBeVoid
• Add missing @ParameterizedTest annotation when @ValueSource is used or replace @Test with @ParameterizedTestorg.openrewrite.java.testing.junit5.AddParameterizedTestAnnotation
• Remove duplicates uses of @TestTemplate implementations for a single methodorg.openrewrite.java.testing.junit5.RemoveDuplicateTestTemplates
• Replace fail() in try-catch blocks with Assertions.assertDoesNotThrow(() -> { ... })org.openrewrite.java.testing.junit5.RemoveTryCatchFailBlocks
• Make lifecycle methods non privateorg.openrewrite.java.testing.junit5.LifecycleNonPrivate
• Applies JUnit 5 assertThrows on last statement in lambda block onlyorg.openrewrite.java.testing.junit5.AssertThrowsOnLastStatement
• assertTrue(x instanceof y) to assertInstanceOf(y.class, x)org.openrewrite.java.testing.junit5.AssertTrueInstanceofToAssertInstanceOf
• Make implausibly long @Timeout values explicit in minutesorg.openrewrite.java.testing.junit5.ImplausibleTimeoutToMinutes
• Use JUnit5's assertSame or assertNotSame instead of assertTrue(... == ...)org.openrewrite.java.testing.junit5.UseAssertSame
• Remove JUnit Jupiter migrationsupportorg.openrewrite.java.testing.junit.RemoveJupiterMigrationSupport

Data tables

Structured output this recipe can produce.

• Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
• Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
• Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
• Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats