Fix support for JVM shutdown hooks

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

@@ -29,7 +29,10 @@ repository on GitHub.
 [[release-notes-5.13.0-M3-junit-platform-bug-fixes]]
 ==== Bug Fixes
 
-* ❓
+* Reintroduce support for JVM shutdown hooks when using the `-cp`/`--classpath` option of
+  the `ConsoleLauncher`. Prior to this release, the created class loader was closed prior
+  to JVM shutdown hooks being invoked, which caused hooks to fail with a
+  `ClassNotFoundException` when loading classes during shutdown.
 
 [[release-notes-5.13.0-M3-junit-platform-deprecations-and-breaking-changes]]
 ==== Deprecations and Breaking Changes

junit-platform-console/src/main/java/org/junit/platform/console/ConsoleLauncher.java

@@ -19,6 +19,7 @@
 import org.junit.platform.console.options.CommandFacade;
 import org.junit.platform.console.options.CommandResult;
 import org.junit.platform.console.tasks.ConsoleTestExecutor;
+import org.junit.platform.console.tasks.CustomClassLoaderCloseStrategy;
 
 /**
  * The {@code ConsoleLauncher} is a stand-alone application for launching the
@@ -30,17 +31,20 @@
 public class ConsoleLauncher {
 
 	public static void main(String... args) {
-		CommandResult<?> result = newCommandFacade().run(args);
+		CommandFacade facade = newCommandFacade(CustomClassLoaderCloseStrategy.KEEP_OPEN);
+		CommandResult<?> result = facade.run(args);
 		System.exit(result.getExitCode());
 	}
 
 	@API(status = INTERNAL, since = "1.0")
 	public static CommandResult<?> run(PrintWriter out, PrintWriter err, String... args) {
-		return newCommandFacade().run(args, out, err);
+		CommandFacade facade = newCommandFacade(CustomClassLoaderCloseStrategy.CLOSE_AFTER_CALLING_LAUNCHER);
+		return facade.run(args, out, err);
 	}
 
-	private static CommandFacade newCommandFacade() {
-		return new CommandFacade(ConsoleTestExecutor::new);
+	private static CommandFacade newCommandFacade(CustomClassLoaderCloseStrategy classLoaderCleanupStrategy) {
+		return new CommandFacade((discoveryOptions, outputOptions) -> new ConsoleTestExecutor(discoveryOptions,
+			outputOptions, classLoaderCleanupStrategy));
 	}
 
 }

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

@@ -50,31 +50,48 @@ public class ConsoleTestExecutor {
 	private final TestDiscoveryOptions discoveryOptions;
 	private final TestConsoleOutputOptions outputOptions;
 	private final Supplier<Launcher> launcherSupplier;
+	private final CustomClassLoaderCloseStrategy classLoaderCloseStrategy;
 
 	public ConsoleTestExecutor(TestDiscoveryOptions discoveryOptions, TestConsoleOutputOptions outputOptions) {
-		this(discoveryOptions, outputOptions, LauncherFactory::create);
+		this(discoveryOptions, outputOptions, CustomClassLoaderCloseStrategy.CLOSE_AFTER_CALLING_LAUNCHER);
+	}
+
+	public ConsoleTestExecutor(TestDiscoveryOptions discoveryOptions, TestConsoleOutputOptions outputOptions,
+			CustomClassLoaderCloseStrategy classLoaderCloseStrategy) {
+		this(discoveryOptions, outputOptions, classLoaderCloseStrategy, LauncherFactory::create);
 	}
 
 	// for tests only
 	ConsoleTestExecutor(TestDiscoveryOptions discoveryOptions, TestConsoleOutputOptions outputOptions,
 			Supplier<Launcher> launcherSupplier) {
+		this(discoveryOptions, outputOptions, CustomClassLoaderCloseStrategy.CLOSE_AFTER_CALLING_LAUNCHER,
+			launcherSupplier);
+	}
+
+	private ConsoleTestExecutor(TestDiscoveryOptions discoveryOptions, TestConsoleOutputOptions outputOptions,
+			CustomClassLoaderCloseStrategy classLoaderCloseStrategy, Supplier<Launcher> launcherSupplier) {
 		this.discoveryOptions = discoveryOptions;
 		this.outputOptions = outputOptions;
 		this.launcherSupplier = launcherSupplier;
+		this.classLoaderCloseStrategy = classLoaderCloseStrategy;
 	}
 
 	public void discover(PrintWriter out) {
-		new CustomContextClassLoaderExecutor(createCustomClassLoader()).invoke(() -> {
+		createCustomContextClassLoaderExecutor().invoke(() -> {
 			discoverTests(out);
 			return null;
 		});
 	}
 
 	public TestExecutionSummary execute(PrintWriter out, Optional<Path> reportsDir) {
-		return new CustomContextClassLoaderExecutor(createCustomClassLoader()) //
+		return createCustomContextClassLoaderExecutor() //
 				.invoke(() -> executeTests(out, reportsDir));
 	}
 
+	private CustomContextClassLoaderExecutor createCustomContextClassLoaderExecutor() {
+		return new CustomContextClassLoaderExecutor(createCustomClassLoader(), classLoaderCloseStrategy);
+	}
+
 	private void discoverTests(PrintWriter out) {
 		Launcher launcher = launcherSupplier.get();
 		Optional<DetailsPrintingListener> commandLineTestPrinter = createDetailsPrintingListener(out);

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

@@ -0,0 +1,68 @@
+/*
+ * 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 static org.apiguardian.api.API.Status.INTERNAL;
+
+import org.apiguardian.api.API;
+import org.junit.platform.commons.JUnitException;
+
+/**
+ * Defines the strategy for closing custom class loaders created for test
+ * discovery and execution.
+ */
+@API(status = INTERNAL, since = "1.13")
+public enum CustomClassLoaderCloseStrategy {
+
+	/**
+	 * Close the custom class loader after calling the
+	 * {@link org.junit.platform.launcher.Launcher} for test discovery or
+	 * execution.
+	 */
+	CLOSE_AFTER_CALLING_LAUNCHER {
+
+		@Override
+		public void handle(ClassLoader customClassLoader) {
+			if (customClassLoader instanceof AutoCloseable) {
+				close((AutoCloseable) customClassLoader);
+			}
+		}
+
+		private void close(AutoCloseable customClassLoader) {
+			try {
+				customClassLoader.close();
+			}
+			catch (Exception e) {
+				throw new JUnitException("Failed to close custom class loader", e);
+			}
+		}
+	},
+
+	/**
+	 * Rely on the JVM to release resources held by the custom class loader when
+	 * it terminates.
+	 *
+	 * <p>This mode is only safe to use when calling {@link System#exit(int)}
+	 * afterward.
+	 */
+	KEEP_OPEN {
+		@Override
+		public void handle(ClassLoader customClassLoader) {
+			// do nothing
+		}
+	};
+
+	/**
+	 * Handle the class loader according to the strategy.
+	 */
+	public abstract void handle(ClassLoader classLoader);
+
+}

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

@@ -13,17 +13,22 @@
 import java.util.Optional;
 import java.util.function.Supplier;
 
-import org.junit.platform.commons.JUnitException;
-
 /**
  * @since 1.0
  */
 class CustomContextClassLoaderExecutor {
 
 	private final Optional<ClassLoader> customClassLoader;
+	private final CustomClassLoaderCloseStrategy closeStrategy;
 
 	CustomContextClassLoaderExecutor(Optional<ClassLoader> customClassLoader) {
+		this(customClassLoader, CustomClassLoaderCloseStrategy.CLOSE_AFTER_CALLING_LAUNCHER);
+	}
+
+	CustomContextClassLoaderExecutor(Optional<ClassLoader> customClassLoader,
+			CustomClassLoaderCloseStrategy closeStrategy) {
 		this.customClassLoader = customClassLoader;
+		this.closeStrategy = closeStrategy;
 	}
 
 	<T> T invoke(Supplier<T> supplier) {
@@ -43,18 +48,7 @@ private <T> T replaceThreadContextClassLoaderAndInvoke(ClassLoader customClassLo
 		}
 		finally {
 			Thread.currentThread().setContextClassLoader(originalClassLoader);
-			if (customClassLoader instanceof AutoCloseable) {
-				close((AutoCloseable) customClassLoader);
-			}
-		}
-	}
-
-	private static void close(AutoCloseable customClassLoader) {
-		try {
-			customClassLoader.close();
-		}
-		catch (Exception e) {
-			throw new JUnitException("Failed to close custom class loader", e);
+			closeStrategy.handle(customClassLoader);
 		}
 	}
 

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

@@ -11,6 +11,7 @@
 package org.junit.platform.console.tasks;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertSame;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
@@ -28,7 +29,7 @@
 class CustomContextClassLoaderExecutorTests {
 
 	@Test
-	void invokeWithoutCustomClassLoaderDoesNotSetClassLoader() throws Exception {
+	void invokeWithoutCustomClassLoaderDoesNotSetClassLoader() {
 		var originalClassLoader = Thread.currentThread().getContextClassLoader();
 		var executor = new CustomContextClassLoaderExecutor(Optional.empty());
 
@@ -42,7 +43,7 @@ void invokeWithoutCustomClassLoaderDoesNotSetClassLoader() throws Exception {
 	}
 
 	@Test
-	void invokeWithCustomClassLoaderSetsCustomAndResetsToOriginal() throws Exception {
+	void invokeWithCustomClassLoaderSetsCustomAndResetsToOriginal() {
 		var originalClassLoader = Thread.currentThread().getContextClassLoader();
 		ClassLoader customClassLoader = URLClassLoader.newInstance(new URL[0]);
 		var executor = new CustomContextClassLoaderExecutor(Optional.of(customClassLoader));
@@ -57,7 +58,7 @@ void invokeWithCustomClassLoaderSetsCustomAndResetsToOriginal() throws Exception
 	}
 
 	@Test
-	void invokeWithCustomClassLoaderAndEnsureItIsClosedAfterUsage() throws Exception {
+	void invokeWithCustomClassLoaderAndEnsureItIsClosedAfterUsage() {
 		var closed = new AtomicBoolean(false);
 		ClassLoader localClassLoader = new URLClassLoader(new URL[0]) {
 			@Override
@@ -73,4 +74,23 @@ public void close() throws IOException {
 		assertEquals(4711, result);
 		assertTrue(closed.get());
 	}
+
+	@Test
+	void invokeWithCustomClassLoaderAndKeepItOpenAfterUsage() {
+		var closed = new AtomicBoolean(false);
+		ClassLoader localClassLoader = new URLClassLoader(new URL[0]) {
+			@Override
+			public void close() throws IOException {
+				closed.set(true);
+				super.close();
+			}
+		};
+		var executor = new CustomContextClassLoaderExecutor(Optional.of(localClassLoader),
+			CustomClassLoaderCloseStrategy.KEEP_OPEN);
+
+		int result = executor.invoke(() -> 4711);
+
+		assertEquals(4711, result);
+		assertFalse(closed.get());
+	}
 }

platform-tooling-support-tests/projects/standalone/src/other/OtherwiseNotReferencedClass.java

@@ -0,0 +1,14 @@
+/*
+ * 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 other;
+
+public class OtherwiseNotReferencedClass {
+}

platform-tooling-support-tests/projects/standalone/src/standalone/JupiterIntegration.java

@@ -19,6 +19,9 @@ class JupiterIntegration {
 
 	@Test
 	void successful() {
+		Runtime.getRuntime().addShutdownHook(new Thread(() -> {
+			new other.OtherwiseNotReferencedClass();
+		}));
 	}
 
 	@Test

platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/StandaloneTests.java

@@ -30,7 +30,6 @@
 import java.util.stream.Stream;
 
 import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.MethodOrderer;
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
@@ -155,15 +154,15 @@ void printVersionViaModule(@FilePrefix("java") OutputFiles outputFiles) throws E
 	@Test
 	@Order(1)
 	@Execution(SAME_THREAD)
-	void compile(@FilePrefix("javac") OutputFiles javacOutputFiles, @FilePrefix("jar") OutputFiles jarOutputFiles)
-			throws Exception {
+	void compile(@FilePrefix("javac") OutputFiles javacOutputFiles) throws Exception {
 		var result = ProcessStarters.javaCommand("javac") //
 				.workingDir(workspace) //
 				.addArguments("-Xlint:-options") //
 				.addArguments("--release", "8") //
 				.addArguments("-proc:none") //
 				.addArguments("-d", workspace.resolve("bin").toString()) //
 				.addArguments("--class-path", MavenRepo.jar("junit-platform-console-standalone").toString()) //
+				.addArguments(workspace.resolve("src/other/OtherwiseNotReferencedClass.java").toString()) //
 				.addArguments(workspace.resolve("src/standalone/JupiterIntegration.java").toString()) //
 				.addArguments(workspace.resolve("src/standalone/JupiterParamsIntegration.java").toString()) //
 				.addArguments(workspace.resolve("src/standalone/SuiteIntegration.java").toString()) //
@@ -174,17 +173,6 @@ void compile(@FilePrefix("javac") OutputFiles javacOutputFiles, @FilePrefix("jar
 		assertEquals(0, result.exitCode());
 		assertTrue(result.stdOut().isEmpty());
 		assertTrue(result.stdErr().isEmpty());
-
-		// create "tests.jar" that'll be picked-up by "testWithJarredTestClasses()" later
-		var jarFolder = Files.createDirectories(workspace.resolve("jar"));
-		var jarResult = ProcessStarters.javaCommand("jar") //
-				.workingDir(workspace) //
-				.addArguments("--create") //
-				.addArguments("--file", jarFolder.resolve("tests.jar").toString()) //
-				.addArguments("-C", workspace.resolve("bin").toString(), ".") //
-				.redirectOutput(jarOutputFiles) //
-				.startAndWait();
-		assertEquals(0, jarResult.exitCode());
 	}
 
 	@Test
@@ -431,23 +419,7 @@ void execute(@FilePrefix("console-launcher") OutputFiles outputFiles) throws Exc
 
 		assertEquals(1, result.exitCode());
 
-		var expectedOutLines = Files.readAllLines(workspace.resolve("expected-out.txt"));
-		var expectedErrLines = Files.readAllLines(workspace.resolve("expected-err.txt"));
-		assertLinesMatch(expectedOutLines, result.stdOutLines());
-		var actualErrLines = result.stdErrLines();
-		if (actualErrLines.getFirst().contains("stty: /dev/tty: No such device or address")) {
-			// Happens intermittently on GitHub Actions on Windows
-			actualErrLines = new ArrayList<>(actualErrLines);
-			actualErrLines.removeFirst();
-		}
-		assertLinesMatch(expectedErrLines, actualErrLines);
-
-		var jupiterVersion = Helper.version("junit-jupiter-engine");
-		var vintageVersion = Helper.version("junit-vintage-engine");
-		assertTrue(result.stdErr().contains("junit-jupiter"
-				+ " (group ID: org.junit.jupiter, artifact ID: junit-jupiter-engine, version: " + jupiterVersion));
-		assertTrue(result.stdErr().contains("junit-vintage"
-				+ " (group ID: org.junit.vintage, artifact ID: junit-vintage-engine, version: " + vintageVersion));
+		assertOutputOnCurrentJvm(result);
 	}
 
 	@Test
@@ -530,27 +502,57 @@ private static List<String> getExpectedErrLinesOnJava8(Path workspace) throws IO
 	@Test
 	@Order(6)
 	@Execution(SAME_THREAD)
-	@Disabled("https://github.com/junit-team/junit5/issues/1724")
-	void executeWithJarredTestClasses(@FilePrefix("console-launcher") OutputFiles outputFiles) throws Exception {
-		var jar = MavenRepo.jar("junit-platform-console-standalone");
-		var path = new ArrayList<String>();
-		// path.add("bin"); // "exploded" test classes are found, see also test() above
-		path.add(workspace.resolve("standalone/jar/tests.jar").toAbsolutePath().toString());
-		path.add(jar.toString());
+	void executeWithJarredTestClasses(@FilePrefix("jar") OutputFiles jarOutputFiles,
+			@FilePrefix("console-launcher") OutputFiles outputFiles) throws Exception {
+		var jar = workspace.resolve("tests.jar");
+		var jarResult = ProcessStarters.javaCommand("jar") //
+				.workingDir(workspace) //
+				.addArguments("--create") //
+				.addArguments("--file", jar.toAbsolutePath().toString()) //
+				.addArguments("-C", workspace.resolve("bin").toString(), ".") //
+				.redirectOutput(jarOutputFiles) //
+				.startAndWait();
+
+		assertEquals(0, jarResult.exitCode());
+
 		var result = ProcessStarters.java() //
+				.workingDir(workspace) //
+				.putEnvironment("NO_COLOR", "1") // --disable-ansi-colors
 				.addArguments("--show-version") //
 				.addArguments("-enableassertions") //
 				.addArguments("-Djava.util.logging.config.file=logging.properties") //
-				.addArguments("--class-path", String.join(File.pathSeparator, path)) //
-				.addArguments("org.junit.platform.console.ConsoleLauncher") //
+				.addArguments("-Djunit.platform.launcher.interceptors.enabled=true") //
+				.addArguments("-jar", MavenRepo.jar("junit-platform-console-standalone").toString()) //
 				.addArguments("execute") //
 				.addArguments("--scan-class-path") //
 				.addArguments("--disable-banner") //
 				.addArguments("--include-classname", "standalone.*") //
-				.addArguments("--fail-if-no-tests") //
+				.addArguments("--classpath", jar.toAbsolutePath().toString()) //
 				.redirectOutput(outputFiles) //
 				.startAndWait();
 
 		assertEquals(1, result.exitCode());
+
+		assertOutputOnCurrentJvm(result);
+	}
+
+	private static void assertOutputOnCurrentJvm(ProcessResult result) throws IOException {
+		var expectedOutLines = Files.readAllLines(workspace.resolve("expected-out.txt"));
+		var expectedErrLines = Files.readAllLines(workspace.resolve("expected-err.txt"));
+		assertLinesMatch(expectedOutLines, result.stdOutLines());
+		var actualErrLines = result.stdErrLines();
+		if (actualErrLines.getFirst().contains("stty: /dev/tty: No such device or address")) {
+			// Happens intermittently on GitHub Actions on Windows
+			actualErrLines = new ArrayList<>(actualErrLines);
+			actualErrLines.removeFirst();
+		}
+		assertLinesMatch(expectedErrLines, actualErrLines);
+
+		var jupiterVersion = Helper.version("junit-jupiter-engine");
+		var vintageVersion = Helper.version("junit-vintage-engine");
+		assertTrue(result.stdErr().contains("junit-jupiter"
+				+ " (group ID: org.junit.jupiter, artifact ID: junit-jupiter-engine, version: " + jupiterVersion));
+		assertTrue(result.stdErr().contains("junit-vintage"
+				+ " (group ID: org.junit.vintage, artifact ID: junit-vintage-engine, version: " + vintageVersion));
 	}
 }