docs: requirements file support for maven plugin

Author: ih0r-d

integration-tests/prepare_venv_requirements_pom.xml

@@ -0,0 +1,92 @@
+<?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-prepare-venv</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  <packaging>jar</packaging>
+  <name>Test MyMojo</name>
+
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>3.8.1</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.graalvm.polyglot</groupId>
+      <artifactId>python</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>
+            <goals>
+              <goal>process-graalpy-resources</goal>
+            </goals>
+          </execution>
+        </executions>
+          <configuration>
+              <requirementsFile>requirements.txt</requirementsFile>
+          </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>

integration-tests/test_maven_plugin.py

@@ -835,6 +835,51 @@ def test_multiple_namespaced_vfs(self):
             assert return_code == 0, log
 
 
+    def test_requirements_txt_packages(self):
+      with util.TemporaryTestDirectory() as dir:
+        target_name = "requirements_packages"
+        target_dir = os.path.join(str(dir), target_name)
+        pom_template = os.path.join(
+            os.path.dirname(__file__),
+            "prepare_venv_requirements_pom.xml",
+        )
+        self.generate_app(dir, target_dir, target_name, pom_template)
+
+        requirements_txt = os.path.join(target_dir, "requirements.txt")
+        if not os.path.exists(requirements_txt):
+          with open(requirements_txt, "w", encoding="utf-8") as f:
+            f.write("pyfiglet==1.0.2\n")
+
+        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)
+        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()
+
+        # підстав назву пакета з requirements.txt
+        assert "pyfiglet==" in lock_content
+
 if __name__ == "__main__":
     run_path = os.path.join(os.path.abspath(__file__), 'run.py')
     print(f"Run this file using the run.py driver ({run_path})")