JUnit Jupiter migration from JUnit 4.x

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.junit5.JUnit4to5Migration

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 JUnit 4 environmentVariables rule to JUnit 5 system stubs extensionorg.openrewrite.java.testing.junit5.EnvironmentVariables
• Use wiremock extensionorg.openrewrite.java.testing.junit5.UseWiremockExtension
• Use JUnit Jupiter @Disabledorg.openrewrite.java.testing.junit5.IgnoreToDisabled
• Use JUnit Jupiter Executableorg.openrewrite.java.testing.junit5.ThrowingRunnableToExecutable
• Remove JUnit 4 @RunWith annotations that do not require an @ExtendsWith replacementorg.openrewrite.java.testing.junit5.RemoveObsoleteRunners
• Remove Maven plugin dependencyorg.openrewrite.maven.RemovePluginDependency
• Upgrade Surefire Pluginorg.openrewrite.java.testing.junit5.UpgradeSurefirePlugin
• Add Hamcrest JUnit dependencyorg.openrewrite.java.testing.junit5.AddHamcrestJUnitDependency
• Use MatcherAssert#assertThat(..)org.openrewrite.java.testing.junit5.UseHamcrestAssertThat
• Use Assertions#assume*(..) and Hamcrest's MatcherAssume#assume*(..)org.openrewrite.java.testing.junit5.MigrateAssumptions
• Migrate from JUnit 4 @FixedMethodOrder to JUnit 5 @TestMethodOrderorg.openrewrite.java.testing.junit5.UseTestMethodOrder
• Migrate JUnit 4 TestCase to JUnit Jupiterorg.openrewrite.java.testing.junit5.MigrateJUnitTestCase
• Change method nameorg.openrewrite.java.ChangeMethodName
• JUnit 4 Assert To JUnit Jupiter Assertionsorg.openrewrite.java.testing.junit5.AssertToAssertions
• JUnit 4 @Category to JUnit Jupiter @Tagorg.openrewrite.java.testing.junit5.CategoryToTag
• Migrate JUnit 4 assertion failure exceptions to JUnit Jupiterorg.openrewrite.java.testing.junit5.MigrateAssertionFailedError
• Cleanup JUnit importsorg.openrewrite.java.testing.junit5.CleanupJUnitImports
• Use JUnit Jupiter @TempDirorg.openrewrite.java.testing.junit5.TemporaryFolderToTempDir
• Make @TempDir fields non finalorg.openrewrite.java.testing.junit5.TempDirNonFinal
• JUnit TestName @Rule to JUnit Jupiter TestInfoorg.openrewrite.java.testing.junit5.TestRuleToTestInfo
• Migrate JUnit 4 lifecycle annotations to JUnit Jupiterorg.openrewrite.java.testing.junit5.UpdateBeforeAfterAnnotations
• Migrate JUnit 4 @Test annotations to JUnit 5org.openrewrite.java.testing.junit5.UpdateTestAnnotation
• JUnit 4 @Rule Timeout to JUnit Jupiter's Timeoutorg.openrewrite.java.testing.junit5.TimeoutRuleToClassAnnotation
• Add missing @BeforeEach, @AfterEach, @Test to overriding methodsorg.openrewrite.java.testing.junit5.AddMissingTestBeforeAfterAnnotations
• JUnit 4 @RunWith(Parameterized.class) to JUnit Jupiter parameterized testsorg.openrewrite.java.testing.junit5.ParameterizedRunnerToParameterized
• Pragmatists @RunWith(JUnitParamsRunner.class) to JUnit Jupiter @Parameterized testsorg.openrewrite.java.testing.junit5.JUnitParamsRunnerToParameterized
• JUnit 4 ExpectedException To JUnit Jupiter's assertThrows()org.openrewrite.java.testing.junit5.ExpectedExceptionToAssertThrows
• OkHttp 3.x MockWebServer @Rule To 4.x MockWebServerorg.openrewrite.java.testing.junit5.UpdateMockWebServer
• Use Vert.x JUnit 5 Extensionorg.openrewrite.java.testing.junit5.VertxUnitToVertxJunit5
• JUnit 4 @RunWith(Enclosed.class) to JUnit Jupiter @Nestedorg.openrewrite.java.testing.junit5.EnclosedToNested
• JUnit 5 inner test classes should be annotated with @Nestedorg.openrewrite.java.testing.junit5.AddMissingNested
• Use OkHttp 3 MockWebServer for JUnit 5org.openrewrite.java.testing.junit5.UpgradeOkHttpMockWebServer
• Use Mockito JUnit Jupiter extensionorg.openrewrite.java.testing.junit5.UseMockitoExtension
• Add org.hamcrest:hamcrest if it is usedorg.openrewrite.java.testing.hamcrest.AddHamcrestIfUsed
• Use XMLUnit Legacy for JUnit 5org.openrewrite.java.testing.junit5.UseXMLUnitLegacy
• Remove a Gradle or Maven dependencyorg.openrewrite.java.dependencies.RemoveDependency
• Remove Maven managed dependencyorg.openrewrite.maven.RemoveManagedDependency
• Exclude JUnit 4, unless Testcontainers is usedorg.openrewrite.java.testing.junit5.ExcludeJUnit4UnlessUsingTestcontainers
• Remove a Gradle or Maven dependencyorg.openrewrite.java.dependencies.RemoveDependency
• Remove Maven managed dependencyorg.openrewrite.maven.RemoveManagedDependency
• Exclude Maven dependencyorg.openrewrite.maven.ExcludeDependency
• Add JUnit Jupiter dependenciesorg.openrewrite.java.testing.junit5.AddJupiterDependencies
• Add Gradle or Maven dependencyorg.openrewrite.java.dependencies.AddDependency
• Upgrade Maven plugin versionorg.openrewrite.maven.UpgradePluginVersion
• Upgrade Maven plugin versionorg.openrewrite.maven.UpgradePluginVersion
• Gradle Test use JUnit Jupiterorg.openrewrite.java.testing.junit5.GradleUseJunitJupiter
• Change typeorg.openrewrite.java.ChangeType
• Use Arquillian JUnit 5 Extensionorg.openrewrite.java.testing.arquillian.ArquillianJUnit4ToArquillianJUnit5
• Use Byteman JUnit 5 dependencyorg.openrewrite.java.testing.byteman.BytemanJUnit4ToBytemanJUnit5
• Migrate rider-spring (JUnit4) to rider-junit5 (JUnit5)org.openrewrite.java.testing.dbrider.MigrateDbRiderSpringToDbRiderJUnit5
• Handle the usage of ExternalResourceRule fields using @ExtendWith(ExternalResourceSupport.class)org.openrewrite.java.testing.junit5.HandleExternalResourceRules

Data tables

Structured output this recipe can produce.

• Maven metadata failuresAttempts to resolve maven metadata that failed.org.openrewrite.maven.table.MavenMetadataFailures
• 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