From 3853830320876863b0d622b923a805c80ef7a973 Mon Sep 17 00:00:00 2001 From: Ziyi Lin Date: Thu, 1 Jun 2023 20:02:06 +0800 Subject: [PATCH] Discover tests with another Java process JUnitPlatformFeature discovers tests before analysis. The discovery procsee will initialize some of the test classes when @RunWith, @Parameterized annotations are used. As they are loaded by the ImageClassloader, the initialization may cause eager class initialization error during native image building time. This commit lauches the test discovery in a another Java process in the JUnitPlatformFeature to make sure the test class initialization at discovery time won't affect the native image class initialization policy. --- .../junit/platform/JUnitPlatformFeature.java | 117 ++------ .../platform/NativeImageJUnitLauncher.java | 19 +- .../junit/platform/TestsDiscoveryHelper.java | 262 ++++++++++++++++++ .../platform/PlatformConfigProvider.java | 1 - .../config/vintage/VintageConfigProvider.java | 2 - .../buildtools/maven/NativeTestMojo.java | 11 + 6 files changed, 311 insertions(+), 101 deletions(-) create mode 100644 common/junit-platform-native/src/main/java/org/graalvm/junit/platform/TestsDiscoveryHelper.java diff --git a/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/JUnitPlatformFeature.java b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/JUnitPlatformFeature.java index e9fc8c155..2882141a8 100644 --- a/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/JUnitPlatformFeature.java +++ b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/JUnitPlatformFeature.java @@ -42,38 +42,21 @@ package org.graalvm.junit.platform; import org.graalvm.junit.platform.config.core.PluginConfigProvider; +import org.graalvm.nativeimage.ImageInfo; import org.graalvm.nativeimage.ImageSingletons; import org.graalvm.nativeimage.hosted.Feature; import org.graalvm.nativeimage.hosted.RuntimeClassInitialization; -import org.junit.platform.engine.DiscoverySelector; -import org.junit.platform.engine.discovery.DiscoverySelectors; -import org.junit.platform.engine.discovery.UniqueIdSelector; -import org.junit.platform.engine.support.descriptor.ClassSource; -import org.junit.platform.launcher.Launcher; -import org.junit.platform.launcher.LauncherDiscoveryRequest; -import org.junit.platform.launcher.TestIdentifier; -import org.junit.platform.launcher.TestPlan; -import org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder; -import org.junit.platform.launcher.core.LauncherFactory; -import org.junit.platform.launcher.listeners.UniqueIdTrackingListener; -import java.io.IOException; -import java.io.UncheckedIOException; -import java.nio.file.Files; import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.HashSet; +import java.util.ArrayList; import java.util.List; -import java.util.Optional; import java.util.ServiceLoader; import java.util.function.Consumer; -import java.util.stream.Collectors; -import java.util.stream.Stream; @SuppressWarnings("unused") public final class JUnitPlatformFeature implements Feature { - public final boolean debug = System.getProperty("debug") != null; + public static final boolean debug = System.getProperty(TestsDiscoveryHelper.DEBUG) != null; private static final NativeImageConfigurationImpl nativeImageConfigImpl = new NativeImageConfigurationImpl(); private final ServiceLoader extensionConfigProviders = ServiceLoader.load(PluginConfigProvider.class); @@ -86,65 +69,28 @@ public void duringSetup(DuringSetupAccess access) { @Override public void beforeAnalysis(BeforeAnalysisAccess access) { RuntimeClassInitialization.initializeAtBuildTime(NativeImageJUnitLauncher.class); - List classpathRoots = access.getApplicationClassPath(); - List selectors = getSelectors(classpathRoots); - - Launcher launcher = LauncherFactory.create(); - TestPlan testplan = discoverTestsAndRegisterTestClassesForReflection(launcher, selectors); - ImageSingletons.add(NativeImageJUnitLauncher.class, new NativeImageJUnitLauncher(launcher, testplan)); - } - - private List getSelectors(List classpathRoots) { - try { - Path outputDir = Paths.get(System.getProperty(UniqueIdTrackingListener.OUTPUT_DIR_PROPERTY_NAME)); - String prefix = System.getProperty(UniqueIdTrackingListener.OUTPUT_FILE_PREFIX_PROPERTY_NAME, - UniqueIdTrackingListener.DEFAULT_OUTPUT_FILE_PREFIX); - List selectors = readAllFiles(outputDir, prefix) - .map(DiscoverySelectors::selectUniqueId) - .collect(Collectors.toList()); - if (!selectors.isEmpty()) { - System.out.printf( - "[junit-platform-native] Running in 'test listener' mode using files matching pattern [%s*] " - + "found in folder [%s] and its subfolders.%n", - prefix, outputDir.toAbsolutePath()); - return selectors; + List> discoveredTests; + if (Boolean.parseBoolean(System.getProperty("isolateTestDiscovery"))) { + List discoveredTestNames = TestsDiscoveryHelper.launchTestDiscovery(debug, classpathRoots); + discoveredTests = new ArrayList<>(); + for (String discoveredTestName : discoveredTestNames) { + try { + discoveredTests.add(Class.forName(discoveredTestName, false, access.getApplicationClassLoader())); + } catch (ClassNotFoundException e) { + throw new RuntimeException(e); + } } - } catch (Exception ex) { - debug("Failed to read UIDs from UniqueIdTrackingListener output files: " + ex.getMessage()); + } else { + TestsDiscoveryHelper helper = new TestsDiscoveryHelper(debug, classpathRoots); + discoveredTests = helper.discoverTests(); } - - System.out.println("[junit-platform-native] Running in 'test discovery' mode. Note that this is a fallback mode."); - if (debug) { - classpathRoots.forEach(entry -> debug("Selecting classpath root: " + entry)); + for (Class discoveredTest : discoveredTests) { + registerTestClassForReflection(discoveredTest); } - return DiscoverySelectors.selectClasspathRoots(new HashSet<>(classpathRoots)); - } - - /** - * Use the JUnit Platform Launcher to discover tests and register classes - * for reflection. - */ - private TestPlan discoverTestsAndRegisterTestClassesForReflection(Launcher launcher, - List selectors) { - - LauncherDiscoveryRequest request = LauncherDiscoveryRequestBuilder.request() - .selectors(selectors) - .build(); - TestPlan testPlan = launcher.discover(request); - - testPlan.getRoots().stream() - .flatMap(rootIdentifier -> testPlan.getDescendants(rootIdentifier).stream()) - .map(TestIdentifier::getSource) - .filter(Optional::isPresent) - .map(Optional::get) - .filter(ClassSource.class::isInstance) - .map(ClassSource.class::cast) - .map(ClassSource::getJavaClass) - .forEach(this::registerTestClassForReflection); - - return testPlan; + ImageSingletons.add(NativeImageJUnitLauncher.class, + new NativeImageJUnitLauncher(new TestsDiscoveryHelper(debug, classpathRoots))); } private void registerTestClassForReflection(Class clazz) { @@ -170,26 +116,11 @@ public static void debug(String format, Object... args) { } public static boolean debug() { - return ImageSingletons.lookup(JUnitPlatformFeature.class).debug; - } - - private Stream readAllFiles(Path dir, String prefix) throws IOException { - return findFiles(dir, prefix).map(outputFile -> { - try { - return Files.readAllLines(outputFile); - } catch (IOException ex) { - throw new UncheckedIOException(ex); - } - }).flatMap(List::stream); - } - - private static Stream findFiles(Path dir, String prefix) throws IOException { - if (!Files.exists(dir)) { - return Stream.empty(); + if (!ImageInfo.inImageCode()) { + return debug; + } else { + return ImageSingletons.lookup(JUnitPlatformFeature.class).debug; } - return Files.find(dir, Integer.MAX_VALUE, - (path, basicFileAttributes) -> (basicFileAttributes.isRegularFile() - && path.getFileName().toString().startsWith(prefix))); } } diff --git a/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/NativeImageJUnitLauncher.java b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/NativeImageJUnitLauncher.java index c386fa1c5..b7858f26b 100644 --- a/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/NativeImageJUnitLauncher.java +++ b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/NativeImageJUnitLauncher.java @@ -43,6 +43,8 @@ import org.graalvm.nativeimage.ImageInfo; import org.graalvm.nativeimage.ImageSingletons; +import org.graalvm.nativeimage.Platform; +import org.graalvm.nativeimage.Platforms; import org.junit.platform.launcher.Launcher; import org.junit.platform.launcher.TestExecutionListener; import org.junit.platform.launcher.TestPlan; @@ -59,11 +61,17 @@ public class NativeImageJUnitLauncher { static final String DEFAULT_OUTPUT_FOLDER = Paths.get("test-results-native").resolve("test").toString(); final Launcher launcher; - final TestPlan testPlan; + TestPlan testPlan; + final TestsDiscoveryHelper testsDiscoveryHelper; - public NativeImageJUnitLauncher(Launcher launcher, TestPlan testPlan) { - this.launcher = launcher; - this.testPlan = testPlan; + @Platforms(Platform.HOSTED_ONLY.class) + public NativeImageJUnitLauncher(TestsDiscoveryHelper testsDiscoveryHelper) { + this.testsDiscoveryHelper = testsDiscoveryHelper; + launcher = testsDiscoveryHelper.getLauncher(); + } + + private void discoverTests() { + testPlan = testsDiscoveryHelper.discoverTestPlan(); } public void registerTestExecutionListeners(TestExecutionListener testExecutionListener) { @@ -115,7 +123,8 @@ public static void main(String... args) { PrintWriter out = new PrintWriter(System.out); NativeImageJUnitLauncher launcher = ImageSingletons.lookup(NativeImageJUnitLauncher.class); - + //Discover the test plan at runtime. + launcher.discoverTests(); if (!silent) { out.println("JUnit Platform on Native Image - report"); out.println("----------------------------------------\n"); diff --git a/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/TestsDiscoveryHelper.java b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/TestsDiscoveryHelper.java new file mode 100644 index 000000000..f0a2ca5fa --- /dev/null +++ b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/TestsDiscoveryHelper.java @@ -0,0 +1,262 @@ +/* + * Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * The Universal Permissive License (UPL), Version 1.0 + * + * Subject to the condition set forth below, permission is hereby granted to any + * person obtaining a copy of this software, associated documentation and/or + * data (collectively the "Software"), free of charge and under any and all + * copyright rights in the Software, and any and all patent rights owned or + * freely licensable by each licensor hereunder covering either (i) the + * unmodified Software as contributed to or provided by such licensor, or (ii) + * the Larger Works (as defined below), to deal in both + * + * (a) the Software, and + * + * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if + * one is included with the Software each a "Larger Work" to which the Software + * is contributed by such licensors), + * + * without restriction, including without limitation the rights to copy, create + * derivative works of, display, perform, and distribute the Software and make, + * use, sell, offer for sale, import, export, have made, and have sold the + * Software and the Larger Work(s), and to sublicense the foregoing rights on + * either these or other terms. + * + * This license is subject to the following condition: + * + * The above copyright notice and either this complete permission notice or at a + * minimum a reference to the UPL must be included in all copies or substantial + * portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package org.graalvm.junit.platform; + +import org.graalvm.compiler.serviceprovider.JavaVersionUtil; +import org.junit.platform.engine.DiscoverySelector; +import org.junit.platform.engine.discovery.DiscoverySelectors; +import org.junit.platform.engine.discovery.UniqueIdSelector; +import org.junit.platform.engine.support.descriptor.ClassSource; +import org.junit.platform.launcher.Launcher; +import org.junit.platform.launcher.LauncherDiscoveryRequest; +import org.junit.platform.launcher.TestIdentifier; +import org.junit.platform.launcher.TestPlan; +import org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder; +import org.junit.platform.launcher.core.LauncherFactory; +import org.junit.platform.launcher.listeners.UniqueIdTrackingListener; + +import java.io.BufferedReader; +import java.io.File; +import java.io.FileReader; +import java.io.FileWriter; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +public class TestsDiscoveryHelper { + public static final String TESTDISCOVERY_OUTPUT = "testdiscovery.output"; + public static final String DEBUG = "debug"; + + private List selectors; + private Launcher launcher = LauncherFactory.create(); + private TestPlan testPlan; + + public static void main(String[] args) throws IOException { + if (args.length == 0) { + throw new RuntimeException("Must set classpath roots"); + } + List list = Arrays.stream(args[0].split(File.pathSeparator)).map(s -> Paths.get(s)).collect(Collectors.toList()); + TestsDiscoveryHelper testsDiscoveryHelper = new TestsDiscoveryHelper(Boolean.parseBoolean(System.getProperty(DEBUG, "false")), list); + List> ret = testsDiscoveryHelper.discoverTests(); + String outputPath = System.getProperty(TESTDISCOVERY_OUTPUT); + String output = ret.stream().map(c -> c.getName()).reduce((s1, s2) -> s1 + "\n" + s2).get(); + try (FileWriter fw = new FileWriter(new File(outputPath))) { + fw.write(output); + fw.flush(); + } catch (IOException e) { + throw e; + } + } + + public TestsDiscoveryHelper(boolean debug, List classpathRoots) { + selectors = getSelectors(debug, classpathRoots); + } + + public Launcher getLauncher() { + return launcher; + } + + public TestPlan discoverTestPlan() { + LauncherDiscoveryRequest request = LauncherDiscoveryRequestBuilder.request() + .selectors(selectors) + .build(); + testPlan = launcher.discover(request); + return testPlan; + } + + /** + * Launch another Java process to discover tests to avoid unintended class initialization for native image + * building. + * @param debug is debug turned on + * @param classpathRoots class paths + * @return a list of discovered test names + */ + public static List launchTestDiscovery(boolean debug, List classpathRoots) { + int discoverResult; + Path resultFile; + try { + resultFile = Files.createTempFile("native-image-build-tool-ret-", ""); + ProcessBuilder pb = new ProcessBuilder(); + + String javaHome = System.getProperty("java.home"); + List command = new ArrayList<>(); + command.add(javaHome + File.separator + "bin" + File.separator + "java"); + StringBuilder args = new StringBuilder(" "); + String debugPort = System.getProperty("isolateTestDiscoveryDebugPort"); + if (debugPort != null && !debugPort.equals("-1")) { + args.append("-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address="); + if (JavaVersionUtil.JAVA_SPEC >= 9) { + args.append("*:"); + } + args.append(debugPort).append(" "); + } + + // Use the same system properties as current Java process + System.getProperties().forEach((k, v) -> { + if (!k.equals("line.separator") && !k.equals("java.system.class.loader") + && !((String) k).startsWith("jdk.module")) { + args.append("-D" + k + "=\"" + v + "\"").append(" "); + } + }); + args.append("-D" + TESTDISCOVERY_OUTPUT + "=" + resultFile).append(" "); + args.append("-D" + DEBUG + "=" + debug).append(" "); + args.append("-cp").append(" "); + String cp = classpathRoots.stream().map(p -> p.toString()).collect(Collectors.joining(File.pathSeparator)); + args.append(cp).append(" "); + args.append(TestsDiscoveryHelper.class.getName()).append(" "); + args.append(cp).append(" "); + + // Run the new process in the form of "java @argfile" + Path argFile = Files.createTempFile("native-image-build-tool-args-", ""); + try (FileWriter fw = new FileWriter(argFile.toFile())) { + fw.write(args.toString()); + fw.flush(); + } catch (IOException e) { + throw e; + } + command.add("@" + argFile.toString()); + pb.command(command); + Map env = pb.environment(); + if (env == null) { + env = new HashMap<>(); + } + env.putAll(System.getenv()); + + pb.inheritIO(); + System.out.println("[junit-platform-native] Launching tests discovery in a a separated JVM."); + Process process = pb.start(); + discoverResult = process.waitFor(); + } catch (IOException | InterruptedException e) { + throw new RuntimeException(e); + } + // The discovery results are written in the file, read it. + List ret; + if (discoverResult == 0) { + try { + ret = new ArrayList<>(); + BufferedReader br = new BufferedReader(new FileReader(resultFile.toFile())); + String line; + while ((line = br.readLine()) != null) { + ret.add(line); + } + } catch (IOException e) { + throw new RuntimeException(e); + } + } else { + throw new RuntimeException("Discover test plan was failed."); + } + return ret; + } + + /** + * Use the JUnit Platform Launcher to discover tests and register classes + * for reflection. + * + * @return a List of discovered junit test classes + */ + public List> discoverTests() { + discoverTestPlan(); + return testPlan.getRoots().stream() + .flatMap(rootIdentifier -> testPlan.getDescendants(rootIdentifier).stream()) + .map(TestIdentifier::getSource) + .filter(Optional::isPresent) + .map(Optional::get) + .filter(ClassSource.class::isInstance) + .map(ClassSource.class::cast) + .map(cs -> cs.getJavaClass()).collect(Collectors.toList()); + } + + private List getSelectors(boolean debug, List classpathRoots) { + try { + Path outputDir = Paths.get(System.getProperty(UniqueIdTrackingListener.OUTPUT_DIR_PROPERTY_NAME)); + String prefix = System.getProperty(UniqueIdTrackingListener.OUTPUT_FILE_PREFIX_PROPERTY_NAME, + UniqueIdTrackingListener.DEFAULT_OUTPUT_FILE_PREFIX); + List selectors = readAllFiles(outputDir, prefix) + .map(DiscoverySelectors::selectUniqueId) + .collect(Collectors.toList()); + if (!selectors.isEmpty()) { + System.out.printf( + "[junit-platform-native] Running in 'test listener' mode using files matching pattern [%s*] " + + "found in folder [%s] and its subfolders.%n", + prefix, outputDir.toAbsolutePath()); + return selectors; + } + } catch (Exception ex) { + JUnitPlatformFeature.debug("Failed to read UIDs from UniqueIdTrackingListener output files: " + ex.getMessage()); + } + + System.out.println("[junit-platform-native] Running in 'test discovery' mode. Note that this is a fallback mode."); + if (debug) { + classpathRoots.forEach(entry -> JUnitPlatformFeature.debug("Selecting classpath root: " + entry)); + } + return DiscoverySelectors.selectClasspathRoots(new HashSet<>(classpathRoots)); + } + + private Stream readAllFiles(Path dir, String prefix) throws IOException { + return findFiles(dir, prefix).map(outputFile -> { + try { + return Files.readAllLines(outputFile); + } catch (IOException ex) { + throw new UncheckedIOException(ex); + } + }).flatMap(List::stream); + } + + private static Stream findFiles(Path dir, String prefix) throws IOException { + if (!Files.exists(dir)) { + return Stream.empty(); + } + return Files.find(dir, Integer.MAX_VALUE, + (path, basicFileAttributes) -> (basicFileAttributes.isRegularFile() + && path.getFileName().toString().startsWith(prefix))); + } +} diff --git a/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/config/platform/PlatformConfigProvider.java b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/config/platform/PlatformConfigProvider.java index d67cd5d77..a07344f1c 100644 --- a/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/config/platform/PlatformConfigProvider.java +++ b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/config/platform/PlatformConfigProvider.java @@ -58,7 +58,6 @@ public void onLoad(NativeImageConfiguration config) { "org.junit.platform.launcher.core.LauncherConfigurationParameters", "org.junit.platform.commons.logging.LoggerFactory", "org.junit.platform.engine.UniqueIdFormat", - "org.junit.platform.commons.util.ReflectionUtils", // https://github.com/graalvm/native-build-tools/issues/300 "org.junit.platform.reporting.open.xml.OpenTestReportGeneratingListener" }; diff --git a/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/config/vintage/VintageConfigProvider.java b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/config/vintage/VintageConfigProvider.java index b5a6eec98..c2cf51dbe 100644 --- a/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/config/vintage/VintageConfigProvider.java +++ b/common/junit-platform-native/src/main/java/org/graalvm/junit/platform/config/vintage/VintageConfigProvider.java @@ -53,8 +53,6 @@ public void onLoad(NativeImageConfiguration config) { "org.junit.vintage.engine.support.UniqueIdReader", "org.junit.vintage.engine.support.UniqueIdStringifier", "org.junit.runner.Description", - "org.junit.runners.BlockJUnit4ClassRunner", - "org.junit.runners.JUnit4", /* Workaround until we can register serializable classes from a native-image feature */ "org.junit.runner.Result" }; diff --git a/native-maven-plugin/src/main/java/org/graalvm/buildtools/maven/NativeTestMojo.java b/native-maven-plugin/src/main/java/org/graalvm/buildtools/maven/NativeTestMojo.java index aaf95fbe7..809eebd26 100644 --- a/native-maven-plugin/src/main/java/org/graalvm/buildtools/maven/NativeTestMojo.java +++ b/native-maven-plugin/src/main/java/org/graalvm/buildtools/maven/NativeTestMojo.java @@ -84,6 +84,12 @@ public class NativeTestMojo extends AbstractNativeImageMojo { @Parameter(property = "skipNativeTests", defaultValue = "false") private boolean skipNativeTests; + @Parameter(property = "isolateTestDiscovery", defaultValue = "true") + private boolean isolateTestDiscovery; + + @Parameter(property = "isolateTestDiscoveryDebugPort", defaultValue = "-1") + private int isolateTestDiscoveryDebugPort; + @Override protected void populateApplicationClasspath() throws MojoExecutionException { super.populateApplicationClasspath(); @@ -138,6 +144,11 @@ public void execute() throws MojoExecutionException { configureEnvironment(); buildArgs.add("--features=org.graalvm.junit.platform.JUnitPlatformFeature"); + buildArgs.add("-DisolateTestDiscovery=" + isolateTestDiscovery); + if (isolateTestDiscovery) { + buildArgs.add("-DisolateTestDiscoveryDebugPort=" + isolateTestDiscoveryDebugPort); + } + if (systemProperties == null) { systemProperties = new HashMap<>(); }