optimize logic where env variables in run shell cmd

Author: Yang Guo

platform-api/src/main/java/com/flow/platform/api/domain/EnvObject.java

@@ -17,23 +17,31 @@
 package com.flow.platform.api.domain;
 
 import com.flow.platform.api.envs.EnvKey;
+import com.flow.platform.api.envs.EnvUtil;
 import com.flow.platform.api.envs.EnvValue;
 import com.flow.platform.domain.Jsonable;
 import com.flow.platform.yml.parser.annotations.YmlSerializer;
 import com.google.gson.annotations.Expose;
-import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.Map;
 
 /**
  * The object with environment variables map
  *
  * @author yang
  */
-public abstract class EnvObject extends Jsonable {
+public class EnvObject extends Jsonable {
 
     @YmlSerializer(required = false)
     @Expose
-    protected Map<String, String> envs = new HashMap<>();
+    protected Map<String, String> envs = new LinkedHashMap<>();
+
+    public EnvObject() {
+    }
+
+    public EnvObject(Map<String, String> envs) {
+        this.envs = envs;
+    }
 
     public Map<String, String> getEnvs() {
         return envs;
@@ -82,6 +90,10 @@ public void putEnv(EnvKey key, String value) {
         envs.put(key.name(), value);
     }
 
+    public void putAll(Map<String, String> envs) {
+        EnvUtil.merge(envs, this.envs, true);
+    }
+
     public void removeEnv(EnvKey key) {
         envs.remove(key.name());
     }

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

@@ -16,12 +16,12 @@
 
 package com.flow.platform.api.service.job;
 
+import com.flow.platform.api.domain.EnvObject;
 import com.flow.platform.api.domain.job.Job;
 import com.flow.platform.api.domain.node.Node;
 import com.flow.platform.core.exception.IllegalStatusException;
 import com.flow.platform.domain.AgentPath;
 import com.flow.platform.domain.CmdInfo;
-import java.util.Map;
 
 /**
  * Control center cmd service gateway
@@ -49,7 +49,7 @@ public interface CmdService {
      * @return CmdInfo instance
      * @throws IllegalStatusException throw cmd cannot be sent
      */
-    CmdInfo runShell(Job job, Node node, String cmdId, Map<String, String> extra);
+    CmdInfo runShell(Job job, Node node, String cmdId, EnvObject envVars);
 
     /**
      * Send shutdown cmd to agent, and shutdown host machine

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

@@ -16,10 +16,11 @@
 
 package com.flow.platform.api.service.job;
 
-import com.flow.platform.api.envs.AgentEnvs;
-import com.flow.platform.api.envs.FlowEnvs;
+import com.flow.platform.api.domain.EnvObject;
 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.FlowEnvs;
 import com.flow.platform.api.util.PlatformURL;
 import com.flow.platform.core.exception.HttpException;
 import com.flow.platform.core.exception.IllegalParameterException;
@@ -35,9 +36,7 @@
 import com.flow.platform.util.http.HttpResponse;
 import com.flow.platform.util.http.HttpURL;
 import com.google.common.base.Strings;
-import com.google.common.collect.ImmutableMap;
 import java.io.UnsupportedEncodingException;
-import java.util.Map;
 import org.apache.http.entity.ContentType;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -102,20 +101,15 @@ public void deleteSession(Job job) {
     }
 
     @Override
-    public CmdInfo runShell(Job job, Node node, String cmdId, Map<String, String> extra) {
-        Map<String, String> envs = ImmutableMap.<String, String>builder()
-            .putAll(node.getEnvs())
-            .putAll(extra)
-            .build();
-
+    public CmdInfo runShell(Job job, Node node, String cmdId, EnvObject envVars) {
         CmdInfo cmdInfo = new CmdInfo(zone, null, CmdType.RUN_SHELL, node.getScript());
-        cmdInfo.setInputs(envs);
+        cmdInfo.setInputs(envVars.getEnvs());
         cmdInfo.setWebhook(buildCmdWebhook(job));
-        cmdInfo.setOutputEnvFilter(job.getEnv(FlowEnvs.FLOW_ENV_OUTPUT_PREFIX, "FLOW_OUTPUT"));
+        cmdInfo.setOutputEnvFilter(envVars.getEnv(FlowEnvs.FLOW_ENV_OUTPUT_PREFIX, "FLOW_OUTPUT"));
         cmdInfo.setSessionId(job.getSessionId());
         cmdInfo.setExtra(node.getPath()); // use cmd.extra to keep node path info
         cmdInfo.setCustomizedId(cmdId);
-        cmdInfo.setWorkingDir(job.getEnv(AgentEnvs.FLOW_AGENT_WORKSPACE, null));
+        cmdInfo.setWorkingDir(envVars.getEnv(AgentEnvs.FLOW_AGENT_WORKSPACE, null));
 
         try {
             LOGGER.traceMarker("RunShell", "step name - %s, node path - %s", node.getName(), node.getPath());

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

@@ -27,6 +27,7 @@
 import com.flow.platform.api.dao.job.JobYmlDao;
 import com.flow.platform.api.dao.job.NodeResultDao;
 import com.flow.platform.api.domain.CmdCallbackQueueItem;
+import com.flow.platform.api.domain.EnvObject;
 import com.flow.platform.api.domain.job.Job;
 import com.flow.platform.api.domain.job.JobCategory;
 import com.flow.platform.api.domain.job.JobStatus;
@@ -362,21 +363,23 @@ private void run(Node node, Job job) {
             return;
         }
 
-        // pass job env to node
-        EnvUtil.merge(job.getEnvs(), node.getEnvs(), false);
+        // create env vars instance which will pass to agent
+        EnvObject envVars = new EnvObject();
+        envVars.putAll(job.getEnvs());
 
         // pass root node output to current node
         NodeResult rootResult = nodeResultService.find(tree.root().getPath(), job.getId());
-        EnvUtil.merge(rootResult.getOutputs(), node.getEnvs(), false);
+        envVars.putAll(rootResult.getOutputs());
 
         // to run node with customized cmd id
         try {
             NodeResult nodeResult = nodeResultService.find(node.getPath(), job.getId());
 
             Map<String, String> credentialEnvs = credentialService.find(node);
             EnvUtil.keepNewlineForEnv(credentialEnvs, null);
+            envVars.putAll(credentialEnvs);
 
-            CmdInfo cmd = cmdService.runShell(job, node, nodeResult.getCmdId(), credentialEnvs);
+            CmdInfo cmd = cmdService.runShell(job, node, nodeResult.getCmdId(), envVars);
         } catch (IllegalStatusException e) {
             CmdInfo rawCmd = (CmdInfo) e.getData();
             rawCmd.setStatus(CmdStatus.EXCEPTION);