[GR-62456] Backport to 24.2: GraalPy Maven plugin incorrectly prints warning about default resources directory.

PullRequest: graalpython/3698

Author: steve-s

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

@@ -133,6 +133,8 @@ def check_gradle_generated_app(self, community):
             cmd = gradlew_cmd + ["build"]
             out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir, logger=log)
             util.check_ouput("BUILD SUCCESS", out, logger=log)
+            util.check_ouput("Virtual filesystem is deployed to default resources directory", out, logger=log)
+            util.check_ouput("This can cause conflicts if used with other Java libraries that also deploy GraalPy virtual filesystem", out, logger=log)
             self.check_filelist(target_dir, log)
 
             cmd = gradlew_cmd + ["nativeCompile"]
@@ -413,7 +415,7 @@ def check_gradle_python_resources_dir_and_external_dir_error(self):
             gradle_cmd = util.get_gradle_wrapper(target_dir, self.env)
             cmd = gradle_cmd + ["graalPyResources"]
             out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir)
-            util.check_ouput("Cannot set both 'externalDirectory' and 'resourcesDirectory' at the same time", out)
+            util.check_ouput("Cannot set both 'externalDirectory' and 'resourceDirectory' at the same time", out)
             assert return_code != 0, out
 
 
@@ -478,6 +480,8 @@ def check_gradle_namespaced_vfs(self):
 
             app1_gradle_cmd = util.get_gradle_wrapper(app1_dir, self.env)
             out, return_code = util.run_cmd(app1_gradle_cmd + ['publishToMavenLocal'], self.env, cwd=app1_dir)
+            util.check_ouput("Virtual filesystem is deployed to default resources directory", out, contains=False)
+            util.check_ouput("This can cause conflicts if used with other Java libraries that also deploy GraalPy virtual filesystem", out, contains=False)
             assert return_code == 0, out
 
             app2_gradle_cmd = util.get_gradle_wrapper(app2_dir, self.env)

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

@@ -115,6 +115,8 @@ def check_generated_app(self, use_default_vfs_path, use_utils_pkg=False):
             cmd = mvnw_cmd + ["package", "-Pnative", "-DmainClass=it.pkg.GraalPy"]
             out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir)
             util.check_ouput("BUILD SUCCESS", out)
+            util.check_ouput("Virtual filesystem is deployed to default resources directory", out, contains=use_default_vfs_path)
+            util.check_ouput("This can cause conflicts if used with other Java libraries that also deploy GraalPy virtual filesystem.", out, contains=use_default_vfs_path)
 
             # check fileslist.txt
             fl_path = os.path.join(target_dir, "target", "classes", vfs_prefix, "fileslist.txt")

graalpython/graalpy-maven-plugin/src/main/java/org/graalvm/python/maven/plugin/ManageResourcesMojo.java

@@ -145,7 +145,7 @@ public void execute() throws MojoExecutionException {
         }
 
         if (resourceDirectory == null) {
-            if (externalDirectory != null) {
+            if (externalDirectory == null) {
                 getLog().info(String.format("Virtual filesystem is deployed to default resources directory '%s'. " +
                         "This can cause conflicts if used with other Java libraries that also deploy GraalPy virtual filesystem. " +
                         "Consider adding <resourceDirectory>GRAALPY-VFS/${project.groupId}/${project.artifactId}</resourceDirectory> to your pom.xml, " +
@@ -162,7 +162,7 @@ public void execute() throws MojoExecutionException {
             getLog().warn("The GraalPy plugin <pythonHome> configuration setting was deprecated and has no effect anymore.\n" +
                 "For execution in jvm mode, the python language home is always available.\n" +
                 "When building a native executable using GraalVM Native Image, then the full python language home is by default embedded into the native executable.\n" +
-                    "For more details, please refer to the documentation of GraalVM Native Image options IncludeLanguageResources and CopyLanguageResources documentation.");
+                    "For more details, please refer to the documentation of GraalVM Native Image options IncludeLanguageResources and CopyLanguageResources.");
         }
 
         manageVenv();

graalpython/org.graalvm.python.embedding/src/org/graalvm/python/embedding/GraalPyResources.java

@@ -198,7 +198,12 @@ private GraalPyResources() {
      * location</li>
      * <li><code>/org.graalvm.python.vfs/src</code> - is set as the python sources location</li>
      * </ul>
-     * </p>
+     * <p>
+     * When the virtual filesystem is located in other than the default resource directory,
+     * {@code org.graalvm.python.vfs}, i.e., using Maven or Gradle option {@code resourceDirectory},
+     * use {@link #contextBuilder(VirtualFileSystem)} and
+     * {@link VirtualFileSystem.Builder#resourceDirectory(String)} when building the
+     * {@link VirtualFileSystem}.
      *
      * @return a new {@link Context} instance
      * @since 24.2.0
@@ -233,6 +238,12 @@ public static Context createContext() {
      *     }
      * }
      * </pre>
+     * <p>
+     * When the virtual filesystem is located in other than the default resource directory,
+     * {@code org.graalvm.python.vfs}, i.e., using Maven or Gradle option {@code resourceDirectory},
+     * use {@link #contextBuilder(VirtualFileSystem)} and
+     * {@link VirtualFileSystem.Builder#resourceDirectory(String)} when building the
+     * {@link VirtualFileSystem}.
      * 
      * @see <a href=
      *      "https://github.com/oracle/graalpython/blob/master/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/PythonOptions.java">PythonOptions</a>
@@ -308,13 +319,14 @@ public static Context.Builder contextBuilder(VirtualFileSystem vfs) {
 
     /**
      * Creates a GraalPy context preconfigured with GraalPy and polyglot Context configuration
-     * options for use with resources located in a real filesystem.
+     * options for use with resources located in an external directory in real filesystem.
      * <p>
      * Following resource paths are preconfigured:
      * <ul>
-     * <li><code>${resourcesDirectory}/venv</code> - is set as the python virtual environment
+     * <li><code>${externalResourcesDirectory}/venv</code> - is set as the python virtual
+     * environment location</li>
+     * <li><code>${externalResourcesDirectory}/src</code> - is set as the python sources
      * location</li>
-     * <li><code>${resourcesDirectory}/src</code> - is set as the python sources location</li>
      * </ul>
      * </p>
      * <p>
@@ -343,19 +355,20 @@ public static Context.Builder contextBuilder(VirtualFileSystem vfs) {
      * </ul>
      * </p>
      * 
-     * @param resourcesDirectory the root directory with GraalPy specific embedding resources
+     * @param externalResourcesDirectory the root directory with GraalPy specific embedding
+     *            resources
      * @return a new {@link org.graalvm.polyglot.Context.Builder} instance
      * @since 24.2.0
      */
-    public static Context.Builder contextBuilder(Path resourcesDirectory) {
+    public static Context.Builder contextBuilder(Path externalResourcesDirectory) {
         String execPath;
         if (VirtualFileSystemImpl.isWindows()) {
-            execPath = resourcesDirectory.resolve(VirtualFileSystemImpl.VFS_VENV).resolve("Scripts").resolve("python.exe").toAbsolutePath().toString();
+            execPath = externalResourcesDirectory.resolve(VirtualFileSystemImpl.VFS_VENV).resolve("Scripts").resolve("python.exe").toAbsolutePath().toString();
         } else {
-            execPath = resourcesDirectory.resolve(VirtualFileSystemImpl.VFS_VENV).resolve("bin").resolve("python").toAbsolutePath().toString();
+            execPath = externalResourcesDirectory.resolve(VirtualFileSystemImpl.VFS_VENV).resolve("bin").resolve("python").toAbsolutePath().toString();
         }
 
-        String srcPath = resourcesDirectory.resolve(VirtualFileSystemImpl.VFS_SRC).toAbsolutePath().toString();
+        String srcPath = externalResourcesDirectory.resolve(VirtualFileSystemImpl.VFS_SRC).toAbsolutePath().toString();
         return createContextBuilder().
         // allow all IO access
                         allowIO(IOAccess.ALL).
@@ -437,8 +450,9 @@ public static Path getNativeExecutablePath() {
      * The structure of the created resource directory will stay the same like the embedded Python
      * resources structure:
      * <ul>
-     * <li><code>${resourcesDirectory}/venv</code> - the python virtual environment location</li>
-     * <li><code>${resourcesDirectory}/src</code> - the python sources location</li>
+     * <li><code>${externalResourcesDirectory}/venv</code> - the python virtual environment
+     * location</li>
+     * <li><code>${externalResourcesDirectory}/src</code> - the python sources location</li>
      * </ul>
      * </p>
      * </p>
@@ -456,17 +470,17 @@ public static Path getNativeExecutablePath() {
      * </p>
      *
      * @param vfs the {@link VirtualFileSystem} from which resources are to be extracted
-     * @param resourcesDirectory the target directory to extract the resources to
+     * @param externalResourcesDirectory the target directory to extract the resources to
      * @throws IOException if resources isn't a directory
      * @see #contextBuilder(Path)
      * @see VirtualFileSystem.Builder#resourceLoadingClass(Class)
      *
      * @since 24.2.0
      */
-    public static void extractVirtualFileSystemResources(VirtualFileSystem vfs, Path resourcesDirectory) throws IOException {
-        if (Files.exists(resourcesDirectory) && !Files.isDirectory(resourcesDirectory)) {
-            throw new IOException(String.format("%s has to be a directory", resourcesDirectory.toString()));
+    public static void extractVirtualFileSystemResources(VirtualFileSystem vfs, Path externalResourcesDirectory) throws IOException {
+        if (Files.exists(externalResourcesDirectory) && !Files.isDirectory(externalResourcesDirectory)) {
+            throw new IOException(String.format("%s has to be a directory", externalResourcesDirectory.toString()));
         }
-        vfs.impl.extractResources(resourcesDirectory);
+        vfs.impl.extractResources(externalResourcesDirectory);
     }
 }

graalpython/org.graalvm.python.gradle.plugin/src/main/java/org/graalvm/python/GraalPyGradlePlugin.java

@@ -117,11 +117,11 @@ public void apply(Project project) {
 
             if (extension.getPythonResourcesDirectory().isPresent() && extension.getExternalDirectory().isPresent()) {
                 throw new GradleException(
-                        "Cannot set both 'externalDirectory' and 'resourcesDirectory' at the same time. " +
+                        "Cannot set both 'externalDirectory' and 'resourceDirectory' at the same time. " +
                                 "New property 'externalDirectory' is a replacement for deprecated 'pythonResourcesDirectory'. " +
                                 "If you want to deploy the virtual environment into physical filesystem, use 'externalDirectory'. " +
                                 "The deployment of the external directory alongside the application is not handled by the GraalPy Maven plugin in such case." +
-                                "If you wish to bundle the virtual filesystem in Java resources, use 'resourcesDirectory'. " +
+                                "If you wish to bundle the virtual filesystem in Java resources, use 'resourceDirectory'. " +
                                 "For more details, please refer to https://www.graalvm.org/latest/reference-manual/python/Embedding-Build-Tools. ");
             }
 
@@ -132,9 +132,9 @@ public void apply(Project project) {
             // Run the vfsFilesListTask conditionally only if 'externalDirectory' is not set
             if (!extension.getPythonResourcesDirectory().isPresent() && !extension.getExternalDirectory().isPresent()) {
                 if (!extension.getResourceDirectory().isPresent()) {
-                    proj.getLogger().info(String.format("Virtual filesystem is deployed to default resources directory '%s'. " +
+                    proj.getLogger().warn(String.format("Virtual filesystem is deployed to default resources directory '%s'. " +
                                     "This can cause conflicts if used with other Java libraries that also deploy GraalPy virtual filesystem. " +
-                                    "Consider adding `resourcesDirectory = \"GRAALPY-VFS/${groupId}/${artifactId}\"` to your build.gradle script " +
+                                    "Consider adding `resourceDirectory = \"GRAALPY-VFS/${groupId}/${artifactId}\"` to your build.gradle script " +
                                     "(replace the placeholders with values specific to your project), " +
                                     "moving any existing sources from '%s' to '%s', and using VirtualFileSystem$Builder#resourceDirectory." +
                                     "For more details, please refer to https://www.graalvm.org/latest/reference-manual/python/Embedding-Build-Tools. ",
@@ -192,7 +192,7 @@ private TaskProvider<ResourcesTask> registerResourcesTask(Project project, Confi
                 t.getLogger().warn("The GraalPy plugin pythonHome configuration setting was deprecated and has no effect anymore.\n" +
                         "For execution in jvm mode, the python language home is always available.\n" +
                         "When building a native executable using GraalVM Native Image, then the full python language home is by default embedded into the native executable.\n" +
-                        "For more details, please refer to the documentation of GraalVM Native Image options IncludeLanguageResources and CopyLanguageResources documentation.");
+                        "For more details, please refer to the documentation of GraalVM Native Image options IncludeLanguageResources and CopyLanguageResources.");
             }
             t.getPackages().set(extension.getPackages());