Mark unstable build as success on Gitlab (#328)

Co-authored-by: Пятизбянцев Илья Андреевич <ipyatizbyantsev@nicetu.spb.ru>

Author: pyatizbyantsevia

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

@@ -0,0 +1,64 @@
+package io.jenkins.plugins.gitlabbranchsource;
+
+import hudson.Extension;
+import jenkins.scm.api.SCMSource;
+import jenkins.scm.api.trait.SCMSourceContext;
+import jenkins.scm.api.trait.SCMSourceTrait;
+import jenkins.scm.api.trait.SCMSourceTraitDescriptor;
+import org.jenkinsci.Symbol;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+
+public class GitLabMarkUnstableAsSuccessTrait extends SCMSourceTrait {
+
+    private boolean markUnstableAsSuccess = false;
+
+    @DataBoundConstructor
+    public GitLabMarkUnstableAsSuccessTrait() {
+        // empty
+    }
+
+    @DataBoundSetter
+    public void setMarkUnstableAsSuccess(boolean markUnstableAsSuccess) {
+        this.markUnstableAsSuccess = markUnstableAsSuccess;
+    }
+
+    public boolean getMarkUnstableAsSuccess() {
+        return markUnstableAsSuccess;
+    }
+
+    @Override
+    protected void decorateContext(SCMSourceContext<?, ?> context) {
+        if (context instanceof GitLabSCMSourceContext) {
+            GitLabSCMSourceContext ctx = (GitLabSCMSourceContext) context;
+            ctx.withMarkUnstableAsSuccess(doMarkUnstableAsSuccess());
+        }
+    }
+
+    public boolean doMarkUnstableAsSuccess() {
+        return markUnstableAsSuccess;
+    }
+
+    /**
+     * Our descriptor.
+     */
+    @Extension
+    @Symbol("gitlabMarkUnstableAsSuccess")
+    public static class DescriptorImpl extends SCMSourceTraitDescriptor {
+
+        @Override
+        public String getDisplayName() {
+            return Messages.GitLabMarkUnstableAsSuccessTrait_displayName();
+        }
+
+        @Override
+        public Class<? extends SCMSourceContext> getContextClass() {
+            return GitLabSCMSourceContext.class;
+        }
+
+        @Override
+        public Class<? extends SCMSource> getSourceClass() {
+            return GitLabSCMSource.class;
+        }
+    }
+}

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

@@ -71,6 +71,8 @@ public class GitLabSCMSourceContext extends SCMSourceContext<GitLabSCMSourceCont
 
     private boolean alwaysIgnoreMRWorkInProgress = false;
 
+    private boolean markUnstableAsSuccess = false;
+
     public GitLabSCMSourceContext(@CheckForNull SCMSourceCriteria criteria, @NonNull SCMHeadObserver observer) {
         super(criteria, observer);
     }
@@ -147,6 +149,10 @@ public final boolean getOnlyTrustedMembersCanTrigger() {
         return onlyTrustedMembersCanTrigger;
     }
 
+    public final boolean getMarkUnstableAsSuccess() {
+        return markUnstableAsSuccess;
+    }
+
     public boolean alwaysBuildMROpen() {
         return alwaysBuildMROpen;
     }
@@ -261,6 +267,12 @@ public final GitLabSCMSourceContext withProjectAvatarDisabled(boolean disabled)
         return this;
     }
 
+    @NonNull
+    public final GitLabSCMSourceContext withMarkUnstableAsSuccess(boolean disabled) {
+        this.markUnstableAsSuccess = disabled;
+        return this;
+    }
+
     @NonNull
     public final GitLabSCMSourceContext withLogCommentEnabled(boolean enabled) {
         this.logCommentEnabled = enabled;

src/main/java/io/jenkins/plugins/gitlabbranchsource/helpers/GitLabPipelineStatusNotifier.java

@@ -311,8 +311,13 @@ private static void sendNotifications(Run<?, ?> build, TaskListener listener) {
             state = Constants.CommitBuildState.SUCCESS;
         } else if (Result.UNSTABLE.equals(result)) {
             status.setDescription(build.toString() + ": This commit is unstable with partial failure.");
-            status.setStatus("FAILED");
-            state = Constants.CommitBuildState.FAILED;
+            if (sourceContext.getMarkUnstableAsSuccess()) {
+                status.setStatus("SUCCESS");
+                state = Constants.CommitBuildState.SUCCESS;
+            } else {
+                status.setStatus("FAILED");
+                state = Constants.CommitBuildState.FAILED;
+            }
         } else if (Result.FAILURE.equals(result)) {
             status.setDescription(build.toString() + ": There was a failure building this commit.");
             status.setStatus("FAILED");

src/main/resources/io/jenkins/plugins/gitlabbranchsource/GitLabMarkUnstableAsSuccessTrait/config.jelly

@@ -0,0 +1,6 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
+    <f:entry title="${%Mark unstable as success}" field="markUnstableAsSuccess">
+        <f:checkbox default="true"/>
+    </f:entry>
+</j:jelly>

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

@@ -60,3 +60,4 @@ 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}
 WebhookListenerBuildConditionsTrait.displayName=Webhook Listener Conditions
+GitLabMarkUnstableAsSuccessTrait.displayName=Mark unstable build as successful on Gitlab