Add EqualityRulesRecipes

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

Author: Vincent Potucek

.github/workflows/build-pull-request.yml

@@ -1,22 +1,22 @@
-name: Build Pull Request
+name: Build Pull Request 🏭️
 on: pull_request
 permissions:
   contents: read
 jobs:
   build:
-    name: Build Pull Request
+    name: Build 🏗
     if: ${{ github.repository == 'spring-projects/spring-boot' }}
     runs-on: ${{ vars.UBUNTU_MEDIUM || 'ubuntu-latest' }}
     steps:
-      - name: Check Out Code
+      - name: Checkout Code 📥
         uses: actions/checkout@v6
-      - name: Build
+      - name: Build 📦
         id: build
         uses: ./.github/actions/build
-      - name: Print JVM Thread Dumps When Cancelled
+      - name: Log Potentially Cancelled JVM Thread Dumps 📋
         if: cancelled()
         uses: ./.github/actions/print-jvm-thread-dumps
-      - name: Upload Build Reports
+      - name: Upload Build Report 📊
         if: failure()
         uses: actions/upload-artifact@v6
         with:

.github/workflows/distribute.yml

@@ -19,6 +19,7 @@ permissions:
   contents: read
 jobs:
   distribute-spring-enterprise-release-bundle:
+    name: Distribute Release Bundle 📦
     runs-on: ${{ vars.UBUNTU_SMALL || 'ubuntu-latest' }}
     steps:
       - name: Create Bundle

.github/workflows/run-codeql-analysis.yml

@@ -1,11 +1,12 @@
-name: "Run CodeQL Analysis"
+name: Run CodeQL Analysis 📊
 on:
   push:
   pull_request:
   workflow_dispatch:
 permissions: read-all
 jobs:
   run-analysis:
+    name: Inspect 🔎
     permissions:
       actions: read
       contents: read

.github/workflows/sanity.yml

@@ -0,0 +1,16 @@
+name: Sanity Check 🕊️
+on:
+  pull_request:
+permissions: read-all
+jobs:
+  verify:
+    name: Inspect 🔎
+    runs-on: ${{ vars.UBUNTU_SMALL || 'ubuntu-latest' }}
+    steps:
+      - name: Checkout Code 📥
+        uses: actions/checkout@v6
+      - name: Build 📦
+        id: build
+        uses: ./.github/actions/build
+      - name: Rewrite ♻️
+        run: ./gradlew rewriteDryRun -Dorg.gradle.jvmargs=-Xmx10G

build.gradle

@@ -16,6 +16,7 @@
 
 plugins {
 	id "base"
+	id "org.openrewrite.rewrite" version "7.23.0" apply false
 }
 
 description = "Spring Boot Build"
@@ -46,3 +47,5 @@ subprojects {
 		resolutionStrategy.cacheChangingModulesFor 0, "minutes"
 	}
 }
+
+apply from: rootProject.file("gradle/plugins/config/sanity.gradle")

buildpack/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/Cache.java

@@ -70,15 +70,15 @@ public String getDescription() {
 	 * @return the cache, or {@code null} if it is not a volume cache
 	 */
 	public @Nullable Volume getVolume() {
-		return (this.format.equals(Format.VOLUME)) ? (Volume) this : null;
+		return (this.format == Format.VOLUME) ? (Volume) this : null;
 	}
 
 	/**
 	 * Return the details of the cache if it is a bind cache.
 	 * @return the cache, or {@code null} if it is not a bind cache
 	 */
 	public @Nullable Bind getBind() {
-		return (this.format.equals(Format.BIND)) ? (Bind) this : null;
+		return (this.format == Format.BIND) ? (Bind) this : null;
 	}
 
 	/**
@@ -120,7 +120,7 @@ public boolean equals(@Nullable Object obj) {
 			return false;
 		}
 		Cache other = (Cache) obj;
-		return Objects.equals(this.format, other.format);
+		return this.format == other.format;
 	}
 
 	@Override

core/spring-boot-test/src/main/java/org/springframework/boot/test/system/OutputCapture.java

@@ -122,7 +122,7 @@ public String getAll() {
 	 */
 	@Override
 	public String getOut() {
-		return get(this.out, Type.OUT::equals);
+		return get(this.out, (v) -> v == Type.OUT);
 	}
 
 	/**
@@ -131,7 +131,7 @@ public String getOut() {
 	 */
 	@Override
 	public String getErr() {
-		return get(this.err, Type.ERR::equals);
+		return get(this.err, (v) -> v == Type.ERR);
 	}
 
 	/**

core/spring-boot-test/src/main/java/org/springframework/boot/test/util/TestPropertyValues.java

@@ -211,7 +211,7 @@ private void addToSources(MutablePropertySources sources, Type type, String name
 			}
 		}
 		Map<String, Object> source = new LinkedHashMap<>(this.properties);
-		sources.addFirst((type.equals(Type.MAP) ? new MapPropertySource(name, source)
+		sources.addFirst((type == Type.MAP ? new MapPropertySource(name, source)
 				: new SystemEnvironmentPropertySource(name, source)));
 	}
 

gradle/plugins/config/sanity.gradle

@@ -0,0 +1,10 @@
+project.apply(plugin: "org.openrewrite.rewrite")
+repositories {
+	mavenCentral()
+}
+rewrite {
+	activeRecipe("org.springframework.boot.openrewrite.SanityCheck")
+	configFile = project.getRootProject().file("${rootDir}/gradle/plugins/config/sanity.yml")
+	setExportDatatables(true)
+	setFailOnDryRunResults(true)
+}

gradle/plugins/config/sanity.yml

@@ -0,0 +1,15 @@
+---
+type: specs.openrewrite.org/v1beta/recipe
+name: org.springframework.boot.openrewrite.SanityCheck
+displayName: Apply all common best practices
+description: Comprehensive code quality recipe combining modernization, security, and best practices.
+recipeList:
+  - tech.picnic.errorprone.refasterrules.EqualityRulesRecipes
+# - org.openrewrite.java.testing.junit.JupiterBestPractices
+# - org.openrewrite.java.testing.junit5.CleanupAssertions
+# - org.openrewrite.java.testing.junit5.StaticImports
+# - org.openrewrite.staticanalysis.EqualsAvoidsNull
+# - tech.picnic.errorprone.refasterrules.NullRulesRecipes
+# - tech.picnic.errorprone.refasterrules.StringRulesRecipes
+# - tech.picnic.errorprone.refasterrules.TimeRulesRecipes
+---