Moderne licensed

Migrate Spring Boot 2.x projects to JUnit 5 from JUnit 4

Recipe IDorg.openrewrite.java.spring.boot2.SpringBoot2JUnit4to5MigrationArtifactorg.openrewrite.recipe:rewrite-spring

This recipe will migrate a Spring Boot application's tests from JUnit 4 to JUnit 5. This spring-specific migration includes conversion of Spring Test runners to Spring Test extensions and awareness of the composable Spring Test annotations.

Composite recipespringjunitjupitertestbootMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.java.spring.boot2.SpringBoot2JUnit4to5Migration")
}

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-spring:6.40.0")
}

Then run

./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.spring.boot2.SpringBoot2JUnit4to5Migration

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

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

Definition

This recipe runs the following recipes in order.

JUnit Jupiter migration from JUnit 4.xorg.openrewrite.java.testing.junit5.JUnit4to5Migration
Migrate @OutputCaptureRule to @ExtendWith(OutputCaptureExtension.class)org.openrewrite.java.spring.boot2.OutputCaptureExtension
Remove unnecessary Spring @RunWithorg.openrewrite.java.spring.boot2.UnnecessarySpringRunWith
Remove @SpringExtensionorg.openrewrite.java.spring.boot2.UnnecessarySpringExtension
Replace @ExtendWith and @ContextConfiguration with @SpringJunitConfigorg.openrewrite.java.spring.boot2.ReplaceExtendWithAndContextConfiguration
Remove obsolete Spring JUnit runnersorg.openrewrite.java.spring.boot2.RemoveObsoleteSpringRunners
Replace SpringClassRule and SpringMethodRule with JUnit 5 SpringExtensionorg.openrewrite.java.spring.test.SpringRulesToJUnitExtension
Add Gradle or Maven dependencyorg.openrewrite.java.dependencies.AddDependency

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