Updates to sapmachine jlink plugin

RealCLanger · RealCLanger · commit a75478b23042 · 2025-01-10T17:03:55.000+01:00
diff --git a/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/plugins/AddSapMachineTools.java b/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/plugins/AddSapMachineTools.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2025, SAP SE. All rights reserved.
+ * Copyright (c) 2025 SAP SE. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -25,27 +25,21 @@
 
 package jdk.tools.jlink.internal.plugins;
 
+import java.io.IOException;
 import java.io.UncheckedIOException;
-import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.StandardCopyOption;
 import java.util.List;
-import java.util.Locale.Category;
-import java.util.Map;
-import java.util.function.Function;
-import java.io.IOException;
 
 import jdk.tools.jlink.internal.ExecutableImage;
-import jdk.tools.jlink.internal.PostProcessor;
 import jdk.tools.jlink.internal.Platform;
+import jdk.tools.jlink.internal.PostProcessor;
 import jdk.tools.jlink.plugin.PluginException;
 import jdk.tools.jlink.plugin.ResourcePool;
 import jdk.tools.jlink.plugin.ResourcePoolBuilder;
-import jdk.tools.jlink.plugin.ResourcePoolEntry;
 
 /**
- * Adds tools that are SapMachine specific tools
+ * Adds tools that are SapMachine specific
  */
 public class AddSapMachineTools extends AbstractPlugin implements PostProcessor {
 
@@ -68,9 +62,15 @@ public boolean hasRawArgument() {
         return false;
     }
 
-    private final String tools = "lib/" + System.mapLibraryName("asyncProfiler") + " bin/asprof lib/async-profiler.jar lib/converter.jar legal/async/CHANGELOG.md legal/async/LICENSE legal/async/README.md";
-
-    private Path javaHomeFolder;
+    private final String[] tools = {
+            "bin/asprof",
+            "lib/" + System.mapLibraryName("asyncProfiler"),
+            "lib/async-profiler.jar",
+            "lib/converter.jar",
+            "legal/async/CHANGELOG.md",
+            "legal/async/LICENSE",
+            "legal/async/README.md"
+    };
 
     @Override
     public List<String> process(ExecutableImage image) {
@@ -86,26 +86,24 @@ public List<String> process(ExecutableImage image) {
         var sourceJavaHome = Path.of(System.getProperty("java.home"));
         var targetJavaHome = image.getHome();
 
-        for (String tool : tools.split(" ")) {
+        for (String tool : tools) {
             var path = sourceJavaHome.resolve(tool);
             var target = targetJavaHome.resolve(tool);
             if (Files.exists(path)) {
                 try {
                     Files.createDirectories(target.getParent());
-                    Files.createFile(target);
-                    Files.copy(path, target, StandardCopyOption.REPLACE_EXISTING);
+                    Files.copy(path, target);
                 } catch (IOException e) {
                     throw new UncheckedIOException(e);
                 }
             }
         }
 
-        return List.of();
+        return null;
     }
 
     @Override
     public ResourcePool transform(ResourcePool in, ResourcePoolBuilder out) {
         return in;
     }
-
 }
diff --git a/src/jdk.jlink/share/classes/jdk/tools/jlink/resources/plugins.properties b/src/jdk.jlink/share/classes/jdk/tools/jlink/resources/plugins.properties
@@ -287,6 +287,7 @@ Invalid language tag: %s
 include-locales.localedatanotfound=\
 jdk.localedata module was not specified with --add-modules option
 
+# SapMachine 2025-09-01: SapMachine tools plugin
 add-sapmachine-tools.description=\
 Add SapMachine specific tools to the image.
 
diff --git a/src/jdk.jlink/share/classes/jdk/tools/jlink/resources/plugins_de.properties b/src/jdk.jlink/share/classes/jdk/tools/jlink/resources/plugins_de.properties
@@ -158,6 +158,11 @@ include-locales.invalidtag=Ungültiges Sprachtag: %s
 
 include-locales.localedatanotfound=Modul jdk.localedata wurde mit der Option --add-modules nicht angegeben
 
+# SapMachine 2025-09-01: SapMachine tools plugin
+add-sapmachine-tools.description=Fügt SapMachine-spezifische Tools zum Image hinzu.
+
+add-sapmachine-tools.usage=\  --add-sapmachine-tools   Fügt SapMachine-spezifische Tools zum Image hinzu.
+
 main.status.ok=Funktional.
 
 main.status.not.ok= Nicht funktional.
diff --git a/src/jdk.jlink/share/classes/module-info.java b/src/jdk.jlink/share/classes/module-info.java
@@ -84,6 +84,7 @@
         jdk.tools.jlink.internal.plugins.VendorVMBugURLPlugin,
         jdk.tools.jlink.internal.plugins.VendorVersionPlugin,
         jdk.tools.jlink.internal.plugins.CDSPlugin,
+        // SapMachine 2025-01-09: SapMachine tools plugin
         jdk.tools.jlink.internal.plugins.AddSapMachineTools,
         jdk.tools.jlink.internal.plugins.SaveJlinkArgfilesPlugin;
 }
diff --git a/test/jdk/tools/jlink/plugins/AddSapMachineToolsTest.java b/test/jdk/tools/jlink/plugins/AddSapMachineToolsTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2025, SAP SE. All rights reserved.
+ * Copyright (c) 2025 SAP SE. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -21,62 +21,68 @@
  * questions.
  */
 
-import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Path;
 
-import jdk.test.lib.JDKToolFinder;
 import jdk.test.lib.Platform;
-import jdk.test.lib.process.*;
-import jdk.test.whitebox.WhiteBox;
-
-import tests.Helper;
 
 import jtreg.SkippedException;
 
+import static org.testng.Assert.assertFalse;
+import static org.testng.Assert.assertTrue;
+
+import tests.Helper;
+
 /* @test
- * @bug 8264322
  * @summary Test the --add-sapmachine-tools plugin
- * @requires os.family == "linux" | os.family == "mac"
  * @library ../../lib
  * @library /test/lib
  * @modules java.base/jdk.internal.jimage
- *          jdk.jlink/jdk.tools.jlink.internal
- *          jdk.jlink/jdk.tools.jmod
  *          jdk.jlink/jdk.tools.jimage
- *          jdk.compiler
- * @build tests.*
- * @build jdk.test.whitebox.WhiteBox
- * @run driver jdk.test.lib.helpers.ClassFileInstaller jdk.test.whitebox.WhiteBox
- * @run main/othervm -XX:+UnlockDiagnosticVMOptions -XX:+WhiteBoxAPI -Xbootclasspath/a:. CDSPluginTest
+ * @run testng AddSapMachineToolsTest
  */
 
 public class AddSapMachineToolsTest {
+
+    private static final String[] tools = {
+            "bin/asprof",
+            "lib/" + System.mapLibraryName("asyncProfiler"),
+            "lib/async-profiler.jar",
+            "lib/converter.jar",
+            "legal/async/CHANGELOG.md",
+            "legal/async/LICENSE",
+            "legal/async/README.md"
+    };
+
     public static void main(String[] args) throws Throwable {
+        boolean shouldHaveAsync = Platform.isOSX() ||
+                (Platform.isLinux() && (Platform.isAArch64() || Platform.isPPC() || Platform.isX64()) && !Platform.isMusl());
 
-        Helper helper = Helper.newHelper();
-        if (helper == null) {
-            System.err.println("Test not run");
+        Path sourceJavaHome = Path.of(System.getProperty("java.home"));
+
+        if (!shouldHaveAsync) {
+            for (String tool : tools) {
+                assertFalse(Files.exists(sourceJavaHome.resolve(tool)), tool + " should not exist.");
+            }
+            System.err.println("No SapMachine tools files found, as expected");
             return;
         }
 
-        var sourceJavaHome = Path.of(System.getProperty("java.home"));
+        Helper helper = Helper.newHelper();
+        if (helper == null) {
+            throw new SkippedException("JDK image is not suitable for this test.");
+        }
 
-        if (!Files.exists(sourceJavaHome.resolve("lib/async-profiler.jar"))) {
-            System.err.println("Test not run, async-profiler not configured");
-            return;
+        for (String tool : tools) {
+            assertTrue(Files.exists(sourceJavaHome.resolve(tool)), tool + " must exist.");
         }
 
         var module = "sapmachine.tools";
         helper.generateDefaultJModule(module);
-        var image = helper.generateDefaultImage(new String[] { "--add-sapmachine-tools" },
-                                                module)
-            .assertSuccess();
-
-        String subDir = "lib/server/";
+        var image = helper
+                .generateDefaultImage(new String[] { "--add-sapmachine-tools" }, module)
+                .assertSuccess();
 
-        helper.checkImage(image, module, null, null,
-                      new String[] { "lib/async-profiler.jar", "lib/converter.jar",
-                                     "lib/" + System.mapLibraryName("asyncProfiler")});
+        helper.checkImage(image, module, null, null, tools);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,7 @@`
`84`	`84`	`jdk.tools.jlink.internal.plugins.VendorVMBugURLPlugin,`
`85`	`85`	`jdk.tools.jlink.internal.plugins.VendorVersionPlugin,`
`86`	`86`	`jdk.tools.jlink.internal.plugins.CDSPlugin,`
	`87`	`+ // SapMachine 2025-01-09: SapMachine tools plugin`
`87`	`88`	`jdk.tools.jlink.internal.plugins.AddSapMachineTools,`
`88`	`89`	`jdk.tools.jlink.internal.plugins.SaveJlinkArgfilesPlugin;`
`89`	`90`	`}`