Increase compatibility with GraalVM

- Avoid early static initialization during native image compilation
  where possible
- Use and document `--initialize-at-build-time` build argument

Author: marcphilipp

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

@@ -19,7 +19,8 @@ repository on GitHub.
 
 ==== Deprecations and Breaking Changes
 
-* ❓
+* Building native images with GraalVM now requires configuring the build arg
+  `--initialize-at-build-time=org.junit.platform.launcher.core.LauncherConfig`.
 
 ==== New Features and Improvements
 

junit-platform-launcher/src/main/java/org/junit/platform/launcher/core/EngineIdValidator.java

@@ -23,8 +23,6 @@
  */
 class EngineIdValidator {
 
-	private static final Logger logger = LoggerFactory.getLogger(EngineIdValidator.class);
-
 	private EngineIdValidator() {
 	}
 
@@ -33,7 +31,7 @@ static Iterable<TestEngine> validate(Iterable<TestEngine> testEngines) {
 		for (TestEngine testEngine : testEngines) {
 			// check usage of reserved id prefix
 			if (!validateReservedIds(testEngine)) {
-				logger.warn(() -> String.format(
+				getLogger().warn(() -> String.format(
 					"Third-party TestEngine implementations are forbidden to use the reserved 'junit-' prefix for their ID: '%s'",
 					testEngine.getId()));
 			}
@@ -47,6 +45,11 @@ static Iterable<TestEngine> validate(Iterable<TestEngine> testEngines) {
 		return testEngines;
 	}
 
+	private static Logger getLogger() {
+		// Not a constant to avoid problems with building GraalVM native images
+		return LoggerFactory.getLogger(EngineIdValidator.class);
+	}
+
 	// https://github.com/junit-team/junit5/issues/1557
 	private static boolean validateReservedIds(TestEngine testEngine) {
 		String engineId = testEngine.getId();

junit-platform-launcher/src/main/java/org/junit/platform/launcher/core/LauncherFactory.java

@@ -66,8 +66,6 @@
 @API(status = STABLE, since = "1.0")
 public class LauncherFactory {
 
-	private static final ServiceLoaderRegistry SERVICE_LOADER_REGISTRY = new ServiceLoaderRegistry();
-
 	private LauncherFactory() {
 		/* no-op */
 	}
@@ -151,7 +149,7 @@ private static List<LauncherInterceptor> collectLauncherInterceptors(
 			LauncherConfigurationParameters configurationParameters) {
 		if (configurationParameters.getBoolean(ENABLE_LAUNCHER_INTERCEPTORS).orElse(false)) {
 			List<LauncherInterceptor> interceptors = new ArrayList<>();
-			SERVICE_LOADER_REGISTRY.load(LauncherInterceptor.class).forEach(interceptors::add);
+			ServiceLoaderRegistry.load(LauncherInterceptor.class).forEach(interceptors::add);
 			return interceptors;
 		}
 		return emptyList();
@@ -169,7 +167,7 @@ private static Set<TestEngine> collectTestEngines(LauncherConfig config) {
 	private static LauncherSessionListener createLauncherSessionListener(LauncherConfig config) {
 		ListenerRegistry<LauncherSessionListener> listenerRegistry = ListenerRegistry.forLauncherSessionListeners();
 		if (config.isLauncherSessionListenerAutoRegistrationEnabled()) {
-			SERVICE_LOADER_REGISTRY.load(LauncherSessionListener.class).forEach(listenerRegistry::add);
+			ServiceLoaderRegistry.load(LauncherSessionListener.class).forEach(listenerRegistry::add);
 		}
 		config.getAdditionalLauncherSessionListeners().forEach(listenerRegistry::add);
 		return listenerRegistry.getCompositeListener();
@@ -178,15 +176,15 @@ private static LauncherSessionListener createLauncherSessionListener(LauncherCon
 	private static List<PostDiscoveryFilter> collectPostDiscoveryFilters(LauncherConfig config) {
 		List<PostDiscoveryFilter> filters = new ArrayList<>();
 		if (config.isPostDiscoveryFilterAutoRegistrationEnabled()) {
-			SERVICE_LOADER_REGISTRY.load(PostDiscoveryFilter.class).forEach(filters::add);
+			ServiceLoaderRegistry.load(PostDiscoveryFilter.class).forEach(filters::add);
 		}
 		filters.addAll(config.getAdditionalPostDiscoveryFilters());
 		return filters;
 	}
 
 	private static void registerLauncherDiscoveryListeners(LauncherConfig config, Launcher launcher) {
 		if (config.isLauncherDiscoveryListenerAutoRegistrationEnabled()) {
-			SERVICE_LOADER_REGISTRY.load(LauncherDiscoveryListener.class).forEach(
+			ServiceLoaderRegistry.load(LauncherDiscoveryListener.class).forEach(
 				launcher::registerLauncherDiscoveryListeners);
 		}
 		config.getAdditionalLauncherDiscoveryListeners().forEach(launcher::registerLauncherDiscoveryListeners);
@@ -203,7 +201,7 @@ private static void registerTestExecutionListeners(LauncherConfig config, Launch
 
 	private static Stream<TestExecutionListener> loadAndFilterTestExecutionListeners(
 			ConfigurationParameters configurationParameters) {
-		Iterable<TestExecutionListener> listeners = SERVICE_LOADER_REGISTRY.load(TestExecutionListener.class);
+		Iterable<TestExecutionListener> listeners = ServiceLoaderRegistry.load(TestExecutionListener.class);
 		String deactivatedListenersPattern = configurationParameters.get(
 			DEACTIVATE_LISTENERS_PATTERN_PROPERTY_NAME).orElse(null);
 		// @formatter:off

junit-platform-launcher/src/main/java/org/junit/platform/launcher/core/ServiceLoaderRegistry.java

@@ -24,13 +24,16 @@
  */
 class ServiceLoaderRegistry {
 
-	private static final Logger logger = LoggerFactory.getLogger(ServiceLoaderRegistry.class);
-
-	<T> Iterable<T> load(Class<T> serviceProviderClass) {
+	static <T> Iterable<T> load(Class<T> serviceProviderClass) {
 		Iterable<T> listeners = ServiceLoader.load(serviceProviderClass, ClassLoaderUtils.getDefaultClassLoader());
-		logger.config(() -> "Loaded " + serviceProviderClass.getSimpleName() + " instances: "
+		getLogger().config(() -> "Loaded " + serviceProviderClass.getSimpleName() + " instances: "
 				+ stream(listeners.spliterator(), false).map(Object::toString).collect(toList()));
 		return listeners;
 	}
 
+	private static Logger getLogger() {
+		// Not a constant to avoid problems with building GraalVM native images
+		return LoggerFactory.getLogger(ServiceLoaderRegistry.class);
+	}
+
 }

junit-platform-launcher/src/main/java/org/junit/platform/launcher/core/ServiceLoaderTestEngineRegistry.java

@@ -29,13 +29,16 @@ public final class ServiceLoaderTestEngineRegistry {
 	public ServiceLoaderTestEngineRegistry() {
 	}
 
-	private static final Logger logger = LoggerFactory.getLogger(ServiceLoaderTestEngineRegistry.class);
-
 	public Iterable<TestEngine> loadTestEngines() {
 		Iterable<TestEngine> testEngines = ServiceLoader.load(TestEngine.class,
 			ClassLoaderUtils.getDefaultClassLoader());
-		logger.config(() -> TestEngineFormatter.format("Discovered TestEngines", testEngines));
+		getLogger().config(() -> TestEngineFormatter.format("Discovered TestEngines", testEngines));
 		return testEngines;
 	}
 
+	private static Logger getLogger() {
+		// Not a constant to avoid problems with building GraalVM native images
+		return LoggerFactory.getLogger(ServiceLoaderTestEngineRegistry.class);
+	}
+
 }

platform-tests/src/test/java/org/junit/platform/launcher/InterceptorInjectedLauncherSessionListener.java

@@ -28,8 +28,9 @@ public void launcherSessionOpened(LauncherSession session) {
 		CALLS++;
 	}
 
-    @Override
-    public void launcherSessionClosed(LauncherSession session) {
-        assertEquals(TestLauncherInterceptor1.CLASSLOADER_NAME, Thread.currentThread().getContextClassLoader().getName());
-    }
+	@Override
+	public void launcherSessionClosed(LauncherSession session) {
+		assertEquals(TestLauncherInterceptor1.CLASSLOADER_NAME,
+			Thread.currentThread().getContextClassLoader().getName());
+	}
 }

platform-tooling-support-tests/projects/graalvm-starter/build.gradle.kts

@@ -27,3 +27,12 @@ tasks.test {
 		)
 	}
 }
+
+graalvmNative {
+	binaries {
+		named("test") {
+			buildArgs.add("--initialize-at-build-time=org.junit.platform.launcher.core.LauncherConfig")
+			buildArgs.add("-H:+ReportExceptionStackTraces")
+		}
+	}
+}