JUnit Jupiter migration from JUnit 4.x

org.openrewrite.java.testing.junit5.JUnit4to5Migration Migrates JUnit 4.x tests to JUnit Jupiter.
Tags
junit
testing
Source
​Github, Issue Tracker, Maven Central​
groupId: org.openrewrite.recipe
artifactId: rewrite-testing-frameworks
version: 1.35.0
Usage
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-testing-frameworks:1.35.0 in your build file or by running a shell command (in which case no build changes are needed):
Gradle
Maven POM
Maven Command Line
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("5.38.0")
}
​
rewrite {
    activeRecipe("org.openrewrite.java.testing.junit5.JUnit4to5Migration")
}
​
repositories {
    mavenCentral()
}
​
dependencies {
    rewrite("org.openrewrite.recipe:rewrite-testing-frameworks:1.35.0")
}
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>4.42.0</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.java.testing.junit5.JUnit4to5Migration</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-testing-frameworks</artifactId>
            <version>1.35.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>
shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-testing-frameworks:LATEST \
  -Drewrite.activeRecipes=org.openrewrite.java.testing.junit5.JUnit4to5Migration
Definition
Recipe List
Yaml Recipe List
​Use wiremock extension​
​Use JUnit Jupiter @Disabled​
​Reorder method arguments​
methodPattern: org.junit.Assume assume*(String, boolean)
newParameterNames: [b, message]
oldParameterNames: [message, b]
​Change type​
oldFullyQualifiedTypeName: org.junit.Assume
newFullyQualifiedTypeName: org.junit.jupiter.api.Assumptions
​Remove JUnit 4 @RunWith annotations that do not require an @ExtendsWith replacement​
obsoleteRunners: [org.junit.runners.JUnit4, org.junit.runners.BlockJUnit4ClassRunner]
​Remove Maven plugin dependency​
pluginGroupId: org.apache.maven.plugins
pluginArtifactId: maven-surefire-plugin
groupId: org.apache.maven.surefire
artifactId: surefire-junit*
​Use MatcherAssert#assertThat(..)​
​Use Mockito JUnit Jupiter extension​
​Migrate from JUnit 4 @FixedMethodOrder to JUnit 5 @TestMethodOrder​
​Migrate JUnit 4 TestCase to JUnit Jupiter​
​JUnit 4 Assert To JUnit Jupiter Assertions​
​JUnit 4 @Category to JUnit Jupiter @Tag​
​Cleanup JUnit imports​
​Use JUnit Jupiter @TempDir​
​Make @TempDir fields non final​
​JUnit TestName @Rule to JUnit Jupiter TestInfo​
​Migrate JUnit 4 lifecycle annotations to JUnit Jupiter​
​Make lifecycle methods non private​
​Migrate JUnit 4 @Test annotations to JUnit 5​
​JUnit 4 @RunWith(Parameterized.class) to JUnit Jupiter parameterized tests​
​Pragmatists @RunWith(JUnitParamsRunner.class) to JUnit Jupiter Parameterized Tests​
​JUnit 4 ExpectedException To JUnit Jupiter's assertThrows()​
​okhttp3 3.x MockWebserver @Rule To 4.x MockWebServer​
​Use Vertx JUnit 5 Extension​
​JUnit 4 @RunWith(Enclosed.class) to JUnit Jupiter @Nested​
​JUnit 5 inner test classes should be annotated with @Nested​
​Add org.hamcrest:hamcrest if it is used.​
​Remove Maven dependency​
groupId: junit
artifactId: junit
​Exclude Maven dependency​
groupId: junit
artifactId: junit
​Remove Maven dependency​
groupId: org.junit.vintage
artifactId: junit-vintage-engine
​Exclude Maven dependency​
groupId: org.junit.vintage
artifactId: junit-vintage-engine
​Add Maven dependency​
groupId: org.junit.jupiter
artifactId: junit-jupiter
version: 5.x
onlyIfUsing: org.junit.jupiter.api.Test
​Add Maven dependency​
groupId: org.junit.jupiter
artifactId: junit-jupiter-params
version: 5.x
onlyIfUsing: org.junit.jupiter.params.ParameterizedTest
​Upgrade Maven plugin version​
groupId: org.apache.maven.plugins
artifactId: maven-surefire-plugin
newVersion: 2.22.x
​Upgrade Maven plugin version​
groupId: org.apache.maven.plugins
artifactId: maven-failsafe-plugin
newVersion: 2.22.x
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.testing.junit5.JUnit4to5Migration
displayName: JUnit Jupiter migration from JUnit 4.x
description: Migrates JUnit 4.x tests to JUnit Jupiter.
tags:
  - junit
  - testing
recipeList:
  - org.openrewrite.java.testing.junit5.UseWiremockExtension
  - org.openrewrite.java.testing.junit5.IgnoreToDisabled
  - org.openrewrite.java.ReorderMethodArguments:
      methodPattern: org.junit.Assume assume*(String, boolean)
      newParameterNames: [b, message]
      oldParameterNames: [message, b]
  - org.openrewrite.java.ChangeType:
      oldFullyQualifiedTypeName: org.junit.Assume
      newFullyQualifiedTypeName: org.junit.jupiter.api.Assumptions
  - org.openrewrite.java.testing.junit5.RemoveObsoleteRunners:
      obsoleteRunners: [org.junit.runners.JUnit4, org.junit.runners.BlockJUnit4ClassRunner]
  - org.openrewrite.maven.RemovePluginDependency:
      pluginGroupId: org.apache.maven.plugins
      pluginArtifactId: maven-surefire-plugin
      groupId: org.apache.maven.surefire
      artifactId: surefire-junit*
  - org.openrewrite.java.testing.junit5.UseHamcrestAssertThat
  - org.openrewrite.java.testing.junit5.UseMockitoExtension
  - org.openrewrite.java.testing.junit5.UseTestMethodOrder
  - org.openrewrite.java.testing.junit5.MigrateJUnitTestCase
  - org.openrewrite.java.testing.junit5.AssertToAssertions
  - org.openrewrite.java.testing.junit5.CategoryToTag
  - org.openrewrite.java.testing.junit5.CleanupJUnitImports
  - org.openrewrite.java.testing.junit5.TemporaryFolderToTempDir
  - org.openrewrite.java.testing.junit5.TempDirNonFinal
  - org.openrewrite.java.testing.junit5.TestRuleToTestInfo
  - org.openrewrite.java.testing.junit5.UpdateBeforeAfterAnnotations
  - org.openrewrite.java.testing.junit5.LifecycleNonPrivate
  - org.openrewrite.java.testing.junit5.UpdateTestAnnotation
  - org.openrewrite.java.testing.junit5.ParameterizedRunnerToParameterized
  - org.openrewrite.java.testing.junit5.JUnitParamsRunnerToParameterized
  - org.openrewrite.java.testing.junit5.ExpectedExceptionToAssertThrows
  - org.openrewrite.java.testing.junit5.UpdateMockWebServer
  - org.openrewrite.java.testing.junit5.VertxUnitToVertxJunit5
  - org.openrewrite.java.testing.junit5.EnclosedToNested
  - org.openrewrite.java.testing.junit5.AddMissingNested
  - org.openrewrite.java.testing.hamcrest.AddHamcrestIfUsed
  - org.openrewrite.maven.RemoveDependency:
      groupId: junit
      artifactId: junit
  - org.openrewrite.maven.ExcludeDependency:
      groupId: junit
      artifactId: junit
  - org.openrewrite.maven.RemoveDependency:
      groupId: org.junit.vintage
      artifactId: junit-vintage-engine
  - org.openrewrite.maven.ExcludeDependency:
      groupId: org.junit.vintage
      artifactId: junit-vintage-engine
  - org.openrewrite.maven.AddDependency:
      groupId: org.junit.jupiter
      artifactId: junit-jupiter
      version: 5.x
      onlyIfUsing: org.junit.jupiter.api.Test
  - org.openrewrite.maven.AddDependency:
      groupId: org.junit.jupiter
      artifactId: junit-jupiter-params
      version: 5.x
      onlyIfUsing: org.junit.jupiter.params.ParameterizedTest
  - org.openrewrite.maven.UpgradePluginVersion:
      groupId: org.apache.maven.plugins
      artifactId: maven-surefire-plugin
      newVersion: 2.22.x
  - org.openrewrite.maven.UpgradePluginVersion:
      groupId: org.apache.maven.plugins
      artifactId: maven-failsafe-plugin
      newVersion: 2.22.x
​
See how this recipe works across multiple open-source repositories
​​
​​
The Moderne public SaaS instance enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
JUnit Jupiter best practices
JUnit TestName @Rule to JUnit Jupiter TestInfo
Last modified 5h ago