Polish "Add rule to prevent calls to Objects.requireNonNull()"

See gh-41611

Author: wilkinsona

buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitectureCheck.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022-2023 the original author or authors.
+ * Copyright 2022-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@
 import java.net.URLEncoder;
 import java.nio.file.Files;
 import java.nio.file.StandardOpenOption;
+import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 import java.util.function.Supplier;
@@ -49,6 +50,7 @@
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.file.FileTree;
 import org.gradle.api.provider.ListProperty;
+import org.gradle.api.provider.Property;
 import org.gradle.api.tasks.IgnoreEmptyDirectories;
 import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.InputFiles;
@@ -65,21 +67,23 @@
  *
  * @author Andy Wilkinson
  * @author Yanming Zhou
+ * @author Ivan Malutin
  */
 public abstract class ArchitectureCheck extends DefaultTask {
 
 	private FileCollection classes;
 
 	public ArchitectureCheck() {
 		getOutputDirectory().convention(getProject().getLayout().getBuildDirectory().dir(getName()));
+		getProhibitObjectsRequireNonNull().convention(true);
 		getRules().addAll(allPackagesShouldBeFreeOfTangles(),
 				allBeanPostProcessorBeanMethodsShouldBeStaticAndHaveParametersThatWillNotCausePrematureInitialization(),
 				allBeanFactoryPostProcessorBeanMethodsShouldBeStaticAndHaveNoParameters(),
 				noClassesShouldCallStepVerifierStepVerifyComplete(),
 				noClassesShouldConfigureDefaultStepVerifierTimeout(), noClassesShouldCallCollectorsToList(),
-				noClassesShouldCallURLEncoderWithStringEncoding(), noClassesShouldCallURLDecoderWithStringEncoding(),
-				noClassesShouldCallObjectsRequireNonNullWithMessage(),
-				noClassesShouldCallObjectsRequireNonNullWithSupplier());
+				noClassesShouldCallURLEncoderWithStringEncoding(), noClassesShouldCallURLDecoderWithStringEncoding());
+		getRules().addAll(getProhibitObjectsRequireNonNull()
+			.map((prohibit) -> prohibit ? noClassesShouldCallObjectsRequireNonNull() : Collections.emptyList()));
 		getRuleDescriptions().set(getRules().map((rules) -> rules.stream().map(ArchRule::getDescription).toList()));
 	}
 
@@ -212,18 +216,16 @@ private ArchRule noClassesShouldCallURLDecoderWithStringEncoding() {
 			.because("java.net.URLDecoder.decode(String s, Charset charset) should be used instead");
 	}
 
-	private ArchRule noClassesShouldCallObjectsRequireNonNullWithMessage() {
-		return ArchRuleDefinition.noClasses()
-			.should()
-			.callMethod(Objects.class, "requireNonNull", Object.class, String.class)
-			.because("Use org.springframework.utils.Assert.notNull(Object, String) should be used instead");
-	}
-
-	private ArchRule noClassesShouldCallObjectsRequireNonNullWithSupplier() {
-		return ArchRuleDefinition.noClasses()
-			.should()
-			.callMethod(Objects.class, "requireNonNull", Object.class, Supplier.class)
-			.because("Use org.springframework.utils.Assert.notNull(Object, Supplier) should be used instead");
+	private List<ArchRule> noClassesShouldCallObjectsRequireNonNull() {
+		return List.of(
+				ArchRuleDefinition.noClasses()
+					.should()
+					.callMethod(Objects.class, "requireNonNull", Object.class, String.class)
+					.because("org.springframework.utils.Assert.notNull(Object, String) should be used instead"),
+				ArchRuleDefinition.noClasses()
+					.should()
+					.callMethod(Objects.class, "requireNonNull", Object.class, Supplier.class)
+					.because("org.springframework.utils.Assert.notNull(Object, Supplier) should be used instead"));
 	}
 
 	public void setClasses(FileCollection classes) {
@@ -254,6 +256,9 @@ final FileTree getInputClasses() {
 	@Internal
 	public abstract ListProperty<ArchRule> getRules();
 
+	@Internal
+	public abstract Property<Boolean> getProhibitObjectsRequireNonNull();
+
 	@Input
 	// The rules themselves can't be an input as they aren't serializable so we use
 	// their

buildSrc/src/test/java/org/springframework/boot/build/architecture/ArchitectureCheckTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,6 +36,7 @@
  * Tests for {@link ArchitectureCheck}.
  *
  * @author Andy Wilkinson
+ * @author Ivan Malutin
  */
 class ArchitectureCheckTests {
 
@@ -122,34 +123,26 @@ void whenBeanFactoryPostProcessorBeanMethodIsStaticAndHasNoParametersTaskSucceed
 	}
 
 	@Test
-	void whenClassCallsObjectsRequireNonNullWithMessageTaskFailsAndWritesReport() throws Exception {
-		prepareTask("objects/requireNonNullWithMessage", (architectureCheck) -> {
-			assertThatExceptionOfType(GradleException.class).isThrownBy(architectureCheck::checkArchitecture);
-			assertThat(failureReport(architectureCheck)).isNotEmpty();
-		});
-	}
-
-	@Test
-	void whenClassDoesNotCallObjectsRequireNonNullWithMessageTaskSucceedsAndWritesAnEmptyReport() throws Exception {
-		prepareTask("objects/noRequireNonNullWithMessage", (architectureCheck) -> {
+	void whenClassDoesNotCallObjectsRequireNonNullTaskSucceedsAndWritesAnEmptyReport() throws Exception {
+		prepareTask("objects/noRequireNonNull", (architectureCheck) -> {
 			architectureCheck.checkArchitecture();
 			assertThat(failureReport(architectureCheck)).isEmpty();
 		});
 	}
 
 	@Test
-	void whenClassCallsObjectsRequireNonNullWithSupplierTaskFailsAndWritesReport() throws Exception {
-		prepareTask("objects/requireNonNullWithSupplier", (architectureCheck) -> {
+	void whenClassCallsObjectsRequireNonNullWithMessageTaskFailsAndWritesReport() throws Exception {
+		prepareTask("objects/requireNonNullWithString", (architectureCheck) -> {
 			assertThatExceptionOfType(GradleException.class).isThrownBy(architectureCheck::checkArchitecture);
 			assertThat(failureReport(architectureCheck)).isNotEmpty();
 		});
 	}
 
 	@Test
-	void whenClassDoesNotCallObjectsRequireNonNullWithSupplierTaskSucceedsAndWritesAnEmptyReport() throws Exception {
-		prepareTask("objects/noRequireNonNullWithSupplier", (architectureCheck) -> {
-			architectureCheck.checkArchitecture();
-			assertThat(failureReport(architectureCheck)).isEmpty();
+	void whenClassCallsObjectsRequireNonNullWithSupplierTaskFailsAndWritesReport() throws Exception {
+		prepareTask("objects/requireNonNullWithSupplier", (architectureCheck) -> {
+			assertThatExceptionOfType(GradleException.class).isThrownBy(architectureCheck::checkArchitecture);
+			assertThat(failureReport(architectureCheck)).isNotEmpty();
 		});
 	}
 

buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/noRequireNonNullWithMessage/NoRequireNonNullWithMessageUsage.java renamed to buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/noRequireNonNull/NoRequireNonNull.java

@@ -14,24 +14,19 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.build.architecture.objects.noRequireNonNullWithMessage;
+package org.springframework.boot.build.architecture.objects.noRequireNonNull;
+
+import java.util.Collections;
 
 import org.springframework.util.Assert;
 
-/**
- * This class uses `Assert.notNull(Object, String)` instead of
- * `Objects.requireNonNull(Object, String)`, and should pass the architecture check.
- *
- * @author Ivan Malutin
- */
-public class NoRequireNonNullWithMessageUsage {
+class NoRequireNonNull {
 
-	/**
-	 * Example method that uses `Assert.notNull(Object, String)`, which should not be
-	 * flagged by the architecture check.
-	 */
-	public void exampleMethod() {
+	void exampleMethod() {
 		Assert.notNull(new Object(), "Object must not be null");
+		// Compilation of a method reference generates code that uses
+		// Objects.requireNonNull(Object). Check that it doesn't cause a failure.
+		Collections.emptyList().forEach(System.out::println);
 	}
 
 }

buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/noRequireNonNullWithSupplier/NoRequireNonNullWithSupplierUsage.java

@@ -14,23 +14,13 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.build.architecture.objects.requireNonNullWithMessage;
+package org.springframework.boot.build.architecture.objects.requireNonNullWithString;
 
 import java.util.Objects;
 
-/**
- * This class is intentionally designed to test the use of `Objects.requireNonNull(Object,
- * String)`, which should trigger a failure in the architecture check.
- *
- * @author Ivan Malutin
- */
-public class RequireNonNullWithMessageUsage {
+class RequireNonNullWithString {
 
-	/**
-	 * Example method that uses `Objects.requireNonNull(Object, String)`, which should be
-	 * flagged by the architecture check.
-	 */
-	public void exampleMethod() {
+	void exampleMethod() {
 		Objects.requireNonNull(new Object(), "Object cannot be null");
 	}
 

buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/requireNonNullWithMessage/RequireNonNullWithMessageUsage.java renamed to buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/requireNonNullWithString/RequireNonNullWithString.java

@@ -18,19 +18,9 @@
 
 import java.util.Objects;
 
-/**
- * This class is intentionally designed to test the use of `Objects.requireNonNull(Object,
- * Supplier)`, which should trigger a failure in the architecture check.
- *
- * @author Ivan Malutin
- */
-public class RequireNonNullWithSupplierUsage {
+class RequireNonNullWithSupplier {
 
-	/**
-	 * Example method that uses `Objects.requireNonNull(Object, Supplier)`, which should
-	 * be flagged by the architecture check.
-	 */
-	public void exampleMethod() {
+	void exampleMethod() {
 		Objects.requireNonNull(new Object(), () -> "Object cannot be null");
 	}
 

buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/requireNonNullWithSupplier/RequireNonNullWithSupplierUsage.java renamed to buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/requireNonNullWithSupplier/RequireNonNullWithSupplier.java

@@ -21,3 +21,7 @@ dependencies {
 	testRuntimeOnly("org.bouncycastle:bcprov-jdk18on:1.78.1")
 	testRuntimeOnly("org.springframework:spring-webmvc")
 }
+
+tasks.named("checkArchitectureMain").configure {
+	prohibitObjectsRequireNonNull = false
+}

spring-boot-project/spring-boot-tools/spring-boot-loader-classic/build.gradle

@@ -21,3 +21,7 @@ dependencies {
 	testRuntimeOnly("org.bouncycastle:bcprov-jdk18on:1.78.1")
 	testRuntimeOnly("org.springframework:spring-webmvc")
 }
+
+tasks.named("checkArchitectureMain").configure {
+	prohibitObjectsRequireNonNull = false
+}

spring-boot-project/spring-boot-tools/spring-boot-loader/build.gradle

@@ -24,7 +24,6 @@
 import java.util.EnumMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Objects;
 import java.util.Optional;
 
 import com.jayway.jsonpath.JsonPath;
@@ -616,8 +615,8 @@ static class ExampleFailingConstructorBean {
 		private final Object value;
 
 		ExampleFailingConstructorBean(String name, String value) {
-			Objects.requireNonNull(name, "'name' must be not null.");
-			Objects.requireNonNull(value, "'value' must be not null.");
+			Assert.notNull(name, "'name' must be not null.");
+			Assert.notNull(value, "'value' must be not null.");
 			this.name = name;
 			this.value = value;
 		}