test/jdk/tools/jpackage/helpers/jdk/jpackage/test/MacHelper.java
author herrick
Wed, 16 Oct 2019 10:32:08 -0400
branchJDK-8200758-branch
changeset 58648 3bf53ffa9ae7
parent 58416 f09bf58c1f17
child 58888 d802578912f3
permissions -rw-r--r--
8232279 : Improve test helpers #2 Submitted-by: asemenyuk Reviewed-by: aherrick, almatvee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
     1
/*
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
     2
 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
     4
 *
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
     7
 * published by the Free Software Foundation.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
     8
 *
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    13
 * accompanied this code).
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    14
 *
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    18
 *
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    21
 * questions.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    22
 */
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    23
package jdk.jpackage.test;
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    24
58648
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    25
import java.io.ByteArrayInputStream;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    26
import java.io.IOException;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    27
import java.nio.charset.StandardCharsets;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    28
import java.nio.file.Files;
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    29
import java.nio.file.Path;
58648
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    30
import java.util.List;
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58115
diff changeset
    31
import java.util.Set;
58648
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    32
import java.util.stream.Collectors;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    33
import java.util.stream.Stream;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    34
import javax.xml.parsers.DocumentBuilder;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    35
import javax.xml.parsers.DocumentBuilderFactory;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    36
import javax.xml.parsers.ParserConfigurationException;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    37
import javax.xml.xpath.XPath;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    38
import javax.xml.xpath.XPathConstants;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    39
import javax.xml.xpath.XPathFactory;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    40
import jdk.jpackage.test.Functional.ThrowingConsumer;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    41
import jdk.jpackage.test.Functional.ThrowingSupplier;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    42
import org.xml.sax.SAXException;
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    43
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    44
public class MacHelper {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    45
58648
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    46
    public static void withExplodedDmg(JPackageCommand cmd,
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    47
            ThrowingConsumer<Path> consumer) {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    48
        cmd.verifyIsOfType(PackageType.MAC_DMG);
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    49
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    50
        var plist = readPList(new Executor()
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    51
                .setExecutable("/usr/bin/hdiutil")
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    52
                .dumpOutput()
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    53
                .addArguments("attach", cmd.outputBundle().toString(), "-plist")
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    54
                .executeAndGetOutput());
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    55
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    56
        final Path mountPoint = Path.of(plist.queryValue("mount-point"));
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    57
        try {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    58
            Path dmgImage = mountPoint.resolve(cmd.name() + ".app");
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    59
            TKit.trace(String.format("Exploded [%s] in [%s] directory",
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    60
                    cmd.outputBundle(), dmgImage));
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    61
            ThrowingConsumer.toConsumer(consumer).accept(dmgImage);
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    62
        } finally {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    63
            new Executor()
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    64
                    .setExecutable("/usr/bin/hdiutil")
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    65
                    .addArgument("detach").addArgument(mountPoint)
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    66
                    .execute().assertExitCodeIsZero();
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    67
        }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    68
    }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    69
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    70
    public static PListWrapper readPListFromAppImage(Path appImage) {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    71
        return readPList(appImage.resolve("Contents/Info.plist"));
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    72
    }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    73
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    74
    public static PListWrapper readPList(Path path) {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    75
        TKit.assertReadableFileExists(path);
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    76
        return ThrowingSupplier.toSupplier(() -> readPList(Files.readAllLines(
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    77
                path))).get();
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    78
    }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    79
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    80
    public static PListWrapper readPList(List<String> lines) {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    81
        return readPList(lines.stream());
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    82
    }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    83
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    84
    public static PListWrapper readPList(Stream<String> lines) {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    85
        return ThrowingSupplier.toSupplier(() -> new PListWrapper(lines.collect(
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    86
                Collectors.joining()))).get();
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    87
    }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
    88
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    89
    static String getBundleName(JPackageCommand cmd) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    90
        cmd.verifyIsOfType(PackageType.MAC);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    91
        return String.format("%s-%s%s", getPackageName(cmd), cmd.version(),
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    92
                cmd.packageType().getSuffix());
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    93
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    94
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    95
    static Path getInstallationDirectory(JPackageCommand cmd) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    96
        cmd.verifyIsOfType(PackageType.MAC);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    97
        String installDir = Path.of(cmd.getArgumentValue("--install-dir",
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    98
                () -> ""), cmd.name()).toString() + ".app";
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
    99
        return Path.of("/Applications", installDir);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
   100
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
   101
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
   102
    private static String getPackageName(JPackageCommand cmd) {
58115
4a27283b542d /home/aherrick/comment
herrick
parents: 58113
diff changeset
   103
        return cmd.getArgumentValue("--mac-package-name",
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58115
diff changeset
   104
                () -> cmd.name());
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
   105
    }
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58115
diff changeset
   106
58648
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   107
    public static final class PListWrapper {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   108
        public String queryValue(String keyName) {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   109
            XPath xPath = XPathFactory.newInstance().newXPath();
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   110
            // Query for the value of <string> element preceding <key> element
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   111
            // with value equal to `keyName`
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   112
            String query = String.format(
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   113
                    "//string[preceding-sibling::key = \"%s\"][1]", keyName);
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   114
            return ThrowingSupplier.toSupplier(() -> (String) xPath.evaluate(
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   115
                    query, doc, XPathConstants.STRING)).get();
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   116
        }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   117
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   118
        PListWrapper(String xml) throws ParserConfigurationException,
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   119
                SAXException, IOException {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   120
            doc = createDocumentBuilder().parse(new ByteArrayInputStream(
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   121
                    xml.getBytes(StandardCharsets.UTF_8)));
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   122
        }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   123
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   124
        private static DocumentBuilder createDocumentBuilder() throws
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   125
                ParserConfigurationException {
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   126
            DocumentBuilderFactory dbf = DocumentBuilderFactory.newDefaultInstance();
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   127
            dbf.setFeature(
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   128
                    "http://apache.org/xml/features/nonvalidating/load-external-dtd",
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   129
                    false);
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   130
            return dbf.newDocumentBuilder();
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   131
        }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   132
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   133
        private final org.w3c.dom.Document doc;
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   134
    }
3bf53ffa9ae7 8232279 : Improve test helpers #2
herrick
parents: 58416
diff changeset
   135
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58115
diff changeset
   136
    static final Set<Path> CRITICAL_RUNTIME_FILES = Set.of(Path.of(
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58115
diff changeset
   137
            "Contents/Home/lib/server/libjvm.dylib"));
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58115
diff changeset
   138
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents:
diff changeset
   139
}