8353196: [macos] Contents of ".jpackage.xml" file are wrong when building .pkg from unsigned app image

Reviewed-by: almatvee

Author: Alexey Semenyuk

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

@@ -266,6 +266,11 @@ private void writeEntry(InputStream in, Path dstFile) throws IOException {
         Files.copy(in, dstFile);
     }
 
+    @Override
+    protected boolean withAppImageFile(Map<String, ? super Object> params) {
+        return !withPackageFile;
+    }
+
     @Override
     public void prepareApplicationFiles(Map<String, ? super Object> params)
             throws IOException {

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

@@ -173,11 +173,11 @@ protected Path prepareAppBundle(Map<String, ? super Object> params)
             FileUtils.copyRecursive(predefinedImage, appDir,
                     LinkOption.NOFOLLOW_LINKS);
 
-            // Create PackageFile if predefined app image is not signed
-            if (!StandardBundlerParam.isRuntimeInstaller(params) &&
-                    !AppImageFile.load(predefinedImage).isSigned()) {
+            // Alter app image if predefined app image is not signed
+            if (!AppImageFile.load(predefinedImage).isSigned()) {
                 new PackageFile(APP_NAME.fetchFrom(params)).save(
                         ApplicationLayout.macAppImage().resolveAt(appDir));
+                Files.deleteIfExists(AppImageFile.getPathInAppImage(appDir));
                 // We need to re-sign app image after adding ".package" to it.
                 // We only do this if app image was not signed which means it is
                 // signed with ad-hoc signature. App bundles with ad-hoc

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

@@ -66,6 +66,10 @@ public InputStream getResourceAsStream(String name) {
     public abstract void prepareApplicationFiles(
             Map<String, ? super Object> params) throws IOException;
 
+    protected boolean withAppImageFile(Map<String, ? super Object> params) {
+        return true;
+    }
+
     protected void writeCfgFile(Map<String, ? super Object> params) throws
             IOException {
         new CfgFile().initFromParams(params).create(root);
@@ -96,7 +100,9 @@ protected void copyApplication(Map<String, ? super Object> params)
                     appLayout.appDirectory().toAbsolutePath(), excludes);
         }
 
-        AppImageFile.save(root, params);
+        if (withAppImageFile(params)) {
+            AppImageFile.save(root, params);
+        }
 
         List<String> items = APP_CONTENT.fetchFrom(params);
         for (String item : items) {

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

@@ -374,7 +374,7 @@ public Path outputBundle() {
             String dirName;
             if (!TKit.isOSX()) {
                 dirName = name();
-            } else if (hasArgument("--app-image") && hasArgument("--mac-sign")) {
+            } else if (MacHelper.signPredefinedAppImage(this)) {
                 // Request to sign external app image, not to build a new one
                 dirName = getArgumentValue("--app-image");
             } else {
@@ -936,38 +936,54 @@ JPackageCommand assertAppLayout() {
         return this;
     }
 
+    private boolean expectAppImageFile() {
+        if (isRuntime()) {
+            return false;
+        }
+
+        if (TKit.isOSX()) {
+            if (MacHelper.signPredefinedAppImage(this)) {
+                // Request to sign external app image, ".jpackage.xml" file should exist.
+                return true;
+            }
+
+            if (!isImagePackageType() && hasArgument("--app-image")) {
+                // Build native macOS package from an external app image.
+                // If the external app image is signed, ".jpackage.xml" file should be kept, otherwise removed.
+                return AppImageFile.load(Path.of(getArgumentValue("--app-image"))).macSigned();
+            }
+        }
+
+        return isImagePackageType();
+    }
+
     private void assertAppImageFile() {
         Path appImageDir = Path.of("");
         if (isImagePackageType() && hasArgument("--app-image")) {
             appImageDir = Path.of(getArgumentValue("--app-image"));
         }
 
         final Path lookupPath = AppImageFile.getPathInAppImage(appImageDir);
-        if (isRuntime() || (!isImagePackageType() && !TKit.isOSX())) {
+        if (!expectAppImageFile()) {
             assertFileInAppImage(lookupPath, null);
-        } else if (!TKit.isOSX()) {
-            assertFileInAppImage(lookupPath, lookupPath);
         } else {
             assertFileInAppImage(lookupPath, lookupPath);
 
-            // If file exist validated important values based on arguments
-            // Exclude validation when we generating packages from predefined
-            // app images, since we do not know if image is signed or not.
-            if (isImagePackageType() || !hasArgument("--app-image")) {
+            if (TKit.isOSX()) {
                 final Path rootDir = isImagePackageType() ? outputBundle() :
                         pathToUnpackedPackageFile(appInstallationDirectory());
 
                 AppImageFile aif = AppImageFile.load(rootDir);
 
-                boolean expectedValue = hasArgument("--mac-sign");
+                boolean expectedValue = MacHelper.appImageSigned(this);
                 boolean actualValue = aif.macSigned();
-                TKit.assertEquals(Boolean.toString(expectedValue), Boolean.toString(actualValue),
-                    "Check for unexptected value in app image file for <signed>");
+                TKit.assertEquals(expectedValue, actualValue,
+                    "Check for unexpected value of <signed> property in app image file");
 
                 expectedValue = hasArgument("--mac-app-store");
                 actualValue = aif.macAppStore();
-                TKit.assertEquals(Boolean.toString(expectedValue), Boolean.toString(actualValue),
-                    "Check for unexptected value in app image file for <app-store>");
+                TKit.assertEquals(expectedValue, actualValue,
+                    "Check for unexpected value of <app-store> property in app image file");
             }
         }
     }
@@ -1037,11 +1053,17 @@ JPackageCommand setUnpackedPackageLocation(Path path) {
     }
 
     JPackageCommand winMsiLogFile(Path v) {
+        if (!TKit.isWindows()) {
+            throw new UnsupportedOperationException();
+        }
         this.winMsiLogFile = v;
         return this;
     }
 
     public Optional<Path> winMsiLogFile() {
+        if (!TKit.isWindows()) {
+            throw new UnsupportedOperationException();
+        }
         return Optional.ofNullable(winMsiLogFile);
     }
 

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

@@ -33,6 +33,7 @@
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
 import java.util.regex.Pattern;
@@ -149,6 +150,32 @@ public static PListWrapper readPList(Stream<String> lines) {
                 .collect(Collectors.joining()))).get();
     }
 
+    public static boolean signPredefinedAppImage(JPackageCommand cmd) {
+        Objects.requireNonNull(cmd);
+        if (!TKit.isOSX()) {
+            throw new UnsupportedOperationException();
+        }
+        return cmd.hasArgument("--mac-sign") && cmd.hasArgument("--app-image");
+    }
+
+    public static boolean appImageSigned(JPackageCommand cmd) {
+        Objects.requireNonNull(cmd);
+        if (!TKit.isOSX()) {
+            throw new UnsupportedOperationException();
+        }
+
+        if (Optional.ofNullable(cmd.getArgumentValue("--app-image")).map(Path::of).map(AppImageFile::load).map(AppImageFile::macSigned).orElse(false)) {
+            // The external app image is signed, so the app image is signed too.
+            return true;
+        }
+
+        if (!cmd.hasArgument("--mac-sign")) {
+            return false;
+        }
+
+        return (cmd.hasArgument("--mac-signing-key-user-name") || cmd.hasArgument("--mac-app-image-sign-identity"));
+    }
+
     static PackageHandlers createDmgPackageHandlers() {
         return new PackageHandlers(MacHelper::installDmg, MacHelper::uninstallDmg, MacHelper::unpackDmg);
     }