Merge pull request #202 from FlowCI/feature/161

Feature/161

Author: yang.guo

platform-agent/src/test/java/com/flow/platform/agent/test/CmdManagerTest.java

@@ -23,6 +23,7 @@
 import com.flow.platform.domain.CmdResult;
 import com.flow.platform.domain.CmdStatus;
 import com.flow.platform.domain.CmdType;
+import com.google.common.collect.Lists;
 import java.io.IOException;
 import java.util.Map;
 import java.util.UUID;
@@ -119,19 +120,19 @@ public void onException(CmdResult result) {
         String content = String.format("source %s", resourcePath);
 
         Cmd cmd1 = new Cmd("zone1", "agent1", CmdType.RUN_SHELL, content);
-        cmd1.setOutputEnvFilter("FLOW_AGENT");
+        cmd1.setOutputEnvFilter(Lists.newArrayList("FLOW_AGENT"));
         cmd1.setId(UUID.randomUUID().toString());
 
         Cmd cmd2 = new Cmd("zone1", "agent1", CmdType.RUN_SHELL, content);
-        cmd2.setOutputEnvFilter("FLOW_AGENT");
+        cmd2.setOutputEnvFilter(Lists.newArrayList("FLOW_AGENT"));
         cmd2.setId(UUID.randomUUID().toString());
 
         Cmd cmd3 = new Cmd("zone1", "agent1", CmdType.RUN_SHELL, content);
-        cmd3.setOutputEnvFilter("FLOW_AGENT");
+        cmd3.setOutputEnvFilter(Lists.newArrayList("FLOW_AGENT"));
         cmd3.setId(UUID.randomUUID().toString());
 
         Cmd cmd4 = new Cmd("zone1", "agent1", CmdType.RUN_SHELL, content);
-        cmd4.setOutputEnvFilter("FLOW_AGENT");
+        cmd4.setOutputEnvFilter(Lists.newArrayList("FLOW_AGENT"));
         cmd4.setId(UUID.randomUUID().toString());
 
         // when: execute four command by thread

platform-api/src/main/java/com/flow/platform/api/envs/EnvUtil.java

@@ -20,8 +20,11 @@
 import com.flow.platform.domain.Cmd;
 import com.google.common.base.Strings;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.LinkedList;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
@@ -31,6 +34,26 @@
  */
 public class EnvUtil {
 
+    /**
+     * Parse env format with comma like A,B,C to list
+     * @return List instance
+     */
+    public static List<String> parseCommaEnvToList(String input) {
+        if (input == null) {
+            return Collections.emptyList();
+        }
+
+        String[] list = input.split(FlowEnvs.ENV_OUTPUT_SEPARATE);
+        List<String> commaList = new LinkedList<>();
+        for (String item : list) {
+            if (Strings.isNullOrEmpty(item)) {
+                continue;
+            }
+            commaList.add(item);
+        }
+        return commaList;
+    }
+
     /**
      * Convert "\n" to "\\n" in env variable, therefore the env variable still keep \n
      * @param source source env variables

platform-api/src/main/java/com/flow/platform/api/envs/FlowEnvs.java

@@ -58,6 +58,8 @@ public enum FlowEnvs implements EnvKey {
 
     /**
      * Defined env variable output prefix
+     *
+     * Support multiple export, format ex: OUT_VAR_A,OUT_VAR_B,OUT_VAR_C
      */
     FLOW_ENV_OUTPUT_PREFIX(false, true, null),
 
@@ -71,6 +73,8 @@ public enum FlowEnvs implements EnvKey {
      */
     FLOW_TASK_CRONTAB_BRANCH(false, false, null);
 
+    public final static String ENV_OUTPUT_SEPARATE = ",";
+
     private boolean readonly;
 
     private boolean editable;

platform-api/src/main/java/com/flow/platform/api/service/SyncServiceImpl.java

@@ -21,6 +21,7 @@
 import com.flow.platform.api.domain.sync.SyncRepo;
 import com.flow.platform.api.domain.sync.SyncTask;
 import com.flow.platform.api.domain.sync.SyncType;
+import com.flow.platform.api.envs.EnvUtil;
 import com.flow.platform.api.service.job.CmdService;
 import com.flow.platform.core.queue.PriorityMessage;
 import com.flow.platform.domain.Agent;
@@ -220,7 +221,7 @@ public void onCallback(Cmd cmd) {
             runShell.setWebhook(callbackUrl);
             runShell.setSessionId(cmd.getSessionId());
             runShell.setWorkingDir(DEFAULT_CMD_DIR);
-            runShell.setOutputEnvFilter(SyncEvent.FLOW_SYNC_LIST);
+            runShell.setOutputEnvFilter(EnvUtil.parseCommaEnvToList(SyncEvent.FLOW_SYNC_LIST));
             cmdService.sendCmd(runShell, false, 0);
         }
 

platform-api/src/main/java/com/flow/platform/api/service/job/CmdServiceImpl.java

@@ -20,6 +20,7 @@
 import com.flow.platform.api.domain.job.Job;
 import com.flow.platform.api.domain.node.Node;
 import com.flow.platform.api.envs.AgentEnvs;
+import com.flow.platform.api.envs.EnvUtil;
 import com.flow.platform.api.envs.FlowEnvs;
 import com.flow.platform.api.util.PlatformURL;
 import com.flow.platform.core.exception.HttpException;
@@ -105,7 +106,10 @@ public CmdInfo runShell(Job job, Node node, String cmdId, EnvObject envVars) {
         CmdInfo cmdInfo = new CmdInfo(zone, null, CmdType.RUN_SHELL, node.getScript());
         cmdInfo.setInputs(envVars.getEnvs());
         cmdInfo.setWebhook(buildCmdWebhook(job));
-        cmdInfo.setOutputEnvFilter(envVars.getEnv(FlowEnvs.FLOW_ENV_OUTPUT_PREFIX, "FLOW_OUTPUT"));
+
+        String outputFilter = envVars.getEnv(FlowEnvs.FLOW_ENV_OUTPUT_PREFIX, "FLOW_OUTPUT");
+        cmdInfo.setOutputEnvFilter(EnvUtil.parseCommaEnvToList(outputFilter));
+
         cmdInfo.setSessionId(job.getSessionId());
         cmdInfo.setExtra(node.getPath()); // use cmd.extra to keep node path info
         cmdInfo.setCustomizedId(cmdId);

platform-api/src/main/java/com/flow/platform/api/service/job/JobServiceImpl.java

@@ -345,7 +345,7 @@ private Job createJob(String path, JobCategory eventType, Map<String, String> en
     }
 
     /**
-     * run node
+     * Collect env variables and run node
      *
      * @param node job node's script and record cmdId and sync send http
      */
@@ -371,7 +371,7 @@ private void run(Node node, Job job) {
         NodeResult rootResult = nodeResultService.find(tree.root().getPath(), job.getId());
         envVars.putAll(rootResult.getOutputs());
 
-        // pass last step noed status
+        // pass last step node status
         Node prev = tree.prev(node.getPath());
         if (prev != null) {
             NodeResult prevResult = nodeResultService.find(prev.getPath(), job.getId());
@@ -380,6 +380,9 @@ private void run(Node node, Job job) {
             }
         }
 
+        // pass current node envs
+        envVars.putAll(node.getEnvs());
+
         // to run node with customized cmd id
         try {
             NodeResult nodeResult = nodeResultService.find(node.getPath(), job.getId());

platform-api/src/test/java/com/flow/platform/api/test/service/JobServiceTest.java

@@ -16,10 +16,8 @@
 
 package com.flow.platform.api.test.service;
 
-import static com.github.tomakehurst.wiremock.client.WireMock.containing;
 import static com.github.tomakehurst.wiremock.client.WireMock.exactly;
 import static com.github.tomakehurst.wiremock.client.WireMock.matchingJsonPath;
-import static com.github.tomakehurst.wiremock.client.WireMock.moreThan;
 import static com.github.tomakehurst.wiremock.client.WireMock.moreThanOrExactly;
 import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor;
 import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;
@@ -44,7 +42,6 @@
 import com.flow.platform.domain.CmdStatus;
 import com.flow.platform.domain.CmdType;
 import com.flow.platform.queue.PlatformQueue;
-import com.github.tomakehurst.wiremock.client.CountMatchingStrategy;
 import com.google.common.collect.Lists;
 import java.io.IOException;
 import java.time.ZonedDateTime;

platform-api/src/test/java/com/flow/platform/api/test/util/EnvUtilTest.java

@@ -19,6 +19,7 @@
 import com.flow.platform.api.domain.node.Node;
 import com.flow.platform.api.envs.EnvUtil;
 import com.google.common.collect.Sets;
+import java.util.List;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
@@ -44,13 +45,28 @@ public void init() {
         nodes[1] = target;
     }
 
+    @Test
+    public void should_parse_comma_env_format() {
+        List<String> emptyVar = EnvUtil.parseCommaEnvToList("");
+        Assert.assertTrue(emptyVar.isEmpty());
+
+        List<String> singleVar = EnvUtil.parseCommaEnvToList("FIR_VAR");
+        Assert.assertEquals(1, singleVar.size());
+
+        singleVar = EnvUtil.parseCommaEnvToList("FIR_VAR,");
+        Assert.assertEquals(1, singleVar.size());
+
+        List<String> multipleVar = EnvUtil.parseCommaEnvToList("VAR_1,VAR_2,VAR_3,");
+        Assert.assertEquals(3, multipleVar.size());
+    }
+
     @Test
     public void should_merge_env_without_overwrite() {
         // given:
         Node source = nodes[0];
         Node target = nodes[1];
 
-        // when: merget without overwrite
+        // when: merge without overwrite
         EnvUtil.merge(source, target, false);
 
         // then:
@@ -65,7 +81,7 @@ public void should_merge_env_with_overwrite() {
         Node source = nodes[0];
         Node target = nodes[1];
 
-        // when: merget without overwrite
+        // when: merge without overwrite
         EnvUtil.merge(source, target, true);
 
         // then:

platform-cmd-runner/src/main/java/com/flow/platform/cmd/App.java

@@ -93,7 +93,7 @@ public static void main(String[] args) throws Throwable {
             logListener,
             inputs,
             null,
-            "FLOW_", // find env start with FLOW_ and put to cmd result output map
+            Lists.newArrayList("FLOW_"), // find env start with FLOW_ and put to cmd result output map
             null,
             Lists.newArrayList("sleep 20", "echo $FLOW_INPUT", "echo $PWD", "export FLOW_TEST=112233", "cd ~/"));