[GR-58131] Generated launcher in embedding apps points to absolute path where originally created.

PullRequest: graalpython/3522

Author: tomasstupka

graalpython/com.oracle.graal.python.test/src/tests/standalone/test_standalone.py

@@ -38,7 +38,6 @@
 # SOFTWARE.
 
 import os
-import subprocess
 import tempfile
 import unittest
 import urllib.parse
@@ -217,7 +216,7 @@ def generate_app(self, target_dir):
 
     @unittest.skipUnless(is_gradle_enabled, "ENABLE_GRADLE_STANDALONE_UNITTESTS is not true")
     def test_gradle_generated_app(self):
-        with tempfile.TemporaryDirectory() as tmpdir:        
+        with tempfile.TemporaryDirectory() as tmpdir:
             target_dir = os.path.join(str(tmpdir), "generated_app_gradle" + self.target_dir_name_sufix())
             self.generate_app(target_dir)
             build_file = os.path.join(target_dir, self.build_file_name)
@@ -231,7 +230,7 @@ def test_gradle_generated_app(self):
             util.check_ouput("BUILD SUCCESS", out)
 
             cmd = gradlew_cmd + ["nativeCompile"]
-            # gradle needs jdk <= 22, but it looks like the 'gradle nativeCompile' cmd does not complain if higher, 
+            # gradle needs jdk <= 22, but it looks like the 'gradle nativeCompile' cmd does not complain if higher,
             # which is fine, because we need to build the native binary with a graalvm build
             # and the one we have set in JAVA_HOME is at least jdk24
             # => run without gradle = True
@@ -267,6 +266,22 @@ def test_gradle_generated_app(self):
             #GR-51132 - NoClassDefFoundError when running polyglot app in java mode
             util.check_ouput("java.lang.NoClassDefFoundError", out, False)
 
+            # move app to another folder
+            # this will break launcher symlinks, but should be able to recover from that
+            target_dir2 = os.path.join(str(tmpdir), "generated_app_gradle.2" + self.target_dir_name_sufix())
+            os.rename(target_dir, target_dir2)
+            # adding new dep triggers launcher without venv regen
+            self.copy_build_files(target_dir2)
+            build_file2 = os.path.join(target_dir2, self.build_file_name)
+            append(build_file2, self.packages_termcolor_ujson())
+
+            gradlew_cmd2 = util.get_gradle_wrapper(target_dir2, self.env)
+            cmd = gradlew_cmd2 + ["build", "run"]
+            out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir2, gradle = True)
+            util.check_ouput("BUILD SUCCESS", out)
+            util.check_ouput("Deleting GraalPy venv due to broken launcher symlinks", out)
+            util.check_ouput("hello java", out)
+
     @unittest.skipUnless(is_gradle_enabled, "ENABLE_GRADLE_STANDALONE_UNITTESTS is not true")
     def test_gradle_generated_app_external_resources(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -300,7 +315,7 @@ def test_gradle_generated_app_external_resources(self):
             out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir, gradle = True)
             util.check_ouput("BUILD SUCCESS", out)
 
-            # gradle needs jdk <= 22, but it looks like the 'gradle nativeCompile' cmd does not complain if higher, 
+            # gradle needs jdk <= 22, but it looks like the 'gradle nativeCompile' cmd does not complain if higher,
             # which is fine, because we need to build the native binary with a graalvm build
             # and the one we have set in JAVA_HOME is at least jdk24
             # => run without gradle = True
@@ -704,6 +719,19 @@ def test_generated_app(self):
             #GR-51132 - NoClassDefFoundError when running polyglot app in java mode
             util.check_ouput("java.lang.NoClassDefFoundError", out, False)
 
+            # move app to another folder
+            # this will break launcher symlinks, but should be able to recover from that
+            target_dir2 = os.path.join(str(tmpdir), target_name + ".2")
+            os.rename(target_dir, target_dir2)
+            mvnw_cmd2 = util.get_mvn_wrapper(target_dir2, self.env)
+            # adding new dep triggers launcher without venv regen
+            util.replace_in_file(os.path.join(target_dir2, "pom.xml"), "<packages>", "<packages>\n<package>ujson</package>")
+            cmd = mvnw_cmd2 + ["package", "exec:java", "-Dexec.mainClass=it.pkg.GraalPy"]
+            out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir2)
+            util.check_ouput("BUILD SUCCESS", out)
+            util.check_ouput("Deleting GraalPy venv due to changed launcher path", out)
+            util.check_ouput("hello java", out)
+
     @unittest.skipUnless(is_enabled, "ENABLE_STANDALONE_UNITTESTS is not true")
     def test_generated_app_external_resources(self):
         with tempfile.TemporaryDirectory() as tmpdir:

graalpython/org.graalvm.python.embedding.tools/src/org/graalvm/python/embedding/tools/vfs/VFSUtils.java

@@ -391,14 +391,22 @@ public void log(CharSequence var1) {
         }
     }
 
-    public static void createVenv(Path venvDirectory, List<String> packages, Path laucherPath, LauncherClassPath launcherClassPath, String graalPyVersion, SubprocessLog subprocessLog, Log log)
+    public static void createVenv(Path venvDirectory, List<String> packages, Path launcher, LauncherClassPath launcherClassPath, String graalPyVersion, SubprocessLog subprocessLog, Log log)
                     throws IOException {
-        generateLaunchers(laucherPath, launcherClassPath, subprocessLog, log);
+        Path launcherPath = launcher;
+        String externalLauncher = System.getProperty("graalpy.vfs.venvLauncher");
+        if (externalLauncher == null || externalLauncher.trim().isEmpty()) {
+            generateLaunchers(launcherPath, launcherClassPath, subprocessLog, log);
+        } else {
+            launcherPath = Path.of(externalLauncher);
+        }
 
         if (packages != null) {
             trim(packages);
         }
 
+        checkLauncher(venvDirectory, launcherPath, log);
+
         var tag = venvDirectory.resolve("contents");
         List<String> installedPackages = new ArrayList<>();
 
@@ -417,12 +425,11 @@ public static void createVenv(Path venvDirectory, List<String> packages, Path la
                     installedPackages.add(lines.get(i));
                 }
             }
-        } else {
-            log.info(String.format("Creating GraalPy %s venv", graalPyVersion));
         }
 
         if (!Files.exists(venvDirectory)) {
-            runLauncher(laucherPath.toString(), subprocessLog, "-m", "venv", venvDirectory.toString(), "--without-pip");
+            log.info(String.format("Creating GraalPy %s venv", graalPyVersion));
+            runLauncher(launcherPath.toString(), subprocessLog, "-m", "venv", venvDirectory.toString(), "--without-pip");
             runVenvBin(venvDirectory, "graalpy", subprocessLog, "-I", "-m", "ensurepip");
         }
 
@@ -439,6 +446,38 @@ public static void createVenv(Path venvDirectory, List<String> packages, Path la
         }
     }
 
+    private static void checkLauncher(Path venvDirectory, Path launcherPath, Log log) throws IOException {
+        if (!Files.exists(launcherPath)) {
+            throw new IOException(String.format("Launcher file does not exist '%s'", launcherPath));
+        }
+        Path cfg = venvDirectory.resolve("pyvenv.cfg");
+        if (Files.exists(cfg)) {
+            try {
+                List<String> lines = Files.readAllLines(cfg);
+                for (String line : lines) {
+                    int idx = line.indexOf("=");
+                    if (idx > -1) {
+                        String l = line.substring(0, idx).trim();
+                        String r = line.substring(idx + 1).trim();
+                        if (l.trim().equals("executable")) {
+                            Path cfgLauncherPath = Path.of(r);
+                            if (!Files.exists(cfgLauncherPath) || !Files.isSameFile(launcherPath, cfgLauncherPath)) {
+                                log.info(String.format("Deleting GraalPy venv due to changed launcher path"));
+                                delete(venvDirectory);
+                            }
+                            break;
+                        }
+                    }
+                }
+            } catch (IOException e) {
+                e.printStackTrace();
+                throw new IOException(String.format("failed to read config file %s", cfg), e);
+            }
+        } else {
+            log.info(String.format("missing venv config file: '%s'", cfg));
+        }
+    }
+
     private static void generateLaunchers(Path laucherPath, LauncherClassPath launcherClassPath, SubprocessLog subprocessLog, Log log) throws IOException {
         if (!Files.exists(laucherPath)) {
             log.info("Generating GraalPy launchers");