Issue #3166: STDOUT and STDERR are auto closed after test execution

Author: Oyster-zx

documentation/src/docs/asciidoc/release-notes/release-notes-5.13.0-M1.adoc

@@ -27,7 +27,7 @@ repository on GitHub.
 ==== New Features and Improvements
 
 * New optional CLI options `--redirect-stdout` and `--redirect-stderr` to redirect stdout
-and stderr outputs to a file.
+  and stderr outputs to a file.
 
 
 [[release-notes-5.13.0-M1-junit-jupiter]]

documentation/src/docs/asciidoc/user-guide/advanced-topics/junit-platform-reporting.adoc

@@ -154,12 +154,13 @@ $ java -jar junit-platform-console-standalone-{platform-version}.jar <OPTIONS> \
   --config-resource=configuration.properties
 ----
 
-You can redirect standard output and standard error using the --redirect-stdout and --redirect-stderr options:
+You can redirect standard output and standard error using the `--redirect-stdout` and
+`--redirect-stderr` options:
 
 [source,console,subs=attributes+]
 ----
 $ java -jar junit-platform-console-standalone-{platform-version}.jar <OPTIONS> \
-  --redirect-stdout=foo.txt
+  --redirect-stdout=foo.txt \
   --redirect-stderr=bar.txt
 ----
 

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

@@ -51,10 +51,10 @@ static class ConsoleOutputOptions {
 		@Option(names = "-details-theme", hidden = true)
 		private final Theme theme2 = DEFAULT_THEME;
 
-		@Option(names = "--redirect-stdout", paramLabel = "FILE", description = "Redirect tests stdout to a file.")
+		@Option(names = "--redirect-stdout", paramLabel = "FILE", description = "Redirect test output to stdout to a file.")
 		private Path stdout;
 
-		@Option(names = "--redirect-stderr", paramLabel = "FILE", description = "Redirect tests stderr to a file.")
+		@Option(names = "--redirect-stderr", paramLabel = "FILE", description = "Redirect test output to stderr to a file.")
 		private Path stderr;
 
 		private void applyTo(TestConsoleOutputOptions result) {

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

@@ -14,12 +14,10 @@
 import static org.junit.platform.console.tasks.DiscoveryRequestCreator.toDiscoveryRequestBuilder;
 import static org.junit.platform.launcher.LauncherConstants.OUTPUT_DIR_PROPERTY_NAME;
 
-import java.io.IOException;
 import java.io.PrintStream;
 import java.io.PrintWriter;
 import java.net.URL;
 import java.net.URLClassLoader;
-import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.EnumSet;
 import java.util.List;
@@ -106,8 +104,8 @@ private TestExecutionSummary executeTests(PrintWriter out, Optional<Path> report
 
 		PrintStream originalOut = System.out;
 		PrintStream originalErr = System.err;
-		try {
-			redirectStdStreams(outputOptions.getStdoutPath(), outputOptions.getStderrPath());
+		try (StdStreamHandler stdStreamHandler = new StdStreamHandler()) {
+			stdStreamHandler.redirectStdStreams(outputOptions.getStdoutPath(), outputOptions.getStderrPath());
 			launchTests(launcher, reportsDir);
 		}
 		finally {
@@ -206,47 +204,6 @@ private void printSummary(TestExecutionSummary summary, PrintWriter out) {
 		summary.printTo(out);
 	}
 
-	@API(status = INTERNAL, since = "5.12")
-	private boolean isSameFile(Path path1, Path path2) {
-		if (path1 == null || path2 == null)
-			return false;
-		return (path1.normalize().toAbsolutePath().equals(path2.normalize().toAbsolutePath()));
-	}
-
-	private void redirectStdStreams(Path stdoutPath, Path stderrPath) {
-		if (isSameFile(stdoutPath, stderrPath)) {
-			try {
-				PrintStream commonStream = new PrintStream(Files.newOutputStream(stdoutPath), true);
-				System.setOut(commonStream);
-				System.setErr(commonStream);
-			}
-			catch (IOException e) {
-				throw new JUnitException("Error setting up stream for Stdout and Stderr at path: " + stdoutPath, e);
-			}
-		}
-		else {
-			if (stdoutPath != null) {
-				try {
-					PrintStream outStream = new PrintStream(Files.newOutputStream(stdoutPath), true);
-					System.setOut(outStream);
-				}
-				catch (IOException e) {
-					throw new JUnitException("Error setting up stream for Stdout at path: " + stdoutPath, e);
-				}
-			}
-
-			if (stderrPath != null) {
-				try {
-					PrintStream errStream = new PrintStream(Files.newOutputStream(stderrPath), true);
-					System.setErr(errStream);
-				}
-				catch (IOException e) {
-					throw new JUnitException("Error setting up stream for Stderr at path: " + stderrPath, e);
-				}
-			}
-		}
-	}
-
 	@FunctionalInterface
 	public interface Factory {
 		ConsoleTestExecutor create(TestDiscoveryOptions discoveryOptions, TestConsoleOutputOptions outputOptions);

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

@@ -0,0 +1,81 @@
+/*
+ * Copyright 2015-2025 the original author or authors.
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License v2.0 which
+ * accompanies this distribution and is available at
+ *
+ * https://www.eclipse.org/legal/epl-v20.html
+ */
+
+package org.junit.platform.console.tasks;
+
+import java.io.IOException;
+import java.io.PrintStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import org.junit.platform.commons.JUnitException;
+
+class StdStreamHandler implements AutoCloseable {
+	private PrintStream stdout;
+	private PrintStream stderr;
+
+	public StdStreamHandler() {
+	}
+
+	private boolean isSameFile(Path path1, Path path2) {
+		if (path1 == null || path2 == null)
+			return false;
+		return (path1.normalize().toAbsolutePath().equals(path2.normalize().toAbsolutePath()));
+	}
+
+	public void redirectStdStreams(Path stdoutPath, Path stderrPath) {
+		if (isSameFile(stdoutPath, stderrPath)) {
+			try {
+				PrintStream commonStream = new PrintStream(Files.newOutputStream(stdoutPath), true);
+				this.stdout = commonStream;
+				this.stderr = commonStream;
+			}
+			catch (IOException e) {
+				throw new JUnitException("Error setting up stream for Stdout and Stderr at path: " + stdoutPath, e);
+			}
+		}
+		else {
+			if (stdoutPath != null) {
+				try {
+					this.stdout = new PrintStream(Files.newOutputStream(stdoutPath), true);
+				}
+				catch (IOException e) {
+					throw new JUnitException("Error setting up stream for Stdout at path: " + stdoutPath, e);
+				}
+			}
+
+			if (stderrPath != null) {
+				try {
+					this.stderr = new PrintStream(Files.newOutputStream(stderrPath), true);
+				}
+				catch (IOException e) {
+					throw new JUnitException("Error setting up stream for Stderr at path: " + stderrPath, e);
+				}
+			}
+		}
+
+		if (stdout != null) {
+			System.setOut(stdout);
+		}
+		if (stderr != null) {
+			System.setErr(stderr);
+		}
+	}
+
+	@Override
+	public void close() {
+		if (stdout != null) {
+			stdout.close();
+		}
+		if (stderr != null) {
+			stderr.close();
+		}
+	}
+}

platform-tests/src/test/java/org/junit/platform/console/ConsoleLauncherIntegrationTests.java

@@ -10,7 +10,6 @@
 
 package org.junit.platform.console;
 
-import static java.nio.file.Files.deleteIfExists;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertAll;
 import static org.junit.jupiter.api.Assertions.assertArrayEquals;
@@ -22,6 +21,7 @@
 import java.nio.file.Path;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 
@@ -100,33 +100,30 @@ void executeScanModules(final String line) {
 
 	@ParameterizedTest
 	@ValueSource(strings = { "--redirect-stdout", "--redirect-stderr" })
-	void executeWithRedirectedStdStream(String redirectedStream) throws IOException {
-
-		Path outputFile = Path.of("foo.txt");
+	void executeWithRedirectedStdStream(String redirectedStream, @TempDir Path tempDir) throws IOException {
+		Path outputFile = tempDir.resolve("output.txt");
 		var line = String.format(
-			"execute -e junit-jupiter --select-method org.junit.platform.console.options.StdStreamTest#printTest "
+			"execute -e junit-jupiter --select-method org.junit.platform.console.options.StdStreamTestCase#printTest "
 					+ "%s %s",
 			redirectedStream, outputFile);
 		var args = line.split(" ");
 		new ConsoleLauncherWrapper().execute(args);
 
 		assertTrue(Files.exists(outputFile), "File does not exist.");
-		assertEquals(Files.size(outputFile), 20, "Invalid file size.");
-		deleteIfExists(outputFile);
+		assertEquals(20, Files.size(outputFile), "Invalid file size.");
 	}
 
 	@Test
-	void executeWithRedirectedStdStreamsToSameFile() throws IOException {
-		Path outputFile = Path.of("foo.txt");
+	void executeWithRedirectedStdStreamsToSameFile(@TempDir Path tempDir) throws IOException {
+		Path outputFile = tempDir.resolve("output.txt");
 		var line = String.format(
-			"execute -e junit-jupiter --select-method org.junit.platform.console.options.StdStreamTest#printTest "
+			"execute -e junit-jupiter --select-method org.junit.platform.console.options.StdStreamTestCase#printTest "
 					+ "--redirect-stdout %s --redirect-stderr %s",
 			outputFile, outputFile);
 		var args = line.split(" ");
 		new ConsoleLauncherWrapper().execute(args);
 
 		assertTrue(Files.exists(outputFile), "File does not exist.");
-		assertEquals(Files.size(outputFile), 40, "Invalid file size.");
-		deleteIfExists(outputFile);
+		assertEquals(40, Files.size(outputFile), "Invalid file size.");
 	}
 }

platform-tests/src/test/java/org/junit/platform/console/options/StdStreamTest.java renamed to platform-tests/src/test/java/org/junit/platform/console/options/StdStreamTestCase.java

@@ -12,7 +12,7 @@
 
 import org.junit.jupiter.api.Test;
 
-public class StdStreamTest {
+public class StdStreamTestCase {
 
 	@Test
 	void printTest() {