removetestprefix.md

Remove test prefix from JUnit 5 tests

org.openrewrite.java.testing.cleanup.RemoveTestPrefix

Remove test from methods with @Test, @ParameterizedTest, @RepeatedTest or @TestFactory. They no longer have to prefix test to be usable by JUnit 5.

Source

GitHub, Issue Tracker, Maven Central

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

Example

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

Before

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

import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;

class ATest {
    @Test
    void testMethod() {
    }

    @Test
    void test_snake_case() {
    }

    @Nested
    class NestedTestClass {
        @Test
        void testAnotherTestMethod() {
        }
    }

    @Nested
    class AnotherNestedTestClass {
        @Test
        void testYetAnotherTestMethod() {
        }
    }
}

{% endcode %}

After

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

import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;

class ATest {
    @Test
    void method() {
    }

    @Test
    void snake_case() {
    }

    @Nested
    class NestedTestClass {
        @Test
        void anotherTestMethod() {
        }
    }

    @Nested
    class AnotherNestedTestClass {
        @Test
        void yetAnotherTestMethod() {
        }
    }
}

{% endcode %}

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

--- ATest.java
+++ ATest.java
@@ -6,1 +6,1 @@
class ATest {
    @Test
-   void testMethod() {
+   void method() {
    }
@@ -10,1 +10,1 @@

    @Test
-   void test_snake_case() {
+   void snake_case() {
    }
@@ -16,1 +16,1 @@
    class NestedTestClass {
        @Test
-       void testAnotherTestMethod() {
+       void anotherTestMethod() {
        }
@@ -23,1 +23,1 @@
    class AnotherNestedTestClass {
        @Test
-       void testYetAnotherTestMethod() {
+       void yetAnotherTestMethod() {
        }

{% 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.cleanup.RemoveTestPrefix")
}

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.cleanup.RemoveTestPrefix</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.cleanup.RemoveTestPrefix

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

Contributors

• Tim te Beek
• Knut Wannheden
• Patrick
• Jonathan Schnéider
• Michael Keppler

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.