Add tests for FileEntry handling in TestExecutionListeners

Author: marcphilipp

gradle/plugins/common/src/main/kotlin/junitbuild/exec/RunConsoleLauncher.kt

@@ -6,7 +6,13 @@ import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
-import org.gradle.api.tasks.*
+import org.gradle.api.tasks.CacheableTask
+import org.gradle.api.tasks.Classpath
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.Internal
+import org.gradle.api.tasks.Nested
+import org.gradle.api.tasks.SourceSetContainer
+import org.gradle.api.tasks.TaskAction
 import org.gradle.api.tasks.options.Option
 import org.gradle.jvm.toolchain.JavaLauncher
 import org.gradle.jvm.toolchain.JavaToolchainService
@@ -16,7 +22,6 @@ import org.gradle.process.CommandLineArgumentProvider
 import org.gradle.process.ExecOperations
 import trackOperationSystemAsInput
 import java.io.ByteArrayOutputStream
-import java.util.*
 import javax.inject.Inject
 
 @CacheableTask
@@ -97,4 +102,13 @@ abstract class RunConsoleLauncher @Inject constructor(private val execOperations
         debugging.set(enabled)
     }
 
+    @Suppress("unused")
+    @Option(
+        option = "show-output",
+        description = "Show output"
+    )
+    fun setShowOutput(showOutput: Boolean) {
+        hideOutput.set(!showOutput)
+    }
+
 }

junit-platform-engine/src/main/java/org/junit/platform/engine/reporting/FileEntry.java

@@ -60,6 +60,7 @@ public Path getFile() {
 	@Override
 	public String toString() {
 		ToStringBuilder builder = new ToStringBuilder(this);
+		builder.append("timestamp", this.timestamp);
 		builder.append("file", this.file);
 		return builder.toString();
 	}

platform-tests/src/test/java/org/junit/platform/console/tasks/FlatPrintingListenerTests.java

@@ -18,11 +18,13 @@
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
+import java.nio.file.Path;
 
 import org.assertj.core.util.Maps;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 import org.junit.platform.engine.UniqueId;
+import org.junit.platform.engine.reporting.FileEntry;
 import org.junit.platform.engine.reporting.ReportEntry;
 import org.junit.platform.fakes.TestDescriptorStub;
 import org.junit.platform.launcher.TestIdentifier;
@@ -60,6 +62,19 @@ void reportingEntryPublished() {
 			() -> assertTrue(lines[1].endsWith(", foo = 'bar']")));
 	}
 
+	@Test
+	void fileEntryPublished() {
+		var stringWriter = new StringWriter();
+		listener(stringWriter).fileEntryPublished(newTestIdentifier(), FileEntry.from(Path.of("test.txt")));
+		var lines = lines(stringWriter);
+
+		assertEquals(2, lines.length);
+		assertAll("lines in the output", //
+			() -> assertEquals("Reported:    demo-test ([engine:demo-engine])", lines[0]), //
+			() -> assertTrue(lines[1].startsWith(INDENTATION + "=> Reported file: FileEntry [timestamp =")), //
+			() -> assertTrue(lines[1].endsWith(", file = test.txt]")));
+	}
+
 	@Test
 	void executionFinishedWithFailure() {
 		var stringWriter = new StringWriter();

platform-tests/src/test/java/org/junit/platform/console/tasks/TreePrinterTests.java

@@ -21,12 +21,14 @@
 import java.io.PrintWriter;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Path;
 import java.util.List;
 
 import org.junit.jupiter.api.Test;
 import org.junit.platform.console.options.Theme;
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.engine.UniqueId;
+import org.junit.platform.engine.reporting.FileEntry;
 import org.junit.platform.engine.reporting.ReportEntry;
 import org.junit.platform.fakes.TestDescriptorStub;
 import org.junit.platform.launcher.TestIdentifier;
@@ -92,7 +94,7 @@ void reportsAreTabbedCorrectly() {
 		c1.addChild(m1);
 
 		var m2 = new TreeNode(identifier("m-2", "method two")).setResult(successful());
-		m2.addReportEntry(ReportEntry.from("key", "m-2"));
+		m2.addFileEntry(FileEntry.from(Path.of("test.txt")));
 		c1.addChild(m2);
 
 		new TreePrinter(out, Theme.UNICODE, ColorPalette.NONE).print(root);
@@ -105,7 +107,7 @@ void reportsAreTabbedCorrectly() {
 			"      ├─ method one ✔", //
 			"      │     ....-..-..T..:...* key = `m-1`", //
 			"      └─ method two ✔", //
-			"            ....-..-..T..:...* key = `m-2`" //
+			"            ....-..-..T..:...* file:.*" //
 		), //
 			actual());
 	}

…sole/tasks/VerboseTreeListenerTests.java …ks/VerboseTreePrintingListenerTests.javaplatform-tests/src/test/java/org/junit/platform/console/tasks/VerboseTreeListenerTests.java renamed to platform-tests/src/test/java/org/junit/platform/console/tasks/VerboseTreePrintingListenerTests.java platform-tests/src/test/java/org/junit/platform/console/tasks/VerboseTreeListenerTests.java renamed to platform-tests/src/test/java/org/junit/platform/console/tasks/VerboseTreePrintingListenerTests.java

@@ -15,19 +15,21 @@
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
+import java.nio.file.Path;
 import java.util.List;
 
 import org.junit.jupiter.api.Test;
 import org.junit.platform.console.options.Theme;
 import org.junit.platform.engine.UniqueId;
+import org.junit.platform.engine.reporting.FileEntry;
 import org.junit.platform.engine.reporting.ReportEntry;
 import org.junit.platform.fakes.TestDescriptorStub;
 import org.junit.platform.launcher.TestIdentifier;
 
 /**
  * @since 1.3.2
  */
-class VerboseTreeListenerTests {
+class VerboseTreePrintingListenerTests {
 
 	private static final String EOL = System.lineSeparator();
 
@@ -56,6 +58,15 @@ void reportingEntryPublished() {
 		assertLinesMatch(List.of("  reports: ReportEntry \\[timestamp = .+, foo = 'bar'\\]"), List.of(lines));
 	}
 
+	@Test
+	void fileEntryPublished() {
+		var stringWriter = new StringWriter();
+		listener(stringWriter).fileEntryPublished(newTestIdentifier(), FileEntry.from(Path.of("test.txt")));
+		var lines = lines(stringWriter);
+
+		assertLinesMatch(List.of("  reports: FileEntry \\[timestamp = .+, file = test.txt\\]"), List.of(lines));
+	}
+
 	@Test
 	void executionFinishedWithFailure() {
 		var stringWriter = new StringWriter();

platform-tests/src/test/java/org/junit/platform/jfr/FlightRecordingExecutionListenerIntegrationTests.java

@@ -12,13 +12,20 @@
 
 import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass;
 import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.request;
+import static org.junit.platform.launcher.core.OutputDirectoryProviders.hierarchicalOutputDirectoryProvider;
 import static org.moditect.jfrunit.ExpectedEvent.event;
 import static org.moditect.jfrunit.JfrEventsAssert.assertThat;
 
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestReporter;
 import org.junit.jupiter.api.extension.DisabledOnOpenJ9;
+import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.engine.JupiterTestEngine;
 import org.junit.platform.launcher.core.LauncherFactoryForTestingPurposesOnly;
 import org.moditect.jfrunit.EnableEvent;
@@ -33,15 +40,18 @@ public class FlightRecordingExecutionListenerIntegrationTests {
 
 	@Test
 	@EnableEvent("org.junit.*")
-	void reportsEvents() {
+	void reportsEvents(@TempDir Path tempDir) {
 		var launcher = LauncherFactoryForTestingPurposesOnly.createLauncher(new JupiterTestEngine());
 		var request = request() //
 				.selectors(selectClass(TestCase.class)) //
+				.outputDirectoryProvider(hierarchicalOutputDirectoryProvider(tempDir)) //
 				.build();
 
 		launcher.execute(request, new FlightRecordingExecutionListener());
 		jfrEvents.awaitEvents();
 
+		var testFile = findPath(tempDir, "glob:**/test.txt");
+
 		assertThat(jfrEvents) //
 				.contains(event("org.junit.TestPlanExecution") //
 						.with("engineNames", "JUnit Jupiter")) //
@@ -59,17 +69,30 @@ void reportsEvents() {
 				.contains(event("org.junit.ReportEntry") //
 						.with("key", "message") //
 						.with("value", "Hello JFR!")) //
+				.contains(event("org.junit.FileEntry") //
+						.with("path", testFile.toAbsolutePath().toString())) //
 				.contains(event("org.junit.SkippedTest") //
 						.with("displayName", "skipped()") //
 						.with("type", "TEST") //
 						.with("reason", "for demonstration purposes"));
 	}
 
+	private static Path findPath(Path rootDir, @SuppressWarnings("SameParameterValue") String syntaxAndPattern) {
+		var matcher = rootDir.getFileSystem().getPathMatcher(syntaxAndPattern);
+		try (var files = Files.walk(rootDir)) {
+			return files.filter(matcher::matches).findFirst().orElseThrow();
+		}
+		catch (IOException e) {
+			throw new UncheckedIOException(e);
+		}
+	}
+
 	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCase {
 		@Test
 		void test(TestReporter reporter) {
 			reporter.publishEntry("message", "Hello JFR!");
+			reporter.publishFile("test.txt", file -> Files.writeString(file, "test"));
 		}
 
 		@Test