Enable NullAway in junit-platform-reporting

Author: marcphilipp

junit-platform-reporting/junit-platform-reporting.gradle.kts

@@ -2,6 +2,7 @@ import junitbuild.extensions.javaModuleName
 
 plugins {
 	id("junitbuild.java-library-conventions")
+	id("junitbuild.java-nullability-conventions")
 	id("junitbuild.shadow-conventions")
 	`java-test-fixtures`
 }
@@ -13,6 +14,8 @@ dependencies {
 	api(projects.junitPlatformLauncher)
 
 	compileOnlyApi(libs.apiguardian)
+	compileOnly(libs.jspecify)
+
 	compileOnlyApi(libs.openTestReporting.tooling.spi)
 	compileOnly(libs.immutables.valueAnnotations) {
 		because("package-info references enum")

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

@@ -8,11 +8,14 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
+import org.jspecify.annotations.NullMarked;
+
 /**
  * Defines the JUnit Platform Reporting API.
  *
  * @since 1.4
  */
+@NullMarked
 module org.junit.platform.reporting {
 	requires java.xml;
 	requires static transitive org.apiguardian.api;

junit-platform-reporting/src/main/java/org/junit/platform/reporting/legacy/LegacyReportingUtils.java

@@ -13,6 +13,7 @@
 import static org.apiguardian.api.API.Status.MAINTAINED;
 
 import org.apiguardian.api.API;
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.commons.util.Preconditions;
 import org.junit.platform.engine.support.descriptor.ClassSource;
 import org.junit.platform.launcher.TestIdentifier;
@@ -62,10 +63,12 @@ public static String getClassName(TestPlan testPlan, TestIdentifier testIdentifi
 		return getParentLegacyReportingName(testPlan, testIdentifier);
 	}
 
+	@Nullable
 	private static TestIdentifier getParent(TestPlan testPlan, TestIdentifier testIdentifier) {
 		return testPlan.getParent(testIdentifier).orElse(null);
 	}
 
+	@Nullable
 	private static ClassSource getClassSource(TestIdentifier current) {
 		// @formatter:off
 		return current.getSource()

junit-platform-reporting/src/main/java/org/junit/platform/reporting/legacy/xml/LegacyXmlReportGeneratingListener.java

@@ -10,6 +10,7 @@
 
 package org.junit.platform.reporting.legacy.xml;
 
+import static java.util.Objects.requireNonNull;
 import static org.apiguardian.api.API.Status.STABLE;
 
 import java.io.IOException;
@@ -22,6 +23,7 @@
 import javax.xml.stream.XMLStreamException;
 
 import org.apiguardian.api.API;
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.engine.reporting.ReportEntry;
 import org.junit.platform.launcher.TestExecutionListener;
@@ -48,6 +50,7 @@ public class LegacyXmlReportGeneratingListener implements TestExecutionListener
 	private final PrintWriter out;
 	private final Clock clock;
 
+	@Nullable
 	private XmlReportData reportData;
 
 	public LegacyXmlReportGeneratingListener(Path reportsDir, PrintWriter out) {
@@ -83,23 +86,23 @@ public void testPlanExecutionFinished(TestPlan testPlan) {
 
 	@Override
 	public void executionSkipped(TestIdentifier testIdentifier, String reason) {
-		this.reportData.markSkipped(testIdentifier, reason);
+		requiredReportData().markSkipped(testIdentifier, reason);
 		writeXmlReportInCaseOfRoot(testIdentifier);
 	}
 
 	@Override
 	public void executionStarted(TestIdentifier testIdentifier) {
-		this.reportData.markStarted(testIdentifier);
+		requiredReportData().markStarted(testIdentifier);
 	}
 
 	@Override
 	public void reportingEntryPublished(TestIdentifier testIdentifier, ReportEntry entry) {
-		this.reportData.addReportEntry(testIdentifier, entry);
+		requiredReportData().addReportEntry(testIdentifier, entry);
 	}
 
 	@Override
 	public void executionFinished(TestIdentifier testIdentifier, TestExecutionResult result) {
-		this.reportData.markFinished(testIdentifier, result);
+		requiredReportData().markFinished(testIdentifier, result);
 		writeXmlReportInCaseOfRoot(testIdentifier);
 	}
 
@@ -113,13 +116,17 @@ private void writeXmlReportInCaseOfRoot(TestIdentifier testIdentifier) {
 	private void writeXmlReportSafely(TestIdentifier testIdentifier, String rootName) {
 		Path xmlFile = this.reportsDir.resolve("TEST-" + rootName + ".xml");
 		try (Writer fileWriter = Files.newBufferedWriter(xmlFile)) {
-			new XmlReportWriter(this.reportData).writeXmlReport(testIdentifier, fileWriter);
+			new XmlReportWriter(requiredReportData()).writeXmlReport(testIdentifier, fileWriter);
 		}
 		catch (XMLStreamException | IOException e) {
 			printException("Could not write XML report: " + xmlFile, e);
 		}
 	}
 
+	private XmlReportData requiredReportData() {
+		return requireNonNull(this.reportData);
+	}
+
 	private boolean isRoot(TestIdentifier testIdentifier) {
 		return testIdentifier.getParentIdObject().isEmpty();
 	}

junit-platform-reporting/src/main/java/org/junit/platform/reporting/legacy/xml/XmlReportData.java

@@ -25,6 +25,7 @@
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Predicate;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.commons.util.ExceptionUtils;
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.engine.reporting.ReportEntry;
@@ -60,7 +61,7 @@ Clock getClock() {
 		return this.clock;
 	}
 
-	void markSkipped(TestIdentifier testIdentifier, String reason) {
+	void markSkipped(TestIdentifier testIdentifier, @Nullable String reason) {
 		this.skippedTests.put(testIdentifier, reason == null ? "" : reason);
 	}
 
@@ -94,6 +95,7 @@ boolean wasSkipped(TestIdentifier testIdentifier) {
 		return Duration.between(startInstant, endInstant).toMillis() / (double) MILLIS_PER_SECOND;
 	}
 
+	@Nullable
 	String getSkipReason(TestIdentifier testIdentifier) {
 		return findSkippedAncestor(testIdentifier).map(skippedTestIdentifier -> {
 			String reason = this.skippedTests.get(skippedTestIdentifier);

junit-platform-reporting/src/main/java/org/junit/platform/reporting/legacy/xml/XmlReportWriter.java

@@ -15,6 +15,7 @@
 import static java.util.Collections.emptyList;
 import static java.util.Collections.unmodifiableMap;
 import static java.util.Comparator.naturalOrder;
+import static java.util.Objects.requireNonNull;
 import static java.util.function.Function.identity;
 import static java.util.stream.Collectors.counting;
 import static java.util.stream.Collectors.groupingBy;
@@ -55,6 +56,7 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.engine.reporting.ReportEntry;
 import org.junit.platform.launcher.TestIdentifier;
@@ -244,10 +246,10 @@ private void writeSkippedOrErrorOrFailureElement(TestIdentifier testIdentifier,
 			}
 		}
 
-		private void writeSkippedElement(String reason, XMLStreamWriter writer) throws XMLStreamException {
+		private void writeSkippedElement(@Nullable String reason, XMLStreamWriter writer) throws XMLStreamException {
 			if (isNotBlank(reason)) {
 				writer.writeStartElement("skipped");
-				writeCDataSafely(reason);
+				writeCDataSafely(requireNonNull(reason));
 				writer.writeEndElement();
 			}
 			else {
@@ -256,7 +258,7 @@ private void writeSkippedElement(String reason, XMLStreamWriter writer) throws X
 			newLine();
 		}
 
-		private void writeErrorOrFailureElement(Type type, Throwable throwable, XMLStreamWriter writer)
+		private void writeErrorOrFailureElement(Type type, @Nullable Throwable throwable, XMLStreamWriter writer)
 				throws XMLStreamException {
 
 			String elementName = type == FAILURE ? "failure" : "error";

junit-platform-reporting/src/main/java/org/junit/platform/reporting/open/xml/OpenTestReportGeneratingListener.java

@@ -10,6 +10,7 @@
 
 package org.junit.platform.reporting.open.xml;
 
+import static java.util.Objects.requireNonNull;
 import static org.apiguardian.api.API.Status.EXPERIMENTAL;
 import static org.junit.platform.commons.util.StringUtils.isNotBlank;
 import static org.junit.platform.launcher.LauncherConstants.STDERR_REPORT_ENTRY_KEY;
@@ -71,6 +72,7 @@
 import java.util.function.BiConsumer;
 
 import org.apiguardian.api.API;
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.commons.JUnitException;
 import org.junit.platform.commons.util.ExceptionUtils;
 import org.junit.platform.commons.util.StringUtils;
@@ -114,6 +116,8 @@ public class OpenTestReportGeneratingListener implements TestExecutionListener {
 	private final Map<UniqueId, String> inProgressIds = new ConcurrentHashMap<>();
 	private DocumentWriter<Events> eventsFileWriter = DocumentWriter.noop();
 	private final Path workingDir;
+
+	@Nullable
 	private Path outputDir;
 
 	@SuppressWarnings("unused") // Used via ServiceLoader
@@ -361,7 +365,8 @@ public void reportingEntryPublished(TestIdentifier testIdentifier, ReportEntry e
 				}));
 	}
 
-	private static void attachOutput(Attachments attachments, LocalDateTime timestamp, String content, String source) {
+	private static void attachOutput(Attachments attachments, LocalDateTime timestamp, @Nullable String content,
+			String source) {
 		if (content != null) {
 			attachments.append(output(timestamp), output -> output.withSource(source).withContent(content));
 		}
@@ -373,7 +378,7 @@ public void fileEntryPublished(TestIdentifier testIdentifier, FileEntry entry) {
 		eventsFileWriter.append(reported(id, Instant.now()), //
 			reported -> reported.append(attachments(), attachments -> attachments.append(file(entry.getTimestamp()), //
 				file -> {
-					file.withPath(outputDir.relativize(entry.getPath()).toString());
+					file.withPath(requireNonNull(outputDir).relativize(entry.getPath()).toString());
 					entry.getMediaType().ifPresent(file::withMediaType);
 				})));
 	}