[GR-62397] Some inputs in gradle AbstractPackagesTask are set in task config, other in task implementation.

PullRequest: graalpython/3715

Author: tomasstupka

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

@@ -56,9 +56,11 @@
 import org.gradle.api.file.Directory;
 import org.gradle.api.file.DirectoryProperty;
 import org.gradle.api.file.ProjectLayout;
+import org.gradle.api.file.RegularFile;
 import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.plugins.JavaPluginExtension;
 import org.gradle.api.provider.Provider;
+import org.gradle.api.tasks.Internal;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.TaskProvider;
 import org.gradle.jvm.tasks.Jar;
@@ -74,6 +76,7 @@
 
 import static org.graalvm.python.embedding.tools.vfs.VFSUtils.GRAALPY_GROUP_ID;
 import static org.graalvm.python.embedding.tools.vfs.VFSUtils.VFS_ROOT;
+import static org.graalvm.python.embedding.tools.vfs.VFSUtils.VFS_VENV;
 
 public abstract class GraalPyGradlePlugin implements Plugin<Project> {
     private static final String LAUNCHER_CONFIGURATION_NAME = "pythonLauncherClasspath";
@@ -211,8 +214,6 @@ private TaskProvider<InstallPackagesTask> registerInstallPackagesTask(Project pr
     private TaskProvider<LockPackagesTask> registerLockPackagesTask(Project project, Configuration launcherClasspath, GraalPyExtension extension) {
         return project.getTasks().register(GRAALPY_LOCK_PACKAGES_TASK, LockPackagesTask.class, t -> {
             registerPackagesTask(project, launcherClasspath, extension, t);
-            // TODO probably not necessary
-            // t.getOutputs().upToDateWhen(tt -> false);
         });
     }
 
@@ -227,11 +228,18 @@ private void registerPackagesTask(Project project, Configuration launcherClasspa
         t.getPackages().set(extension.getPackages());
 
         DirectoryProperty externalDirectory = extension.getExternalDirectory();
-        t.getOutput().convention(externalDirectory.orElse(extension.getPythonResourcesDirectory().orElse(buildDirectory.dir(DEFAULT_RESOURCES_DIRECTORY))));
-        t.getIncludeVfsRoot().convention(externalDirectory.map(d -> false).orElse(extension.getPythonResourcesDirectory().map(d -> false).orElse(true)));
-        t.getResourceDirectory().set(extension.getResourceDirectory());
+        Directory output = externalDirectory.orElse(extension.getPythonResourcesDirectory().orElse(buildDirectory.dir(DEFAULT_RESOURCES_DIRECTORY))).get();
+        t.getOutput().convention(output);
 
-        t.getGraalPyLockFile().convention(extension.getGraalPyLockFile().orElse(projectDirectory.file(GRAALPY_LOCK_FILE)));
+        String vfsRoot = externalDirectory.isPresent() ? "" : extension.getResourceDirectory().getOrElse(VFS_ROOT);
+        t.getVenvDirectory().set(output.getAsFile().toPath().resolve(vfsRoot).resolve(VFS_VENV).toFile());
+
+        RegularFile graalPyLockFile = extension.getGraalPyLockFile().orElse(projectDirectory.file(GRAALPY_LOCK_FILE)).get();
+        File glfFile = graalPyLockFile.getAsFile();
+        if(!glfFile.isAbsolute()) {
+            graalPyLockFile = projectDirectory.file(glfFile.getPath());
+        }
+        t.getGraalPyLockFile().set(graalPyLockFile);
 
         t.setGroup(GRAALPY_GRADLE_PLUGIN_TASK_GROUP);
     }

graalpython/org.graalvm.python.gradle.plugin/src/main/java/org/graalvm/python/tasks/AbstractPackagesTask.java

@@ -66,8 +66,6 @@
 import java.util.stream.Collectors;
 
 import static org.graalvm.python.embedding.tools.vfs.VFSUtils.LAUNCHER_NAME;
-import static org.graalvm.python.embedding.tools.vfs.VFSUtils.VFS_ROOT;
-import static org.graalvm.python.embedding.tools.vfs.VFSUtils.VFS_VENV;
 
 /**
  * This task is responsible installing the dependencies which were requested by the user.
@@ -121,11 +119,6 @@ public abstract class AbstractPackagesTask extends DefaultTask {
                
         """;
 
-    /** @see #getOutput() */
-    @Input
-    @Optional
-    public abstract Property<Boolean> getIncludeVfsRoot();
-
     @Input
     public abstract ListProperty<String> getPackages();
 
@@ -143,20 +136,15 @@ public abstract class AbstractPackagesTask extends DefaultTask {
      */
     @OutputDirectory
     public abstract DirectoryProperty getOutput();
-    
-    /**
-     * The directory where the VFS should be generated within Java resources, i.e., applied only when
-     * {@link #getIncludeVfsRoot()} is set.
-     */
-    @Input
-    @Optional
-    public abstract Property<String> getResourceDirectory();
 
     @InputFiles
     @Optional
     @PathSensitive(PathSensitivity.RELATIVE)
     public abstract RegularFileProperty getGraalPyLockFile();
 
+    @Internal
+    public abstract RegularFileProperty getVenvDirectory();
+
     /**
      * Desired polyglot runtime and GraalPy version.
      */
@@ -189,25 +177,9 @@ protected Path computeLauncherDirectory() {
         return getLauncherDirectory().get().getAsFile().toPath();
     }
 
-    @Internal
-    protected Path getVenvDirectory() {
-        // XXX why not convention?
-        // XXX skip external/resouces dir and set venv dir from task config
-        String path = "";
-        if (getIncludeVfsRoot().getOrElse(true)) {
-            path = getResourceDirectory().getOrElse(VFS_ROOT);
-        }
-
-        return Path.of(getOutput().get().getAsFile().toURI()).resolve(path).resolve(VFS_VENV);
-    }
-
     @Internal
     protected Path getLockFilePath() {
-        Path rfp = getGraalPyLockFile().get().getAsFile().toPath();
-        if(rfp.isAbsolute()) {
-            return rfp;
-        } else {
-            return getProject().file(getGraalPyLockFile().get()).toPath();
-        }
+        return getGraalPyLockFile().get().getAsFile().toPath();
     }
+
 }

graalpython/org.graalvm.python.gradle.plugin/src/main/java/org/graalvm/python/tasks/InstallPackagesTask.java

@@ -67,7 +67,7 @@
 public abstract class InstallPackagesTask extends AbstractPackagesTask {
     @TaskAction
     public void exec() throws GradleException {
-        Path venvDirectory = getVenvDirectory();
+        Path venvDirectory = getVenvDirectory().get().getAsFile().toPath();
         try {
             VFSUtils.createVenv(venvDirectory, getPackages().get(), getLockFilePath(), PACKAGES_CHANGED_ERROR, MISSING_LOCK_FILE_WARNING, createLauncher(),  getPolyglotVersion().get(), getLog());
         } catch (IOException e) {

graalpython/org.graalvm.python.gradle.plugin/src/main/java/org/graalvm/python/tasks/LockPackagesTask.java

@@ -62,9 +62,9 @@ public abstract class LockPackagesTask extends AbstractPackagesTask {
     public void exec() throws GradleException {
         checkEmptyPackages();
 
-        Path venvDirectory = getVenvDirectory();
+        Path venvDirectory = getVenvDirectory().get().getAsFile().toPath();
         try {
-            VFSUtils.lockPackages(getVenvDirectory(), getPackages().get(), getLockFilePath(), LOCK_FILE_HEADER, createLauncher(), getPolyglotVersion().get(), getLog());
+            VFSUtils.lockPackages(venvDirectory, getPackages().get(), getLockFilePath(), LOCK_FILE_HEADER, createLauncher(), getPolyglotVersion().get(), getLog());
         } catch (IOException e) {
             throw new GradleException(String.format("failed to lock packages in python virtual environment %s", venvDirectory), e);
         }