feat: add <requirementsFile> support with direct pip install -r forwarding

Author: ih0r-d

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

@@ -40,6 +40,7 @@
  */
 package org.graalvm.python.maven.plugin;
 
+import java.util.ArrayList;
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.artifact.DefaultArtifact;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
@@ -110,7 +111,7 @@ public AbstractGraalPyMojo(ProjectBuilder projectBuilder) {
 	@Parameter
 	List<String> packages;
 
-    @Parameter(property = "requirementsFile", defaultValue = "requirements.txt")
+    @Parameter(property = "requirementsFile")
     String requirementsFile;
 
 	@SuppressFBWarnings("UUF_UNUSED_FIELD")
@@ -164,8 +165,7 @@ protected void preExec(boolean enableWarnings) throws MojoExecutionException {
                         "Cannot use <packages> and <requirementsFile> at the same time. "
                                 + "New option <requirementsFile> is a replacement for using <packages> with list of inline <package>.");
             }
-
-            packages = loadRequirementsPackages(reqFilePath);
+            packages = new ArrayList<>();
         } else if (packages != null) {
             packages = packages.stream()
                     .filter(p -> p != null && !p.trim().isEmpty())
@@ -216,7 +216,7 @@ protected void preExec(boolean enableWarnings) throws MojoExecutionException {
 		}
 	}
 
-    private Path resolveReqFile() {
+    protected Path resolveReqFile() {
         if (requirementsFile == null || requirementsFile.isBlank()) {
             return null;
         }
@@ -237,15 +237,6 @@ private Path resolveReqFile() {
 
         return null;
     }
-    private List<String> loadRequirementsPackages(Path path) throws MojoExecutionException {
-        try {
-            return VFSUtils.requirementsPackages(path);
-        } catch (IOException e) {
-            throw new MojoExecutionException(
-                    "Failed to read Python requirements from file: " + requirementsFile
-                            + ". Please verify that the file exists and is readable.", e);
-        }
-    }
 
     protected void postExec() throws MojoExecutionException {
 		for (Resource r : project.getBuild().getResources()) {

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

@@ -46,6 +46,7 @@
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.ProjectBuilder;
 import org.graalvm.python.embedding.tools.vfs.VFSUtils;
+import org.graalvm.python.embedding.tools.vfs.VFSUtils.Launcher;
 import org.graalvm.python.embedding.tools.vfs.VFSUtils.PackagesChangedException;
 
 import javax.inject.Inject;
@@ -98,9 +99,10 @@ private void manageVenv() throws MojoExecutionException {
 		Path venvDirectory = getVenvDirectory();
 		MavenDelegateLog log = new MavenDelegateLog(getLog());
 		Path lockFile = getLockFile();
+        Path reqFile = resolveReqFile();
 		try {
 			VFSUtils.createVenv(venvDirectory, packages, lockFile, MISSING_LOCK_FILE_WARNING, createLauncher(),
-					getGraalPyVersion(project), log);
+					getGraalPyVersion(project), log, reqFile);
 		} catch (PackagesChangedException pce) {
 			String pluginPkgsString = pce.getPluginPackages().isEmpty()
 					? "None"

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

@@ -64,8 +64,46 @@ public class LockPackagesMojo extends AbstractGraalPyMojo {
 			This file contains a list of all required Python packages with their specific versions,
 			based on the packages defined in the plugin configuration and their dependencies.
 			""";
-
-	@Inject
+    public static final String MISSING_DEPENDENCY_CONFIGURATION_ERROR = """
+            In order to run the lock-packages goal you must declare Python dependencies in the graalpy-maven-plugin configuration.
+            
+            You must configure Python dependencies in one of the following ways:
+            
+              Option 1: Use <packages> with inline versioned package entries:
+            
+                <plugin>
+                  <groupId>org.graalvm.python</groupId>
+                  <artifactId>graalpy-maven-plugin</artifactId>
+                  <configuration>
+                    <packages>
+                      <package>{package_name}=={package_version}</package>
+                    </packages>
+                    ...
+                  </configuration>
+                </plugin>
+            
+              Option 2: Use a pip-compatible requirements file:
+            
+                <plugin>
+                  <groupId>org.graalvm.python</groupId>
+                  <artifactId>graalpy-maven-plugin</artifactId>
+                  <configuration>
+                    <requirementsFile>requirements.txt</requirementsFile>
+                    ...
+                  </configuration>
+                </plugin>
+            
+            NOTE:
+              • The <configuration> section must be declared on the graalpy-maven-plugin itself,
+                not inside the process-graalpy-resources execution goal.
+              • Do not define both <packages> and <requirementsFile> at the same time.
+            
+            For more information, please refer to:
+            https://github.com/oracle/graalpython/blob/master/docs/user/Embedding-Build-Tools.md
+            """;
+
+
+    @Inject
 	public LockPackagesMojo(ProjectBuilder projectBuilder) {
 		super(projectBuilder);
 	}
@@ -93,33 +131,15 @@ protected void manageVenv() throws MojoExecutionException {
 		}
 	}
 
-	private void checkEmptyPackages() throws MojoExecutionException {
-		if ((packages == null || packages.isEmpty())) {
-			getLog().error("");
-			getLog().error(
-					"In order to run the lock-packages goal there have to be python packages declared in the graalpy-maven-plugin configuration.");
-			getLog().error("");
-			getLog().error(
-					"NOTE that the <configuration> section has to be declared for the whole graalpy-maven-plugin");
-			getLog().error("and not specifically for the process-graalpy-resources execution goal.");
-			getLog().error("");
-			getLog().error("Please add the <packages> section to your configuration as follows:");
-			getLog().error("<plugin>");
-			getLog().error("  <groupId>org.graalvm.python</groupId>");
-			getLog().error("  <artifactId>graalpy-maven-plugin</artifactId>");
-			getLog().error("  <configuration>");
-			getLog().error("    <packages>");
-			getLog().error("      <package>{package_name}=={package_version}</package>");
-			getLog().error("    </packages>");
-			getLog().error("    ...");
-			getLog().error("  </configuration>");
-			getLog().error("");
-
-			getLog().error(
-					"For more information, please refer to https://github.com/oracle/graalpython/blob/master/docs/user/Embedding-Build-Tools.md");
-			getLog().error("");
-
-			throw new MojoExecutionException("missing python packages in plugin configuration");
-		}
-	}
+    private void checkEmptyPackages() throws MojoExecutionException {
+        Path reqFilePath = resolveReqFile();
+        boolean emptyPackages = packages == null || packages.isEmpty();
+        boolean requirementsExists = reqFilePath != null;
+        if (emptyPackages && !requirementsExists) {
+            getLog().error("");
+            getLog().error(MISSING_DEPENDENCY_CONFIGURATION_ERROR);
+            getLog().error("");
+            throw new MojoExecutionException("Missing Python dependency configuration.");
+        }
+    }
 }

integration-tests/test_maven_plugin.py

@@ -857,28 +857,9 @@ def test_requirements_txt_packages(self):
         util.check_ouput("BUILD SUCCESS", out)
         assert return_code == 0
 
-        cmd = mvnw_cmd + ["org.graalvm.python:graalpy-maven-plugin:lock-packages"]
-        out, return_code = util.run_cmd(cmd, self.env, cwd=target_dir)
-
-        util.check_ouput("BUILD SUCCESS", out)
-        assert return_code == 0
-
-        util.check_ouput(
-            "In order to run the lock-packages goal there have to be python packages declared in the graalpy-maven-plugin configuration",
-            out,
-            contains=False,
-        )
-
-        # lock-файл створився
         lock_file = os.path.join(target_dir, "graalpy.lock")
-        assert os.path.exists(lock_file)
-
-        # 3) перевіряємо, що в lock-файлі є хоча б один пакет з requirements.txt
-        with open(lock_file, encoding="utf-8") as f:
-          lock_content = f.read()
+        assert not os.path.exists(lock_file)
 
-        # підстав назву пакета з requirements.txt
-        assert "pyfiglet==" in lock_content
 
 if __name__ == "__main__":
     run_path = os.path.join(os.path.abspath(__file__), 'run.py')