(re)activate rewrite capability

Author: Vincent Potucek

CONTRIBUTING.md

@@ -72,9 +72,9 @@ Whenever an acronym is included as part of a field name or parameter name:
 - Otherwise, keep the first letter of the acronym uppercase and use lowercase for the
   rest of the acronym -- for example, `String defaultUrl;`.
 
-### Formatting
+### Automated Refactoring
 
-#### Code
+#### Formatting
 
 Code formatting is enforced using the [Spotless](https://github.com/diffplug/spotless)
 Gradle plugin. You can use `gradle spotlessApply` to format new code and add missing
@@ -89,6 +89,12 @@ Eclipse settings.
 It is forbidden to use _wildcard imports_ (e.g., `import static org.junit.jupiter.api.Assertions.*;`)
 in Java code.
 
+#### Recipes
+
+The build system incorporates [Moderne](https://moderne.io/) rewrite capabilities for automated code transformations. These modifications are environment-driven enlisted in the [junitbuild.java-library-conventions.gradle.kts](gradle/plugins/common/src/main/kotlin/junitbuild.java-library-conventions.gradle.kts)
+
+You can use `gradle rewriteRun` to apply these changes.
+
 #### Documentation
 
 Text in `*.adoc` and `*.md` files should be wrapped at 90 characters whenever technically

documentation/src/test/resources/log4j2-test.xml

@@ -16,4 +16,4 @@
 			<AppenderRef ref="Console" />
 		</Root>
 	</Loggers>
-</Configuration>
+</Configuration>

gradle/plugins/common/src/main/kotlin/junitbuild.java-library-conventions.gradle.kts

@@ -18,12 +18,14 @@ plugins {
 }
 
 rewrite {
-	activeRecipe("org.openrewrite.java.migrate.UpgradeToJava17")
+	activeRecipe("org.openrewrite.staticanalysis.MissingOverrideAnnotation")
+	activeRecipe("org.openrewrite.staticanalysis.RemoveUnusedPrivateMethods")
+	activeRecipe("org.openrewrite.text.EndOfLineAtEndOfFile")
+	failOnDryRunResults = true
 }
-
 dependencies {
 	rewrite(platform(dependencyFromLibs("openrewrite-recipe-bom")))
-	rewrite("org.openrewrite.recipe:rewrite-migrate-java")
+	rewrite("org.openrewrite.recipe:rewrite-static-analysis")
 }
 
 val mavenizedProjects: List<Project> by rootProject.extra
@@ -281,6 +283,9 @@ tasks {
 	checkstyleTest {
 		config = resources.text.fromFile(checkstyle.configDirectory.file("checkstyleTest.xml"))
 	}
+	check {
+		dependsOn(rewriteDryRun)
+	}
 }
 
 pluginManager.withPlugin("java-test-fixtures") {

gradle/plugins/common/src/main/kotlin/junitbuild.spotless-conventions.gradle.kts

@@ -13,13 +13,11 @@ spotless {
 		targetExclude("gradle/plugins/**/build/**")
 		leadingSpacesToTabs()
 		trimTrailingWhitespace()
-		endWithNewline()
 	}
 
 	format("documentation") {
 		target("*.adoc", "*.md", "src/**/*.adoc", "src/**/*.md")
 		trimTrailingWhitespace()
-		endWithNewline()
 	}
 
 	pluginManager.withPlugin("java") {
@@ -36,7 +34,6 @@ spotless {
 			val majorMinorVersion = "([0-9]+\\.[0-9]+).*".toRegex().matchEntire(fullVersion)!!.let { it.groups[1]!!.value }
 			eclipse(majorMinorVersion).configFile(javaFormatterConfigFile)
 			trimTrailingWhitespace()
-			endWithNewline()
 			removeUnusedImports()
 		}
 
@@ -46,7 +43,6 @@ spotless {
 			})
 			licenseHeaderFile(license.headerFile, "^$")
 			trimTrailingWhitespace()
-			endWithNewline()
 		}
 	}
 
@@ -56,7 +52,6 @@ spotless {
 			ktlint(requiredVersionFromLibs("ktlint"))
 			licenseHeaderFile(license.headerFile)
 			trimTrailingWhitespace()
-			endWithNewline()
 		}
 		configurations.named { it.startsWith("spotless") }.configureEach {
 			// Workaround for CVE-2024-12798 and CVE-2024-12801
@@ -74,7 +69,6 @@ spotless {
 		groovy {
 			licenseHeaderFile(license.headerFile)
 			trimTrailingWhitespace()
-			endWithNewline()
 		}
 	}
 }

junit-jupiter-engine/src/main/resources/META-INF/services/org.junit.platform.engine.TestEngine

@@ -1 +1 @@
-org.junit.jupiter.engine.JupiterTestEngine
+org.junit.jupiter.engine.JupiterTestEngine

junit-vintage-engine/src/main/resources/META-INF/services/org.junit.platform.engine.TestEngine

@@ -1 +1 @@
-org.junit.vintage.engine.VintageTestEngine
+org.junit.vintage.engine.VintageTestEngine

junit-vintage-engine/src/test/resources/log4j2-test.xml

@@ -13,4 +13,4 @@
 			<AppenderRef ref="Console" />
 		</Root>
 	</Loggers>
-</Configuration>
+</Configuration>

platform-tests/src/test/resources/do_not_delete_me.txt

@@ -1,3 +1,3 @@
 I am used by tests, so...
 
-Do NOT delete me!
+Do NOT delete me!

platform-tests/src/test/resources/testservices/META-INF/services/org.junit.platform.launcher.TestExecutionListener

@@ -1,3 +1,3 @@
 org.junit.platform.launcher.listeners.NoopTestExecutionListener
 org.junit.platform.launcher.listeners.UnusedTestExecutionListener
-org.junit.platform.launcher.listeners.AnotherUnusedTestExecutionListener
+org.junit.platform.launcher.listeners.AnotherUnusedTestExecutionListener

rewrite.yml

@@ -0,0 +1,33 @@
+type: specs.openrewrite.org/v1beta/recipe
+name: org.junit.jupiter.AddLicenseHeader
+displayName: AddLicenseHeader
+recipeList:
+  - org.openrewrite.java.AddLicenseHeader:
+    licenseText: """
+      /*
+       * Copyright 2015-${CURRENT_YEAR} the original author or authors.
+       *
+       * All rights reserved. This program and the accompanying materials are
+       * made available under the terms of the Eclipse Public License v2.0 which
+       * accompanies this distribution and is available at
+       *
+       * https://www.eclipse.org/legal/epl-v20.html
+       */
+      """
+---
+type: specs.openrewrite.org/v1beta/style
+name: org.junit.jupiter.NoTabsNoStarImports
+styleConfigs:
+  - org.openrewrite.java.style.TabsAndIndentsStyle:
+      useTabCharacter: false
+  - org.openrewrite.java.style.ImportLayoutStyle:
+      classCountToUseStarImport: 999
+---
+# remove after 21 migration
+type: specs.openrewrite.org/v1beta/recipe
+name: org.junit.jupiter.Java21ForTests
+displayName: Java21ForTests
+preconditions:
+ - org.openrewrite.java.search.IsLikelyTest
+recipeList:
+ - org.openrewrite.java.migrate.UpgradeToJava21