Enable NullAway in junit-platform-console

Author: marcphilipp

junit-platform-console/junit-platform-console.gradle.kts

@@ -1,8 +1,11 @@
 import junitbuild.extensions.javaModuleName
 import junitbuild.java.UpdateJarAction
+import net.ltgt.gradle.errorprone.errorprone
+import net.ltgt.gradle.nullaway.nullaway
 
 plugins {
 	id("junitbuild.java-library-conventions")
+	id("junitbuild.java-nullability-conventions")
 	id("junitbuild.shadow-conventions")
 }
 
@@ -13,6 +16,7 @@ dependencies {
 	api(projects.junitPlatformReporting)
 
 	compileOnlyApi(libs.apiguardian)
+	compileOnly(libs.jspecify)
 
 	shadowed(libs.picocli)
 
@@ -27,6 +31,13 @@ tasks {
 			"--add-modules", "info.picocli",
 			"--add-reads", "${javaModuleName}=info.picocli"
 		))
+		options.errorprone.nullaway {
+			excludedFieldAnnotations.addAll(
+				"picocli.CommandLine.ArgGroup",
+				"picocli.CommandLine.Mixin",
+				"picocli.CommandLine.Spec",
+			)
+		}
 	}
 	javadoc {
 		(options as StandardJavadocDocletOptions).apply {

junit-platform-console/src/main/java/module-info.java

@@ -8,12 +8,15 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
+import org.jspecify.annotations.NullMarked;
+
 /**
  * Support for launching the JUnit Platform from the console.
  *
  * @since 1.0
  * @provides java.util.spi.ToolProvider
  */
+@NullMarked
 module org.junit.platform.console {
 	requires static org.apiguardian.api;
 	requires org.junit.platform.commons;

junit-platform-console/src/main/java/org/junit/platform/console/options/CommandResult.java

@@ -15,6 +15,7 @@
 import java.util.Optional;
 
 import org.apiguardian.api.API;
+import org.jspecify.annotations.Nullable;
 
 /**
  * @since 1.10
@@ -40,14 +41,16 @@ public static <T> CommandResult<T> failure() {
 		return create(FAILURE, null);
 	}
 
-	public static <T> CommandResult<T> create(int exitCode, T value) {
+	public static <T> CommandResult<T> create(int exitCode, @Nullable T value) {
 		return new CommandResult<>(exitCode, value);
 	}
 
 	private final int exitCode;
+
+	@Nullable
 	private final T value;
 
-	private CommandResult(int exitCode, T value) {
+	private CommandResult(int exitCode, @Nullable T value) {
 		this.exitCode = exitCode;
 		this.value = value;
 	}

junit-platform-console/src/main/java/org/junit/platform/console/options/ExecuteTestsCommand.java

@@ -16,13 +16,15 @@
 import java.nio.file.Path;
 import java.util.Optional;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.console.tasks.ConsoleTestExecutor;
 import org.junit.platform.launcher.listeners.TestExecutionSummary;
 
 import picocli.CommandLine;
 import picocli.CommandLine.ArgGroup;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Mixin;
+import picocli.CommandLine.Option;
 
 @Command(//
 		name = "execute", //
@@ -93,10 +95,11 @@ public int getExitCode() {
 
 	static class ReportingOptions {
 
-		@CommandLine.Option(names = "--fail-if-no-tests", description = "Fail and return exit status code 2 if no tests are found.")
+		@Option(names = "--fail-if-no-tests", description = "Fail and return exit status code 2 if no tests are found.")
 		private boolean failIfNoTests; // no single-dash equivalent: was introduced in 5.3-M1
 
-		@CommandLine.Option(names = "--reports-dir", paramLabel = "DIR", description = "Enable report output into a specified local directory (will be created if it does not exist).")
+		@Nullable
+		@Option(names = "--reports-dir", paramLabel = "DIR", description = "Enable report output into a specified local directory (will be created if it does not exist).")
 		private Path reportsDir;
 
 		Optional<Path> getReportsDir() {

junit-platform-console/src/main/java/org/junit/platform/console/options/MainCommand.java

@@ -10,14 +10,16 @@
 
 package org.junit.platform.console.options;
 
+import static java.util.Objects.requireNonNull;
+
 import java.util.Optional;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.console.tasks.ConsoleTestExecutor;
 
 import picocli.CommandLine;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.IExitCodeGenerator;
-import picocli.CommandLine.Mixin;
 import picocli.CommandLine.Model.CommandSpec;
 import picocli.CommandLine.Option;
 import picocli.CommandLine.ParameterException;
@@ -50,12 +52,10 @@ class MainCommand implements Runnable, IExitCodeGenerator {
 	@Option(names = "--version", versionHelp = true, description = "Display version information.")
 	private boolean versionRequested;
 
-	@Mixin
-	AnsiColorOptionMixin ansiColorOption;
-
 	@Spec
 	CommandSpec commandSpec;
 
+	@Nullable
 	CommandResult<?> commandResult;
 
 	MainCommand(ConsoleTestExecutor.Factory consoleTestExecutorFactory) {
@@ -79,7 +79,7 @@ else if (versionRequested) {
 
 	@Override
 	public int getExitCode() {
-		return commandResult.getExitCode();
+		return requireNonNull(commandResult).getExitCode();
 	}
 
 	CommandResult<?> run(String[] args,

junit-platform-console/src/main/java/org/junit/platform/console/options/TestConsoleOutputOptions.java

@@ -16,6 +16,7 @@
 import java.util.Locale;
 
 import org.apiguardian.api.API;
+import org.jspecify.annotations.Nullable;
 
 /**
  * @since 1.10
@@ -28,11 +29,18 @@ public class TestConsoleOutputOptions {
 	static final Theme DEFAULT_THEME = Theme.valueOf(ConsoleUtils.charset());
 
 	private boolean ansiColorOutputDisabled;
+
+	@Nullable
 	private Path colorPalettePath;
+
 	private boolean isSingleColorPalette;
 	private Details details = DEFAULT_DETAILS;
 	private Theme theme = DEFAULT_THEME;
+
+	@Nullable
 	private Path stdoutPath;
+
+	@Nullable
 	private Path stderrPath;
 
 	public boolean isAnsiColorOutputDisabled() {
@@ -43,11 +51,12 @@ public void setAnsiColorOutputDisabled(boolean ansiColorOutputDisabled) {
 		this.ansiColorOutputDisabled = ansiColorOutputDisabled;
 	}
 
+	@Nullable
 	public Path getColorPalettePath() {
 		return colorPalettePath;
 	}
 
-	public void setColorPalettePath(Path colorPalettePath) {
+	public void setColorPalettePath(@Nullable Path colorPalettePath) {
 		this.colorPalettePath = colorPalettePath;
 	}
 
@@ -76,22 +85,24 @@ public void setTheme(Theme theme) {
 	}
 
 	@API(status = INTERNAL, since = "1.13")
+	@Nullable
 	public Path getStdoutPath() {
 		return this.stdoutPath;
 	}
 
 	@API(status = INTERNAL, since = "1.13")
-	public void setStdoutPath(Path stdoutPath) {
+	public void setStdoutPath(@Nullable Path stdoutPath) {
 		this.stdoutPath = stdoutPath;
 	}
 
 	@API(status = INTERNAL, since = "1.13")
+	@Nullable
 	public Path getStderrPath() {
 		return this.stderrPath;
 	}
 
 	@API(status = INTERNAL, since = "1.13")
-	public void setStderrPath(Path stderrPath) {
+	public void setStderrPath(@Nullable Path stderrPath) {
 		this.stderrPath = stderrPath;
 	}
 

junit-platform-console/src/main/java/org/junit/platform/console/options/TestConsoleOutputOptionsMixin.java

@@ -16,6 +16,8 @@
 
 import java.nio.file.Path;
 
+import org.jspecify.annotations.Nullable;
+
 import picocli.CommandLine.ArgGroup;
 import picocli.CommandLine.Option;
 
@@ -26,6 +28,7 @@ class TestConsoleOutputOptionsMixin {
 
 	static class ConsoleOutputOptions {
 
+		@Nullable
 		@Option(names = "--color-palette", paramLabel = "FILE", description = "Specify a path to a properties file to customize ANSI style of output (not supported by all terminals).")
 		private Path colorPalette;
 
@@ -41,9 +44,11 @@ static class ConsoleOutputOptions {
 				+ "Use one of: ${COMPLETION-CANDIDATES}. Default is detected based on default character encoding.")
 		private final Theme theme = DEFAULT_THEME;
 
+		@Nullable
 		@Option(names = "--redirect-stdout", paramLabel = "FILE", description = "Redirect test output to stdout to a file.")
 		private Path stdout;
 
+		@Nullable
 		@Option(names = "--redirect-stderr", paramLabel = "FILE", description = "Redirect test output to stderr to a file.")
 		private Path stderr;
 

junit-platform-console/src/main/java/org/junit/platform/console/options/TestDiscoveryOptions.java

@@ -24,6 +24,7 @@
 import java.util.Map;
 
 import org.apiguardian.api.API;
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.engine.DiscoverySelector;
 import org.junit.platform.engine.DiscoverySelectorIdentifier;
 import org.junit.platform.engine.discovery.ClassSelector;
@@ -46,6 +47,8 @@ public class TestDiscoveryOptions {
 
 	private boolean scanClasspath;
 	private List<Path> additionalClasspathEntries = emptyList();
+
+	@Nullable
 	private List<Path> selectedClasspathEntries = emptyList();
 
 	private boolean scanModulepath;
@@ -104,11 +107,12 @@ public void setAdditionalClasspathEntries(List<Path> additionalClasspathEntries)
 		this.additionalClasspathEntries = additionalClasspathEntries;
 	}
 
+	@Nullable
 	public List<Path> getSelectedClasspathEntries() {
 		return this.selectedClasspathEntries;
 	}
 
-	public void setSelectedClasspathEntries(List<Path> selectedClasspathEntries) {
+	public void setSelectedClasspathEntries(@Nullable List<Path> selectedClasspathEntries) {
 		this.selectedClasspathEntries = selectedClasspathEntries;
 	}
 

junit-platform-console/src/main/java/org/junit/platform/console/options/TestDiscoveryOptionsMixin.java

@@ -16,6 +16,7 @@
 import java.util.List;
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.engine.DiscoverySelectorIdentifier;
 import org.junit.platform.engine.discovery.ClassNameFilter;
 import org.junit.platform.engine.discovery.ClassSelector;
@@ -50,6 +51,7 @@ class TestDiscoveryOptionsMixin {
 
 	static class SelectorOptions {
 
+		@Nullable
 		@Option(names = { "--scan-classpath",
 				"--scan-class-path" }, converter = ClasspathEntriesConverter.class, paramLabel = "PATH", arity = "0..1", description = "Scan all directories on the classpath or explicit classpath roots. " //
 						+ "Without arguments, only directories on the system classpath as well as additional classpath " //

junit-platform-console/src/main/java/org/junit/platform/console/tasks/DiscoveryRequestCreator.java

@@ -82,12 +82,14 @@ private static List<ClasspathRootSelector> createClasspathRootSelectors(TestDisc
 	}
 
 	private static Set<Path> determineClasspathRoots(TestDiscoveryOptions options) {
-		if (options.getSelectedClasspathEntries().isEmpty()) {
+		var selectedClasspathEntries = Preconditions.notNull(options.getSelectedClasspathEntries(),
+			() -> "No classpath entries selected");
+		if (selectedClasspathEntries.isEmpty()) {
 			Set<Path> rootDirs = new LinkedHashSet<>(ReflectionUtils.getAllClasspathRootDirectories());
 			rootDirs.addAll(options.getExistingAdditionalClasspathEntries());
 			return rootDirs;
 		}
-		return new LinkedHashSet<>(options.getSelectedClasspathEntries());
+		return new LinkedHashSet<>(selectedClasspathEntries);
 	}
 
 	private static void addFilters(LauncherDiscoveryRequestBuilder requestBuilder, TestDiscoveryOptions options,