Allow RequireExplicitNullMarking to be disabled on a per-task basis

See gh-23

Author: wilkinsona

README.md

@@ -30,6 +30,14 @@ nullability {
 }
 ```
 
+The extension can also be used to disable the `RequireExplicitNullMarking` check:
+
+```groovy
+nullability {
+	requireExplicitNullMarking = false
+}
+```
+
 ## Types of Nullability Checking
 
 The plugin supports two types of nullability checking, `main` and `tests`.
@@ -41,7 +49,7 @@ Checking using `tests` differs from `main`. It adds support for AssertJ's custom
 ## Configuring Nullability Checking
 
 The plugin adds a `nullability` extension to the `options` of all `JavaCompile` tasks.
-The extension provides a single property, `checking`, that can be used to configure the type of null checking that is performed.
+The extension provides a property, `checking`, that can be used to configure the type of null checking that is performed.
 It defaults to `main` for tasks whose name matches `compile(\\d+)?Java`.
 For all other `JavaCompile` tasks it defaults to `disabled`.
 
@@ -51,3 +59,12 @@ The following enables `tests` nullability checking for `compileTestJava`:
 tasks.named("compileTestJava") {
 	options.nullability.checking = "tests"
 }
+```
+
+The task-level `nullability` extension also provides a property, `requireExplicitNullMarking`, that can be used to disable the `RequireExplicitNullMarking` check for a specific task:
+
+```groovy
+tasks.named("compileTestJava") {
+	options.nullability.requireExplicitNullMarking = false
+}
+```

src/main/java/io/spring/gradle/nullability/NullabilityOptions.java

@@ -47,12 +47,13 @@ public abstract class NullabilityOptions {
 	 */
 	@Inject
 	public NullabilityOptions(ErrorProneOptions errorProne, NullabilityPluginExtension nullability) {
+		getRequireExplicitNullMarking().convention(nullability.getRequireExplicitNullMarking());
 		Provider<Checking> checkingAsEnum = getChecking()
 			.map((string) -> Checking.valueOf(string.toUpperCase(Locale.ROOT)));
 		errorProne.getEnabled().set(checkingAsEnum.map((checking) -> checking != Checking.DISABLED));
 		errorProne.getDisableAllChecks().set(checkingAsEnum.map((checking) -> checking != Checking.DISABLED));
 		errorProne.getCheckOptions().putAll(checkingAsEnum.map(this::checkOptions));
-		errorProne.getChecks().putAll(checkingAsEnum.map((checking) -> checks(checking, nullability)));
+		errorProne.getChecks().putAll(checkingAsEnum.map(this::checks));
 	}
 
 	private Map<String, String> checkOptions(Checking checking) {
@@ -74,11 +75,11 @@ private Map<String, String> checkOptions(Checking checking) {
 		return options;
 	}
 
-	private Map<String, CheckSeverity> checks(Checking checking, NullabilityPluginExtension nullability) {
+	private Map<String, CheckSeverity> checks(Checking checking) {
 		if (checking != Checking.DISABLED) {
 			Map<String, CheckSeverity> checks = new HashMap<>();
 			checks.put("NullAway", CheckSeverity.ERROR);
-			if (Boolean.TRUE.equals(nullability.getRequireExplicitNullMarking().get())) {
+			if (Boolean.TRUE.equals(getRequireExplicitNullMarking().get())) {
 				checks.put("RequireExplicitNullMarking", CheckSeverity.ERROR);
 			}
 			return checks;
@@ -92,6 +93,12 @@ private Map<String, CheckSeverity> checks(Checking checking, NullabilityPluginEx
 	 */
 	public abstract Property<String> getChecking();
 
+	/**
+	 * Whether explicit null marking is required.
+	 * @return the property for whether explicit null marking is required
+	 */
+	public abstract Property<Boolean> getRequireExplicitNullMarking();
+
 	/**
 	 * The type of null checking to perform for the {@link JavaCompile} task.
 	 */

src/test/java/io/spring/gradle/nullability/NullabilityPluginIntegrationTests.java

@@ -124,6 +124,14 @@ void compileFailsForCodeThatIsNotNullMarked() throws IOException {
 		assertThat(result.getOutput()).contains("[RequireExplicitNullMarking]");
 	}
 
+	@Test
+	void compileFailsForCodeThatIsNotNullMarkedWhenDisabledOnTheExtensionAndEnabledOnTheTask() throws IOException {
+		Path pkg = createSrcDirectories("main");
+		writeExampleClass(pkg);
+		BuildResult result = this.gradleBuild.prepareRunner("compileJava").buildAndFail();
+		assertThat(result.getOutput()).contains("[RequireExplicitNullMarking]");
+	}
+
 	@Test
 	void compileSucceedsForCodeThatIsNotNullMarkedWhenRequireExplicitNullMarkingIsDisabled() throws IOException {
 		Path pkg = createSrcDirectories("main");
@@ -132,6 +140,15 @@ void compileSucceedsForCodeThatIsNotNullMarkedWhenRequireExplicitNullMarkingIsDi
 		assertThat(result.task(":compileJava").getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
 	}
 
+	@Test
+	void compileSucceedsForCodeThatIsNotNullMarkedWhenRequireExplicitNullMarkingIsDisabledOnTheTask()
+			throws IOException {
+		Path pkg = createSrcDirectories("main");
+		writeExampleClass(pkg);
+		BuildResult result = this.gradleBuild.prepareRunner("compileJava").build();
+		assertThat(result.task(":compileJava").getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
+	}
+
 	private Path createSrcDirectories(String sourceSetName) {
 		Path projectDir = this.gradleBuild.getProjectDir().toPath();
 		Path pkg = projectDir.resolve("src/%s/java/com/example".formatted(sourceSetName));

src/test/resources/io/spring/gradle/nullability/NullabilityPluginIntegrationTests-compileFailsForCodeThatIsNotNullMarkedWhenDisabledOnTheExtensionAndEnabledOnTheTask.gradle

@@ -0,0 +1,20 @@
+plugins {
+	id "io.spring.nullability"
+	id "java"
+}
+
+repositories {
+	mavenCentral()
+}
+
+dependencies {
+	testCompileOnly("org.jspecify:jspecify:1.0.0")
+}
+
+nullability {
+	requireExplicitNullMarking = false
+}
+
+tasks.named("compileJava") {
+	options.nullability.requireExplicitNullMarking = true
+} 

src/test/resources/io/spring/gradle/nullability/NullabilityPluginIntegrationTests-compileSucceedsForCodeThatIsNotNullMarkedWhenRequireExplicitNullMarkingIsDisabledOnTheTask.gradle

@@ -0,0 +1,16 @@
+plugins {
+	id "io.spring.nullability"
+	id "java"
+}
+
+repositories {
+	mavenCentral()
+}
+
+dependencies {
+	testCompileOnly("org.jspecify:jspecify:1.0.0")
+}
+
+tasks.named("compileJava") {
+	options.nullability.requireExplicitNullMarking = false
+}