Refaster rules related to AssertJ assertions over expressions that may throw a Throwable subtype

tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes

For reasons of consistency we prefer org.assertj.core.api.Assertions#assertThatThrownBy over static methods for specific exception types. Note that only the most common assertion expressions are rewritten here; covering all cases would require the implementation of an Error Prone check instead. Source.

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.AssertJThrowingCallableRulesRecipes")
}

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.AssertJThrowingCallableRulesRecipes")
    }
    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.AssertJThrowingCallableRulesRecipes</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.AssertJThrowingCallableRulesRecipes 

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 AssertJThrowingCallableRulesRecipes

Definition

Recipe List

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIllegalArgumentException

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIllegalArgumentExceptionHasMessage

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIllegalArgumentExceptionHasMessageStartingWith

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIllegalArgumentExceptionHasMessageContaining

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIllegalStateException

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIllegalStateExceptionHasMessage

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIllegalStateExceptionHasMessageStartingWith

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIllegalStateExceptionHasMessageContaining

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIllegalStateExceptionHasMessageNotContaining

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByNullPointerException

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByNullPointerExceptionHasMessage

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByNullPointerExceptionHasMessageStartingWith

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByNullPointerExceptionHasMessageContaining

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByNullPointerExceptionHasMessageNotContaining

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIOException

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIOExceptionHasMessage

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIOExceptionHasMessageStartingWith

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIOExceptionHasMessageContaining

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByIOExceptionHasMessageNotContaining

• Refaster template AssertJThrowingCallableRules.AssertThatThrownBy

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByHasMessage

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByHasMessageStartingWith

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByHasMessageContaining

• Refaster template AssertJThrowingCallableRules.AssertThatThrownByHasMessageNotContaining

Yaml Recipe List

       ---
       type: specs.openrewrite.org/v1beta/recipe
       name: tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes
       displayName: Refaster rules related to AssertJ assertions over expressions that may throw a `Throwable` subtype
       description: <p>For reasons of consistency we prefer `org.assertj.core.api.Assertions#assertThatThrownBy` over static methods for specific exception
types. Note that only the most common assertion expressions are rewritten here; covering all
cases would require the implementation of an Error Prone check instead. [Source](https://error-prone.picnic.tech/refasterrules/AssertJThrowingCallableRules).
recipeList:
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIllegalArgumentExceptionRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIllegalArgumentExceptionHasMessageRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIllegalArgumentExceptionHasMessageStartingWithRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIllegalArgumentExceptionHasMessageContainingRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIllegalStateExceptionRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIllegalStateExceptionHasMessageRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIllegalStateExceptionHasMessageStartingWithRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIllegalStateExceptionHasMessageContainingRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIllegalStateExceptionHasMessageNotContainingRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByNullPointerExceptionRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByNullPointerExceptionHasMessageRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByNullPointerExceptionHasMessageStartingWithRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByNullPointerExceptionHasMessageContainingRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByNullPointerExceptionHasMessageNotContainingRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIOExceptionRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIOExceptionHasMessageRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIOExceptionHasMessageStartingWithRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIOExceptionHasMessageContainingRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByIOExceptionHasMessageNotContainingRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByHasMessageRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByHasMessageStartingWithRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByHasMessageContainingRecipe
  - tech.picnic.errorprone.refasterrules.AssertJThrowingCallableRulesRecipes$AssertThatThrownByHasMessageNotContainingRecipe

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.