JUnit Jupiter migration from JUnit 4.x

org.openrewrite.java.testing.junit5.JUnit4to5Migration

Migrates JUnit 4.x tests to JUnit Jupiter.

Tags

• junit

• testing

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-testing-frameworks

• version: 2.7.0

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-testing-frameworks:2.7.0 in your build file or by running a shell command (in which case no build changes are needed):

Gradle

1. Add the following to your build.gradle file:

build.gradle

plugins {
    id("org.openrewrite.rewrite") version("6.12.0")
}

rewrite {
    activeRecipe("org.openrewrite.java.testing.junit5.JUnit4to5Migration")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-testing-frameworks:2.7.0")
}

2. Run gradle rewriteRun to run the recipe.

Gradle init script

1. Create a file named init.gradle in the root of your project.

init.gradle

initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:6.12.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-testing-frameworks:2.7.0")
    }
    rewrite {
        activeRecipe("org.openrewrite.java.testing.junit5.JUnit4to5Migration")
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

2. Run gradle --init-script init.gradle rewriteRun to run the recipe.

Maven POM

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.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>2.7.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Maven Command Line

shell

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-testing-frameworks:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.testing.junit5.JUnit4to5Migration

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe JUnit4to5Migration

Definition

Recipe List

• Use wiremock extension

• Use JUnit Jupiter @Disabled

• Use JUnit Jupiter Executable

• 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 Assertions#assume*(..) and Hamcrest's MatcherAssume#assume*(..)

• Use Mockito JUnit Jupiter extension

• Migrate from JUnit 4 @FixedMethodOrder to JUnit 5 @TestMethodOrder

• Migrate JUnit 4 TestCase to JUnit Jupiter

• Change method name

  • methodPattern: org.junit.Assert assertEquals(.., Object[], Object[])

  • newMethodName: assertArrayEquals

• 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

• Migrate JUnit 4 @Test annotations to JUnit 5

• Add missing @BeforeEach, @AfterEach, @Test to overriding methods

• 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()

• OkHttp 3.x MockWebServer @Rule To 4.x MockWebServer

• Use Vert.x 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.

• Use XMLUnit Legacy for JUnit 5

• Remove a Gradle or Maven dependency

  • groupId: junit

  • artifactId: junit

• Exclude Maven dependency

  • groupId: junit

  • artifactId: junit

• Remove exclusion

  • groupId: org.testcontainers

  • artifactId: testcontainers

  • exclusionGroupId: junit

  • exclusionArtifactId: junit

• Remove exclusion

  • groupId: org.springframework.boot

  • artifactId: spring-boot-testcontainers

  • exclusionGroupId: junit

  • exclusionArtifactId: junit

• Remove a Gradle or Maven dependency

  • groupId: org.junit.vintage

  • artifactId: junit-vintage-engine

• Exclude Maven dependency

  • groupId: org.junit.vintage

  • artifactId: junit-vintage-engine

• Add JUnit Jupiter dependencies

• Add Gradle or Maven dependency

  • groupId: org.junit.jupiter

  • artifactId: junit-jupiter-params

  • version: 5.x

  • onlyIfUsing: org.junit.jupiter.params.ParameterizedTest

  • scope: test

  • acceptTransitive: true

• Upgrade Gradle or Maven dependency versions

  • groupId: org.mockito

  • artifactId: *

  • newVersion: 3.x

  • overrideManagedVersion: false

• Add Gradle or Maven dependency

  • groupId: org.mockito

  • artifactId: mockito-junit-jupiter

  • version: 3.x

  • onlyIfUsing: org.mockito..*

  • scope: test

  • acceptTransitive: true

• Upgrade Maven plugin version

  • groupId: org.apache.maven.plugins

  • artifactId: maven-surefire-plugin

  • newVersion: 3.1.x

• Upgrade Maven plugin version

  • groupId: org.apache.maven.plugins

  • artifactId: maven-failsafe-plugin

  • newVersion: 3.1.x

• Gradle Test use JUnit Jupiter

Yaml Recipe List

---
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.testing.junit5.ThrowingRunnableToExecutable
  - 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.MigrateAssumptions
  - org.openrewrite.java.testing.junit5.UseMockitoExtension
  - org.openrewrite.java.testing.junit5.UseTestMethodOrder
  - org.openrewrite.java.testing.junit5.MigrateJUnitTestCase
  - org.openrewrite.java.ChangeMethodName:
      methodPattern: org.junit.Assert assertEquals(.., Object[], Object[])
      newMethodName: assertArrayEquals
  - 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.UpdateTestAnnotation
  - org.openrewrite.java.testing.junit5.AddMissingTestBeforeAfterAnnotations
  - 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.java.testing.junit5.UseXMLUnitLegacy
  - org.openrewrite.java.dependencies.RemoveDependency:
      groupId: junit
      artifactId: junit
  - org.openrewrite.maven.ExcludeDependency:
      groupId: junit
      artifactId: junit
  - org.openrewrite.maven.RemoveExclusion:
      groupId: org.testcontainers
      artifactId: testcontainers
      exclusionGroupId: junit
      exclusionArtifactId: junit
  - org.openrewrite.maven.RemoveExclusion:
      groupId: org.springframework.boot
      artifactId: spring-boot-testcontainers
      exclusionGroupId: junit
      exclusionArtifactId: junit
  - org.openrewrite.java.dependencies.RemoveDependency:
      groupId: org.junit.vintage
      artifactId: junit-vintage-engine
  - org.openrewrite.maven.ExcludeDependency:
      groupId: org.junit.vintage
      artifactId: junit-vintage-engine
  - org.openrewrite.java.testing.junit5.AddJupiterDependencies
  - org.openrewrite.java.dependencies.AddDependency:
      groupId: org.junit.jupiter
      artifactId: junit-jupiter-params
      version: 5.x
      onlyIfUsing: org.junit.jupiter.params.ParameterizedTest
      scope: test
      acceptTransitive: true
  - org.openrewrite.java.dependencies.UpgradeDependencyVersion:
      groupId: org.mockito
      artifactId: *
      newVersion: 3.x
      overrideManagedVersion: false
  - org.openrewrite.java.dependencies.AddDependency:
      groupId: org.mockito
      artifactId: mockito-junit-jupiter
      version: 3.x
      onlyIfUsing: org.mockito..*
      scope: test
      acceptTransitive: true
  - org.openrewrite.maven.UpgradePluginVersion:
      groupId: org.apache.maven.plugins
      artifactId: maven-surefire-plugin
      newVersion: 3.1.x
  - org.openrewrite.maven.UpgradePluginVersion:
      groupId: org.apache.maven.plugins
      artifactId: maven-failsafe-plugin
      newVersion: 3.1.x
  - org.openrewrite.java.testing.junit5.GradleUseJunitJupiter

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform 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.

Contributors

Patrick Way, Sam Snyder, Jonathan Schneider, Knut Wannheden, Patrick, Greg Adams, Jonathan Schnéider, Tracey Yoshima, Greg Adams, Tim te Beek, magicwerk, Nick McKinney, Tyler Van Gorder, Tim te Beek, Sofia Britto Schwartz, Aaron Gershman, Michael Keppler, John Burns, traceyyoshima, Scott Jungling, Tim te Beek, Peter Puškár, Joan Viladrosa, Kun Li, Kyle Scully, Simon Verhoeven, Mike Solomon