Move MacHelper.PListWrapper to utils.PListReader

Author: alexeysemenyukoracle

src/jdk.jpackage/share/classes/jdk/jpackage/internal/util/PListReader.java

@@ -0,0 +1,100 @@
+/*
+ * Copyright (c) 2025, Oracle and/or its affiliates. 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package jdk.jpackage.internal.util;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.Objects;
+import java.util.Optional;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathFactory;
+import jdk.jpackage.internal.util.function.ThrowingSupplier;
+import org.w3c.dom.Node;
+import org.xml.sax.SAXException;
+
+public final class PListReader {
+
+    public String queryValue(String keyName) {
+        final var node = getNode(keyName);
+        switch (node.getNodeName()) {
+            case "string" -> {
+                return node.getTextContent();
+            }
+            default -> {
+                throw new NoSuchElementException();
+            }
+        }
+    }
+
+    public boolean queryBoolValue(String keyName) {
+        final var node = getNode(keyName);
+        switch (node.getNodeName()) {
+            case "true" -> {
+                return true;
+            }
+            case "false" -> {
+                return false;
+            }
+            default -> {
+                throw new NoSuchElementException();
+            }
+        }
+    }
+
+    public List<String> queryArrayValue(String keyName) {
+        final var node = getNode(keyName);
+        switch (node.getNodeName()) {
+            case "array" -> {
+                return XmlUtils.toStream(node.getChildNodes()).filter(n -> {
+                    return n.getNodeName().equals("string");
+                }).map(Node::getTextContent).toList();
+            }
+            default -> {
+                throw new NoSuchElementException();
+            }
+        }
+    }
+
+    public PListReader(Node doc) {
+        this.root = Objects.requireNonNull(doc);
+    }
+
+    public PListReader(byte[] xmlData) throws ParserConfigurationException, SAXException, IOException {
+        this(XmlUtils.initDocumentBuilder().parse(new ByteArrayInputStream(xmlData)));
+    }
+
+    private Node getNode(String keyName) {
+        final var xPath = XPathFactory.newInstance().newXPath();
+        final var query = String.format("//*[preceding-sibling::key = \"%s\"][1]", keyName);
+        return Optional.ofNullable(ThrowingSupplier.toSupplier(() -> {
+            return (Node) xPath.evaluate(query, root, XPathConstants.NODE);
+        }).get()).orElseThrow(NoSuchElementException::new);
+    }
+
+    private final Node root;
+}

src/jdk.jpackage/share/classes/jdk/jpackage/internal/util/XmlUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2024, 2025, Oracle and/or its affiliates. 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
@@ -30,6 +30,10 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Collection;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+import java.util.stream.Stream;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
@@ -41,10 +45,26 @@
 import javax.xml.transform.TransformerException;
 import javax.xml.transform.TransformerFactory;
 import javax.xml.transform.stax.StAXResult;
+import javax.xml.xpath.XPath;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathExpressionException;
+import org.w3c.dom.Element;
+import org.w3c.dom.NamedNodeMap;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
 
 
 public final class XmlUtils {
 
+    @FunctionalInterface
+    public interface XmlConsumerNoArg {
+        void accept() throws IOException, XMLStreamException;
+    }
+
+    public static XmlConsumer toXmlConsumer(XmlConsumerNoArg xmlConsumer) {
+        return xml -> xmlConsumer.accept();
+    }
+
     public static void createXml(Path dstFile, XmlConsumer xmlConsumer) throws
             IOException {
         XMLOutputFactory xmlFactory = XMLOutputFactory.newInstance();
@@ -101,4 +121,29 @@ public static DocumentBuilderFactory initDocumentBuilderFactory() {
         }
         return dbf;
     }
+
+    public static Stream<Node> queryNodes(Node xml, XPath xPath, String xpathExpr) throws XPathExpressionException {
+        return toStream((NodeList) xPath.evaluate(xpathExpr, xml, XPathConstants.NODESET));
+    }
+
+    public static Stream<Node> toStream(NodeList nodes) {
+        return Optional.ofNullable(nodes).map(v -> {
+            return IntStream.range(0, v.getLength()).mapToObj(v::item);
+        }).orElseGet(Stream::of);
+    }
+
+    public static Stream<Node> toStream(NamedNodeMap nodes) {
+        return Optional.ofNullable(nodes).map(v -> {
+            return IntStream.range(0, v.getLength()).mapToObj(v::item);
+        }).orElseGet(Stream::of);
+    }
+
+    public static String elementValue(Element e, XPath xPath) {
+        try {
+            return queryNodes(e, xPath, "text()").map(Node::getNodeValue).collect(Collectors.joining());
+        } catch (XPathExpressionException ex) {
+            // Should never happen
+            throw new RuntimeException(ex);
+        }
+    }
 }

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

@@ -31,27 +31,22 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 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;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
-import javax.xml.parsers.ParserConfigurationException;
-import javax.xml.xpath.XPath;
 import javax.xml.xpath.XPathConstants;
 import javax.xml.xpath.XPathFactory;
 import jdk.jpackage.internal.RetryExecutor;
+import jdk.jpackage.internal.util.PListReader;
 import jdk.jpackage.internal.util.PathUtils;
+import jdk.jpackage.internal.util.XmlUtils;
 import jdk.jpackage.internal.util.function.ThrowingConsumer;
 import jdk.jpackage.internal.util.function.ThrowingSupplier;
 import jdk.jpackage.test.PackageTest.PackageHandlers;
-import org.w3c.dom.NodeList;
-import org.xml.sax.SAXException;
 
 public final class MacHelper {
 
@@ -129,25 +124,25 @@ public static void withExplodedDmg(JPackageCommand cmd,
         }
     }
 
-    public static PListWrapper readPListFromAppImage(Path appImage) {
+    public static PListReader readPListFromAppImage(Path appImage) {
         return readPList(appImage.resolve("Contents/Info.plist"));
     }
 
-    public static PListWrapper readPList(Path path) {
+    public static PListReader readPList(Path path) {
         TKit.assertReadableFileExists(path);
         return ThrowingSupplier.toSupplier(() -> readPList(Files.readAllLines(
                 path))).get();
     }
 
-    public static PListWrapper readPList(List<String> lines) {
+    public static PListReader readPList(List<String> lines) {
         return readPList(lines.stream());
     }
 
-    public static PListWrapper readPList(Stream<String> lines) {
-        return ThrowingSupplier.toSupplier(() -> new PListWrapper(lines
+    public static PListReader readPList(Stream<String> lines) {
+        return ThrowingSupplier.toSupplier(() -> new PListReader(lines
                 // Skip leading lines before xml declaration
                 .dropWhile(Pattern.compile("\\s?<\\?xml\\b.+\\?>").asPredicate().negate())
-                .collect(Collectors.joining()))).get();
+                .collect(Collectors.joining()).getBytes(StandardCharsets.UTF_8))).get();
     }
 
     public static boolean signPredefinedAppImage(JPackageCommand cmd) {
@@ -261,7 +256,7 @@ private static Path unpackPkg(JPackageCommand cmd, Path destinationDir) {
             }).forEach(ThrowingConsumer.toConsumer(pkgDir -> {
                 // Installation root of the package is stored in
                 // /pkg-info@install-location attribute in $pkgDir/PackageInfo xml file
-                var doc = createDocumentBuilder().parse(
+                var doc = XmlUtils.initDocumentBuilder().parse(
                         new ByteArrayInputStream(Files.readAllBytes(
                                 pkgDir.resolve("PackageInfo"))));
                 var xPath = XPathFactory.newInstance().newXPath();
@@ -370,73 +365,10 @@ private static String getPackageId(JPackageCommand cmd) {
         });
     }
 
-    public static final class PListWrapper {
-        public String queryValue(String keyName) {
-            XPath xPath = XPathFactory.newInstance().newXPath();
-            // Query for the value of <string> element preceding <key> element
-            // with value equal to `keyName`
-            String query = String.format(
-                    "//string[preceding-sibling::key = \"%s\"][1]", keyName);
-            return ThrowingSupplier.toSupplier(() -> (String) xPath.evaluate(
-                    query, doc, XPathConstants.STRING)).get();
-        }
-
-        public Boolean queryBoolValue(String keyName) {
-            XPath xPath = XPathFactory.newInstance().newXPath();
-            // Query boolean element preceding <key> element
-            // with value equal to `keyName`
-            String query = String.format(
-                    "name(//*[preceding-sibling::key = \"%s\"])", keyName);
-            String value = ThrowingSupplier.toSupplier(() -> (String) xPath.evaluate(
-                    query, doc, XPathConstants.STRING)).get();
-            return Boolean.valueOf(value);
-        }
-
-        public List<String> queryArrayValue(String keyName) {
-            XPath xPath = XPathFactory.newInstance().newXPath();
-            // Query string array preceding <key> element with value equal to `keyName`
-            String query = String.format(
-                    "//array[preceding-sibling::key = \"%s\"]", keyName);
-            NodeList list = ThrowingSupplier.toSupplier(() -> (NodeList) xPath.evaluate(
-                    query, doc, XPathConstants.NODESET)).get();
-            if (list.getLength() != 1) {
-                throw new RuntimeException(
-                        String.format("Unable to find <array> element for key = \"%s\"]",
-                                keyName));
-            }
-
-            NodeList childList = list.item(0).getChildNodes();
-            List<String> values = new ArrayList<>(childList.getLength());
-            for (int i = 0; i < childList.getLength(); i++) {
-                if (childList.item(i).getNodeName().equals("string")) {
-                    values.add(childList.item(i).getTextContent());
-                }
-            }
-            return values;
-        }
-
-        private PListWrapper(String xml) throws ParserConfigurationException,
-                SAXException, IOException {
-            doc = createDocumentBuilder().parse(new ByteArrayInputStream(
-                    xml.getBytes(StandardCharsets.UTF_8)));
-        }
-
-        private final org.w3c.dom.Document doc;
-    }
-
     public static boolean isXcodeDevToolsInstalled() {
         return Inner.XCODE_DEV_TOOLS_INSTALLED;
     }
 
-    private static DocumentBuilder createDocumentBuilder() throws
-                ParserConfigurationException {
-        DocumentBuilderFactory dbf = DocumentBuilderFactory.newDefaultInstance();
-        dbf.setFeature(
-                "http://apache.org/xml/features/nonvalidating/load-external-dtd",
-                false);
-        return dbf.newDocumentBuilder();
-    }
-
     private static String getServicePListFileName(String packageName,
             String launcherName) {
         try {