Merge pull request #85 from robotframework/feat/python_runner

Feat/python runner

Author: Hi-Fi

.github/workflows/maven.yml

@@ -11,9 +11,9 @@ jobs:
         java: [ 8, 11 ]
     name: Test with Java ${{ matrix.java }}
     steps:
-    - uses: actions/checkout@v2.0.0
+    - uses: actions/checkout@v2
     - name: Set up JDK ${{ matrix.java }}
-      uses: actions/setup-java@v1.3.0
+      uses: actions/setup-java@v1
       with:
         java-version: ${{ matrix.java }}
     - name: Build with Maven
@@ -24,13 +24,13 @@ jobs:
     runs-on: ubuntu-latest
     name: Release package
     steps:
-    - uses: actions/checkout@v2.0.0
+    - uses: actions/checkout@v2
     - name: Set up JDK
-      uses: actions/setup-java@v1.3.0
+      uses: actions/setup-java@v1
       with:
         java-version: 8
     - name: Release Maven package
-      uses: samuelmeuli/action-maven-publish@82d218a8bc9cacee5493e3604d651ab3ca74b506 #v1.0.0
+      uses: samuelmeuli/action-maven-publish@201a45a3f311b2ee888f252ba9f4194257545709 #v1.4.0
       with:
         gpg_private_key: ${{ secrets.gpg_private_key }}
         gpg_passphrase: ${{ secrets.gpg_passphrase }}

pom.xml

@@ -7,7 +7,7 @@
 	<groupId>org.robotframework</groupId>
 	<artifactId>robotframework-maven-plugin</artifactId>
 	<packaging>maven-plugin</packaging>
-	<version>1.7.3-SNAPSHOT</version>
+	<version>1.8.0-SNAPSHOT</version>
 	<name>Robot Framework Maven Plugin</name>
 	<description>
         Maven plugin for the Robot Framework.
@@ -123,7 +123,7 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-javadoc-plugin</artifactId>
-						<version>3.1.1</version>
+						<version>3.2.0</version>
 						<executions>
 							<execution>
 								<id>attach-javadocs</id>
@@ -203,7 +203,7 @@
 		<dependency>
 			<groupId>com.google.guava</groupId>
 			<artifactId>guava</artifactId>
-			<version>29.0-jre</version>
+			<version>30.1-jre</version>
 		</dependency>
 		<dependency>
 			<groupId>org.apache.maven</groupId>
@@ -226,7 +226,7 @@
 		<dependency>
 			<groupId>junit</groupId>
 			<artifactId>junit</artifactId>
-			<version>4.13.1</version>
+			<version>4.13.2</version>
 			<scope>test</scope>
 			<exclusions>
 				<exclusion>
@@ -252,7 +252,7 @@
 		<dependency>
 			<groupId>org.mockito</groupId>
 			<artifactId>mockito-core</artifactId>
-			<version>2.28.2</version>
+			<version>3.7.7</version>
 			<scope>test</scope>
 			<exclusions>
 				<exclusion>
@@ -264,13 +264,13 @@
 		<dependency>
 			<groupId>org.powermock</groupId>
 			<artifactId>powermock-module-junit4</artifactId>
-			<version>2.0.7</version>
+			<version>2.0.9</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.powermock</groupId>
 			<artifactId>powermock-api-mockito2</artifactId>
-			<version>2.0.7</version>
+			<version>2.0.9</version>
 			<scope>test</scope>
 		</dependency>
 
@@ -333,7 +333,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-resources-plugin</artifactId>
-				<version>3.1.0</version>
+				<version>3.2.0</version>
 			</plugin>
 			<plugin>
 				<inherited>true</inherited>
@@ -348,14 +348,14 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-surefire-plugin</artifactId>
-				<version>3.0.0-M4</version>
+				<version>3.0.0-M5</version>
 			</plugin>
 			<plugin>
 				<!-- integration tests can be skipped using -DskipITs, or -Darguments="-DskipITs"
 					in a release build, note that you need -D twice in the latter case -->
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-failsafe-plugin</artifactId>
-				<version>3.0.0-M4</version>
+				<version>3.0.0-M5</version>
 				<configuration>
 					<environmentVariables>
 						<MAVEN_LIBRARY_VERSION>${project.version}</MAVEN_LIBRARY_VERSION>
@@ -401,7 +401,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-site-plugin</artifactId>
-				<version>3.8.2</version>
+				<version>3.9.1</version>
 			</plugin>
 			<plugin>
 				<groupId>com.github.github</groupId>

src/main/java/org/robotframework/mavenplugin/AbstractMojoWithLoadedClasspath.java

@@ -47,6 +47,40 @@ public abstract class AbstractMojoWithLoadedClasspath
      */
     private String localRepository;
 
+    /**
+     * <p>Test are executed in a new process if this configuration is used.</p>
+     * <p>The classpath for the new process will include by default all the test
+     * scope dependencies from the pom.</p>
+     *
+     * <ul>
+     *     <li>Environment variables can be added with <strong>environmentVariables</strong> map. CLASSPATH environment
+     *     variable is added (prepended) to the default dependencies.</li>
+     *     <li><strong>excludeDependencies</strong> can be used to exclude the test scope dependencies from the classpath of the new process.</li>
+     *     <li><strong>jvmArgs</strong> can be used to specify JVM options</li>
+     *     <li><strong>runnerClass</strong> can be used to specify runner class</li>
+     *     <li><strong>runWithPython</strong> can be used to specify running with Python Robot Framework</li>
+     * </ul>
+     *
+     * Example:
+     * <pre><![CDATA[<externalRunner>
+     *      <environmentVariables>
+     *          <foo>bar</foo>
+     *          <CLASSPATH>this-should-be-seen-by-external-process.jar</CLASSPATH>
+     *      </environmentVariables>
+     *      <jvmArgs>
+     *          <jvmArg>-XX:PermSize=128m</jvmArg>
+     *          <jvmArg>-XX:MaxPermSize=256m</jvmArg>
+     *          <jvmArg>-Xmx512m</jvmArg>
+     *      </jvmArgs>
+     *      <excludeDependencies>true</excludeDependencies>
+     *      <runnerClass>org.robotframework.RobotFramework</runnerClass>
+     *      <runWithPython>false</runWithPython>
+     * </externalRunner>]]></pre>
+     *
+     * @parameter
+     */
+    protected ExternalRunnerConfiguration externalRunner;
+
     public void execute()
             throws MojoExecutionException, MojoFailureException {
         loadClassPath();

src/main/java/org/robotframework/mavenplugin/AcceptanceTestMojo.java

@@ -75,20 +75,25 @@ private int executeRobot(String[] runArguments) throws MojoExecutionException {
             return externalExecute(runArguments);
         }
     }
-
+    
     private int externalExecute(String[] runArguments) throws MojoExecutionException {
         try {
-            return exec(RobotFramework.class, runArguments, externalRunner.getEnvironmentVariables());
+            if (externalRunner.getRunWithPython()) {
+                return PythonRunner.exec("robot", runArguments);
+            } else {
+                return exec(externalRunner.getRunnerClass(), runArguments, externalRunner.getEnvironmentVariables());
+            }
         } catch (IOException e) {
             throw new MojoExecutionException("Executing external robot failed.", e);
         } catch (InterruptedException e) {
             throw new MojoExecutionException("Executing external robot failed.", e);
         }
     }
 
-    public int exec(Class klass, String[] arguments, Map<String, String> environment) throws IOException,
+    public int exec(String runnerClass, String[] arguments, Map<String, String> environment) throws IOException,
             InterruptedException {
-        ProcessBuilder builder = new ProcessBuilder(createExternalCommand(klass, arguments, externalRunner.getJvmArgs()));
+        runnerClass = runnerClass == null ? RobotFramework.class.getCanonicalName() : runnerClass;
+        ProcessBuilder builder = new ProcessBuilder(createExternalCommand(runnerClass, arguments, externalRunner.getJvmArgs()));
         Map<String, String> env =  builder.environment();
         String classpath = externalRunner.getExcludeDependencies() ? getRobotJar() : getClassPathString();
         if (environment.containsKey("CLASSPATH")) {
@@ -104,14 +109,13 @@ public int exec(Class klass, String[] arguments, Map<String, String> environment
         return process.waitFor();
     }
 
-    private List<String> createExternalCommand(Class klass, String[] arguments, List<String> jvmArgs) {
+    private List<String> createExternalCommand(String runnerClass, String[] arguments, List<String> jvmArgs) {
         String javaHome = System.getProperty("java.home");
         String javaBin = join(File.separator, javaHome, "bin", "java");
-        String className = klass.getCanonicalName();
         List<String> cmd = new ArrayList<String>();
         cmd.add(javaBin);
         cmd.addAll(jvmArgs);
-        cmd.add(className);
+        cmd.add(runnerClass);
         cmd.addAll(Arrays.asList(arguments));
         System.out.println("Executing Robot with command:");
         System.out.println(cmd);
@@ -225,7 +229,6 @@ private String[] generateRunArguments() {
         generatedArguments.addFileToArguments(report, "-r");
         generatedArguments.addFileToArguments(debugFile, "-b");
         generatedArguments.addFileToArguments(argumentFile, "-A");
-        generatedArguments.addFileToArguments(runFailed, "-R");
 
         generatedArguments.addNonEmptyStringToArguments(console, "--console");
         generatedArguments.addNonEmptyStringToArguments(name, "-N");
@@ -828,15 +831,6 @@ private String[] generateRunArguments() {
      */
     private boolean runEmptySuite;
 
-    /**
-     * Re-run failed tests, based on output.xml file. This can also be set via
-	 * commandline using -DrunFailed=path/to/output.xml.
-     *
-     * @parameter property="runFailed"
-     */
-    private File runFailed;
-
-
     /**
      * If true, sets the return code to zero regardless of failures in test cases. Error codes are
      * returned normally.
@@ -845,36 +839,6 @@ private String[] generateRunArguments() {
      */
     private boolean noStatusReturnCode;
 
-    /**
-     * <p>Test are executed in a new process if this configuration is used.</p>
-     * <p>The classpath for the new process will include by default all the test
-     * scope dependencies from the pom.</p>
-     *
-     * <ul>
-     *     <li>Environment variables can be added with <strong>environmentVariables</strong> map. CLASSPATH environment
-     *     variable is added (prepended) to the default dependencies.</li>
-     *     <li><strong>excludeDependencies</strong> can be used to exclude the test scope dependencies from the classpath of the new process.</li>
-     *     <li><strong>jvmArgs</strong> can be used to specify JVM options</li>
-     * </ul>
-     *
-     * Example:
-     * <pre><![CDATA[<externalRunner>
-     *      <environmentVariables>
-     *          <foo>bar</foo>
-     *          <CLASSPATH>this-should-be-seen-by-external-process.jar</CLASSPATH>
-     *      </environmentVariables>
-     *      <jvmArgs>
-     *          <jvmArg>-XX:PermSize=128m</jvmArg>
-     *          <jvmArg>-XX:MaxPermSize=256m</jvmArg>
-     *          <jvmArg>-Xmx512m</jvmArg>
-     *      </jvmArgs>
-     *      <excludeDependencies>true</excludeDependencies>
-     * </externalRunner>]]></pre>
-     *
-     * @parameter
-     */
-    private ExternalRunnerConfiguration externalRunner;
-
     /**
      * Turn on generic automation mode.
      *

src/main/java/org/robotframework/mavenplugin/ExternalRunnerConfiguration.java

@@ -37,13 +37,35 @@ public class ExternalRunnerConfiguration {
      */
     private boolean excludeDependencies;
 
+    /**
+     * Execute with pure Python (needs to be available when running).
+     *
+     * @parameter default-value="false"
+     */
+    private boolean runWithPython;
+
+    /**
+     * Runner class to start test run.
+     *
+     * @parameter default-value="org.robotframework.RobotFramework"
+     */
+    private String runnerClass;
+
     public Map<String, String> getEnvironmentVariables() {
         return environmentVariables != null ? environmentVariables : Collections.EMPTY_MAP;
     }
     public boolean getExcludeDependencies() {
         return excludeDependencies;
     }
 
+    public boolean getRunWithPython() {
+        return runWithPython;
+    }
+
+    public String getRunnerClass() {
+        return runnerClass;
+    }
+
     /**
      * JVM arguments for the new runner process.
      * 

src/main/java/org/robotframework/mavenplugin/LibDocMojo.java

@@ -51,8 +51,13 @@ public void runLibDoc() throws IOException {
         if (projectBaseDir == null)
             projectBaseDir = new File("");
         List<String[]> runArgs = libdoc.generateRunArguments(projectBaseDir);
-        for (String[] args : runArgs)
-            RobotFramework.run(args);
+        for (String[] args : runArgs) {
+            if (externalRunner != null && externalRunner.getRunWithPython()) {
+                PythonRunner.run(args);
+            } else {
+                RobotFramework.run(args);
+            }
+        }
     }
 
     /**

src/main/java/org/robotframework/mavenplugin/PythonRunner.java

@@ -0,0 +1,30 @@
+package org.robotframework.mavenplugin;
+
+import java.io.IOException;
+
+import org.apache.commons.lang3.ArrayUtils;
+
+public class PythonRunner{
+    public static void run(String[] commandWithRunArguments) {
+        try {
+            exec(commandWithRunArguments);
+        } catch (Exception e) {
+            // Nothing to do
+        }
+    }
+
+    public static int exec(String command, String[] runArguments) throws IOException,
+    InterruptedException {
+        return exec(ArrayUtils.insert(0, runArguments, command));
+    }
+
+    public static int exec(String[] commandWithRunArguments) throws IOException,
+    InterruptedException {
+        Process process = Runtime.getRuntime().exec(String.join(" ", commandWithRunArguments));
+        StreamReader stdout = new StreamReader(process.getInputStream());
+        StreamReader stderr = new StreamReader(process.getErrorStream());
+        stdout.start();
+        stderr.start();
+        return process.waitFor();
+    }
+}

src/main/java/org/robotframework/mavenplugin/RebotMojo.java

@@ -50,7 +50,11 @@ protected void subclassExecute()
     public void runRebot()
             throws IOException {
         this.ensureOutputDirectoryExists();
-        RobotFramework.run(this.generateRunArguments());
+        if (externalRunner != null && externalRunner.getRunWithPython()) {
+            PythonRunner.run(this.generateRunArguments());
+        } else {
+            RobotFramework.run(this.generateRunArguments());
+        }
     }
 
 

src/main/java/org/robotframework/mavenplugin/TestDocMojo.java

@@ -58,7 +58,11 @@ public void runTestDoc()
         List<String[]> runArgs = testdoc.generateRunArguments(projectBaseDir);
         for (String[] args : runArgs) {
             getLog().debug("Run arguments -> " + args);
-            RobotFramework.run(args);
+            if (externalRunner != null && externalRunner.getRunWithPython()) {
+                PythonRunner.run(args);
+            } else {
+                RobotFramework.run(args);
+            }
         }
     }
 

src/test/java/org/robotframework/mavenplugin/AcceptanceTestAndVerifyMojoIT.java

@@ -5,12 +5,13 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
 
 import org.apache.maven.it.VerificationException;
 import org.apache.maven.it.Verifier;
 import org.apache.maven.plugin.testing.AbstractMojoTestCase;
-import org.codehaus.plexus.component.MapOrientedComponent;
 
 public class AcceptanceTestAndVerifyMojoIT
         extends AbstractMojoTestCase {