Add Bitbucket Server Version option (#332)

* Add Bitbucket Server Version option

This works around incompatibilities between older versions of bitbucket and bitbucket v7.x.
Let's users specify their version.

* Make enums not use anonymous classes

* Add tests and simpler default

* Reworded help

* Clean up call code

There's no reason to have two separate loops over all pull requests.

Author: bitwiseman

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/endpoints/BitbucketServerEndpoint.java

@@ -23,6 +23,7 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket.endpoints;
 
+import com.cloudbees.jenkins.plugins.bitbucket.server.BitbucketServerVersion;
 import com.cloudbees.jenkins.plugins.bitbucket.server.BitbucketServerWebhookImplementation;
 import com.cloudbees.plugins.credentials.common.StandardCredentials;
 import com.damnhandy.uri.template.UriTemplate;
@@ -34,6 +35,7 @@
 import hudson.util.ListBoxModel;
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.util.Objects;
 import javax.annotation.Nonnull;
 import jenkins.scm.api.SCMName;
 import org.apache.commons.lang.StringUtils;
@@ -80,6 +82,11 @@ public class BitbucketServerEndpoint extends AbstractBitbucketEndpoint {
     @NonNull
     private BitbucketServerWebhookImplementation webhookImplementation = BitbucketServerWebhookImplementation.PLUGIN;
 
+    /**
+     * The server version for this endpoint.
+     */
+    private BitbucketServerVersion serverVersion = BitbucketServerVersion.VERSION_7;
+
     /**
      * Whether to always call the can merge api when retrieving pull requests.
      */
@@ -142,6 +149,26 @@ public void setCallChanges(boolean callChanges) {
         this.callChanges = callChanges;
     }
 
+    @NonNull
+    public static BitbucketServerVersion findServerVersion(String serverUrl) {
+        final AbstractBitbucketEndpoint endpoint = BitbucketEndpointConfiguration.get().findEndpoint(serverUrl);
+        if (endpoint instanceof BitbucketServerEndpoint) {
+            return ((BitbucketServerEndpoint) endpoint).getServerVersion();
+        }
+
+        return BitbucketServerVersion.VERSION_7;
+    }
+
+    @NonNull
+    public BitbucketServerVersion getServerVersion() {
+        return this.serverVersion;
+    }
+
+    @DataBoundSetter
+    public void setServerVersion(@NonNull BitbucketServerVersion serverVersion) {
+        this.serverVersion = Objects.requireNonNull(serverVersion);
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -181,6 +208,10 @@ private Object readResolve() {
         if (getBitbucketJenkinsRootUrl() != null) {
             setBitbucketJenkinsRootUrl(getBitbucketJenkinsRootUrl());
         }
+        if (serverVersion == null) {
+            serverVersion = BitbucketServerVersion.VERSION_7;
+        }
+
         return this;
     }
 
@@ -218,6 +249,16 @@ public ListBoxModel doFillWebhookImplementationItems() {
             return items;
         }
 
+        @Restricted(NoExternalUse.class)
+        public ListBoxModel doFillServerVersionItems() {
+            ListBoxModel items = new ListBoxModel();
+            for (BitbucketServerVersion serverVersion : BitbucketServerVersion.values()) {
+                items.add(serverVersion, serverVersion.name());
+            }
+
+            return items;
+        }
+
         /**
          * Checks that the supplied URL is valid.
          *

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/WebhookConfiguration.java

@@ -26,8 +26,11 @@
 import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSource;
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketWebHook;
 import com.cloudbees.jenkins.plugins.bitbucket.client.repository.BitbucketRepositoryHook;
+import com.cloudbees.jenkins.plugins.bitbucket.endpoints.AbstractBitbucketEndpoint;
 import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketCloudEndpoint;
+import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketEndpointConfiguration;
 import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketServerEndpoint;
+import com.cloudbees.jenkins.plugins.bitbucket.server.BitbucketServerVersion;
 import com.cloudbees.jenkins.plugins.bitbucket.server.client.repository.BitbucketServerWebhook;
 import com.cloudbees.jenkins.plugins.bitbucket.server.client.repository.NativeBitbucketServerWebhook;
 import com.damnhandy.uri.template.UriTemplate;
@@ -56,19 +59,25 @@ public class WebhookConfiguration {
     ));
 
     /**
-     * The list of events available in Bitbucket Server.
+     * The list of events available in Bitbucket Server v7.x.
      */
-    private static final List<String> NATIVE_SERVER_EVENTS = Collections.unmodifiableList(Arrays.asList(
+    private static final List<String> NATIVE_SERVER_EVENTS_v7 = Collections.unmodifiableList(Arrays.asList(
             HookEventType.SERVER_REFS_CHANGED.getKey(),
             HookEventType.SERVER_PULL_REQUEST_OPENED.getKey(),
             HookEventType.SERVER_PULL_REQUEST_MERGED.getKey(),
             HookEventType.SERVER_PULL_REQUEST_DECLINED.getKey(),
             HookEventType.SERVER_PULL_REQUEST_DELETED.getKey(),
             HookEventType.SERVER_PULL_REQUEST_MODIFIED.getKey(),
             HookEventType.SERVER_PULL_REQUEST_REVIEWER_UPDATED.getKey(),
+            // only on v7.x and above
             HookEventType.SERVER_PULL_REQUEST_FROM_REF_UPDATED.getKey()
     ));
 
+    /**
+     * The list of events available in Bitbucket Server v6.x.
+     */
+    private static final List<String> NATIVE_SERVER_EVENTS_v6 = Collections.unmodifiableList(NATIVE_SERVER_EVENTS_v7.subList(0, 6));
+
     /**
      * The title of the webhook.
      */
@@ -131,7 +140,8 @@ boolean updateHook(BitbucketWebHook hook, BitbucketSCMSource owner) {
             boolean updated = false;
 
             NativeBitbucketServerWebhook serverHook = (NativeBitbucketServerWebhook) hook;
-            String url = getNativeServerWebhookUrl(owner.getServerUrl(), owner.getEndpointJenkinsRootUrl());
+            String serverUrl = owner.getServerUrl();
+            String url = getNativeServerWebhookUrl(serverUrl, owner.getEndpointJenkinsRootUrl());
 
             if (!url.equals(serverHook.getUrl())) {
                 serverHook.setUrl(url);
@@ -140,11 +150,11 @@ boolean updateHook(BitbucketWebHook hook, BitbucketSCMSource owner) {
 
             List<String> events = serverHook.getEvents();
             if (events == null) {
-                serverHook.setEvents(NATIVE_SERVER_EVENTS);
+                serverHook.setEvents(getNativeServerEvents(serverUrl));
                 updated = true;
-            } else if (!events.containsAll(NATIVE_SERVER_EVENTS)) {
+            } else if (!events.containsAll(getNativeServerEvents(serverUrl))) {
                 Set<String> newEvents = new TreeSet<>(events);
-                newEvents.addAll(NATIVE_SERVER_EVENTS);
+                newEvents.addAll(getNativeServerEvents(serverUrl));
                 serverHook.setEvents(new ArrayList<>(newEvents));
                 updated = true;
             }
@@ -158,6 +168,7 @@ boolean updateHook(BitbucketWebHook hook, BitbucketSCMSource owner) {
     public BitbucketWebHook getHook(BitbucketSCMSource owner) {
         final String serverUrl = owner.getServerUrl();
         final String rootUrl = owner.getEndpointJenkinsRootUrl();
+
         if (BitbucketCloudEndpoint.SERVER_URL.equals(serverUrl)) {
             BitbucketRepositoryHook hook = new BitbucketRepositoryHook();
             hook.setEvents(CLOUD_EVENTS);
@@ -171,7 +182,7 @@ public BitbucketWebHook getHook(BitbucketSCMSource owner) {
             case NATIVE: {
                 NativeBitbucketServerWebhook hook = new NativeBitbucketServerWebhook();
                 hook.setActive(true);
-                hook.setEvents(NATIVE_SERVER_EVENTS);
+                hook.setEvents(getNativeServerEvents(serverUrl));
                 hook.setDescription(description);
                 hook.setUrl(getNativeServerWebhookUrl(serverUrl, rootUrl));
                 return hook;
@@ -189,6 +200,19 @@ public BitbucketWebHook getHook(BitbucketSCMSource owner) {
         }
     }
 
+    private static List<String> getNativeServerEvents(String serverUrl) {
+        AbstractBitbucketEndpoint endpoint = BitbucketEndpointConfiguration.get().findEndpoint(serverUrl);
+        if (endpoint instanceof BitbucketServerEndpoint) {
+            if (((BitbucketServerEndpoint)endpoint).getServerVersion().equals(BitbucketServerVersion.VERSION_6)) {
+                return NATIVE_SERVER_EVENTS_v6;
+            }
+        }
+
+        // Not specifically v6, use v7.
+        // Better to give an error than quietly not register some events.
+        return NATIVE_SERVER_EVENTS_v7;
+    }
+
     private static String getNativeServerWebhookUrl(String serverUrl, String rootUrl) {
         return UriTemplate.buildFromTemplate(rootUrl)
             .template(BitbucketSCMSourcePushHookReceiver.FULL_PATH)

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/BitbucketServerVersion.java

@@ -0,0 +1,44 @@
+/**
+ * The MIT License
+ *
+ * Copyright (c) 2016-2020, CloudBees Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.cloudbees.jenkins.plugins.bitbucket.server;
+
+import hudson.model.ModelObject;
+
+public enum BitbucketServerVersion implements ModelObject {
+    VERSION_7("Bitbucket v7.x (and later)"),
+    VERSION_6("Bitbucket v6.x (and earlier)");
+
+    private final String displayName;
+
+    BitbucketServerVersion(String displayName) {
+        this.displayName = displayName;
+    }
+
+    @Override
+    public String getDisplayName() {
+        return displayName;
+    }
+
+}
+

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/BitbucketServerWebhookImplementation.java

@@ -28,18 +28,19 @@
 /** The different webhook implementations available for Bitbucket Server. */
 public enum BitbucketServerWebhookImplementation implements ModelObject {
     /** Plugin-based webhooks. */
-    PLUGIN {
-        @Override
-        public String getDisplayName() {
-            return "Plugin";
-        }
-    },
+    PLUGIN("Plugin"),
 
     /** Native webhooks, available since Bitbucket Server 5.4. */
-    NATIVE {
-        @Override
-        public String getDisplayName() {
-            return "Native";
-        }
+    NATIVE("Native");
+
+    private final String displayName;
+
+    BitbucketServerWebhookImplementation(String displayName) {
+        this.displayName = displayName;
+    }
+
+    @Override
+    public String getDisplayName() {
+        return displayName;
     }
 }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/BitbucketServerAPIClient.java

@@ -42,6 +42,7 @@
 import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketEndpointConfiguration;
 import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketServerEndpoint;
 import com.cloudbees.jenkins.plugins.bitbucket.filesystem.BitbucketSCMFile;
+import com.cloudbees.jenkins.plugins.bitbucket.server.BitbucketServerVersion;
 import com.cloudbees.jenkins.plugins.bitbucket.server.BitbucketServerWebhookImplementation;
 import com.cloudbees.jenkins.plugins.bitbucket.server.client.branch.BitbucketServerBranch;
 import com.cloudbees.jenkins.plugins.bitbucket.server.client.branch.BitbucketServerBranches;
@@ -334,25 +335,21 @@ private List<BitbucketServerPullRequest> getPullRequests(UriTemplate template)
                 || pr.getSource().getBranch() == null
                 || pr.getDestination().getBranch() == null);
 
-        // set commit closure to make commit informations available when need, in a similar way to when request branches
+        AbstractBitbucketEndpoint endpointConfig = BitbucketEndpointConfiguration.get().findEndpoint(baseURL);
+        final BitbucketServerEndpoint endpoint = endpointConfig instanceof BitbucketServerEndpoint ?
+            (BitbucketServerEndpoint) endpointConfig : null;
+
         for (BitbucketServerPullRequest pullRequest : pullRequests) {
+            // set commit closure to make commit informations available when need, in a similar way to when request branches
             setupClosureForPRBranch(pullRequest);
-        }
-
-        AbstractBitbucketEndpoint endpointConfig = BitbucketEndpointConfiguration.get().findEndpoint(baseURL);
-        if (endpointConfig instanceof BitbucketServerEndpoint) {
-            final BitbucketServerEndpoint endpoint = (BitbucketServerEndpoint) endpointConfig;
-            if (!endpoint.isCallCanMerge() && !endpoint.isCallChanges()) {
-                return pullRequests;
-            }
 
-            // This is required for Bitbucket Server to update the refs/pull-requests/* references
-            // See https://community.atlassian.com/t5/Bitbucket-questions/Change-pull-request-refs-after-Commit-instead-of-after-Approval/qaq-p/194702#M6829
-            for (BitbucketServerPullRequest pullRequest : pullRequests) {
+            if (endpoint != null) {
+                // This is required for Bitbucket Server to update the refs/pull-requests/* references
+                // See https://community.atlassian.com/t5/Bitbucket-questions/Change-pull-request-refs-after-Commit-instead-of-after-Approval/qaq-p/194702#M6829
                 if (endpoint.isCallCanMerge()) {
                     pullRequest.setCanMerge(getPullRequestCanMergeById(pullRequest.getId()));
                 }
-                if (endpoint.isCallChanges()) {
+                if (endpoint.isCallChanges() && BitbucketServerVersion.VERSION_7.equals(endpoint.getServerVersion())) {
                     callPullRequestChangesById(pullRequest.getId());
                 }
             }

src/main/resources/com/cloudbees/jenkins/plugins/bitbucket/endpoints/BitbucketServerEndpoint/config-detail.jelly

@@ -7,6 +7,9 @@
   <f:entry title="${%Server URL}" field="serverUrl">
     <f:textbox/>
   </f:entry>
+  <f:entry title="${%Server Version}" field="serverVersion">
+    <f:select />
+  </f:entry>
   <f:entry field="callCanMerge">
     <f:checkbox title="${%Call Can Merge}" default="true"/>
   </f:entry>

src/main/resources/com/cloudbees/jenkins/plugins/bitbucket/endpoints/BitbucketServerEndpoint/help-serverVersion.html

@@ -0,0 +1,3 @@
+<div>
+    Select the version of Bitbucket server for this endpoint. Some features may not work if this setting does not match the version of the referenced server.
+</div>