parameterizedrunnertoparameterized.md

JUnit 4 @RunWith(Parameterized.class) to JUnit Jupiter parameterized tests

org.openrewrite.java.testing.junit5.ParameterizedRunnerToParameterized

Convert JUnit 4 parameterized runner the JUnit Jupiter parameterized test equivalent.

Source

GitHub, Issue Tracker, Maven Central

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

Example

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

Before

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

import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;

import java.util.Arrays;
import java.util.List;

@RunWith(Parameterized.class)
public class VetTests {

    private String firstName;
    private String lastName;
    private Integer id;

    public VetTests(String firstName, String lastName, Integer id) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.id = id;
    }

    @Test
    public void testSerialization() {
        Vet vet = new Vet();
        vet.setFirstName(firstName);
        vet.setLastName(lastName);
        vet.setId(id);
    }

    @Parameters
    public static List<Object[]> parameters() {
        return Arrays.asList(
            new Object[] { "Otis", "TheDog", 124 },
            new Object[] { "Garfield", "TheBoss", 126 });
    }
}

{% endcode %}

After

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

import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;

import java.util.Arrays;
import java.util.List;

public class VetTests {

    private String firstName;
    private String lastName;
    private Integer id;

    public void initVetTests(String firstName, String lastName, Integer id) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.id = id;
    }

    @MethodSource("parameters")
    @ParameterizedTest
    public void testSerialization(String firstName, String lastName, Integer id) {
        initVetTests(firstName, lastName, id);
        Vet vet = new Vet();
        vet.setFirstName(firstName);
        vet.setLastName(lastName);
        vet.setId(id);
    }

    public static List<Object[]> parameters() {
        return Arrays.asList(
            new Object[] { "Otis", "TheDog", 124 },
            new Object[] { "Garfield", "TheBoss", 126 });
    }
}

{% endcode %}

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

--- VetTests.java
+++ VetTests.java
@@ -1,4 +1,2 @@
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.junit.runners.Parameterized;
-import org.junit.runners.Parameterized.Parameters;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;

@@ -9,1 +7,0 @@
import java.util.List;

-@RunWith(Parameterized.class)
public class VetTests {
@@ -16,1 +13,1 @@
    private Integer id;

-   public VetTests(String firstName, String lastName, Integer id) {
+   public void initVetTests(String firstName, String lastName, Integer id) {
        this.firstName = firstName;
@@ -22,2 +19,4 @@
    }

-   @Test
-   public void testSerialization() {
+   @MethodSource("parameters")
+   @ParameterizedTest
+   public void testSerialization(String firstName, String lastName, Integer id) {
+       initVetTests(firstName, lastName, id);
        Vet vet = new Vet();
@@ -30,1 +29,0 @@
    }

-   @Parameters
    public static List<Object[]> parameters() {

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

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

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

Contributors

• Patrick Way
• Patrick
• Jonathan Schneider
• Sam Snyder
• Knut Wannheden
• Tim te Beek
• Aaron Gershman
• traceyyoshima
• Michael Keppler
• Scott Jungling

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.