git-task: default variables (#76)

walmartlabs · Aug 26, 2022 · 311ea60 · 311ea60
1 parent 48c4215
commit 311ea60
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 18 deletions.
diff --git a/tasks/git/src/main/java/com/walmartlabs/concord/plugins/git/GitTask.java b/tasks/git/src/main/java/com/walmartlabs/concord/plugins/git/GitTask.java
@@ -97,7 +97,9 @@ public GitTask(GitSecretService secretService, Path processWorkDir) {
         this.processWorkDir = processWorkDir;
     }
 
-    public Map<String, Object> execute(Map<String, Object> in) throws Exception {
+    public Map<String, Object> execute(Map<String, Object> in, Map<String, Object> defaults) throws Exception {
+        in = merge(in, defaults);
+
         Action action = getAction(in);
         log.info("Starting '{}' action...", action);
 
@@ -201,7 +203,7 @@ private Map<String, Object> doPull(Map<String, Object> in) throws Exception {
                     log.info("Fetch result: '{}'", fetchResult);
                 }
 
-                log.info("Merge result: '{}'", mergeResult.toString());
+                log.info("Merge result: '{}'", mergeResult);
                 log.info("Merge status: '{}'", mergeStatus.toString().toUpperCase());
 
                 switch (mergeStatus) {
@@ -227,7 +229,7 @@ private Map<String, Object> doPull(Map<String, Object> in) throws Exception {
                         if (!fetchResult.isEmpty()) {
                             log.error("Fetch result: '{}'", result.getFetchResult().getMessages());
                         }
-                        log.error("Merge result: '{}'", mergeResult.toString());
+                        log.error("Merge result: '{}'", mergeResult);
                         log.error("Merge status: '{}'", mergeStatus.toString().toUpperCase());
                         throw new IllegalArgumentException("Git pull action failed. Please fix the above errors before retrying...");
                     }
@@ -613,6 +615,12 @@ private static String getHeadSHA(Path dstDir) throws RefNotFoundException {
         }
     }
 
+    private static Map<String, Object> merge(Map<String, Object> in, Map<String, Object> defaults) {
+        Map<String, Object> result = new HashMap<>(defaults != null ? defaults : Collections.emptyMap());
+        result.putAll(in);
+        return result;
+    }
+
     private static Action getAction(Map<String, Object> in) {
         String v = MapUtils.assertString(in, ACTION_KEY);
         try {

diff --git a/tasks/git/src/main/java/com/walmartlabs/concord/plugins/git/v1/GitTaskV1.java b/tasks/git/src/main/java/com/walmartlabs/concord/plugins/git/v1/GitTaskV1.java
@@ -22,10 +22,7 @@
 
 import com.walmartlabs.concord.plugins.git.GitSecretService;
 import com.walmartlabs.concord.plugins.git.GitTask;
-import com.walmartlabs.concord.sdk.Context;
-import com.walmartlabs.concord.sdk.ContextUtils;
-import com.walmartlabs.concord.sdk.SecretService;
-import com.walmartlabs.concord.sdk.Task;
+import com.walmartlabs.concord.sdk.*;
 
 import javax.inject.Inject;
 import javax.inject.Named;
@@ -41,6 +38,9 @@ public class GitTaskV1 implements Task {
     private static final String OUT_KEY = "out";
     private static final String DEFAULT_OUT_VAR_KEY = "result";
 
+    @InjectVariable("gitParams")
+    private Map<String, Object> defaults;
+
     private final SecretService secretService;
 
     @Inject
@@ -51,7 +51,7 @@ public GitTaskV1(SecretService secretService) {
     @Override
     public void execute(Context ctx) throws Exception {
         Map<String, Object> result = new GitTask(new SecretServiceV1(secretService, ctx), ContextUtils.getWorkDir(ctx))
-                .execute(ctx.toMap());
+                .execute(ctx.toMap(), defaults);
 
         String out = ContextUtils.getString(ctx, OUT_KEY, DEFAULT_OUT_VAR_KEY);
         ctx.setVariable(out, result);

diff --git a/tasks/git/src/main/java/com/walmartlabs/concord/plugins/git/v2/GitTaskV2.java b/tasks/git/src/main/java/com/walmartlabs/concord/plugins/git/v2/GitTaskV2.java
@@ -34,16 +34,18 @@
 @Named("git")
 public class GitTaskV2 implements Task {
 
+    private final Context context;
     private final GitTask delegate;
 
     @Inject
-    public GitTaskV2(SecretService secretService, WorkingDirectory workDir) {
-        this.delegate = new GitTask(new SecretServiceV2(secretService), workDir.getValue());
+    public GitTaskV2(Context context) {
+        this.context = context;
+        this.delegate = new GitTask(new SecretServiceV2(context.secretService()), context.workingDirectory());
     }
 
     @Override
     public TaskResult.SimpleResult execute(Variables input) throws Exception {
-        Map<String, Object> result = delegate.execute(input.toMap());
+        Map<String, Object> result = delegate.execute(input.toMap(), context.defaultVariables().toMap());
 
         // we can't change the delegate's return type w/o breaking compatibility with Concord < 1.62.0
         // and we can't break that right now as we don't have a way to properly communicate this breakage

diff --git a/tasks/git/src/test/java/com/walmartlabs/concord/plugins/git/v2/GitTaskV2Test.java b/tasks/git/src/test/java/com/walmartlabs/concord/plugins/git/v2/GitTaskV2Test.java
@@ -25,22 +25,20 @@
 import com.walmartlabs.concord.plugins.git.GitTask;
 import com.walmartlabs.concord.plugins.git.TokenSecret;
 import com.walmartlabs.concord.plugins.git.Utils;
+import com.walmartlabs.concord.runtime.v2.sdk.Context;
 import com.walmartlabs.concord.runtime.v2.sdk.MapBackedVariables;
 import com.walmartlabs.concord.runtime.v2.sdk.SecretService;
 import com.walmartlabs.concord.runtime.v2.sdk.TaskResult;
-import com.walmartlabs.concord.runtime.v2.sdk.WorkingDirectory;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 import static org.junit.jupiter.api.Assertions.*;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 public class GitTaskV2Test {
 
@@ -63,7 +61,12 @@ public void test() throws Exception {
         input.put(GitTask.ACTION_KEY, GitTask.Action.CLONE.name());
         input.put(GitTask.GIT_URL, "https://github.com/walmartlabs/concord-plugins.git");
 
-        GitTaskV2 task = new GitTaskV2(mock(SecretService.class), new WorkingDirectory(workDir));
+        Context context = mock(Context.class);
+        when(context.secretService()).thenReturn(mock(SecretService.class));
+        when(context.workingDirectory()).thenReturn(workDir);
+        when(context.defaultVariables()).thenReturn(new MapBackedVariables(Collections.emptyMap()));
+
+        GitTaskV2 task = new GitTaskV2(context);
         TaskResult.SimpleResult result = task.execute(new MapBackedVariables(input));
         assertTrue(result.ok());
     }

diff --git a/tasks/gremlin/src/main/java/com/walmartlabs/concord/plugins/gremlin/TaskParams.java b/tasks/gremlin/src/main/java/com/walmartlabs/concord/plugins/gremlin/TaskParams.java
@@ -677,7 +677,6 @@ private static Variables merge(Variables variables, Map<String, Object> defaults
         return new MapBackedVariables(variablesMap);
     }
 
-
     public static <E extends Enum<E>> E assertEnum(Variables variables, String name, Class<E> enumData) {
         E result = getEnum(variables, name, enumData, null);
         if (result != null) {