Merge remote-tracking branch 'origin/fix-JUnit5BestPractices' into fix-JUnit5BestPractices

# Conflicts:
#	gradle/config/rewrite.yml
#	gradle/plugins/common/src/main/kotlin/junitbuild.rewrite-conventions.gradle.kts
#	platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/JUnitStartTests.java

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/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",

junit-jupiter-api/src/main/java/org/junit/jupiter/api/AssertAll.java

@@ -28,7 +28,7 @@
  *
  * @since 5.0
  */
-class AssertAll {
+final class AssertAll {
 
 	private AssertAll() {
 		/* no-op */

junit-jupiter-api/src/main/java/org/junit/jupiter/api/AssertArrayEquals.java

@@ -28,7 +28,7 @@
  *
  * @since 5.0
  */
-class AssertArrayEquals {
+final class AssertArrayEquals {
 
 	private AssertArrayEquals() {
 		/* no-op */
@@ -523,7 +523,7 @@ private static void failArraysNotEqual(@Nullable Object expected, @Nullable Obje
 	}
 
 	private static Deque<Integer> nullSafeIndexes(@Nullable Deque<Integer> indexes, int newIndex) {
-		Deque<Integer> result = (indexes != null ? indexes : new ArrayDeque<>());
+		Deque<Integer> result = indexes != null ? indexes : new ArrayDeque<>();
 		result.addLast(newIndex);
 		return result;
 	}

junit-jupiter-api/src/main/java/org/junit/jupiter/api/AssertDoesNotThrow.java

@@ -29,7 +29,7 @@
  *
  * @since 5.2
  */
-class AssertDoesNotThrow {
+final class AssertDoesNotThrow {
 
 	private AssertDoesNotThrow() {
 		/* no-op */

junit-jupiter-api/src/main/java/org/junit/jupiter/api/AssertEquals.java

@@ -25,7 +25,7 @@
  *
  * @since 5.0
  */
-class AssertEquals {
+final class AssertEquals {
 
 	private AssertEquals() {
 		/* no-op */

junit-jupiter-api/src/main/java/org/junit/jupiter/api/AssertFalse.java

@@ -24,7 +24,7 @@
  *
  * @since 5.0
  */
-class AssertFalse {
+final class AssertFalse {
 
 	private AssertFalse() {
 		/* no-op */