add web hook cause (#36)

Author: jetersen

src/main/java/io/jenkins/plugins/gitlabbranchsource/AbstractGitLabSCMHeadEvent.java

@@ -49,4 +49,6 @@ public boolean isMatch(@NonNull SCM scm) {
     @NonNull
     protected abstract Map<SCMHead, SCMRevision> headsFor(GitLabSCMSource source);
 
+    public abstract GitLabWebHookCause getCause();
+
 }

src/main/java/io/jenkins/plugins/gitlabbranchsource/GitLabMergeRequestSCMEvent.java

@@ -164,4 +164,9 @@ public Map<SCMHead, SCMRevision> headsFor(GitLabSCMSource source) {
         return result;
     }
 
+    @Override
+    public GitLabWebHookCause getCause() {
+        return new GitLabWebHookCause().fromMergeRequest(getPayload());
+    }
+
 }

src/main/java/io/jenkins/plugins/gitlabbranchsource/GitLabPushSCMEvent.java

@@ -86,4 +86,10 @@ public Map<SCMHead, SCMRevision> headsFor(GitLabSCMSource source) {
             StringUtils.isNotBlank(getPayload().getAfter())
                 ? new BranchSCMRevision(h, getPayload().getAfter()) : null);
     }
+
+    @Override
+    public GitLabWebHookCause getCause() {
+        return new GitLabWebHookCause().fromPush(getPayload());
+    }
+
 }

src/main/java/io/jenkins/plugins/gitlabbranchsource/GitLabSCMCauseAction.java

@@ -0,0 +1,17 @@
+package io.jenkins.plugins.gitlabbranchsource;
+
+import hudson.model.Cause;
+import hudson.model.CauseAction;
+
+public class GitLabSCMCauseAction extends CauseAction {
+
+    public GitLabSCMCauseAction(Cause... causes) {
+        super(causes);
+    }
+
+    public String getDescription() {
+        GitLabWebHookCause cause = findCause(GitLabWebHookCause.class);
+        return (cause != null) ? cause.getShortDescription() : null;
+    }
+
+}

src/main/java/io/jenkins/plugins/gitlabbranchsource/GitLabSCMSource.java

@@ -633,6 +633,10 @@ protected List<Action> retrieveActions(@NonNull SCMRevision revision, SCMHeadEve
             actions.add(GitLabLink.toCommit(commitUrl));
         }
 
+        if (event instanceof AbstractGitLabSCMHeadEvent) {
+            actions.add(new GitLabSCMCauseAction(((AbstractGitLabSCMHeadEvent) event).getCause()));
+        }
+
         return actions;
     }
 

src/main/java/io/jenkins/plugins/gitlabbranchsource/GitLabTagPushSCMEvent.java

@@ -84,4 +84,9 @@ public Map<SCMHead, SCMRevision> headsFor(GitLabSCMSource source) {
                 ? new GitTagSCMRevision(h, hash) : null);
     }
 
+    @Override
+    public GitLabWebHookCause getCause() {
+        return new GitLabWebHookCause().fromTag(getPayload());
+    }
+
 }

src/main/java/io/jenkins/plugins/gitlabbranchsource/GitLabWebHookCause.java

@@ -0,0 +1,69 @@
+package io.jenkins.plugins.gitlabbranchsource;
+
+import hudson.triggers.SCMTrigger.SCMTriggerCause;
+import org.apache.commons.lang.StringUtils;
+import org.gitlab4j.api.webhook.MergeRequestEvent;
+import org.gitlab4j.api.webhook.MergeRequestEvent.ObjectAttributes;
+import org.gitlab4j.api.webhook.PushEvent;
+import org.gitlab4j.api.webhook.TagPushEvent;
+
+public class GitLabWebHookCause extends SCMTriggerCause {
+
+    private String description;
+
+    public GitLabWebHookCause() {
+        super("");
+    }
+
+    public GitLabWebHookCause fromPush(PushEvent pushEvent) {
+        String userName = pushEvent.getUserName();
+        if (StringUtils.isBlank(userName)) {
+            description = Messages.GitLabWebHookCause_ShortDescription_Push_noUser();
+        } else {
+            description = Messages.GitLabWebHookCause_ShortDescription_Push(userName);
+        }
+        return this;
+    }
+
+    public GitLabWebHookCause fromMergeRequest(MergeRequestEvent mergeRequestEvent) {
+        ObjectAttributes objectAttributes = mergeRequestEvent.getObjectAttributes();
+        String id = String.valueOf(objectAttributes.getIid());
+        String sourceNameSpace = objectAttributes.getSource().getNamespace();
+        String targetNameSpace = objectAttributes.getTarget().getNamespace();
+        String nameSpace =
+            StringUtils.equals(sourceNameSpace, targetNameSpace) ? "" : sourceNameSpace + "/";
+        String source = String.format("%s%s", nameSpace, objectAttributes.getSourceBranch());
+        description = Messages.GitLabWebHookCause_ShortDescription_MergeRequestHook(
+            id, source, objectAttributes.getTargetBranch());
+        return this;
+    }
+
+    public GitLabWebHookCause fromTag(TagPushEvent tagPushEvent) {
+        String userName = tagPushEvent.getUserName();
+        if (StringUtils.isBlank(userName)) {
+            description = Messages.GitLabWebHookCause_ShortDescription_Push_noUser();
+        } else {
+            description = Messages.GitLabWebHookCause_ShortDescription_Push(userName);
+        }
+        return this;
+    }
+
+    @Override
+    public String getShortDescription() {
+        return description;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!super.equals(o)) {
+            return false;
+        }
+        return o instanceof GitLabWebHookCause;
+    }
+
+    @Override
+    public int hashCode() {
+        return super.hashCode();
+    }
+
+}

src/main/resources/io/jenkins/plugins/gitlabbranchsource/Messages.properties

@@ -48,3 +48,6 @@ HookRegistrationTrait.useSystem=Use System credentials for {0} management mode (
 SkipNotificationsTrait.displayName=Skip pipeline status notifications
 LogCommentTrait.displayName=Log build status as comment on GitLab
 TriggerMRCommentTrait.displayName=Trigger build on merge request comment
+GitLabWebHookCause.ShortDescription.Push_noUser=Started by GitLab push
+GitLabWebHookCause.ShortDescription.Push=Started by GitLab push by {0}
+GitLabWebHookCause.ShortDescription.MergeRequestHook=Triggered by GitLab Merge Request #{0}: {1} => {2}