junit5bestpractices.md

JUnit Jupiter best practices

org.openrewrite.java.testing.junit5.JUnit5BestPractices

Applies best practices to tests.

Tags

• junit
• testing

Source

GitHub, Issue Tracker, Maven Central

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

Examples

Example 1

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

Before

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

import org.junit.jupiter.api.Assertions;

public class Test {
    void method() {
        Assertions.assertTrue(true);
    }
}

{% endcode %}

After

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

import static org.junit.jupiter.api.Assertions.assertTrue;

public class Test {
    void method() {
        assertTrue(true);
    }
}

{% endcode %}

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

--- Test.java
+++ Test.java
@@ -1,1 +1,1 @@
-import org.junit.jupiter.api.Assertions;
+import static org.junit.jupiter.api.Assertions.assertTrue;

@@ -5,1 +5,1 @@
public class Test {
    void method() {
-       Assertions.assertTrue(true);
+       assertTrue(true);
    }

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

---

Example 2

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

Before

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

import org.junit.jupiter.api.Assertions;

public class Test {
    void method() {
        Assertions.assertTrue(true);
    }
}

{% endcode %}

After

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

import static org.junit.jupiter.api.Assertions.assertTrue;

public class Test {
    void method() {
        assertTrue(true);
    }
}

{% endcode %}

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

--- Test.java
+++ Test.java
@@ -1,1 +1,1 @@
-import org.junit.jupiter.api.Assertions;
+import static org.junit.jupiter.api.Assertions.assertTrue;

@@ -5,1 +5,1 @@
public class Test {
    void method() {
-       Assertions.assertTrue(true);
+       assertTrue(true);
    }

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

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.JUnit5BestPractices</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.JUnit5BestPractices

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

Definition

{% tabs %} {% tab title="Recipe List" %}

• Statically import JUnit Jupiter assertions
• JUnit Jupiter migration from JUnit 4.x
• Clean Up Assertions
• Remove public visibility of JUnit 5 tests

{% endtab %}

{% tab title="Yaml Recipe List" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.testing.junit5.JUnit5BestPractices
displayName: JUnit Jupiter best practices
description: Applies best practices to tests.
tags:
  - junit
  - testing
recipeList:
  - org.openrewrite.java.testing.junit5.StaticImports
  - org.openrewrite.java.testing.junit5.JUnit4to5Migration
  - org.openrewrite.java.testing.junit5.CleanupAssertions
  - org.openrewrite.java.testing.cleanup.TestsShouldNotBePublic:

{% endtab %} {% endtabs %}

Contributors

• Patrick Way
• Patrick
• Jonathan Schneider
• Knut Wannheden
• Sam Snyder
• Yeikel
• Jonathan Schnéider
• Greg Adams
• Tim te Beek
• Tracey Yoshima
• Greg Adams
• Nick McKinney
• Tim te Beek
• Tyler Van Gorder
• Sofia Britto Schwartz
• Aaron Gershman
• traceyyoshima
• Michael Keppler
• Ties van de Ven
• Scott Jungling
• Tim te Beek
• Kun Li
• Kyle Scully

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.