support condition as groovy script

gy2006 · gy2006 · commit 99838da684cd · 2020-08-02T00:23:29.000+02:00
diff --git a/core/pom.xml b/core/pom.xml
@@ -64,6 +64,12 @@
       <artifactId>minio</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.codehaus.groovy</groupId>
+      <artifactId>groovy-all</artifactId>
+      <type>pom</type>
+    </dependency>
+
     <dependency>
       <groupId>com.github.ben-manes.caffeine</groupId>
       <artifactId>caffeine</artifactId>
diff --git a/core/src/main/java/com/flowci/core/agent/domain/ShellIn.java b/core/src/main/java/com/flowci/core/agent/domain/ShellIn.java
@@ -1,8 +1,10 @@
 package com.flowci.core.agent.domain;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.flowci.domain.DockerOption;
 import com.flowci.domain.StringVars;
 import com.flowci.domain.Vars;
+import com.flowci.util.StringHelper;
 import com.google.common.base.Strings;
 import lombok.Getter;
 import lombok.Setter;
@@ -31,6 +33,9 @@ public final class ShellIn extends CmdIn {
 
     private List<DockerOption> dockers;
 
+    @JsonIgnore
+    private String condition;
+
     private List<String> scripts = new LinkedList<>();
 
     private int timeout = 1800;
@@ -57,4 +62,9 @@ public void addEnvFilters(Set<String> exports) {
     public void addInputs(StringVars vars) {
         inputs.putAll(vars);
     }
+
+    @JsonIgnore
+    public boolean hasCondition() {
+        return StringHelper.hasValue(condition);
+    }
 }
diff --git a/core/src/main/java/com/flowci/core/job/manager/ConditionManager.java b/core/src/main/java/com/flowci/core/job/manager/ConditionManager.java
@@ -0,0 +1,9 @@
+package com.flowci.core.job.manager;
+
+import com.flowci.core.agent.domain.CmdIn;
+import groovy.util.ScriptException;
+
+public interface ConditionManager {
+
+    boolean run(CmdIn in) throws ScriptException;
+}
diff --git a/core/src/main/java/com/flowci/core/job/manager/ConditionManagerImpl.java b/core/src/main/java/com/flowci/core/job/manager/ConditionManagerImpl.java
@@ -0,0 +1,42 @@
+package com.flowci.core.job.manager;
+
+import com.flowci.core.agent.domain.CmdIn;
+import com.flowci.core.agent.domain.ShellIn;
+import groovy.lang.Binding;
+import groovy.lang.GroovyRuntimeException;
+import groovy.lang.GroovyShell;
+import groovy.util.ScriptException;
+import lombok.extern.log4j.Log4j2;
+import org.codehaus.groovy.control.CompilationFailedException;
+import org.springframework.stereotype.Component;
+
+@Log4j2
+@Component
+public class ConditionManagerImpl implements ConditionManager {
+
+    @Override
+    public boolean run(CmdIn in) throws ScriptException {
+        if (!(in instanceof ShellIn)) {
+            return true;
+        }
+
+        ShellIn shell = (ShellIn) in;
+        if (!shell.hasCondition()) {
+            return true;
+        }
+
+        Binding binding = new Binding();
+        shell.getInputs().forEach(binding::setVariable);
+
+        try {
+            GroovyShell groovy = new GroovyShell(binding);
+            Object value = groovy.evaluate(shell.getCondition());
+            if (value instanceof Boolean) {
+                return (Boolean) value;
+            }
+            throw new ScriptException("The return type is not boolean");
+        } catch (GroovyRuntimeException e) {
+            throw new ScriptException(e.getMessage());
+        }
+    }
+}
diff --git a/core/src/test/java/com/flowci/core/test/job/ConditionManagerTest.java b/core/src/test/java/com/flowci/core/test/job/ConditionManagerTest.java
@@ -0,0 +1,40 @@
+package com.flowci.core.test.job;
+
+import com.flowci.core.agent.domain.ShellIn;
+import com.flowci.core.job.manager.ConditionManager;
+import com.flowci.core.test.SpringScenario;
+import groovy.util.ScriptException;
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.testng.Assert;
+
+public class ConditionManagerTest extends SpringScenario {
+
+    @Autowired
+    private ConditionManager conditionManager;
+
+    @Test
+    public void should_run_groovy_condition() throws ScriptException {
+        ShellIn in = new ShellIn();
+        in.getInputs().put("foo", "helloword");
+        in.setCondition(
+                "println \"$foo\"; "
+                        + "return true;"
+        );
+
+        Assert.assertTrue(conditionManager.run(in));
+    }
+
+    @Test(expected = ScriptException.class)
+    public void should_throw_exception_if_wrong_return_type() throws ScriptException {
+        ShellIn in = new ShellIn();
+        in.getInputs().put("foo", "helloword");
+        in.setCondition(
+                "println \"$foo\"; "
+                        + "hello = \"1234\";"
+                        + "return hello;"
+        );
+
+        conditionManager.run(in);
+    }
+}
diff --git a/pom.xml b/pom.xml
@@ -35,13 +35,11 @@
         <swagger2.version>2.7.0</swagger2.version>
         <jgit.version>5.0.3.201809091024-r</jgit.version>
         <jsch.version>0.1.55</jsch.version>
-        <groovy-all.version>2.4.12</groovy-all.version>
         <docker-java.version>3.2.1</docker-java.version>
         <cron-utils.version>7.0.5</cron-utils.version>
         <amqp-client.version>5.9.0</amqp-client.version>
         <java-jwt.version>3.8.1</java-jwt.version>
         <minio.version>6.0.11</minio.version>
-        <protobuf-java.version>3.11.4</protobuf-java.version>
         <log4j-core.version>2.11.2</log4j-core.version>
     </properties>
 
@@ -155,18 +153,6 @@
                 <version>${java-jwt.version}</version>
             </dependency>
 
-            <dependency>
-                <groupId>com.google.protobuf</groupId>
-                <artifactId>protobuf-java</artifactId>
-                <version>${protobuf-java.version}</version>
-            </dependency>
-
-            <dependency>
-                <groupId>org.codehaus.groovy</groupId>
-                <artifactId>groovy-all</artifactId>
-                <version>${groovy-all.version}</version>
-            </dependency>
-
             <dependency>
                 <groupId>com.cronutils</groupId>
                 <artifactId>cron-utils</artifactId>
@@ -314,6 +300,13 @@
                 <version>${curator.version}</version>
             </dependency>
 
+            <dependency>
+                <groupId>org.codehaus.groovy</groupId>
+                <artifactId>groovy-all</artifactId>
+                <version>3.0.4</version>
+                <type>pom</type>
+            </dependency>
+
             <dependency>
                 <groupId>org.apache.curator</groupId>
                 <artifactId>curator-test</artifactId>
@@ -334,7 +327,6 @@
                 <version>${wiremock.version}</version>
                 <scope>test</scope>
             </dependency>
-
         </dependencies>
     </dependencyManagement>
 
diff --git a/tree/pom.xml b/tree/pom.xml
@@ -28,11 +28,6 @@
       <artifactId>snakeyaml</artifactId>
     </dependency>
 
-    <dependency>
-      <groupId>org.codehaus.groovy</groupId>
-      <artifactId>groovy-all</artifactId>
-    </dependency>
-
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
diff --git a/tree/src/main/java/com/flowci/tree/StepNode.java b/tree/src/main/java/com/flowci/tree/StepNode.java
@@ -19,7 +19,7 @@ public class StepNode extends Node {
     /**
      * Node before groovy script;
      */
-    private String before;
+    private String condition;
 
     /**
      * Node execute script, can be null
@@ -50,7 +50,7 @@ public boolean hasPlugin() {
     }
 
     @JsonIgnore
-    public boolean hasBefore() {
-        return !Strings.isNullOrEmpty(before);
+    public boolean hasCondition() {
+        return !Strings.isNullOrEmpty(condition);
     }
 }
diff --git a/tree/src/main/java/com/flowci/tree/yml/FlowYml.java b/tree/src/main/java/com/flowci/tree/yml/FlowYml.java
@@ -18,7 +18,6 @@
 
 import com.flowci.exception.YmlException;
 import com.flowci.tree.*;
-import com.flowci.util.ObjectsHelper;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.NonNull;
diff --git a/tree/src/main/java/com/flowci/tree/yml/StepYml.java b/tree/src/main/java/com/flowci/tree/yml/StepYml.java
@@ -19,7 +19,6 @@
 import com.flowci.exception.YmlException;
 import com.flowci.tree.NodePath;
 import com.flowci.tree.StepNode;
-import com.flowci.util.ObjectsHelper;
 import com.flowci.util.StringHelper;
 import com.google.common.collect.Sets;
 import lombok.Getter;
@@ -39,7 +38,10 @@ public class StepYml extends YmlBase<StepNode> {
 
     private static final String DefaultStepPrefix = "step-";
 
-    private String before;
+    /**
+     * Groovy script
+     */
+    private String condition;
 
     private String script;
 
@@ -59,7 +61,7 @@ public class StepYml extends YmlBase<StepNode> {
 
     public StepNode toNode(int index) {
         StepNode node = new StepNode(buildName(index));
-        node.setBefore(before);
+        node.setCondition(condition);
         node.setScript(script);
         node.setPlugin(plugin);
         node.setExports(Sets.newHashSet(exports));
diff --git a/tree/src/test/java/com/flowci/tree/test/YmlParserTest.java b/tree/src/test/java/com/flowci/tree/test/YmlParserTest.java
@@ -82,7 +82,7 @@ public void should_get_node_from_yml() {
         Assert.assertEquals("echo step version", step1.getEnv("FLOW_VERSION"));
 
         Assert.assertTrue(step1.isAllowFailure());
-        Assert.assertEquals("println(FLOW_WORKSPACE)\ntrue\n", step1.getBefore());
+        Assert.assertEquals("println(FLOW_WORKSPACE)\ntrue\n", step1.getCondition());
 
         StepNode step2 = steps.get(1);
         Assert.assertEquals("step2", step2.getName());
diff --git a/tree/src/test/resources/flow-with-invalid-name.yml b/tree/src/test/resources/flow-with-invalid-name.yml
@@ -17,7 +17,7 @@ selector:
     - local
 
 steps:
-  - before: |
+  - condition: |
       println(FLOW_WORKSPACE)
       true
     envs:
diff --git a/tree/src/test/resources/flow.yml b/tree/src/test/resources/flow.yml
@@ -25,7 +25,7 @@ notifications:
       FLOWCI_SMTP_CONFIG: 'test-config'
 
 steps:
- - before: |
+ - condition: |
      println(FLOW_WORKSPACE)
      true
    envs:

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public class StepNode extends Node {`
`19`	`19`	`/**`
`20`	`20`	`* Node before groovy script;`
`21`	`21`	`*/`
`22`		`- private String before;`
	`22`	`+ private String condition;`
`23`	`23`
`24`	`24`	`/**`
`25`	`25`	`* Node execute script, can be null`
`@@ -50,7 +50,7 @@ public boolean hasPlugin() {`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`@JsonIgnore`
`53`		`- public boolean hasBefore() {`
`54`		`- return !Strings.isNullOrEmpty(before);`
	`53`	`+ public boolean hasCondition() {`
	`54`	`+ return !Strings.isNullOrEmpty(condition);`
`55`	`55`	`}`
`56`	`56`	`}`