Add GitHub branch and pull request info to the 'Details' widget

pom.xml

@@ -35,7 +35,7 @@
     <hpi.compatibleSinceVersion>2.2.0</hpi.compatibleSinceVersion>
     <!-- https://www.jenkins.io/doc/developer/plugin-development/choosing-jenkins-baseline/ -->
     <jenkins.baseline>2.504</jenkins.baseline>
-    <jenkins.version>${jenkins.baseline}.1</jenkins.version>
+    <jenkins.version>${jenkins.baseline}.3</jenkins.version>
     <spotless.check.skip>false</spotless.check.skip>
   </properties>
 
@@ -44,7 +44,7 @@
       <dependency>
         <groupId>io.jenkins.tools.bom</groupId>
         <artifactId>bom-${jenkins.baseline}.x</artifactId>
-        <version>5294.va_d2e144c80e1</version>
+        <version>5506.va_222b_131ec34</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubBranchDetail.java

@@ -0,0 +1,42 @@
+package org.jenkinsci.plugins.github_branch_source;
+
+import edu.umd.cs.findbugs.annotations.Nullable;
+import hudson.model.Actionable;
+import hudson.model.Run;
+import jenkins.model.details.Detail;
+import jenkins.model.details.DetailGroup;
+import jenkins.scm.api.SCMDetailGroup;
+import jenkins.scm.api.metadata.ObjectMetadataAction;
+
+public class GitHubBranchDetail extends Detail {
+    public GitHubBranchDetail(Actionable object) {
+        super(object);
+    }
+
+    @Nullable
+    @Override
+    public String getIconClassName() {
+        return "symbol-git-branch-outline plugin-ionicons-api";
+    }
+
+    @Nullable
+    @Override
+    public String getDisplayName() {
+        return getObjectMetadataAction().getObjectDisplayName();
+    }
+
+    @Override
+    public String getLink() {
+        return getObjectMetadataAction().getObjectUrl();
+    }
+
+    @Override
+    public DetailGroup getGroup() {
+        return SCMDetailGroup.get();
+    }
+
+    private ObjectMetadataAction getObjectMetadataAction() {
+        Run<?, ?> run = (Run<?, ?>) getObject();
+        return run.getParent().getAction(ObjectMetadataAction.class);
+    }
+}

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubCommitDetail.java

@@ -0,0 +1,75 @@
+package org.jenkinsci.plugins.github_branch_source;
+
+import hudson.model.Actionable;
+import hudson.model.Run;
+import jenkins.model.details.Detail;
+import jenkins.model.details.DetailGroup;
+import jenkins.plugins.git.AbstractGitSCMSource;
+import jenkins.scm.api.SCMDetailGroup;
+import jenkins.scm.api.SCMRevision;
+import jenkins.scm.api.SCMRevisionAction;
+
+public class GitHubCommitDetail extends Detail {
+    public GitHubCommitDetail(Actionable object) {
+        super(object);
+    }
+
+    public String getIconClassName() {
+        return "symbol-git-commit-outline plugin-ionicons-api";
+    }
+
+    @Override
+    public String getDisplayName() {
+        SCMRevision revision = getRevision();
+
+        if (revision == null) {
+            return null;
+        }
+
+        if (revision instanceof AbstractGitSCMSource.SCMRevisionImpl abstractRevision) {
+            return abstractRevision.getHash().substring(0, 7);
+        }
+
+        if (revision instanceof PullRequestSCMRevision pullRequestSCMRevision) {
+            return pullRequestSCMRevision.getPullHash().substring(0, 7);
+        }
+
+        return null;
+    }
+
+    @Override
+    public String getLink() {
+        SCMRevision revision = getRevision();
+
+        if (revision == null) {
+            return null;
+        }
+
+        if (revision instanceof AbstractGitSCMSource.SCMRevisionImpl abstractRevision) {
+            return new GitHubRepositoryDetail(getObject()).getLink() + "/commit/" + abstractRevision.getHash();
+        }
+
+        if (revision instanceof PullRequestSCMRevision pullRequestSCMRevision) {
+            Run<?, ?> run = (Run<?, ?>) getObject();
+            GitHubLink repoLink = run.getParent().getAction(GitHubLink.class);
+            return repoLink.getUrl() + "/commits/" + pullRequestSCMRevision.getPullHash();
+        }
+
+        return null;
+    }
+
+    @Override
+    public DetailGroup getGroup() {
+        return SCMDetailGroup.get();
+    }
+
+    private SCMRevision getRevision() {
+        SCMRevisionAction scmRevisionAction = getObject().getAction(SCMRevisionAction.class);
+
+        if (scmRevisionAction == null) {
+            return null;
+        }
+
+        return scmRevisionAction.getRevision();
+    }
+}

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubDetailFactory.java

@@ -0,0 +1,53 @@
+package org.jenkinsci.plugins.github_branch_source;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.Extension;
+import hudson.model.Run;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import jenkins.model.details.Detail;
+import jenkins.model.details.DetailFactory;
+import jenkins.scm.api.SCMRevision;
+import jenkins.scm.api.SCMRevisionAction;
+import jenkins.scm.api.SCMSource;
+
+@Extension
+public final class GitHubDetailFactory extends DetailFactory<Run> {
+
+    @Override
+    public Class<Run> type() {
+        return Run.class;
+    }
+
+    @NonNull
+    @Override
+    public List<? extends Detail> createFor(@NonNull Run target) {
+        SCMSource src = SCMSource.SourceByItem.findSource(target.getParent());
+
+        // Don't add details for non-GitHub SCM sources
+        if (!(src instanceof GitHubSCMSource)) {
+            return Collections.emptyList();
+        }
+
+        SCMRevisionAction scmRevisionAction = target.getAction(SCMRevisionAction.class);
+
+        if (scmRevisionAction == null) {
+            return Collections.emptyList();
+        }
+
+        List<Detail> details = new ArrayList<>();
+        SCMRevision revision = scmRevisionAction.getRevision();
+
+        if (revision instanceof PullRequestSCMRevision) {
+            details.add(new GitHubPullRequestDetail(target));
+        } else {
+            details.add(new GitHubBranchDetail(target));
+        }
+
+        details.add(new GitHubCommitDetail(target));
+        details.add(new GitHubRepositoryDetail(target));
+
+        return details;
+    }
+}

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubPullRequestDetail.java

@@ -0,0 +1,42 @@
+package org.jenkinsci.plugins.github_branch_source;
+
+import edu.umd.cs.findbugs.annotations.Nullable;
+import hudson.model.Actionable;
+import hudson.model.Run;
+import jenkins.model.details.Detail;
+import jenkins.model.details.DetailGroup;
+import jenkins.scm.api.SCMDetailGroup;
+import jenkins.scm.api.metadata.ObjectMetadataAction;
+
+public class GitHubPullRequestDetail extends Detail {
+    public GitHubPullRequestDetail(Actionable object) {
+        super(object);
+    }
+
+    @Nullable
+    @Override
+    public String getIconClassName() {
+        return "symbol-git-pull-request-outline plugin-ionicons-api";
+    }
+
+    @Nullable
+    @Override
+    public String getDisplayName() {
+        return getObjectMetadataAction().getObjectDisplayName();
+    }
+
+    @Override
+    public String getLink() {
+        return getObjectMetadataAction().getObjectUrl();
+    }
+
+    @Override
+    public DetailGroup getGroup() {
+        return SCMDetailGroup.get();
+    }
+
+    private ObjectMetadataAction getObjectMetadataAction() {
+        Run<?, ?> run = (Run<?, ?>) getObject();
+        return run.getParent().getAction(ObjectMetadataAction.class);
+    }
+}

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubRepositoryDetail.java

@@ -0,0 +1,59 @@
+package org.jenkinsci.plugins.github_branch_source;
+
+import edu.umd.cs.findbugs.annotations.Nullable;
+import hudson.model.Actionable;
+import hudson.model.Run;
+import jenkins.model.details.Detail;
+import jenkins.model.details.DetailGroup;
+import jenkins.scm.api.SCMDetailGroup;
+import jenkins.scm.api.SCMSource;
+
+public class GitHubRepositoryDetail extends Detail {
+    public GitHubRepositoryDetail(Actionable object) {
+        super(object);
+    }
+
+    @Nullable
+    @Override
+    public String getIconClassName() {
+        return "symbol-logo-github plugin-ionicons-api";
+    }
+
+    @Nullable
+    @Override
+    public String getDisplayName() {
+        GitHubSCMSource source = getSCMSource();
+
+        if (source == null) {
+            return null;
+        }
+
+        return source.getRepoOwner() + "/" + source.getRepository();
+    }
+
+    @Override
+    public String getLink() {
+        GitHubSCMSource source = getSCMSource();
+
+        if (source == null) {
+            return null;
+        }
+
+        return source.getRepositoryUrl();
+    }
+
+    @Override
+    public DetailGroup getGroup() {
+        return SCMDetailGroup.get();
+    }
+
+    private GitHubSCMSource getSCMSource() {
+        var source = SCMSource.SourceByItem.findSource(((Run) getObject()).getParent());
+
+        if (source instanceof GitHubSCMSource githubSource) {
+            return githubSource;
+        }
+
+        return null;
+    }
+}

src/test/java/org/jenkinsci/plugins/github_branch_source/GitHubBranchDetailTest.java

@@ -0,0 +1,28 @@
+package org.jenkinsci.plugins.github_branch_source;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+import hudson.model.Job;
+import hudson.model.Run;
+import jenkins.scm.api.metadata.ObjectMetadataAction;
+import org.junit.jupiter.api.Test;
+
+class GitHubBranchDetailTest {
+
+    @Test
+    void displaysAsExpected() {
+        Run run = mock(Run.class);
+        Job job = mock(Job.class);
+        when(run.getParent()).thenReturn(job);
+        ObjectMetadataAction metadata = mock(ObjectMetadataAction.class);
+        when(metadata.getObjectDisplayName()).thenReturn("main");
+        when(metadata.getObjectUrl()).thenReturn("https://github.com/octo/hello-world/tree/main");
+        when(job.getAction(ObjectMetadataAction.class)).thenReturn(metadata);
+
+        GitHubBranchDetail detail = new GitHubBranchDetail(run);
+
+        assertEquals("main", detail.getDisplayName());
+        assertEquals("https://github.com/octo/hello-world/tree/main", detail.getLink());
+    }
+}