[GR-54225] NPE if package tag in graalpy-maven-plugin config is empty.

tomasstupka · tomasstupka · commit e36f493b9d11 · 2024-05-30T21:50:07.000Z
PullRequest: graalpython/3342
diff --git a/graalpython/com.oracle.graal.python.test/src/tests/standalone/check_home_pom.xml b/graalpython/com.oracle.graal.python.test/src/tests/standalone/check_home_pom.xml
@@ -73,14 +73,7 @@ SOFTWARE.
         <executions>
           <execution>
             <configuration>
-              <pythonHome>
-                <includes>
-                  <include>.*__init__\.py</include>
-                </includes>
-                <excludes>
-                  <exclude>.*html/__init__\.py</exclude>
-                </excludes>
-              </pythonHome>
+
             </configuration>
             <goals>
               <goal>process-graalpy-resources</goal>
diff --git a/graalpython/com.oracle.graal.python.test/src/tests/standalone/check_packages_pom.xml b/graalpython/com.oracle.graal.python.test/src/tests/standalone/check_packages_pom.xml
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Copyright (c) 2023, 2023, Oracle and/or its affiliates. All rights reserved.
+DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any
+person obtaining a copy of this software, associated documentation and/or
+data (collectively the "Software"), free of charge and under any and all
+copyright rights in the Software, and any and all patent rights owned or
+freely licensable by each licensor hereunder covering either (i) the
+unmodified Software as contributed to or provided by such licensor, or (ii)
+the Larger Works (as defined below), to deal in both
+
+(a) the Software, and
+
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+one is included with the Software each a "Larger Work" to which the Software
+is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create
+derivative works of, display, perform, and distribute the Software and make,
+use, sell, offer for sale, import, export, have made, and have sold the
+Software and the Larger Work(s), and to sublicense the foregoing rights on
+either these or other terms.
+
+This license is subject to the following condition:
+
+The above copyright notice and either this complete permission notice or at a
+minimum a reference to the UPL must be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  
+  <groupId>org.apache.maven.plugin.my.unit</groupId>
+  <artifactId>project-check-packages</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  <packaging>jar</packaging>
+  <name>Test MyMojo</name>
+  
+  <dependencies>
+    <dependency>
+      <groupId>org.graalvm.polyglot</groupId>
+      <artifactId>python-community</artifactId>
+      <version>${env.GRAALPY_VERSION}</version>
+      <type>pom</type>
+    </dependency>
+    <dependency>
+      <groupId>org.graalvm.python</groupId>
+      <artifactId>python-launcher</artifactId>
+      <version>${env.GRAALPY_VERSION}</version>
+    </dependency>
+  </dependencies>
+  
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.graalvm.python</groupId>
+        <artifactId>graalpy-maven-plugin</artifactId>
+        <version>${env.GRAALPY_VERSION}</version>
+        <executions>
+          <execution>
+            <configuration>
+              <packages>
+
+              </packages>
+            </configuration>
+            <goals>
+              <goal>process-graalpy-resources</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>
diff --git a/graalpython/com.oracle.graal.python.test/src/tests/standalone/test_standalone.py b/graalpython/com.oracle.graal.python.test/src/tests/standalone/test_standalone.py
@@ -75,6 +75,12 @@ def get_gp():
 
     return graalpy
 
+def replace_in_file(file, str, replace_str):
+    with open(file, "r") as f:
+        contents = f.read()
+    with open(file, "w") as f:
+        f.write(contents.replace(str, replace_str))
+
 class PolyglotAppTest(unittest.TestCase):
 
     def setUpClass(self):
@@ -259,11 +265,7 @@ def test_gen_launcher_and_venv(self):
             util.check_ouput("termcolor", out, False)
 
             # remove ujson pkg from plugin config and check if unistalled
-            with open(os.path.join(target_dir, "pom.xml"), "r") as f:
-                contents = f.read()
-
-            with open(os.path.join(target_dir, "pom.xml"), "w") as f:
-                f.write(contents.replace("<package>ujson</package>", ""))
+            replace_in_file(os.path.join(target_dir, "pom.xml"), "<package>ujson</package>", "")
 
             cmd = mvnw_cmd + ["process-resources"]
             out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir)
@@ -272,31 +274,124 @@ def test_gen_launcher_and_venv(self):
             util.check_ouput("Uninstalling ujson", out)
             util.check_ouput("termcolor", out, False)
 
+    def check_tagfile(self, target_dir, expected):
+        with open(os.path.join(target_dir, "target", "classes", VFS_PREFIX, "home", "tagfile")) as f:
+            lines = f.readlines()
+        assert lines == expected, "expected tagfile " + str(expected) + ", but got " + str(lines)
+
     @unittest.skipUnless(is_enabled, "ENABLE_STANDALONE_UNITTESTS is not true")
     def test_check_home(self):
-        with tempfile.TemporaryDirectory() as tmpdir:
+         with tempfile.TemporaryDirectory() as tmpdir:
             target_name = "check_home_test"
             target_dir = os.path.join(str(tmpdir), target_name)
             pom_template = os.path.join(os.path.dirname(__file__), "check_home_pom.xml")
             self.generate_app(tmpdir, target_dir, target_name, pom_template)
 
             mvnw_cmd = util.get_mvn_wrapper(target_dir, self.env)
 
-            cmd = mvnw_cmd + ["process-resources"]
-            out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir)
+            # 1. process-resources with no pythonHome config
+            process_resources_cmd = mvnw_cmd + ["process-resources"]
+            out, return_code = util.run_cmd(process_resources_cmd, self.env, cwd=target_dir)
+            util.check_ouput("BUILD SUCCESS", out)
+            util.check_ouput("Copying std lib to ", out)
+
+            home_dir = os.path.join(target_dir, "target", "classes", VFS_PREFIX, "home")
+            assert os.path.exists(home_dir)
+            assert os.path.exists(os.path.join(home_dir, "lib-graalpython"))
+            assert os.path.isdir(os.path.join(home_dir, "lib-graalpython"))
+            assert os.path.exists(os.path.join(home_dir, "lib-python"))
+            assert os.path.isdir(os.path.join(home_dir, "lib-python"))
+            assert os.path.exists(os.path.join(home_dir, "tagfile"))
+            assert os.path.isfile(os.path.join(home_dir, "tagfile"))
+            self.check_tagfile(target_dir, [f'{self.graalvmVersion}\n', 'include:.*\n'])
+
+            # 2. process-resources with empty pythonHome includes and excludes
+            shutil.copyfile(pom_template, os.path.join(target_dir, "pom.xml"))
+            util.patch_pom_repositories(os.path.join(target_dir, "pom.xml"))
+            replace_in_file(os.path.join(target_dir, "pom.xml"), "</configuration>", "<pythonHome></pythonHome></configuration>")
+            out, return_code = util.run_cmd(process_resources_cmd, self.env, cwd=target_dir)
+            util.check_ouput("BUILD SUCCESS", out)
+            util.check_ouput("Copying std lib to ", out, False)
+            self.check_tagfile(target_dir, [f'{self.graalvmVersion}\n', 'include:.*\n'])
 
-            # check fileslist.txt
+            shutil.copyfile(pom_template, os.path.join(target_dir, "pom.xml"))
+            util.patch_pom_repositories(os.path.join(target_dir, "pom.xml"))
+            replace_in_file(os.path.join(target_dir, "pom.xml"), "</configuration>", "<pythonHome><includes></includes><excludes></excludes></pythonHome></configuration>")
+            out, return_code = util.run_cmd(process_resources_cmd, self.env, cwd=target_dir)
+            util.check_ouput("BUILD SUCCESS", out)
+            util.check_ouput("Copying std lib to ", out, False)
+            self.check_tagfile(target_dir, [f'{self.graalvmVersion}\n', 'include:.*\n'])
+
+            shutil.copyfile(pom_template, os.path.join(target_dir, "pom.xml"))
+            util.patch_pom_repositories(os.path.join(target_dir, "pom.xml"))
+            home_tag = """
+                        <pythonHome>
+                            <includes>
+                                <include></include>
+                                <include> </include>
+                            </includes>
+                            <excludes>
+                                <exclude></exclude>
+                                <exclude> </exclude>
+                            </excludes>
+                        </pythonHome>
+                    """
+            replace_in_file(os.path.join(target_dir, "pom.xml"), "</configuration>", home_tag + "</configuration>")
+            out, return_code = util.run_cmd(process_resources_cmd, self.env, cwd=target_dir)
+            util.check_ouput("BUILD SUCCESS", out)
+            util.check_ouput("Copying std lib to ", out, False)
+            self.check_tagfile(target_dir, [f'{self.graalvmVersion}\n', 'include:.*\n'])
+
+            # 3. process-resources with pythonHome includes and excludes
+            home_tag = """
+                <pythonHome>
+                    <includes>
+                        <include>.*__init__\.py</include>
+                    </includes>
+                    <excludes>
+                        <exclude>.*html/__init__\.py</exclude>
+                    </excludes>
+                </pythonHome>
+            """
+            replace_in_file(os.path.join(target_dir, "pom.xml"), "</configuration>", home_tag + "</configuration>")
+            out, return_code = util.run_cmd(process_resources_cmd, self.env, cwd=target_dir)
+            util.check_ouput("BUILD SUCCESS", out)
+            util.check_ouput("Deleting GraalPy home due to changed includes or excludes", out)
+            util.check_ouput("Copying std lib to ", out)
+            self.check_tagfile(target_dir, [f'{self.graalvmVersion}\n', 'include:.*__init__\\.py\n', 'exclude:.*html/__init__\\.py\n'])
+
+            # 4. check fileslist.txt
             fl_path = os.path.join(target_dir, "target", "classes", VFS_PREFIX, "fileslist.txt")
             with open(fl_path) as f:
                 for line in f:
                     line = f.readline()
                     # string \n
                     line = line[:len(line)-1]
-                    if line.endswith("/") or line == "/" + VFS_PREFIX + "/home/tagfile" or line == "/" + VFS_PREFIX + "/proj/hello.py":
+                    if not line.startswith("/" + VFS_PREFIX + "/home/") or line.endswith("/"):
                         continue
                     assert line.endswith("/__init__.py")
                     assert not line.endswith("html/__init__.py")
 
+    @unittest.skipUnless(is_enabled, "ENABLE_STANDALONE_UNITTESTS is not true")
+    def test_empty_packages(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            target_name = "empty_packages_test"
+            target_dir = os.path.join(str(tmpdir), target_name)
+            pom_template = os.path.join(os.path.dirname(__file__), "check_packages_pom.xml")
+            self.generate_app(tmpdir, target_dir, target_name, pom_template)
+
+            mvnw_cmd = util.get_mvn_wrapper(target_dir, self.env)
+
+            cmd = mvnw_cmd + ["process-resources"]
+            out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir)
+            util.check_ouput("BUILD SUCCESS", out)
+
+            replace_in_file(os.path.join(target_dir, "pom.xml"), "</packages>", "<package></package><package> </package></packages>")
+
+            cmd = mvnw_cmd + ["process-resources"]
+            out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir)
+            util.check_ouput("BUILD SUCCESS", out)
+
 @unittest.skipUnless(is_enabled, "ENABLE_STANDALONE_UNITTESTS is not true")
 def test_native_executable_one_file():
     graalpy = util.get_gp()
diff --git a/graalpython/graalpy-archetype-polyglot-app/src/main/resources/archetype-resources/pom.xml b/graalpython/graalpy-archetype-polyglot-app/src/main/resources/archetype-resources/pom.xml
@@ -46,19 +46,20 @@
         <executions>
           <execution>
             <configuration>
-              <!-- specify python packages as if used with pip -->
+              <!-- specify python packages and their versions as if used with pip -->
               <packages>
                 <package>termcolor==2.2</package>
               </packages>
               <pythonHome>
-                <!-- java-like regular expression what file paths should be included into venv/home;
-                     default is all -->
                 <includes>
+                  <!-- java-like regular expression what file paths should be included into venv/home;
+                       if empty than default is all -->
                   <include>.*</include>
-                </includes>
+                </includes>                
+                <excludes>
                 <!-- java-like regular expression what file paths should be excluded from venv/home;
                      default is none -->
-                <excludes>
+                  <!-- <exclude></exclude> -->
                 </excludes>
               </pythonHome>
             </configuration>
diff --git a/graalpython/graalpy-maven-plugin/src/main/java/org/graalvm/python/maven/plugin/ManageResourcesMojo.java b/graalpython/graalpy-maven-plugin/src/main/java/org/graalvm/python/maven/plugin/ManageResourcesMojo.java
@@ -142,6 +142,16 @@ public void execute() throws MojoExecutionException {
         manageNativeImageConfig();
     }
 
+    private void trim(List<String> l) {
+        Iterator<String> it = l.iterator();
+        while(it.hasNext()) {
+            String p = it.next();
+            if(p == null || p.trim().isEmpty()) {
+                it.remove();
+            }
+        }
+    }
+
     private void manageNativeImageConfig() throws MojoExecutionException {
         Path metaInf = getMetaInfDirectory(project);
         Path resourceConfig = metaInf.resolve("resource-config.json");
@@ -168,9 +178,23 @@ public static class PythonHome {
     private void manageHome() throws MojoExecutionException {
         var homeDirectory = getHomeDirectory(project);
         if (pythonHome == null) {
-            delete(homeDirectory);
-            return;
+            pythonHome = new PythonHome();
+            pythonHome.includes = Arrays.asList(".*");
+            pythonHome.excludes = Collections.emptyList();
+        } else {
+            if (pythonHome.includes != null) {
+                trim(pythonHome.includes);
+            }
+            if (pythonHome.includes == null || pythonHome.includes.isEmpty()) {
+                pythonHome.includes = Arrays.asList(".*");
+            }
+            if (pythonHome.excludes == null) {
+                pythonHome.excludes = Collections.emptyList();
+            } else {
+                trim(pythonHome.excludes);
+            }
         }
+
         var tag = homeDirectory.resolve("tagfile");
         var graalPyVersion = getGraalPyVersion(project);
 
@@ -264,6 +288,9 @@ private void manageVenv() throws MojoExecutionException {
 
         var venvDirectory = getVenvDirectory(project);
 
+        if(packages != null) {
+            trim(packages);
+        }
         if (packages == null || packages.isEmpty()) {
             getLog().info(String.format("No venv packages declared, deleting %s", venvDirectory));
             delete(venvDirectory);
