[JENKINS-74970] Could not send notifications to Bitbucket Server when pull request is from fork (#998)

Fix how the API client for Bitbucket Server is built to send build notification status of scm head that comes from a fork. In this case user does not have grants on commits in the forked repository. Build notification status must be always placed in the target repository.

Author: cronik

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/impl/notifier/BitbucketBuildStatusNotifications.java

@@ -218,29 +218,36 @@ private static void sendNotifications(BitbucketSCMSource source, Run<?, ?> build
             .filters().stream()
             .anyMatch(ExcludeOriginPRBranchesSCMHeadFilter.class::isInstance);
 
-        String key;
-        String refName;
-        BitbucketApi bitbucket;
+        final String key;
+        final String refName;
+        final BitbucketApi bitbucket;
         if (rev instanceof PullRequestSCMRevision) {
             listener.getLogger().println("[Bitbucket] Notifying pull request build result");
             PullRequestSCMHead head = (PullRequestSCMHead) rev.getHead();
             key = getBuildKey(build, head.getOriginName(), shareBuildKeyBetweenBranchAndPR);
-            /*
-             * Poor documentation for bitbucket cloud at:
-             * https://community.atlassian.com/t5/Bitbucket-questions/Re-Builds-not-appearing-in-pull-requests/qaq-p/1805991/comment-id/65864#M65864
-             * that means refName null or valued with only head.getBranchName()
-             *
-             * For Bitbucket Server, refName should be "refs/heads/" + the name
-             * of the source branch of the pull request, and the build status
-             * should be posted to the repository that contains that branch.
-             * If refName is null, then Bitbucket Server does not show the
-             * build status in the list of pull requests, but still shows it
-             * on the web page of the individual pull request.
-             */
-            bitbucket = source.buildBitbucketClient(head);
-            if (BitbucketApiUtils.isCloud(bitbucket)) {
+            if (BitbucketApiUtils.isCloud(source.getServerUrl())) {
+                /*
+                 * Poor documentation for bitbucket cloud at:
+                 * https://community.atlassian.com/t5/Bitbucket-questions/Re-Builds-not-appearing-in-pull-requests/qaq-p/1805991/comment-id/65864#M65864
+                 * that means refName null or valued with only head.getBranchName()
+                 */
                 refName = null;
+                bitbucket = source.buildBitbucketClient(head);
             } else {
+                /*
+                 * Head may point to a forked repository that the credentials do
+                 * not have access to, resulting in a 401 error. So we need to
+                 * push build status to the target repository
+                 */
+                bitbucket = source.buildBitbucketClient();
+                /*
+                 * For Bitbucket Server, refName should be "refs/heads/" + the
+                 * name of the source branch of the pull request, and the build
+                 * status should be posted to the repository that contains that
+                 * branch. If refName is null, then Bitbucket Server does not
+                 * show the build status in the list of pull requests, but still
+                 * shows it on the web page of the individual pull request.
+                 */
                 refName = "refs/heads/" + head.getBranchName();
             }
         } else {

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/impl/notifier/BitbucketBuildStatusNotificationsJUnit5Test.java

@@ -27,6 +27,10 @@
 import com.cloudbees.jenkins.plugins.bitbucket.BitbucketMockApiFactory;
 import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSource;
 import com.cloudbees.jenkins.plugins.bitbucket.BranchSCMHead;
+import com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait;
+import com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait.TrustEveryone;
+import com.cloudbees.jenkins.plugins.bitbucket.PullRequestSCMHead;
+import com.cloudbees.jenkins.plugins.bitbucket.PullRequestSCMRevision;
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketApi;
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketBuildStatus;
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketBuildStatus.Status;
@@ -54,16 +58,20 @@
 import jenkins.model.JenkinsLocationConfiguration;
 import jenkins.plugins.git.AbstractGitSCMSource.SCMRevisionImpl;
 import jenkins.scm.api.SCMHead;
+import jenkins.scm.api.SCMHeadOrigin.Fork;
 import jenkins.scm.api.SCMRevision;
 import jenkins.scm.api.SCMRevisionAction;
+import jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy;
 import jenkins.scm.api.trait.SCMSourceTrait;
+import org.apache.commons.codec.digest.DigestUtils;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
 import org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
+import org.jvnet.hudson.test.Issue;
 import org.jvnet.hudson.test.JenkinsRule;
 import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
 import org.mockito.ArgumentCaptor;
@@ -107,8 +115,9 @@ void test_status_notification_for_given_build_result(UnaryOperator<BitbucketBuil
         assertThat(captor.getValue().getState()).isEqualTo(expectedStatus.name());
     }
 
+    @Issue("JENKINS-72780")
     @Test
-    void test_status_notification_for_given_build_result(@NonNull JenkinsRule r) throws Exception {
+    void test_status_notification_name_when_UseReadableNotificationIds_is_true(@NonNull JenkinsRule r) throws Exception {
         StreamBuildListener taskListener = new StreamBuildListener(System.out, StandardCharsets.UTF_8);
         URL jenkinsURL = new URL("http://example.com:" + r.getURL().getPort() + r.contextPath + "/");
         JenkinsLocationConfiguration.get().setUrl(jenkinsURL.toString());
@@ -133,6 +142,41 @@ void test_status_notification_for_given_build_result(@NonNull JenkinsRule r) thr
         assertThat(captor.getValue().getKey()).isEqualTo("P/BRANCH-JOB");
     }
 
+    @Issue("JENKINS-74970")
+    @Test
+    void test_status_notification_on_fork(@NonNull JenkinsRule r) throws Exception {
+        StreamBuildListener taskListener = new StreamBuildListener(System.out, StandardCharsets.UTF_8);
+        URL jenkinsURL = new URL("http://example.com:" + r.getURL().getPort() + r.contextPath + "/");
+        JenkinsLocationConfiguration.get().setUrl(jenkinsURL.toString());
+
+        String serverURL = "https://acme.bitbucket.org";
+
+        ForkPullRequestDiscoveryTrait trait = new ForkPullRequestDiscoveryTrait(2, new TrustEveryone());
+        BranchSCMHead targetHead = new BranchSCMHead("master");
+        PullRequestSCMHead scmHead = new PullRequestSCMHead("name", "repoOwner", "repository1", "feature1", "1", "title", targetHead, new Fork("repository1"), ChangeRequestCheckoutStrategy.HEAD);
+        SCMRevisionImpl prRevision = new SCMRevisionImpl(scmHead, "cff417db");
+        SCMRevisionImpl targetRevision = new SCMRevisionImpl(targetHead, "c341232342311");
+        SCMRevision scmRevision = new PullRequestSCMRevision(scmHead, targetRevision, prRevision);
+        WorkflowRun build = prepareBuildForNotification(r, trait, serverURL, scmRevision);
+        doReturn(Result.SUCCESS).when(build).getResult();
+
+        FilePath workspace = r.jenkins.getWorkspaceFor(build.getParent());
+
+        BitbucketApi apiClient = mock(BitbucketServerAPIClient.class);
+        BitbucketMockApiFactory.add(serverURL, apiClient);
+
+        JobCheckoutListener listener = new JobCheckoutListener();
+        listener.onCheckout(build, null, workspace, taskListener, null, SCMRevisionState.NONE);
+
+        ArgumentCaptor<BitbucketBuildStatus> captor = ArgumentCaptor.forClass(BitbucketBuildStatus.class);
+        verify(apiClient).postBuildStatus(captor.capture());
+        assertThat(captor.getValue()).satisfies(status -> {
+            assertThat(status.getHash()).isEqualTo(prRevision.getHash());
+            assertThat(status.getKey()).isEqualTo(DigestUtils.md5Hex("p/branch-job"));
+            assertThat(status.getRefname()).isEqualTo("refs/heads/" + scmHead.getBranchName());
+        });
+    }
+
     private static Stream<Arguments> buildStatusProvider() {
         UnaryOperator<BitbucketBuildStatusNotificationsTrait> notifyAbortAsCancelled = t -> {
             t.setSendStoppedNotificationForAbortBuild(true);
@@ -156,6 +200,12 @@ private static Stream<Arguments> buildStatusProvider() {
     }
 
     private WorkflowRun prepareBuildForNotification(@NonNull JenkinsRule r, @NonNull SCMSourceTrait trait, @NonNull String serverURL) throws Exception {
+        SCMHead scmHead = new BranchSCMHead("master");
+        SCMRevision scmRevision = new SCMRevisionImpl(scmHead, "c341232342311");
+        return prepareBuildForNotification(r, trait, serverURL, scmRevision);
+    }
+
+    private WorkflowRun prepareBuildForNotification(@NonNull JenkinsRule r, @NonNull SCMSourceTrait trait, @NonNull String serverURL, SCMRevision scmRevision) throws Exception {
         BitbucketSCMSource scmSource = new BitbucketSCMSource("repoOwner", "repository");
         scmSource.setServerUrl(serverURL);
         scmSource.setTraits(List.of(trait));
@@ -166,8 +216,6 @@ private WorkflowRun prepareBuildForNotification(@NonNull JenkinsRule r, @NonNull
 
         WorkflowJob job = new WorkflowJob(project, "branch-job");
 
-        SCMHead scmHead = new BranchSCMHead("master");
-        SCMRevision scmRevision = new SCMRevisionImpl(scmHead, "c341232342311");
         SCM scm = mock(SCM.class);
 
         WorkflowRun build = mock(WorkflowRun.class);
@@ -178,7 +226,7 @@ private WorkflowRun prepareBuildForNotification(@NonNull JenkinsRule r, @NonNull
         BranchProjectFactory<WorkflowJob, WorkflowRun> projectFactory = mock(BranchProjectFactory.class);
         when(projectFactory.isProject(job)).thenReturn(true);
         when(projectFactory.asProject(job)).thenReturn(job);
-        Branch branch = new Branch(scmSource.getId(), scmHead, scm, Collections.emptyList());
+        Branch branch = new Branch(scmSource.getId(), scmRevision.getHead(), scm, Collections.emptyList());
         when(projectFactory.getBranch(job)).thenReturn(branch);
         project.setProjectFactory(projectFactory);