[JENKINS-74913] Allow extension point in bitbucket source plugin to provide a implementation for web-hooks management

new interface to apply a webhook configuration to the Bitbucket

Author: nfalco79

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMNavigator.java

@@ -33,7 +33,6 @@
 import com.cloudbees.jenkins.plugins.bitbucket.client.repository.UserRoleInRepository;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.avatars.BitbucketTeamAvatarMetadataAction;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.endpoint.BitbucketCloudEndpoint;
-import com.cloudbees.jenkins.plugins.bitbucket.impl.endpoint.BitbucketServerEndpoint;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.util.BitbucketApiUtils;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.util.BitbucketCredentialsUtils;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.util.MirrorListSupplier;
@@ -407,17 +406,6 @@ public static FormValidation doCheckCredentialsId(@AncestorInPath SCMSourceOwner
             return BitbucketCredentialsUtils.checkCredentialsId(context, value, serverURL);
         }
 
-        @RequirePOST
-        public static FormValidation doCheckMirrorId(@QueryParameter String value,
-                                                     @QueryParameter(fixEmpty = true, value = "serverUrl") String serverURL) {
-            if (!value.isEmpty()) {
-                if (BitbucketServerEndpoint.supportsMirror(serverURL)) {
-                    return FormValidation.error("Mirror is not supported by the choosen webhooks");
-                }
-            }
-            return FormValidation.ok();
-        }
-
         @RequirePOST
         public ListBoxModel doFillCredentialsIdItems(@AncestorInPath SCMSourceOwner context,
                                                      @QueryParameter(fixEmpty = true, value = "serverUrl", required = true) String serverURL) {

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

@@ -44,7 +44,6 @@
 import com.cloudbees.jenkins.plugins.bitbucket.hooks.HasPullRequests;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.avatars.BitbucketRepoAvatarMetadataAction;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.endpoint.BitbucketCloudEndpoint;
-import com.cloudbees.jenkins.plugins.bitbucket.impl.endpoint.BitbucketServerEndpoint;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.extension.BitbucketEnvVarExtension;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.extension.GitClientAuthenticatorExtension;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.util.BitbucketApiUtils;
@@ -293,14 +292,6 @@ public void setServerUrl(@CheckForNull String serverURL) {
         }
     }
 
-    @Restricted(NoExternalUse.class)
-    @Deprecated(since = "936.4.0", forRemoval = true)
-    // expose if needed in BitbucketEndpointProvider, normally could be get from endpoint if not customized
-    @NonNull
-    public String getEndpointJenkinsRootURL() {
-        return BitbucketEndpointProvider.lookupEndpointJenkinsRootURL(serverUrl);
-    }
-
     @Override
     @NonNull
     public List<SCMSourceTrait> getTraits() {
@@ -1070,17 +1061,6 @@ public static FormValidation doCheckServerUrl(@AncestorInPath SCMSourceOwner con
             return FormValidation.ok();
         }
 
-        @RequirePOST
-        public static FormValidation doCheckMirrorId(@QueryParameter String value,
-                                                     @QueryParameter(fixEmpty = true, value = "serverUrl") String serverURL) {
-            if (!value.isEmpty()) {
-                if (BitbucketServerEndpoint.supportsMirror(serverURL)) {
-                    return FormValidation.error("Mirror can only be used with native webhooks");
-                }
-            }
-            return FormValidation.ok();
-        }
-
         public boolean isServerUrlSelectable() {
             return !BitbucketEndpointProvider.all().isEmpty();
         }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSourceContext.java

@@ -23,7 +23,6 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket;
 
-import com.cloudbees.jenkins.plugins.bitbucket.hooks.WebhookConfiguration;
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.model.TaskListener;
@@ -76,11 +75,6 @@ public class BitbucketSCMSourceContext extends SCMSourceContext<BitbucketSCMSour
      */
     @NonNull
     private WebhookRegistration webhookRegistration = WebhookRegistration.SYSTEM;
-    /**
-     * The {@link WebhookConfiguration} to use in this context.
-     */
-    @NonNull
-    private WebhookConfiguration webhookConfiguration = new WebhookConfiguration();
 
     /**
      * {@code true} if notifications should be disabled in this context.
@@ -202,16 +196,6 @@ public final WebhookRegistration webhookRegistration() {
         return webhookRegistration;
     }
 
-    /**
-     * Returns the {@link WebhookConfiguration} configuration.
-     *
-     * @return the {@link WebhookConfiguration} configuration.
-     */
-    @NonNull
-    public final WebhookConfiguration webhookConfiguration() {
-        return webhookConfiguration;
-    }
-
     /**
      * Returns {@code true} if notifications should be disabled.
      *
@@ -341,18 +325,6 @@ public final BitbucketSCMSourceContext withForkPRStrategies(
         return this;
     }
 
-    /**
-     * Defines the {@link WebhookRegistration} mode to use in this context.
-     *
-     * @param configuration the webhook configuration.
-     * @return {@code this} for method chaining.
-     */
-    @NonNull
-    public final BitbucketSCMSourceContext webhookConfiguration(WebhookConfiguration configuration) {
-        webhookConfiguration = configuration;
-        return this;
-    }
-
     /**
      * Defines the {@link WebhookRegistration} mode to use in this context.
      *

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/BitbucketApi.java

@@ -23,7 +23,7 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket.api;
 
-import com.cloudbees.jenkins.plugins.bitbucket.api.webhook.BitbucketWebhook;
+import com.cloudbees.jenkins.plugins.bitbucket.api.webhook.BitbucketWebhookConfiguration;
 import com.cloudbees.jenkins.plugins.bitbucket.client.repository.UserRoleInRepository;
 import com.cloudbees.jenkins.plugins.bitbucket.filesystem.BitbucketSCMFile;
 import edu.umd.cs.findbugs.annotations.CheckForNull;
@@ -193,7 +193,7 @@ boolean checkPathExists(@NonNull String branchOrHash, @NonNull String path)
      *
      * @param hook the webhook object
      * @throws IOException if there was a network communications error.
-     * @deprecated Use the {@link BitbucketWebhook} implementation to gather
+     * @deprecated Use the {@link BitbucketWebhookConfiguration} implementation to gather
      *             information about webhook.
      */
     @Deprecated(since = "937.0.0", forRemoval = true)
@@ -205,7 +205,7 @@ default void registerCommitWebHook(@NonNull BitbucketWebHook hook) throws IOExce
      *
      * @param hook the webhook object
      * @throws IOException if there was a network communications error.
-     * @deprecated Use the {@link BitbucketWebhook} implementation to gather
+     * @deprecated Use the {@link BitbucketWebhookConfiguration} implementation to gather
      *             information about webhook.
      */
     @Deprecated(since = "937.0.0", forRemoval = true)
@@ -217,7 +217,7 @@ default void updateCommitWebHook(@NonNull BitbucketWebHook hook) throws IOExcept
      *
      * @param hook the webhook object
      * @throws IOException if there was a network communications error.
-     * @deprecated Use the {@link BitbucketWebhook} implementation to gather
+     * @deprecated Use the {@link BitbucketWebhookConfiguration} implementation to gather
      *             information about webhook.
      */
     @Deprecated(since = "937.0.0", forRemoval = true)
@@ -229,7 +229,7 @@ default void removeCommitWebHook(@NonNull BitbucketWebHook hook) throws IOExcept
      *
      * @return the list of webhooks registered in the repository.
      * @throws IOException if there was a network communications error.
-     * @deprecated Use the {@link BitbucketWebhook} implementation to gather
+     * @deprecated Use the {@link BitbucketWebhookConfiguration} implementation to gather
      *             information about webhook.
      */
     @Deprecated(since = "937.0.0", forRemoval = true)

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/endpoint/BitbucketEndpoint.java

@@ -24,7 +24,7 @@
 package com.cloudbees.jenkins.plugins.bitbucket.api.endpoint;
 
 import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSource;
-import com.cloudbees.jenkins.plugins.bitbucket.api.webhook.BitbucketWebhook;
+import com.cloudbees.jenkins.plugins.bitbucket.api.webhook.BitbucketWebhookConfiguration;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.util.BitbucketCredentialsUtils;
 import com.cloudbees.plugins.credentials.common.StandardCredentials;
 import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials;
@@ -80,11 +80,11 @@ public interface BitbucketEndpoint extends Describable<BitbucketEndpoint> {
     /**
      * Returns the webhook implementation that this endpoint is using to manage the incoming payload.
      *
-     * @return the {@link BitbucketWebhook} implementation selected for this endpoint.
+     * @return the {@link BitbucketWebhookConfiguration} implementation selected for this endpoint.
      * @since 937.0.0
      */
     @NonNull
-    BitbucketWebhook getWebhook();
+    BitbucketWebhookConfiguration getWebhook();
 
     /**
      * Returns {@code true} if and only if Jenkins is supposed to auto-manage

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/endpoint/BitbucketEndpointProvider.java

@@ -23,7 +23,7 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket.api.endpoint;
 
-import com.cloudbees.jenkins.plugins.bitbucket.api.webhook.BitbucketWebhook;
+import com.cloudbees.jenkins.plugins.bitbucket.api.webhook.BitbucketWebhookConfiguration;
 import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketEndpointConfiguration;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.endpoint.BitbucketCloudEndpoint;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.endpoint.BitbucketServerEndpoint;
@@ -104,14 +104,15 @@ public static <T extends BitbucketEndpoint> Optional<T> lookupEndpoint(@CheckFor
      *
      * @param serverURL the server url to check.
      * @return the verbatim setting provided by endpoint configuration
-     * @deprecated This is a value specific for of {@link BitbucketWebhook}
+     * @deprecated This value depends on the underline {@link BitbucketWebhookConfiguration} configured for the endpoint.
      */
     @Deprecated(since = "937.0.0", forRemoval = true)
     @NonNull
     public static String lookupEndpointJenkinsRootURL(@CheckForNull String serverURL) {
-        return lookupEndpoint(serverURL)
+        String jenkinsURL = lookupEndpoint(serverURL)
                 .map(BitbucketEndpoint::getEndpointJenkinsRootURL)
-                .orElse(Util.ensureEndsWith(URLUtils.normalizeURL(Util.fixEmptyAndTrim(DisplayURLProvider.get().getRoot())), "/"));
+                .orElse(URLUtils.normalizeURL(Util.fixEmptyAndTrim(DisplayURLProvider.get().getRoot())));
+        return Util.ensureEndsWith(jenkinsURL, "/");
     }
 
     /**

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/webhook/BitbucketWebhookClient.java

@@ -4,7 +4,7 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.io.IOException;
 
-public interface BitbucketWebhookClient {
+public interface BitbucketWebhookClient extends AutoCloseable {
 
     String post(@NonNull String path, @CheckForNull String payload) throws IOException ;
 
@@ -14,4 +14,7 @@ public interface BitbucketWebhookClient {
 
     @NonNull
     String get(@NonNull String path) throws IOException ;
+
+    @Override
+    void close() throws IOException;
 }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/webhook/BitbucketWebhook.java renamed to src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/webhook/BitbucketWebhookConfiguration.java

@@ -23,15 +23,11 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket.api.webhook;
 
-import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSource;
-import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketWebHook;
 import com.cloudbees.jenkins.plugins.bitbucket.api.endpoint.BitbucketEndpoint;
-import com.cloudbees.jenkins.plugins.bitbucket.hooks.WebhookConfiguration;
 import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials;
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.model.Describable;
-import java.util.Collection;
 import jenkins.model.Jenkins;
 
 /**
@@ -40,7 +36,7 @@
  *
  * @since 937.0.0
  */
-public interface BitbucketWebhook extends Describable<BitbucketWebhook> {
+public interface BitbucketWebhookConfiguration extends Describable<BitbucketWebhookConfiguration> {
 
     /**
      * Name to use to describe the hook implementation.
@@ -77,6 +73,25 @@ public interface BitbucketWebhook extends Describable<BitbucketWebhook> {
     @CheckForNull
     String getCredentialsId();
 
+    /**
+     * A custom Jenkins root URL to be used by the webhook implementation as
+     * part of the receiver callback endpoint.
+     * <p>
+     * The returned value must ensure that ends with a slash {@code /}
+     *
+     * @return the verbatim setting provided by endpoint configuration
+     */
+    @CheckForNull
+    String getEndpointJenkinsRootURL();
+
+    /**
+     * Returns the implementation that is in charge to apply this configuration to the Bitbucket.
+     * @param <T> the specific BitbucketWebhookIntegration subtype.
+     * @return a new instance of the integration, never return a singleton instance.
+     * FIXME think if returns class and in case instantiate via reflection and apply this configuration to ensure NO singleton.
+     */
+    <T extends BitbucketWebhookIntegration> T getIntegration();
+
     /**
      * @see Describable#getDescriptor()
      */
@@ -85,15 +100,4 @@ default BitbucketWebhookDescriptor getDescriptor() {
         return (BitbucketWebhookDescriptor) Jenkins.get().getDescriptorOrDie(getClass());
     }
 
-    @NonNull
-    <T extends BitbucketWebHook> Collection<T> retrieveHooks(@NonNull String serverURL, @NonNull BitbucketWebhookClient client);
-    <T extends BitbucketWebHook> void registerHook(@NonNull T payload, @NonNull BitbucketWebhookClient client);
-    <T extends BitbucketWebHook> void updateHook(@NonNull T payload, @NonNull BitbucketWebhookClient client);
-    void removeHook(@NonNull BitbucketWebHook payload, @NonNull BitbucketWebhookClient client);
-
-    @NonNull
-    <T extends BitbucketWebHook> T buildPayload(@NonNull WebhookConfiguration hookConfig, @NonNull BitbucketSCMSource source);
-    <T extends BitbucketWebHook> boolean shouldUpdate(@NonNull T existing, @NonNull T newOne);
-
-
 }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/webhook/BitbucketWebhookDescriptor.java

@@ -28,11 +28,11 @@
 import hudson.model.Descriptor;
 
 /**
- * {@link Descriptor} for {@link BitbucketWebhook}s.
+ * {@link Descriptor} for {@link BitbucketWebhookConfiguration}s.
  *
  * @since 937.0.0
  */
-public abstract class BitbucketWebhookDescriptor extends Descriptor<BitbucketWebhook> {
+public abstract class BitbucketWebhookDescriptor extends Descriptor<BitbucketWebhookConfiguration> {
 
     /**
      * Returns if this implementation can supports and can be installed by the

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/webhook/BitbucketWebhookIntegration.java

@@ -0,0 +1,23 @@
+package com.cloudbees.jenkins.plugins.bitbucket.api.webhook;
+
+import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketWebHook;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.ExtensionPoint;
+import java.io.IOException;
+import java.util.Collection;
+import jenkins.scm.api.trait.SCMSourceTrait;
+
+public interface BitbucketWebhookIntegration extends ExtensionPoint {
+
+    void setRepositoryOwner(@NonNull String repositoryOwner);
+    void setRepositoryName(@NonNull String repositoryName);
+    void setServerURL(@NonNull String serverURL);
+    void setCallbackURL(@NonNull String callbackURL);
+
+    Collection<Class<? extends SCMSourceTrait>> supportedTraits();
+    void apply(SCMSourceTrait trait);
+
+    Collection<BitbucketWebHook> retrieve(@NonNull BitbucketWebhookClient client) throws IOException;
+    void register(@NonNull BitbucketWebhookClient client) throws IOException;
+    void remove(@NonNull BitbucketWebHook payload, @NonNull BitbucketWebhookClient client) throws IOException;
+}