Refaster rules that replace TestNG assertions with equivalent AssertJ assertions

tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes

_

Some of the classes below have TestNG @BeforeTemplates that reference wildcard type bounds (<?>), while the associated AssertJ @AfterTemplates reference stricter type bounds. This introduces the risk of producing invalid code. We do this anyway, because TestNG's wildcard types can cause javac to infer less specific types than AssertJ requires, while the appropriate (more specific) types will be inferred properly when plugged into AssertJ's API.

The following is an example of a TestNG statement, which would not be rewritten if it weren't for the wildcard matching (note that the type parameters of the map on the right-hand side will be inferred to be `` rather than ``).

{@code
 List> myMaps = new ArrayList<>();
 assertEquals(myMaps, ImmutableList.of(ImmutableMap.of()));
 }

. [Source](https://error-prone.picnic.tech/refasterrules/TestNGToAssertJRules)._

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-third-party

• version: 0.5.1

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-third-party:0.5.1 in your build file or by running a shell command (in which case no build changes are needed):

Gradle

1. Add the following to your build.gradle file:

build.gradle

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

rewrite {
    activeRecipe("tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-third-party:0.5.1")
}

2. Run gradle rewriteRun to run the recipe.

Gradle init script

1. Create a file named init.gradle in the root of your project.

init.gradle

initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:6.16.1") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-third-party:0.5.1")
    }
    rewrite {
        activeRecipe("tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes")
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

2. Run gradle --init-script init.gradle rewriteRun to run the recipe.

Maven POM

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.34.0</version>
        <configuration>
          
          <activeRecipes>
            <recipe>tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-third-party</artifactId>
            <version>0.5.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Maven Command Line

You will need to have Maven installed on your machine before you can run the following command.

shell

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-third-party:RELEASE -Drewrite.activeRecipes=tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes 

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe TestNGToAssertJRulesRecipes

Definition

Recipe List

• Refaster template TestNGToAssertJRules.Fail

• Refaster template TestNGToAssertJRules.FailWithMessage

• Refaster template TestNGToAssertJRules.FailWithMessageAndThrowable

• Refaster template TestNGToAssertJRules.AssertTrue

• Refaster template TestNGToAssertJRules.AssertTrueWithMessage

• Refaster template TestNGToAssertJRules.AssertFalse

• Refaster template TestNGToAssertJRules.AssertFalseWithMessage

• Refaster template TestNGToAssertJRules.AssertNull

• Refaster template TestNGToAssertJRules.AssertNullWithMessage

• Refaster template TestNGToAssertJRules.AssertNotNull

• Refaster template TestNGToAssertJRules.AssertNotNullWithMessage

• Refaster template TestNGToAssertJRules.AssertSame

• Refaster template TestNGToAssertJRules.AssertSameWithMessage

• Refaster template TestNGToAssertJRules.AssertNotSame

• Refaster template TestNGToAssertJRules.AssertNotSameWithMessage

• Refaster template TestNGToAssertJRules.AssertEqual

• Refaster template TestNGToAssertJRules.AssertEqualWithMessage

• Refaster template TestNGToAssertJRules.AssertEqualFloatsWithDelta

• Refaster template TestNGToAssertJRules.AssertEqualFloatsWithDeltaWithMessage

• Refaster template TestNGToAssertJRules.AssertEqualDoublesWithDelta

• Refaster template TestNGToAssertJRules.AssertEqualDoublesWithDeltaWithMessage

• Refaster template TestNGToAssertJRules.AssertEqualArrayIterationOrder

• Refaster template TestNGToAssertJRules.AssertEqualArrayIterationOrderWithMessage

• Refaster template TestNGToAssertJRules.AssertEqualArraysIrrespectiveOfOrder

• Refaster template TestNGToAssertJRules.AssertEqualArraysIrrespectiveOfOrderWithMessage

• Refaster template TestNGToAssertJRules.AssertUnequal

• Refaster template TestNGToAssertJRules.AssertUnequalWithMessage

• Refaster template TestNGToAssertJRules.AssertUnequalFloatsWithDelta

• Refaster template TestNGToAssertJRules.AssertUnequalFloatsWithDeltaWithMessage

• Refaster template TestNGToAssertJRules.AssertUnequalDoublesWithDelta

• Refaster template TestNGToAssertJRules.AssertUnequalDoublesWithDeltaWithMessage

• Refaster template TestNGToAssertJRules.AssertThrows

Yaml Recipe List

       ---
       type: specs.openrewrite.org/v1beta/recipe
       name: tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes
       displayName: Refaster rules that replace TestNG assertions with equivalent AssertJ assertions
       description: <p>Some of the classes below have TestNG `@BeforeTemplate`s that reference wildcard type
bounds (`<?>`), while the associated AssertJ `@AfterTemplate`s reference stricter
type bounds. This introduces the risk of producing invalid code. We do this anyway, because
TestNG's wildcard types can cause javac to infer less specific types than AssertJ requires, while
the appropriate (more specific) types _will_ be inferred properly when plugged into AssertJ's
API.

<p>The following is an example of a TestNG statement, which would not be rewritten if it weren't
for the wildcard matching (note that the type parameters of the map on the right-hand side will
be inferred to be `<Object, Object>` rather than `<String, Object>`).

<pre>{@code
List<Map<String, Object>> myMaps = new ArrayList<>();
assertEquals(myMaps, ImmutableList.of(ImmutableMap.of()));
}</pre>. [Source](https://error-prone.picnic.tech/refasterrules/TestNGToAssertJRules).
recipeList:
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$FailRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$FailWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$FailWithMessageAndThrowableRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertTrueRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertTrueWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertFalseRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertFalseWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertNullRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertNullWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertNotNullRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertNotNullWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertSameRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertSameWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertNotSameRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertNotSameWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualFloatsWithDeltaRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualFloatsWithDeltaWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualDoublesWithDeltaRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualDoublesWithDeltaWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualArrayIterationOrderRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualArrayIterationOrderWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualArraysIrrespectiveOfOrderRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertEqualArraysIrrespectiveOfOrderWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertUnequalRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertUnequalWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertUnequalFloatsWithDeltaRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertUnequalFloatsWithDeltaWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertUnequalDoublesWithDeltaRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertUnequalDoublesWithDeltaWithMessageRecipe
  - tech.picnic.errorprone.refasterrules.TestNGToAssertJRulesRecipes$AssertThrowsRecipe

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.