[JENKINS-57988] Remove hashmap (#16)

* added link to token creation section

* broken code with serverMap

* added java streams support for server filters

* removed warning for server url

* serverMap is no more transient

* added more Java 8 streams to filter gitlab servers

* added info for jcasc in README

* removed hashmaps from GitLabServers

* removed commented code

* removed unnecessary newline

* use newer Jenkins Version for PersistentDescriptor, which calls load

PersistentDescriptor calls load on PostConstruct
See: jenkinsci/jenkins#3570

Follow the doc saying you should call save on setters: https://github.com/jenkinsci/jenkins/blob/c489b07f311eb1c3068d0457ff7813261ec8ece5/core/src/main/java/jenkins/model/GlobalConfiguration.java#L35

Though the docs is a bit outdated it is not aware of PersistentDescriptor

* relative links

Co-Authored-By: Joseph Petersen <[email protected]>

Author: baymac

README.md

@@ -238,7 +238,7 @@ Assuming plugin installation has been done already.
      
 6. Adding a Personal Access Token Credentials:
 
-   This is a manual setup. To automatically generate Personal Accees Token see next section
+   This is a manual setup. To automatically generate Personal Accees Token see next [section](#creating-personal-access-token-within-jenkins).
 
     i. User is required to add a `GitLab Personal Access Token` type credentials entry to securely persist the token inside Jenkins
 
@@ -310,6 +310,34 @@ required scope. You can go back to the GitLab Server Configuration to select the
 credentials with the `id` returned by token creator. It should be a a 128-bit long UUID-4 string (36 characters).
 
    ![gitlab-token-creator](docs/img/gitlab-token-creator.png)
+   
+### Configuration as Code
+
+There is an easier way to setup GitLab Server configuration on your Jenkins server. Jenkins
+Configuration as Code (JCasC) allows you to configure your Jenkins Global Configuration by a simple `yaml` file. If you
+use Jenkins Code as Configuration on your Jenkins Instance, you can add the following to your `jenkins.yaml`. 
+
+```yaml
+credentials:
+  system:
+    domainCredentials:
+      - credentials:
+          - gitlabPersonalAccessToken:
+              scope: SYSTEM
+              id: "i<3GitLab"
+              token: "XfsqZvVtAx5YCph5bq3r" # gitlab personal access token
+
+unclassified:
+  gitLabServers:
+    servers:
+      - credentialsId: "i<3GitLab"
+        manageHooks: true
+        name: "gitlab.com"
+        serverUrl: "https://gitlab.com"
+```
+
+See handling secrets [section](https://github.com/jenkinsci/configuration-as-code-plugin#handling-secrets) for better
+security.
 
 ### Setting up GitLab for jobs
 

pom.xml

@@ -15,7 +15,7 @@
         <revision>0.0.2.</revision>
         <changelist>-SNAPSHOT</changelist>
         <!-- Baseline Jenkins version you use to build the plugin. Users must have this version or newer to run. -->
-        <jenkins.version>2.138.4</jenkins.version>
+        <jenkins.version>2.150.3</jenkins.version>
         <java.level>8</java.level>
         <!-- Other properties you may want to use:
           ~ jenkins-test-harness.version: Jenkins Test Harness version you use to test the plugin. For Jenkins version >= 1.580.1 use JTH 2.0 or higher.

src/main/java/io/jenkins/plugins/gitlabserverconfig/servers/GitLabServer.java

@@ -226,10 +226,9 @@ public static FormValidation doCheckServerUrl(@QueryParameter String value) {
             // TODO:[JENKINS-57747] Add support for GitLab Ultimate (self hosted) and Gold (saas)
             if (GITLAB_SERVER_URL.equals(value)) {
                 LOGGER.info("Server URL is fine - %s", value);
-                return FormValidation.ok();
             }
             LOGGER.info("Unable to validate serverUrl - %s", value);
-            return FormValidation.warning(Messages.GitLabServer_recheckUrl());
+            return FormValidation.ok();
         }
 
         @NonNull

src/main/java/io/jenkins/plugins/gitlabserverconfig/servers/GitLabServers.java

@@ -2,29 +2,33 @@
 
 import hudson.Extension;
 import hudson.ExtensionList;
-import hudson.Util;
 import hudson.model.Descriptor;
+import hudson.model.PersistentDescriptor;
 import hudson.util.ListBoxModel;
 import io.jenkins.plugins.gitlabserverconfig.servers.helpers.GitLabPersonalAccessTokenCreator;
 import java.util.ArrayList;
 import java.util.Collections;
-import java.util.Iterator;
 import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.function.Function;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
 import javax.annotation.CheckForNull;
 import javax.annotation.Nonnull;
 import jenkins.model.GlobalConfiguration;
 import jenkins.model.Jenkins;
-import net.sf.json.JSONObject;
 import org.apache.commons.lang.StringUtils;
-import org.kohsuke.stapler.StaplerRequest;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import static hudson.Util.fixNull;
+
 /**
  * Represents the global configuration of GitLab servers.
  */
 @Extension
-public class GitLabServers extends GlobalConfiguration {
+public class GitLabServers extends GlobalConfiguration implements PersistentDescriptor {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(GitLabServers.class);
 
@@ -35,20 +39,17 @@ public class GitLabServers extends GlobalConfiguration {
     private List<GitLabServer> servers;
 
     /**
-     * Constructor.
-     */
-    public GitLabServers() {
-        load();
-    }
-
-    /**
-     * {@inheritDoc}
+     * Helper function to get predicate to filter servers
+     * based on their names
+     *
+     * @param keyExtractor the Function to filter
+     * @param <T> In this case it is server
+     * @return a predicate to filter servers list
      */
-    @Override
-    public boolean configure(StaplerRequest req, JSONObject json) throws FormException {
-        servers = req.bindJSONToList(GitLabServer.class, json.get("servers"));
-        save();
-        return super.configure(req, json);
+    private static <T> Predicate<T> distinctByKey(
+            Function<? super T, ?> keyExtractor) {
+        Map<Object, Boolean> seen = new ConcurrentHashMap<>();
+        return t -> seen.putIfAbsent(keyExtractor.apply(t), Boolean.TRUE) == null;
     }
 
     /**
@@ -61,15 +62,15 @@ public static GitLabServers get() {
     }
 
     /**
-     * Populates a {@link ListBoxModel} with the endpoints.
+     * Populates a {@link ListBoxModel} with the servers.
      *
-     * @return A {@link ListBoxModel} with all the endpoints
+     * @return A {@link ListBoxModel} with all the servers
      */
     public ListBoxModel getServerItems() {
         ListBoxModel result = new ListBoxModel();
-        for (GitLabServer endpoint : getServers()) {
-            String serverUrl = endpoint.getServerUrl();
-            String displayName = endpoint.getName();
+        for (GitLabServer server : getServers()) {
+            String serverUrl = server.getServerUrl();
+            String displayName = server.getName();
             result.add(StringUtils.isBlank(displayName) ? serverUrl : displayName + " (" + serverUrl + ")", serverUrl);
         }
         return result;
@@ -103,74 +104,70 @@ public List<Descriptor> actions() {
     }
 
     /**
-     * Sets the list of endpoints.
+     * Sets the list of GitLab Servers
      *
-     * @param endpoints the list of endpoints.
+     * @param servers the list of endpoints.
      */
-    public void setServers(@CheckForNull List<? extends GitLabServer> endpoints) {
+    public void setServers(@CheckForNull List<? extends GitLabServer> servers) {
         Jenkins.get().checkPermission(Jenkins.ADMINISTER);
-        servers = new ArrayList<>(Util.fixNull(endpoints));
+        this.servers = fixNull(servers).stream()
+            .filter(distinctByKey(GitLabServer::getName)).collect(Collectors.toList());
+        save();
     }
 
     /**
-     * Adds an endpoint
+     * Adds an server
      * Checks if the GitLab Server name is unique
      *
-     * @param endpoint the endpoint to add.
+     * @param server the server to add.
      * @return {@code true} if the list of endpoints was modified
      */
-    public boolean addServer(@Nonnull GitLabServer endpoint) {
-        List<GitLabServer> endpoints = new ArrayList<>(getServers());
-        for (GitLabServer ep : endpoints) {
-            if (Util.fixNull(ep.getName()).equals(Util.fixNull(endpoint.getName()))) {
-                return false;
-            }
+    public boolean addServer(@Nonnull GitLabServer server) {
+        List<GitLabServer> servers = new ArrayList<>(getServers());
+        GitLabServer s = servers.stream()
+                .filter(server1 -> server1.getName().equals(server.getName()))
+                .findAny()
+                .orElse(null);
+        if(s != null) {
+            return false;
         }
-        endpoints.add(endpoint);
-        setServers(endpoints);
+        servers.add(server);
+        setServers(servers);
         return true;
     }
 
     /**
      * Updates an existing endpoint (or adds if missing)
      * Checks if the GitLab Server name is matched
      *
-     * @param endpoint the endpoint to update.
+     * @param server the server to update.
+     * @return {@code true} if the list of endpoints was modified
      */
-    public void updateServer(@Nonnull GitLabServer endpoint) {
-        List<GitLabServer> endpoints = new ArrayList<>(getServers());
-        boolean found = false;
-        for (int i = 0; i < endpoints.size(); i++) {
-            GitLabServer ep = endpoints.get(i);
-            if (Util.fixNull(ep.getName()).equals(Util.fixNull(endpoint.getName()))) {
-                endpoints.set(i, endpoint);
-                found = true;
-                break;
-            }
-        }
-        if (!found) {
-            endpoints.add(endpoint);
+    public boolean updateServer(@Nonnull GitLabServer server) {
+        List<GitLabServer> servers = new ArrayList<>(getServers());
+        if(!servers.contains(server)) {
+            return false;
         }
-        setServers(endpoints);
+        servers = servers.stream()
+                .map(oldServer -> oldServer.getName().equals(server.getName()) ? server : oldServer)
+                .collect(Collectors.toList());
+        setServers(servers);
+        return true;
     }
 
     /**
-     * Removes an endpoint.
+     * Removes a server entry
      * Checks if the GitLab Server name is matched
      *
-     * @param name the server URL to remove.
+     * @param name the server name to remove.
      * @return {@code true} if the list of endpoints was modified
      */
     public boolean removeServer(@CheckForNull String name) {
-        boolean modified = false;
-        List<GitLabServer> endpoints = new ArrayList<>(getServers());
-        for (Iterator<GitLabServer> iterator = endpoints.iterator(); iterator.hasNext(); ) {
-            if (Util.fixNull(name).equals(Util.fixNull(iterator.next().getName()))) {
-                iterator.remove();
-                modified = true;
-            }
+        List<GitLabServer> servers = new ArrayList<>(getServers());
+        boolean removed = servers.removeIf(s -> s.getName().equals(name));
+        if(removed) {
+            setServers(servers);
         }
-        setServers(endpoints);
-        return modified;
+        return removed;
     }
 }

src/main/resources/io/jenkins/plugins/gitlabserverconfig/servers/Messages.properties

@@ -8,4 +8,3 @@ GitLabServer.serverVersion=GitLab Version: <code>{0}</code>
 GitLabServer.failedValidation=Failed to validate the account <code>{0}</code>
 GitLabServer.credentialsNotResolved=Cannot resolve suitable credentials with id: <code>{0}</code>
 GitLabServer.advancedSectionForFuture=Advanced configurations will be added in later release
-GitLabServer.recheckUrl=Checks for community version of GitLab is supported but GitLab Gold, Ultimate, Community self hosted etc are not supported yet. Please test the connection to see if your URL is valid