Overload run() API and reuse console printing listener

Author: sormuras

junit-onramp/junit-onramp.gradle.kts

@@ -16,6 +16,7 @@ dependencies {
 	compileOnlyApi(projects.junitJupiterEngine)
 
 	implementation(projects.junitPlatformLauncher)
+	implementation(projects.junitPlatformConsole)
 }
 
 japicmp {

junit-onramp/src/main/java/module-info.java

@@ -16,7 +16,7 @@
  * import module org.junit.onramp;
  *
  *  void main() {
- *    JUnit.run(this);
+ *    JUnit.run();
  *  }
  *
  *  @Test
@@ -31,6 +31,7 @@
 
 	requires transitive org.junit.jupiter;
 	requires org.junit.platform.launcher;
+	requires org.junit.platform.console;
 
 	exports org.junit.onramp;
 }

junit-onramp/src/main/java/org/junit/onramp/ContainerFeedPrintingListener.java

@@ -10,6 +10,7 @@
 
 package org.junit.onramp;
 
+import static java.lang.StackWalker.Option.RETAIN_CLASS_REFERENCE;
 import static org.apiguardian.api.API.Status.EXPERIMENTAL;
 import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass;
 import static org.junit.platform.engine.discovery.DiscoverySelectors.selectModule;
@@ -20,34 +21,44 @@
 
 import org.apiguardian.api.API;
 import org.junit.platform.commons.JUnitException;
+import org.junit.platform.console.output.ColorPalette;
+import org.junit.platform.console.output.TestFeedPrintingListener;
+import org.junit.platform.engine.DiscoverySelector;
 import org.junit.platform.launcher.core.LauncherFactory;
 import org.junit.platform.launcher.listeners.SummaryGeneratingListener;
 
 @API(status = EXPERIMENTAL, since = "6.0")
 public final class JUnit {
-
-	private JUnit() {
+	/**
+	 * Run all tests defined in the caller class.
+	 */
+	public static void run() {
+		var walker = StackWalker.getInstance(RETAIN_CLASS_REFERENCE);
+		run(selectClass(walker.getCallerClass()));
 	}
 
-	public static void run(Object instance) {
-		var listener = new SummaryGeneratingListener();
-		var builder = request();
+	/**
+	 * Run all tests defined in the given test class.
+	 * @param testClass  the class to discover and execute tests in
+	 */
+	public static void run(Class<?> testClass) {
+		run(selectClass(testClass));
+	}
 
-		if (instance instanceof Class<?> testClass) {
-			// handling `JUnit.run(getClass())`
-			builder.selectors(selectClass(testClass));
-		}
-		else if (instance instanceof Module testModule) {
-			// handling `JUnit.run(getClass().getModule())`
-			builder.selectors(selectModule(testModule));
-		}
-		else {
-			// handling `JUnit.run(this)`
-			builder.selectors(selectClass(instance.getClass()));
-		}
+	/**
+	 * Run all tests defined in the given module.
+	 * @param testModule the module to discover and execute tests in
+	 */
+	public static void run(Module testModule) {
+		run(selectModule(testModule));
+	}
 
-		var request = builder.forExecution() //
-				.listeners(listener, new ContainerFeedPrintingListener()) //
+	private static void run(DiscoverySelector selector) {
+		var listener = new SummaryGeneratingListener();
+		var writer = new PrintWriter(System.out, true, Charset.defaultCharset());
+		var printer = new TestFeedPrintingListener(writer, ColorPalette.DEFAULT);
+		var request = request().selectors(selector).forExecution() //
+				.listeners(listener, printer) //
 				.build();
 		var launcher = LauncherFactory.create();
 		launcher.execute(request);
@@ -61,4 +72,7 @@ else if (instance instanceof Module testModule) {
 			summary.getTotalFailureCount(), //
 			summary.getTotalFailureCount() == 1 ? "" : "s"));
 	}
+
+	private JUnit() {
+	}
 }

junit-onramp/src/main/java/org/junit/onramp/JUnit.java

@@ -28,6 +28,7 @@ dependencies {
 tasks {
 	compileJava {
 		options.compilerArgs.addAll(listOf(
+			"-Xlint:-module", // due to qualified exports
 			"--add-modules", "info.picocli",
 			"--add-reads", "${javaModuleName}=info.picocli"
 		))

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

@@ -24,5 +24,7 @@
 	requires org.junit.platform.launcher;
 	requires org.junit.platform.reporting;
 
+	exports org.junit.platform.console.output to org.junit.onramp;
+
 	provides java.util.spi.ToolProvider with org.junit.platform.console.ConsoleLauncherToolProvider;
 }

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

@@ -4,4 +4,5 @@ requires java.base mandated
 requires org.apiguardian.api static transitive
 requires org.jspecify static transitive
 requires org.junit.jupiter transitive
+requires org.junit.platform.console
 requires org.junit.platform.launcher

platform-tooling-support-tests/projects/jar-describe-module/junit-onramp.expected.txt

@@ -7,9 +7,9 @@ requires org.junit.platform.engine
 requires org.junit.platform.launcher
 requires org.junit.platform.reporting
 provides java.util.spi.ToolProvider with org.junit.platform.console.ConsoleLauncherToolProvider
+qualified exports org.junit.platform.console.output to org.junit.onramp
 contains org.junit.platform.console
 contains org.junit.platform.console.command
 contains org.junit.platform.console.options
-contains org.junit.platform.console.output
 contains org.junit.platform.console.shadow.picocli
 main-class org.junit.platform.console.ConsoleLauncher