Recipe testing best practices

Add to your build

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

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

rewrite {
    activeRecipe("org.openrewrite.java.recipes.RecipeTestingBestPractices")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-rewrite:0.33.0")
}

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.recipes.RecipeTestingBestPractices

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-rewrite:RELEASE

Definition

This recipe runs the following recipes in order.

• Replace Stream.collect(Collectors.toUnmodifiableList()) with Stream.toList()org.openrewrite.java.migrate.util.ReplaceStreamCollectWithToList
• One classpath argument per lineorg.openrewrite.java.recipes.ClasspathArgumentsOnePerLine
• RewriteTest classes should not be publicorg.openrewrite.java.recipes.RewriteTestClassesShouldNotBePublic
• Automatically select recipe examples from the unit test cases of a recipeorg.openrewrite.java.recipes.SelectRecipeExamples
• Single @DocumentExample per test classorg.openrewrite.java.recipes.SingleDocumentExample
• Show @DocumentExamples firstorg.openrewrite.java.recipes.ReorderTestMethods
• Replace null with RewriteTest.doesNotExist()org.openrewrite.java.recipes.ReplaceNullWithDoesNotExist
• New line at the end of SourceSpecs text blocksorg.openrewrite.java.recipes.SourceSpecTextBlockNewLine
• Minimal indentation for SourceSpecs text blocksorg.openrewrite.java.recipes.SourceSpecTextBlockIndentation
• Refactor RewriteTest to use defaults methodorg.openrewrite.java.recipes.UseRewriteTestDefaults
• Use StringUtils utility methodsorg.openrewrite.java.recipes.UseStringUtilsRecipes
• Use var for variables initialized with type castsorg.openrewrite.java.migrate.lang.var.UseVarForTypeCast
• Use var for constructor call assignmentsorg.openrewrite.java.migrate.lang.var.UseVarForConstructors
• Apply var to Generic Constructorsorg.openrewrite.java.migrate.lang.var.UseVarForGenericsConstructors
• Apply var to generic method invocationsorg.openrewrite.java.migrate.lang.var.UseVarForGenericMethodInvocations
• Use var for primitive and String variablesorg.openrewrite.java.migrate.lang.var.UseVarForPrimitive
• Use modernized java.util APIsorg.openrewrite.java.migrate.util.JavaUtilAPIs
• Convert Javadoc to Markdown documentation commentsorg.openrewrite.java.migrate.lang.JavadocToMarkdownDocComment
• JUnit 6 best practicesorg.openrewrite.java.testing.junit.JUnit6BestPractices
• AssertJ best practicesorg.openrewrite.java.testing.assertj.Assertj
• Fix missing bracesorg.openrewrite.staticanalysis.NeedBraces
• Remove System.out#println statementsorg.openrewrite.staticanalysis.RemoveSystemOutPrintln
• Reorder annotations alphabeticallyorg.openrewrite.staticanalysis.ReorderAnnotations
• Use static import org.openrewrite..Assertions *(..)org.openrewrite.java.UseStaticImport
• Use static import org.openrewrite.test.RewriteTest *(..)org.openrewrite.java.UseStaticImport
• Use static import org.openrewrite.test.SourceSpecs *(..)org.openrewrite.java.UseStaticImport
• Change method target to staticorg.openrewrite.java.ChangeMethodTargetToStatic
• Change method name java.util.List asList(..) to oforg.openrewrite.java.ChangeMethodName

Data tables

Structured output this recipe can produce.

• Maven metadata failuresAttempts to resolve maven metadata that failed.org.openrewrite.maven.table.MavenMetadataFailures
• Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
• Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
• Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
• Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats