write git patchset vars to job context

gy2006 · gy2006 · commit 858662cc3f01 · 2022-01-27T22:14:56.000+01:00
diff --git a/core/src/main/java/com/flowci/core/common/domain/Variables.java b/core/src/main/java/com/flowci/core/common/domain/Variables.java
@@ -129,18 +129,10 @@ public abstract static class Git {
          * Push / Tag variables
          */
         public static final String PUSH_AUTHOR = "FLOWCI_GIT_AUTHOR";
-
         public static final String PUSH_BRANCH = "FLOWCI_GIT_BRANCH";
-
         public static final String PUSH_MESSAGE = "FLOWCI_GIT_COMMIT_MESSAGE";
-
         public static final String PUSH_COMMIT_TOTAL = "FLOWCI_GIT_COMMIT_TOTAL";
-
-        /**
-         * b64 json content
-         */
-        public static final String PUSH_COMMIT_LIST = "FLOWCI_GIT_COMMIT_LIST";
-
+        public static final String PUSH_COMMIT_LIST = "FLOWCI_GIT_COMMIT_LIST"; // b64 json
         public static final Collection<String> PUSH_TAG_VARS = ImmutableList.<String>builder()
                 .add(PUSH_AUTHOR)
                 .add(PUSH_BRANCH)
@@ -153,31 +145,18 @@ public abstract static class Git {
          * Variables for git pull(mr) request
          */
         public static final String PR_TITLE = "FLOWCI_GIT_PR_TITLE";
-
         public static final String PR_MESSAGE = "FLOWCI_GIT_PR_MESSAGE";
-
         public static final String PR_AUTHOR = "FLOWCI_GIT_AUTHOR";
-
         public static final String PR_URL = "FLOWCI_GIT_PR_URL";
-
         public static final String PR_TIME = "FLOWCI_GIT_PR_TIME";
-
         public static final String PR_NUMBER = "FLOWCI_GIT_PR_NUMBER";
-
         public static final String PR_IS_MERGED = "FLOWCI_GIT_PR_IS_MERGED";
-
         public static final String PR_HEAD_REPO_NAME = "FLOWCI_GIT_PR_HEAD_REPO_NAME";
-
         public static final String PR_HEAD_REPO_BRANCH = "FLOWCI_GIT_PR_HEAD_REPO_BRANCH";
-
         public static final String PR_HEAD_REPO_COMMIT = "FLOWCI_GIT_PR_HEAD_REPO_COMMIT";
-
         public static final String PR_BASE_REPO_NAME = "FLOWCI_GIT_PR_BASE_REPO_NAME";
-
         public static final String PR_BASE_REPO_BRANCH = "FLOWCI_GIT_PR_BASE_REPO_BRANCH";
-
         public static final String PR_BASE_REPO_COMMIT = "FLOWCI_GIT_PR_BASE_REPO_COMMIT";
-
         public static final Collection<String> PR_VARS = ImmutableList.<String>builder()
                 .add(PR_TITLE)
                 .add(PR_MESSAGE)
@@ -194,5 +173,40 @@ public abstract static class Git {
                 .add(PR_BASE_REPO_COMMIT)
                 .build();
 
+        /**
+         * Variables for gerrit patchset
+         */
+        public static final String PATCHSET_SUBJECT = "FLOWCI_GIT_PATCHSET_SUBJECT";
+        public static final String PATCHSET_MESSAGE = "FLOWCI_GIT_PATCHSET_MESSAGE";
+        public static final String PATCHSET_PROJECT = "FLOWCI_GIT_PATCHSET_PROJECT";
+        public static final String PATCHSET_BRANCH = "FLOWCI_GIT_PATCHSET_BRANCH";
+        public static final String PATCHSET_CHANGE_ID = "FLOWCI_GIT_PATCHSET_CHANGE_ID";
+        public static final String PATCHSET_CHANGE_NUM = "FLOWCI_GIT_PATCHSET_CHANGE_NUM";
+        public static final String PATCHSET_CHANGE_URL = "FLOWCI_GIT_PATCHSET_CHANGE_URL";
+        public static final String PATCHSET_PATCH_NUM = "FLOWCI_GIT_PATCHSET_PATCH_NUM";
+        public static final String PATCHSET_PATCH_URL = "FLOWCI_GIT_PATCHSET_PATCH_URL";
+        public static final String PATCHSET_REVISION = "FLOWCI_GIT_PATCHSET_REVISION";
+        public static final String PATCHSET_REF = "FLOWCI_GIT_PATCHSET_REF";
+        public static final String PATCHSET_CREATE_TIME = "FLOWCI_GIT_PATCHSET_CREATE_TIME";
+        public static final String PATCHSET_INSERT_SIZE = "FLOWCI_GIT_PATCHSET_INSERT_SIZE";
+        public static final String PATCHSET_DELETE_SIZE = "FLOWCI_GIT_PATCHSET_DELETE_SIZE";
+        public static final String PATCHSET_AUTHOR = "FLOWCI_GIT_PATCHSET_AUTHOR";
+        public static final Collection<String> PATCH_VARS = ImmutableList.<String>builder()
+                .add(PATCHSET_SUBJECT)
+                .add(PATCHSET_MESSAGE)
+                .add(PATCHSET_PROJECT)
+                .add(PATCHSET_BRANCH)
+                .add(PATCHSET_CHANGE_ID)
+                .add(PATCHSET_CHANGE_NUM)
+                .add(PATCHSET_CHANGE_URL)
+                .add(PATCHSET_PATCH_NUM)
+                .add(PATCHSET_PATCH_URL)
+                .add(PATCHSET_REVISION)
+                .add(PATCHSET_REF)
+                .add(PATCHSET_CREATE_TIME)
+                .add(PATCHSET_INSERT_SIZE)
+                .add(PATCHSET_DELETE_SIZE)
+                .add(PATCHSET_AUTHOR)
+                .build();
     }
 }
diff --git a/core/src/main/java/com/flowci/core/githook/domain/GitPatchSetTrigger.java b/core/src/main/java/com/flowci/core/githook/domain/GitPatchSetTrigger.java
@@ -1,9 +1,12 @@
 package com.flowci.core.githook.domain;
 
+import com.flowci.domain.StringVars;
 import com.flowci.util.StringHelper;
 import lombok.Getter;
 import lombok.Setter;
 
+import static com.flowci.core.common.domain.Variables.Git.*;
+
 /**
  * Git trigger to handle gerrit patchset-created event
  */
@@ -41,6 +44,27 @@ public class GitPatchSetTrigger extends GitTrigger {
 
     private GitUser author;
 
+    @Override
+    public StringVars toVariableMap() {
+        var map = super.toVariableMap();
+        map.put(PATCHSET_SUBJECT, subject);
+        map.put(PATCHSET_MESSAGE, message);
+        map.put(PATCHSET_PROJECT, project);
+        map.put(PATCHSET_BRANCH, branch);
+        map.put(PATCHSET_CHANGE_ID, changeId);
+        map.put(PATCHSET_CHANGE_NUM, String.valueOf(changeNumber));
+        map.put(PATCHSET_CHANGE_URL, changeUrl);
+        map.put(PATCHSET_PATCH_NUM, String.valueOf(patchNumber));
+        map.put(PATCHSET_PATCH_URL, patchUrl);
+        map.put(PATCHSET_REVISION, revision);
+        map.put(PATCHSET_REF, ref);
+        map.put(PATCHSET_CREATE_TIME, createdOn);
+        map.put(PATCHSET_INSERT_SIZE, String.valueOf(sizeInsertions));
+        map.put(PATCHSET_DELETE_SIZE, String.valueOf(sizeDeletions));
+        map.put(PATCHSET_AUTHOR, author.getEmail());
+        return map;
+    }
+
     @Override
     public boolean isSkip() {
         return StringHelper.hasValue(message) && message.contains(SkipMessage);
diff --git a/core/src/main/java/com/flowci/core/githook/domain/GitTrigger.java b/core/src/main/java/com/flowci/core/githook/domain/GitTrigger.java
@@ -22,7 +22,6 @@
 import com.flowci.domain.StringVars;
 import com.flowci.exception.NotFoundException;
 import com.flowci.util.StringHelper;
-import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.Setter;
 import lombok.ToString;
@@ -36,7 +35,6 @@
 @Getter
 @Setter
 @ToString(of = {"source", "event"})
-@EqualsAndHashCode(of = {"source", "event"})
 public abstract class GitTrigger implements Serializable {
 
     protected final static String SkipMessage = "[ci skip]";
@@ -90,6 +88,10 @@ public Trigger toJobTrigger() {
             return Trigger.PR_MERGED;
         }
 
+        if (event == GitEvent.PATCHSET_UPDATE) {
+            return Trigger.PATCHSET;
+        }
+
         throw new NotFoundException("Cannot found related job trigger for {0}", event.name());
     }
 
@@ -100,7 +102,7 @@ public Trigger toJobTrigger() {
      */
     public abstract String getId();
 
-    protected static String buildId(String ...props) {
+    protected static String buildId(String... props) {
         return StringHelper.toBase64(StringHelper.join(props));
     }
 
diff --git a/core/src/main/java/com/flowci/core/job/domain/Job.java b/core/src/main/java/com/flowci/core/job/domain/Job.java
@@ -88,7 +88,12 @@ public enum Trigger {
         /**
          * Git tag event
          */
-        TAG
+        TAG,
+
+        /**
+         * Git patchset trigger
+         */
+        PATCHSET
     }
 
     public enum Status {
diff --git a/core/src/main/java/com/flowci/core/job/domain/JobItem.java b/core/src/main/java/com/flowci/core/job/domain/JobItem.java
@@ -89,6 +89,15 @@ public Context convert(org.bson.Document source) {
             context.putIfNotEmpty(PR_BASE_REPO_NAME);
             context.putIfNotEmpty(PR_BASE_REPO_BRANCH);
 
+            // git patchset
+            context.putIfNotEmpty(PATCHSET_SUBJECT);
+            context.putIfNotEmpty(PATCHSET_BRANCH);
+            context.putIfNotEmpty(PATCHSET_CHANGE_ID);
+            context.putIfNotEmpty(PATCHSET_PATCH_NUM);
+            context.putIfNotEmpty(PATCHSET_PATCH_URL);
+            context.putIfNotEmpty(PATCHSET_AUTHOR);
+            context.putIfNotEmpty(PATCHSET_REF);
+
             return context;
         }
     }
diff --git a/core/src/main/java/com/flowci/core/job/service/JobServiceImpl.java b/core/src/main/java/com/flowci/core/job/service/JobServiceImpl.java
@@ -436,7 +436,7 @@ private void setTriggerBy(Job job) {
             return;
         }
 
-        String createdBy = context.get(PUSH_AUTHOR, "Unknown");
+        String createdBy = context.get(new String[]{PUSH_AUTHOR, PR_AUTHOR, PATCHSET_AUTHOR}, "Unknown");
         job.setCreatedBy(createdBy);
         context.put(Variables.Job.TriggerBy, createdBy);
     }
diff --git a/domain/src/main/java/com/flowci/domain/Vars.java b/domain/src/main/java/com/flowci/domain/Vars.java
@@ -63,6 +63,17 @@ public V get(String key, V defaultValue) {
         return Objects.isNull(value) ? defaultValue : value;
     }
 
+    public V get(String []keys, V defaultValue) {
+        for (var key : keys) {
+            V value = get(key);
+            if (Objects.isNull(value)) {
+                continue;
+            }
+            return value;
+        }
+        return defaultValue;
+    }
+
     public Vars<V> putAndReturn(String k, V v) {
         put(k, v);
         return this;

Original file line number	Diff line number	Diff line change
`@@ -436,7 +436,7 @@ private void setTriggerBy(Job job) {`
`436`	`436`	`return;`
`437`	`437`	`}`
`438`	`438`
`439`		`- String createdBy = context.get(PUSH_AUTHOR, "Unknown");`
	`439`	`+ String createdBy = context.get(new String[]{PUSH_AUTHOR, PR_AUTHOR, PATCHSET_AUTHOR}, "Unknown");`
`440`	`440`	`job.setCreatedBy(createdBy);`
`441`	`441`	`context.put(Variables.Job.TriggerBy, createdBy);`
`442`	`442`	`}`