Add rule to prevent calls to Objects.requireNonNull()
See gh-41611
This commit is contained in:
@@ -121,6 +121,38 @@ class ArchitectureCheckTests {
|
||||
});
|
||||
}
|
||||
|
||||
@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();
|
||||
|
||||
@@ -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");
|
||||
}
|
||||
|
||||
}
|
||||
@@ -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");
|
||||
}
|
||||
|
||||
}
|
||||
@@ -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");
|
||||
}
|
||||
|
||||
}
|
||||
@@ -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");
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user