Add API classes to manage bitbucket endpoints and hide the internal implementations

Author: nfalco79

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

@@ -95,7 +95,7 @@ public BitbucketCloudEndpoint(boolean enableCache, int teamCacheDuration, int re
      *        credentials to use for auto-management of hooks.
      * @param enableHookSignature {@code true} hooks that comes Bitbucket Data
      *        Center are signed.
-     * @param credentialsId The {@link StringCredentials#getId()} of the
+     * @param hookSignatureCredentialsId The {@link StringCredentials#getId()} of the
      *        credentials to use for verify the signature of payload.
      */
     @DataBoundConstructor

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

@@ -46,6 +46,7 @@
 import jenkins.model.GlobalConfiguration;
 import jenkins.model.Jenkins;
 import net.sf.json.JSONObject;
+import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
@@ -157,7 +158,7 @@ public List<BitbucketEndpoint> getEndpoints() {
         // TODO should we add a Jenkins.get().checkPermission(Jenkins.READ); ?
         // make a local copy so if changes in meanwhile you do not get NPE
         List<BitbucketEndpoint> localEndpoints = this.endpoints;
-        return localEndpoints == null || localEndpoints.isEmpty()
+        return CollectionUtils.isEmpty(localEndpoints)
                 ? List.of(new BitbucketCloudEndpoint())
                 : Collections.unmodifiableList(localEndpoints);
     }
@@ -266,8 +267,7 @@ public synchronized BitbucketEndpoint getDefaultEndpoint() {
      *
      * @param serverURL the server URL.
      * @return the normalized server URL.
-     * @deprecated
-     * @see #normalizeServerURL
+     * @deprecated Do not use at all, endpoint URL are already managed internally
      */
     @CheckForNull
     @Deprecated(forRemoval = true)

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

@@ -141,7 +141,7 @@ public BitbucketServerEndpoint(@CheckForNull String displayName, @NonNull String
      *        credentials to use for auto-management of hooks.
      * @param enableHookSignature {@code true} hooks that comes Bitbucket Data
      *        Center are signed.
-     * @param credentialsId The {@link StringCredentials#getId()} of the
+     * @param hookSignatureCredentialsId The {@link StringCredentials#getId()} of the
      *        credentials to use for verify the signature of payload.
      */
     @DataBoundConstructor

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/endpoints/BitbucketEndpointConfigurationTest.java

@@ -295,10 +295,10 @@ void given__instanceWithServer__when__updatingCloud__then__cloudAdded() {
     @Test
     void given__instanceWithServer__when__updatingDifferentServer__then__serverAdded() {
         BitbucketEndpointConfiguration instance = new BitbucketEndpointConfiguration();
-        instance.setEndpoints(List.of(new BitbucketServerEndpoint("Example Inc", "https://bitbucket.example.com/", true, "dummy")));
+        instance.setEndpoints(List.of(new BitbucketServerEndpoint("Example Inc", "https://bitbucket.example.com/", true, "dummy", false, null)));
         assumeTrue("dummy".equals(instance.getEndpoints().get(0).getCredentialsId()));
 
-        instance.updateEndpoint(new BitbucketServerEndpoint("Example Org", "http://example.org:8080/bitbucket/", true, "added"));
+        instance.updateEndpoint(new BitbucketServerEndpoint("Example Org", "http://example.org:8080/bitbucket/", true, "added", false, null));
 
         assertThat(instance.getEndpoints()).hasOnlyElementsOfType(BitbucketServerEndpoint.class);
         assertThat(instance.getEndpoints()).element(0).satisfies(endpoint -> {
@@ -328,8 +328,13 @@ void given__instanceWithServer__when__updatingSameServer__then__serverUpdated()
     @Test
     void given__newInstance__when__removingCloud__then__defaultRestored() {
         BitbucketEndpointConfiguration instance = new BitbucketEndpointConfiguration();
-        assertThat(instance.getEndpoints().get(0).getCredentialsId()).isNull();
-        assertThat(instance.removeEndpoint(buildEndpoint(true, "dummy"))).isTrue();
+        // verify there is always a default endpoint
+        assertThat(instance.getEndpoints()).isNotEmpty()
+            .element(0)
+            .satisfies(endpoint -> assertThat(endpoint.getCredentialsId()).isNull());
+        // remove default does not really remove it
+        assertThat(instance.removeEndpoint(buildEndpoint(true, "dummy"))).isFalse();
+        // default always exists
         assertThat(instance.getEndpoints()).hasOnlyElementsOfType(BitbucketCloudEndpoint.class);
     }
 
@@ -415,8 +420,7 @@ void given__instance__when__multipleEndpoints__then__endpointsSelectable() {
 
     @Test
     void given__instanceWithCloudAndServers__when__findingExistingEndpoint__then__endpointFound() {
-        BitbucketEndpointConfiguration instance = new BitbucketEndpointConfiguration();
-        instance.setEndpoints(
+        BitbucketEndpointConfiguration.get().setEndpoints(
                 Arrays.asList(
                         buildEndpoint(true, "first"),
                         new BitbucketServerEndpoint("Example Inc", "https://bitbucket.example.com/", true, "second"),
@@ -445,8 +449,7 @@ void given__instanceWithCloudAndServers__when__findingExistingEndpoint__then__en
 
     @Test
     void given__instanceWithServers__when__findingNonExistingEndpoint__then__endpointNotFound() {
-        BitbucketEndpointConfiguration instance = new BitbucketEndpointConfiguration();
-        instance.setEndpoints(
+        BitbucketEndpointConfiguration.get().setEndpoints(
                 Arrays.<AbstractBitbucketEndpoint>asList(
                         new BitbucketServerEndpoint("Example Inc", "https://bitbucket.example.com/", true, "dummy"),
                         new BitbucketServerEndpoint("Example Org", "http://example.org:8080/bitbucket/", true, "dummy")
@@ -463,8 +466,7 @@ void given__instanceWithServers__when__findingNonExistingEndpoint__then__endpoin
 
     @Test
     void given__instanceWithCloudAndServers__when__findingInvalid__then__endpointNotFound() {
-        BitbucketEndpointConfiguration instance = new BitbucketEndpointConfiguration();
-        instance.setEndpoints(
+        BitbucketEndpointConfiguration.get().setEndpoints(
                 Arrays.asList(
                         buildEndpoint(true, "first"),
                         new BitbucketServerEndpoint("Example Inc", "https://bitbucket.example.com/", true, "second"),
@@ -526,7 +528,7 @@ void given__instanceWithCloudAndServers__when__resolvingNewEndpointAsSystem__the
         r.jenkins.setAuthorizationStrategy(mockStrategy);
         try (ACLContext context = ACL.as2(ACL.SYSTEM2)) {
             BitbucketEndpointConfiguration instance = new BitbucketEndpointConfiguration();
-            instance.setEndpoints(List.of(new BitbucketServerEndpoint("existing", "https://bitbucket.test", false, null)));
+            instance.setEndpoints(List.of(new BitbucketServerEndpoint("existing", "https://bitbucket.test", false, null, false, null)));
             assertThat(instance.getEndpointItems()).hasSize(1);
             assertThat(instance.readResolveServerUrl(null)).isEqualTo(BitbucketCloudEndpoint.SERVER_URL);
             assertThat(instance.getEndpointItems()).hasSize(2);