Add GitHub scm source implementation for status checks properties

pom.xml

@@ -25,7 +25,7 @@
     <useBeta>true</useBeta>
 
     <!-- Jenkins Plug-in Dependencies Versions -->
-    <checks-api.version>1.0.2</checks-api.version>
+    <checks-api.version>2.0.0-SNAPSHOT</checks-api.version>
     <plugin-util-api.version>1.3.0</plugin-util-api.version>
     <github-branch-source.version>2.9.1</github-branch-source.version>
 

src/main/java/io/jenkins/plugins/checks/github/GitHubSCMSourceStatusChecksProperties.java

@@ -0,0 +1,69 @@
+package io.jenkins.plugins.checks.github;
+
+import edu.hm.hafner.util.VisibleForTesting;
+import hudson.Extension;
+import hudson.model.Job;
+import io.jenkins.plugins.checks.status.StatusChecksProperties;
+import org.jenkinsci.plugins.github_branch_source.GitHubSCMSource;
+
+import java.util.Optional;
+
+/**
+ * Implementing {@link StatusChecksProperties} to retrieve properties from jobs with
+ * {@link GitHubSCMSourceStatusChecksTrait}.
+ */
+@Extension
+public class GitHubSCMSourceStatusChecksProperties implements StatusChecksProperties {
+    private final SCMFacade scmFacade;
+
+    /**
+     * Default constructor.
+     */
+    public GitHubSCMSourceStatusChecksProperties() {
+        this(new SCMFacade());
+    }
+
+    @VisibleForTesting
+    GitHubSCMSourceStatusChecksProperties(final SCMFacade scmFacade) {
+        this.scmFacade = scmFacade;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean isApplicable(final Job<?, ?> job) {
+        return scmFacade.findGitHubSCMSource(job).isPresent();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String getName(final Job<?, ?> job) {
+        Optional<GitHubSCMSource> source = scmFacade.findGitHubSCMSource(job);
+        if (!source.isPresent()) {
+            return "";
+        }
+
+        return getStatusChecksTrait(source.get()).getName();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean isSkipped(final Job<?, ?> job) {
+        Optional<GitHubSCMSource> source = scmFacade.findGitHubSCMSource(job);
+        return source.filter(s -> getStatusChecksTrait(s).isSkip()).isPresent();
+    }
+
+    private GitHubSCMSourceStatusChecksTrait getStatusChecksTrait(final GitHubSCMSource source) {
+        return source.getTraits()
+                .stream()
+                .filter(t -> t instanceof GitHubSCMSourceStatusChecksTrait)
+                .findFirst()
+                .map(t -> (GitHubSCMSourceStatusChecksTrait)t)
+                .orElseThrow(IllegalStateException::new);
+    }
+}

src/main/java/io/jenkins/plugins/checks/github/GitHubSCMSourceStatusChecksTrait.java

@@ -0,0 +1,116 @@
+package io.jenkins.plugins.checks.github;
+
+import hudson.Extension;
+import hudson.util.FormValidation;
+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.apache.commons.lang3.StringUtils;
+import org.jenkinsci.plugins.github_branch_source.GitHubSCMSource;
+import org.jenkinsci.plugins.github_branch_source.GitHubSCMSourceContext;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+import org.kohsuke.stapler.QueryParameter;
+
+/**
+ * Traits to control {@link io.jenkins.plugins.checks.status.StatusChecksProperties} for jobs using
+ * {@link GitHubSCMSource}.
+ */
+public class GitHubSCMSourceStatusChecksTrait extends SCMSourceTrait {
+    private boolean skip = false;
+    private String name = "Jenkins";
+
+    /**
+     * Constructor for stapler.
+     */
+    @DataBoundConstructor
+    public GitHubSCMSourceStatusChecksTrait() {
+        super();
+    }
+
+    /**
+     * Defines the status checks name which is also used as identifier for GitHub checks.
+     *
+     * @return the name of status checks
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Defines whether to skip publishing status checks.
+     *
+     * @return true to skip publishing checks
+     */
+    public boolean isSkip() {
+        return skip;
+    }
+
+    /**
+     * Set the name of the status checks.
+     *
+     * @param name
+     *         name of the checks
+     */
+    @DataBoundSetter
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+    /**
+     * Set if skip publishing status checks.
+     *
+     * @param skip
+     *         true if skip
+     */
+    @DataBoundSetter
+    public void setSkip(final boolean skip) {
+        this.skip = skip;
+    }
+
+    /**
+     * Descriptor implementation for {@link GitHubSCMSourceStatusChecksTrait}.
+     */
+    @Extension
+    public static class DescriptorImpl extends SCMSourceTraitDescriptor {
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public String getDisplayName() {
+            return "Status Checks Properties";
+        }
+
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public Class<? extends SCMSourceContext> getContextClass() {
+            return GitHubSCMSourceContext.class;
+        }
+
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public Class<? extends SCMSource> getSourceClass() {
+            return GitHubSCMSource.class;
+        }
+
+        /**
+         * Checks if the name of status checks is valid.
+         *
+         * @param name
+         *         name of status checks
+         * @return ok if the name is not empty
+         */
+        public FormValidation doCheckName(@QueryParameter final String name) {
+            if (StringUtils.isBlank(name)) {
+                return FormValidation.error("Name should not be empty!");
+            }
+
+            return FormValidation.ok();
+        }
+    }
+}

src/main/resources/io/jenkins/plugins/checks/github/GitHubSCMSourceStatusChecksTrait/config.jelly

@@ -0,0 +1,12 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
+
+  <f:entry title="Skip Publishing Status Checks" field="skip">
+    <f:checkbox default="false"/>
+  </f:entry>
+
+  <f:entry title="Status Checks Name" field="name">
+    <f:textbox default="Jenkins"/>
+  </f:entry>
+
+</j:jelly>