Links

Remove JUnit 4 @RunWith annotations that do not require an @ExtendsWith replacement

org.openrewrite.java.testing.junit5.RemoveObsoleteRunners
Some JUnit 4 @RunWith annotations do not require replacement with an equivalent JUnit Jupiter @ExtendsWith annotation. This can be used to remove those runners that either do not have a JUnit Jupiter equivalent or do not require a replacement as part of JUnit 4 to 5 migration.

Recipe source

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-testing-frameworks
  • version: 2.4.1

Options

Type
Name
Description
Example
List
obsoleteRunners
The fully qualified class names of the JUnit 4 runners to be removed.
org.junit.runners.JUnit4

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.RemoveObsoleteRunnersExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.RemoveObsoleteRunnersExample
displayName: Remove JUnit 4 `@RunWith` annotations that do not require an `@ExtendsWith` replacement example
recipeList:
- org.openrewrite.java.testing.junit5.RemoveObsoleteRunners:
obsoleteRunners: org.junit.runners.JUnit4
Now that com.yourorg.RemoveObsoleteRunnersExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-testing-frameworks:2.4.1 in your build file:
Gradle
Maven
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.8.4")
}
rewrite {
activeRecipe("com.yourorg.RemoveObsoleteRunnersExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-testing-frameworks:2.4.1")
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 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.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.RemoveObsoleteRunnersExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-testing-frameworks</artifactId>
<version>2.4.1</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe RemoveObsoleteRunnersExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
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