[rewrite] add org.junit.openrewrite.SanityCheck

- https://docs.openrewrite.org/recipes/java/testing/junit/jupiterbestpractices

- https://docs.openrewrite.org/recipes/staticanalysis/commonstaticanalysis

- https://docs.openrewrite.org/recipes/java/migrate/upgradetojava17

Signed-off-by: Vincent Potucek <vpotucek@me.com>

Author: Vincent Potucek

.github/workflows/rewrite.yml

@@ -0,0 +1,28 @@
+name: Rewrite ✅
+on:
+  push:
+    branches:
+      - main
+      - 'releases/**'
+    paths:
+      - '.github/**'
+  pull_request:
+    paths:
+      - '.github/**'
+permissions: {}
+jobs:
+  rewrite:
+    name: Sanity Check 🕊
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+    steps:
+      - name: Checkout Repository 📥
+        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        with:
+          persist-credentials: false
+      - name: Dry Run 🧮
+        uses: ./.github/actions/run-gradle
+        with:
+          encryptionKey: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
+          arguments: rewriteDryRun -Dorg.gradle.jvmargs=-Xmx2G

documentation/src/main/java/example/domain/Person.java

@@ -54,9 +54,8 @@ public LocalDate getDateOfBirth() {
 	public int hashCode() {
 		final int prime = 31;
 		int result = 1;
-		result = prime * result + ((firstName == null) ? 0 : firstName.hashCode());
-		result = prime * result + ((lastName == null) ? 0 : lastName.hashCode());
-		return result;
+		result = prime * result + (firstName == null ? 0 : firstName.hashCode());
+		return prime * result + (lastName == null ? 0 : lastName.hashCode());
 	}
 
 	@Override

documentation/src/main/java/example/util/StringUtils.java

@@ -14,7 +14,7 @@
 
 import org.jspecify.annotations.Nullable;
 
-public class StringUtils {
+public final class StringUtils {
 
 	public static boolean isPalindrome(@Nullable String candidate) {
 		int length = requireNonNull(candidate).length();

documentation/src/tools/java/org/junit/api/tools/ApiReportGenerator.java

@@ -46,7 +46,7 @@
 /**
  * @since 1.0
  */
-class ApiReportGenerator {
+final class ApiReportGenerator {
 
 	private static final Logger LOGGER = LoggerFactory.getLogger(ApiReportGenerator.class);
 	private static final String EOL = System.lineSeparator();

gradle/config/rewrite.yml

@@ -0,0 +1,10 @@
+---
+type: specs.openrewrite.org/v1beta/recipe
+name: org.junit.openrewrite.SanityCheck
+displayName: Apply all common best practices
+description: Comprehensive code quality recipe combining modernization, security, and best practices.
+recipeList:
+  - org.openrewrite.java.migrate.UpgradeToJava17
+  - org.openrewrite.java.testing.junit.JupiterBestPractices # consider; org.openrewrite.java.testing.cleanup.BestPractices
+  - org.openrewrite.staticanalysis.CommonStaticAnalysis
+---

gradle/libs.versions.toml

@@ -101,6 +101,7 @@ commonCustomUserData = { id = "com.gradle.common-custom-user-data-gradle-plugin"
 develocity = { id = "com.gradle.develocity", version = "4.2.2" }
 download = { id = "de.undercouch.download", version = "5.6.0" }
 errorProne = { id = "net.ltgt.errorprone", version = "4.3.0" }
+rewrite = { id = "org.openrewrite.rewrite", version = "7.21.0" }
 foojayResolver = { id = "org.gradle.toolchains.foojay-resolver", version = "1.0.0" }
 gitPublish = { id = "org.ajoberstar.git-publish", version = "5.1.3" }
 jmh = { id = "me.champeau.jmh", version = "0.7.3" }

gradle/plugins/common/build.gradle.kts

@@ -7,16 +7,17 @@ plugins {
 
 dependencies {
 	implementation("junitbuild.base:dsl-extensions")
-	implementation(projects.buildParameters)
 	implementation(projects.backwardCompatibility)
-	implementation(libs.plugins.kotlin.markerCoordinates)
+	implementation(projects.buildParameters)
 	implementation(libs.plugins.bnd.markerCoordinates)
 	implementation(libs.plugins.commonCustomUserData.markerCoordinates)
 	implementation(libs.plugins.develocity.markerCoordinates)
 	implementation(libs.plugins.errorProne.markerCoordinates)
 	implementation(libs.plugins.foojayResolver.markerCoordinates)
 	implementation(libs.plugins.jmh.markerCoordinates)
+	implementation(libs.plugins.kotlin.markerCoordinates)
 	implementation(libs.plugins.nullaway.markerCoordinates)
+	implementation(libs.plugins.rewrite.markerCoordinates)
 	implementation(libs.plugins.shadow.markerCoordinates)
 	implementation(libs.plugins.spotless.markerCoordinates)
 }

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

@@ -45,6 +45,7 @@ tasks.withType<JavaCompile>().configureEach {
 			error(
 				"CanonicalAnnotationSyntax",
 				"IsInstanceLambdaUsage",
+				"TryWithResourcesVariable",
 				"PackageLocation",
 				"RedundantStringConversion",
 				"RedundantStringEscape",

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

@@ -9,6 +9,7 @@ plugins {
 	id("junitbuild.eclipse-conventions")
 	id("junitbuild.jacoco-java-conventions")
 	id("junitbuild.java-errorprone-conventions")
+	id("junitbuild.rewrite-conventions")
 }
 
 val mavenizedProjects: List<Project> by rootProject.extra

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

@@ -0,0 +1,75 @@
+plugins {
+	id("org.openrewrite.rewrite")
+}
+
+dependencies {
+	rewrite("org.openrewrite.recipe:rewrite-migrate-java:3.22.0")
+	rewrite("org.openrewrite.recipe:rewrite-static-analysis:2.22.0")
+	rewrite("org.openrewrite.recipe:rewrite-testing-frameworks:3.22.0")
+}
+
+rewrite {
+	activeRecipe("org.junit.openrewrite.SanityCheck")
+	configFile = project.getRootProject().file("gradle/config/rewrite.yml")
+	exclusion(
+		// CommonStaticAnalysis: scope issue; CONSTRUCTOR_NOW_PROTECTED
+		"**AggregatorIntegrationTests.java",
+		"**AnnotationConsumerInitializerTests.java",
+		"**HierarchicalTestEngine.java",
+		"**TypeBasedParameterResolver.java",
+		"**params/aggregator**",
+		"**params/converter**",
+		"**params/provider**",
+		// dedicated might trivial issue.
+		"**DiscoveryIssueNotifier.java",
+		"**XmlReportWriter.java",
+		// JupiterBestPractices: class scope issue;
+		"**BeforeAndAfterSuiteTests.java",
+		"**BridgeMethods.java",
+		"**EngineDiscoveryResultValidatorTests.java", // fixable with @DisabledOnOs(WINDOWS)
+		"**CsvArgumentsProvider.java",
+		"**DefaultArgumentsAccessor.java",
+		"**DiscoverySelectorResolverTests.java",
+		"**DiscoveryTests.java",
+		"**DisplayNameGenerationTests.java",
+		"**DynamicNodeGenerationTests.java",
+		"**DynamicTestTests.java",
+		"**ExceptionHandlingTests.java",
+		"**ExecutionCancellationTests.java",
+		"**ExtensionRegistrationViaParametersAndFieldsTests.java",
+		"**InvocationInterceptorTests.java",
+		"**IsTestMethodTests.java",
+		"**IsTestTemplateMethodTests.java",
+		"**JupiterTestDescriptorTests.java",
+		"**LifecycleMethodUtilsTests.java",
+		"**MultipleTestableAnnotationsTests.java",
+		"**NestedContainerEventConditionTests.java",
+		"**ParallelExecutionIntegrationTests.java",
+		"**ParameterResolverTests.java",
+		"**ParameterizedTestIntegrationTests.java",
+		"**RepeatedTestTests.java",
+		"**StaticPackagePrivateBeforeMethod.java",
+		"**SubclassedAssertionsTests.java",
+		"**TempDirectoryCleanupTests.java",
+		"**TestCase.java",
+		"**TestCases.java",
+		"**TestExecutionExceptionHandlerTests.java",
+		"**TestInstanceFactoryTests.java",
+		"**TestTemplateInvocationTestDescriptorTests.java",
+		"**TestTemplateInvocationTests.java",
+		"**TestTemplateTestDescriptorTests.java",
+		"**TestWatcherTests.java",
+		"**TimeoutExtensionTests.java",
+		"**UniqueIdTrackingListenerIntegrationTests.java",
+		"**WorkerThreadPoolHierarchicalTestExecutorServiceTests.java",
+		"**org/junit/jupiter/engine/bridge**",
+		// trivial import fix.
+		"**Assert**AssertionsTests.java",
+		"**DynamicContainerTests.java",
+		// legacy
+		"**documentation/src/test/java/example**",
+		"**testFixtures/java/org/junit/vintage/engine/samples**",
+	)
+	setExportDatatables(true)
+	setFailOnDryRunResults(true)
+}