Add rule to prevent calls to Objects.requireNonNull()

See gh-41611

Author: ivamly

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

@@ -23,6 +23,8 @@
 import java.nio.file.Files;
 import java.nio.file.StandardOpenOption;
 import java.util.List;
+import java.util.Objects;
+import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
 import com.tngtech.archunit.base.DescribedPredicate;
@@ -75,7 +77,9 @@ public ArchitectureCheck() {
 				allBeanFactoryPostProcessorBeanMethodsShouldBeStaticAndHaveNoParameters(),
 				noClassesShouldCallStepVerifierStepVerifyComplete(),
 				noClassesShouldConfigureDefaultStepVerifierTimeout(), noClassesShouldCallCollectorsToList(),
-				noClassesShouldCallURLEncoderWithStringEncoding(), noClassesShouldCallURLDecoderWithStringEncoding());
+				noClassesShouldCallURLEncoderWithStringEncoding(), noClassesShouldCallURLDecoderWithStringEncoding(),
+				noClassesShouldCallObjectsRequireNonNullWithMessage(),
+				noClassesShouldCallObjectsRequireNonNullWithSupplier());
 		getRuleDescriptions().set(getRules().map((rules) -> rules.stream().map(ArchRule::getDescription).toList()));
 	}
 
@@ -208,6 +212,20 @@ 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");
+	}
+
 	public void setClasses(FileCollection classes) {
 		this.classes = classes;
 	}
@@ -237,7 +255,8 @@ final FileTree getInputClasses() {
 	public abstract ListProperty<ArchRule> getRules();
 
 	@Input
-	// The rules themselves can't be an input as they aren't serializable so we use their
+	// The rules themselves can't be an input as they aren't serializable so we use
+	// their
 	// descriptions instead
 	abstract ListProperty<String> getRuleDescriptions();
 

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

@@ -121,6 +121,38 @@ 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) -> {
+			architectureCheck.checkArchitecture();
+			assertThat(failureReport(architectureCheck)).isEmpty();
+		});
+	}
+
+	@Test
+	void whenClassCallsObjectsRequireNonNullWithSupplierTaskFailsAndWritesReport() throws Exception {
+		prepareTask("objects/requireNonNullWithSupplier", (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();
+		});
+	}
+
 	private void prepareTask(String classes, Callback<ArchitectureCheck> callback) throws Exception {
 		File projectDir = new File(this.temp, "project");
 		projectDir.mkdirs();

buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/noRequireNonNullWithMessage/NoRequireNonNullWithMessageUsage.java

@@ -0,0 +1,37 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture.objects.noRequireNonNullWithMessage;
+
+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 {
+
+	/**
+	 * Example method that uses `Assert.notNull(Object, String)`, which should not be
+	 * flagged by the architecture check.
+	 */
+	public void exampleMethod() {
+		Assert.notNull(new Object(), "Object must not be null");
+	}
+
+}

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

@@ -0,0 +1,37 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture.objects.noRequireNonNullWithSupplier;
+
+import org.springframework.util.Assert;
+
+/**
+ * This class uses `Assert.notNull(Object, Supplier)` instead of
+ * `Objects.requireNonNull(Object, Supplier)`, and should pass the architecture check.
+ *
+ * @author Ivan Malutin
+ */
+public class NoRequireNonNullWithSupplierUsage {
+
+	/**
+	 * Example method that uses `Assert.notNull(Object, Supplier)`, which should not be
+	 * flagged by the architecture check.
+	 */
+	public void exampleMethod() {
+		Assert.notNull(new Object(), () -> "Object must not be null");
+	}
+
+}

buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/requireNonNullWithMessage/RequireNonNullWithMessageUsage.java

@@ -0,0 +1,37 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture.objects.requireNonNullWithMessage;
+
+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 {
+
+	/**
+	 * Example method that uses `Objects.requireNonNull(Object, String)`, which should be
+	 * flagged by the architecture check.
+	 */
+	public void exampleMethod() {
+		Objects.requireNonNull(new Object(), "Object cannot be null");
+	}
+
+}

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

@@ -0,0 +1,37 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture.objects.requireNonNullWithSupplier;
+
+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 {
+
+	/**
+	 * Example method that uses `Objects.requireNonNull(Object, Supplier)`, which should
+	 * be flagged by the architecture check.
+	 */
+	public void exampleMethod() {
+		Objects.requireNonNull(new Object(), () -> "Object cannot be null");
+	}
+
+}