testruletotestinfo.md

JUnit TestName @Rule to JUnit Jupiter TestInfo

org.openrewrite.java.testing.junit5.TestRuleToTestInfo

Replace usages of JUnit 4's @Rule TestName with JUnit 5's TestInfo.

Source

GitHub, Issue Tracker, Maven Central

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

Example

{% tabs %} {% tab title="SomeTest.java" %}

Before

{% code title="SomeTest.java" %}

import org.junit.Rule;
import org.junit.rules.TestName;

public class SomeTest {
    @Rule
    public TestName name = new TestName();
    protected String randomName() {
        return name.getMethodName();
    }

    private static class SomeInnerClass {
    }
}

{% endcode %}

After

{% code title="SomeTest.java" %}

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.TestInfo;

import java.lang.reflect.Method;
import java.util.Optional;

public class SomeTest {
    
    public String name;
    protected String randomName() {
        return name;
    }

    private static class SomeInnerClass {
    }

    @BeforeEach
    public void setup(TestInfo testInfo) {
        Optional<Method> testMethod = testInfo.getTestMethod();
        if (testMethod.isPresent()) {
            this.name = testMethod.get().getName();
        }
    }
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- SomeTest.java
+++ SomeTest.java
@@ -1,2 +1,2 @@
-import org.junit.Rule;
-import org.junit.rules.TestName;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestInfo;

@@ -4,0 +4,3 @@
import org.junit.rules.TestName;

+import java.lang.reflect.Method;
+import java.util.Optional;
+
public class SomeTest {
@@ -5,2 +8,2 @@

public class SomeTest {
-   @Rule
-   public TestName name = new TestName();
+   
+   public String name;
    protected String randomName() {
@@ -8,1 +11,1 @@
    public TestName name = new TestName();
    protected String randomName() {
-       return name.getMethodName();
+       return name;
    }
@@ -13,0 +16,8 @@
    private static class SomeInnerClass {
    }
+
+   @BeforeEach
+   public void setup(TestInfo testInfo) {
+       Optional<Method> testMethod = testInfo.getTestMethod();
+       if (testMethod.isPresent()) {
+           this.name = testMethod.get().getName();
+       }
+   }
}

{% endcode %} {% endtab %} {% endtabs %}

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-testing-frameworks:2.0.2 in your build file or by running a shell command (in which case no build changes are needed): {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

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

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

repositories {
    mavenCentral()
}

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

{% endcode %} {% endtab %} {% tab title="Maven POM" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.java.testing.junit5.TestRuleToTestInfo</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-testing-frameworks</artifactId>
            <version>2.0.2</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %}

{% tab title="Maven Command Line" %} {% code title="shell" %} You will need to have Maven installed on your machine before you can run the following command.

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.TestRuleToTestInfo

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Patrick
• Jonathan Schnéider
• Sam Snyder
• Knut Wannheden
• Scott Jungling
• Aaron Gershman

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.