8363980: [macos] Add JDK specific keys/values to Info.plist of embedded runtime

Reviewed-by: asemenyuk

Author: Alexander Matveev

src/jdk.jpackage/macosx/classes/jdk/jpackage/internal/MacPackagingPipeline.java

@@ -364,25 +364,40 @@ private static void writeRuntimeInfoPlist(
 
         final var app = env.app();
 
+        // If the embedded runtime contains executable(s) in the "bin"
+        // subdirectory, we should use the standalone runtime info plist
+        // template. Otherwise, the user may be unable to run the "java"
+        // or other executables in the "bin" subdirectory of the embedded
+        // runtime.
+        final var useRuntimeInfoPlist = app.isRuntime() ||
+                app.runtimeBuilder().orElseThrow().withNativeCommands() ||
+                Files.isDirectory(env.resolvedLayout().runtimeDirectory().resolve("bin"));
+
         Map<String, String> data = new HashMap<>();
         data.put("CF_BUNDLE_IDENTIFIER", app.bundleIdentifier());
         data.put("CF_BUNDLE_NAME", app.bundleName());
         data.put("CF_BUNDLE_VERSION", app.version());
         data.put("CF_BUNDLE_SHORT_VERSION_STRING", app.shortVersion().toString());
-        if (app.isRuntime()) {
+        if (useRuntimeInfoPlist) {
             data.put("CF_BUNDLE_VENDOR", app.vendor());
         }
 
         final String template;
         final String publicName;
         final String category;
 
-        if (app.isRuntime()) {
+        if (useRuntimeInfoPlist) {
             template = "Runtime-Info.plist.template";
+        } else {
+            template = "ApplicationRuntime-Info.plist.template";
+        }
+
+        // Public name and category should be based on standalone runtime vs
+        // embedded runtime.
+        if (app.isRuntime()) {
             publicName = "Info.plist";
             category = "resource.runtime-info-plist";
         } else {
-            template = "ApplicationRuntime-Info.plist.template";
             publicName = "Runtime-Info.plist";
             category = "resource.app-runtime-info-plist";
         }

src/jdk.jpackage/share/classes/jdk/jpackage/internal/JLinkRuntimeBuilder.java

@@ -83,6 +83,11 @@ public void create(AppImageLayout appImageLayout) throws PackagerException {
         }
     }
 
+    @Override
+    public boolean withNativeCommands() {
+        return !jlinkCmdLine.contains("--strip-native-commands");
+    }
+
     static ModuleFinder createModuleFinder(Collection<Path> modulePath) {
         return ModuleFinder.compose(
                 ModulePath.of(JarFile.runtimeVersion(), true,

src/jdk.jpackage/share/classes/jdk/jpackage/internal/model/RuntimeBuilder.java

@@ -46,6 +46,16 @@ public interface RuntimeBuilder {
      */
     void create(AppImageLayout appImageLayout) throws PackagerException;
 
+    /**
+     * Returns {@code true} if "--strip-native-commands" was not used with jlink.
+     * Default implementation returns {@code false}.
+     *
+     * @return {@code true} if "--strip-native-commands" was not used with jlink
+     */
+    default boolean withNativeCommands() {
+        return false;
+    }
+
     /**
      * Gets the default set of paths where jlink should look up for system Java
      * modules.

test/jdk/tools/jpackage/helpers/jdk/jpackage/test/JPackageCommand.java

@@ -306,24 +306,16 @@ public JPackageCommand setFakeRuntime() {
             TKit.trace(String.format("Init fake runtime in [%s] directory",
                     fakeRuntimeDir));
 
-            Files.createDirectories(fakeRuntimeDir);
-
-            if (TKit.isLinux()) {
-                // Need to make the code in rpm spec happy as it assumes there is
-                // always something in application image.
-                fakeRuntimeDir.resolve("bin").toFile().mkdir();
-            }
-
             if (TKit.isOSX()) {
                 // Make MacAppImageBuilder happy
                 createBulkFile.accept(fakeRuntimeDir.resolve(Path.of(
                         "lib/jli/libjli.dylib")));
             }
 
-            // Mak sure fake runtime takes some disk space.
+            // Make sure fake runtime takes some disk space.
             // Package bundles with 0KB size are unexpected and considered
             // an error by PackageTest.
-            createBulkFile.accept(fakeRuntimeDir.resolve(Path.of("bin", "bulk")));
+            createBulkFile.accept(fakeRuntimeDir.resolve(Path.of("lib", "bulk")));
 
             cmd.setArgumentValue("--runtime-image", fakeRuntimeDir);
         });
@@ -1227,6 +1219,24 @@ public static enum StandardAssert {
                 MacHelper.verifyUnsignedBundleSignature(cmd);
             }
         }),
+        MAC_RUNTIME_PLIST_JDK_KEY(cmd -> {
+            if (TKit.isOSX()) {
+                var appLayout = cmd.appLayout();
+                var plistPath = appLayout.runtimeDirectory().resolve("Contents/Info.plist");
+                var keyName = "JavaVM";
+                var keyValue = MacHelper.readPList(plistPath).findDictValue(keyName);
+                if (cmd.isRuntime() || Files.isDirectory(appLayout.runtimeHomeDirectory().resolve("bin"))) {
+                    // There are native launchers in the runtime
+                    TKit.assertTrue(keyValue.isPresent(), String.format(
+                            "Check the runtime plist file [%s] contains '%s' key",
+                            plistPath, keyName));
+                } else {
+                    TKit.assertTrue(keyValue.isEmpty(), String.format(
+                            "Check the runtime plist file [%s] contains NO '%s' key",
+                            plistPath, keyName));
+                }
+            }
+        }),
         PREDEFINED_APP_IMAGE_COPY(cmd -> {
             Optional.ofNullable(cmd.getArgumentValue("--app-image")).filter(_ -> {
                 return !TKit.isOSX() || !MacHelper.signPredefinedAppImage(cmd);

test/jdk/tools/jpackage/macosx/CustomInfoPListTest.java

@@ -25,6 +25,7 @@
 import static java.util.Map.entry;
 import jdk.jpackage.internal.util.Slot;
 import static jdk.jpackage.internal.util.PListWriter.writeDict;
+import static jdk.jpackage.internal.util.PListWriter.writeKey;
 import static jdk.jpackage.internal.util.PListWriter.writePList;
 import static jdk.jpackage.internal.util.PListWriter.writeString;
 import static jdk.jpackage.internal.util.XmlUtils.createXml;
@@ -431,6 +432,10 @@ void writeRuntimePlist(JPackageCommand cmd, XMLStreamWriter xml) throws XMLStrea
                     writeString(xml, "CFBundleShortVersionString", value("CF_BUNDLE_SHORT_VERSION_STRING", cmd.version()));
                     writeString(xml, "CFBundleVersion", value("CF_BUNDLE_VERSION", cmd.version()));
                     writeString(xml, "CustomInfoPListFA", "DEPLOY_FILE_ASSOCIATIONS");
+                    writeKey(xml, "JavaVM");
+                    writeDict(xml, toXmlConsumer(() -> {
+                        writeString(xml, "JVMVersion", value("CF_BUNDLE_VERSION", cmd.version()));
+                    }));
                 }));
             }));
         }

test/jdk/tools/jpackage/share/AppImagePackageTest.java

@@ -120,7 +120,8 @@ public static void testEmpty(boolean withIcon) throws IOException {
                     StandardAssert.MAIN_JAR_FILE,
                     StandardAssert.MAIN_LAUNCHER_FILES,
                     StandardAssert.MAC_BUNDLE_STRUCTURE,
-                    StandardAssert.RUNTIME_DIRECTORY);
+                    StandardAssert.RUNTIME_DIRECTORY,
+                    StandardAssert.MAC_RUNTIME_PLIST_JDK_KEY);
         })
         .run(Action.CREATE_AND_UNPACK);
     }

test/jdk/tools/jpackage/share/CookedRuntimeTest.java

@@ -51,10 +51,11 @@
 public final class CookedRuntimeTest {
 
     public CookedRuntimeTest(String javaAppDesc, String jlinkOutputSubdir,
-            String runtimeSubdir) {
+            String runtimeSubdir, boolean withNativeCommands) {
         this.javaAppDesc = javaAppDesc;
         this.jlinkOutputSubdir = Path.of(jlinkOutputSubdir);
         this.runtimeSubdir = Path.of(runtimeSubdir);
+        this.withNativeCommands = withNativeCommands;
     }
 
     @Test
@@ -90,6 +91,10 @@ public void test() throws IOException {
                 "--no-header-files",
                 "--no-man-pages");
 
+        if (!withNativeCommands) {
+            jlink.addArgument("--strip-native-commands");
+        }
+
         if (moduleName != null) {
             jlink.addArguments("--add-modules", moduleName, "--module-path",
                     Path.of(cmd.getArgumentValue("--module-path")).resolve(
@@ -127,7 +132,14 @@ public static Collection<?> data() {
         List<Object[]> data = new ArrayList<>();
         for (var javaAppDesc : javaAppDescs) {
             for (var pathCfg : paths) {
-                data.add(new Object[] { javaAppDesc, pathCfg[0], pathCfg[1] });
+                if (TKit.isOSX()) {
+                    // On OSX platform we need to test both runtime root and runtime home
+                    // directories with and without "bin" folder.
+                    data.add(new Object[] { javaAppDesc, pathCfg[0], pathCfg[1], true });
+                    data.add(new Object[] { javaAppDesc, pathCfg[0], pathCfg[1], false });
+                } else {
+                    data.add(new Object[] { javaAppDesc, pathCfg[0], pathCfg[1], true });
+                }
             }
         }
 
@@ -137,4 +149,5 @@ public static Collection<?> data() {
     private final String javaAppDesc;
     private final Path jlinkOutputSubdir;
     private final Path runtimeSubdir;
+    private final boolean withNativeCommands;
 }

test/jdk/tools/jpackage/share/PostImageScriptTest.java

@@ -140,24 +140,24 @@ PackageTest initTest(PackageTest test) {
                         runtimeDir = Path.of("");
                     }
 
-                    final Path runtimeBinDir = runtimeDir.resolve("bin");
+                    final Path runtimeLibDir = runtimeDir.resolve("lib");
 
                     if (TKit.isWindows()) {
                         final List<String> script = new ArrayList<>();
                         script.addAll(WinGlobals.JS_SHELL.expr());
                         script.addAll(WinGlobals.JS_FS.expr());
                         script.addAll(List.of(
                                 "WScript.Echo('PWD: ' + fs.GetFolder(shell.CurrentDirectory).Path)",
-                                String.format("WScript.Echo('Probe directory: %s')", runtimeBinDir),
-                                String.format("fs.GetFolder('%s')", runtimeBinDir.toString().replace('\\', '/'))
+                                String.format("WScript.Echo('Probe directory: %s')", runtimeLibDir),
+                                String.format("fs.GetFolder('%s')", runtimeLibDir.toString().replace('\\', '/'))
                         ));
                         JPackageUserScript.POST_IMAGE.create(cmd, script);
                     } else {
                         JPackageUserScript.POST_IMAGE.create(cmd, List.of(
                                 "set -e",
                                 "printf 'PWD: %s\\n' \"$PWD\"",
-                                String.format("printf 'Probe directory: %%s\\n' '%s'", runtimeBinDir),
-                                String.format("[ -d '%s' ]", runtimeBinDir)
+                                String.format("printf 'Probe directory: %%s\\n' '%s'", runtimeLibDir),
+                                String.format("[ -d '%s' ]", runtimeLibDir)
                         ));
                     }
                 });