[JENKINS-62880] Migrate RedisFingerprintStorage to use Descriptor Configuration

Jenkinsfile

@@ -1,5 +1,5 @@
 def configurations = [
-    [ platform: "linux", jdk: "8", jenkins: "2.242" ],
-    [ platform: "linux", jdk: "11", jenkins: "2.242", javaLevel: "8" ]
+    [ platform: "linux", jdk: "8" ],
+    [ platform: "linux", jdk: "11", javaLevel: "8" ]
 ]
 buildPlugin(configurations: configurations)

plugin/src/main/java/io/jenkins/plugins/redis/CredentialHelper.java

@@ -0,0 +1,73 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2020, Jenkins project contributors
+ *
+ * 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 io.jenkins.plugins.redis;
+
+import com.cloudbees.plugins.credentials.CredentialsProvider;
+import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials;
+import com.cloudbees.plugins.credentials.matchers.IdMatcher;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.security.ACL;
+import jenkins.model.Jenkins;
+
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Helper class to support credential operations.
+ */
+public class CredentialHelper {
+
+    static @NonNull String getUsernameFromCredential(@CheckForNull StandardUsernamePasswordCredentials credential) {
+        if (credential == null) {
+            return "default";
+        }
+        String username = credential.getUsername();
+        if (username.equals("")) {
+            return "default";
+        }
+        return username;
+    }
+
+    static @NonNull String getPasswordFromCredential(@CheckForNull StandardUsernamePasswordCredentials credential) {
+        if (credential == null) {
+            return "";
+        }
+        return credential.getPassword().getPlainText();
+    }
+
+    static StandardUsernamePasswordCredentials getCredential(String id) {
+        StandardUsernamePasswordCredentials credential = null;
+        List<StandardUsernamePasswordCredentials> credentials = CredentialsProvider.lookupCredentials(
+                StandardUsernamePasswordCredentials.class, Jenkins.get(), ACL.SYSTEM, Collections.emptyList());
+        IdMatcher matcher = new IdMatcher(id);
+        for (StandardUsernamePasswordCredentials c : credentials) {
+            if (matcher.matches(c)) {
+                credential = c;
+            }
+        }
+        return credential;
+    }
+
+}

plugin/src/main/java/io/jenkins/plugins/redis/JedisPoolManager.java

@@ -0,0 +1,66 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2020, Jenkins project contributors
+ *
+ * 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 io.jenkins.plugins.redis;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import redis.clients.jedis.Jedis;
+import redis.clients.jedis.JedisPool;
+import redis.clients.jedis.JedisPoolConfig;
+import redis.clients.jedis.exceptions.JedisException;
+
+/**
+ * Singleton Responsible for managing {@link JedisPool}. Creates the connection with Redis and manages resources.
+ */
+public enum JedisPoolManager {
+
+    INSTANCE;
+
+    private volatile JedisPool jedisPool;
+
+    void createJedisPoolFromConfig(RedisFingerprintStorage redisFingerprintStorage) {
+        createJedisPool(redisFingerprintStorage.getHost(), redisFingerprintStorage.getPort(),
+                redisFingerprintStorage.getConnectionTimeout(), redisFingerprintStorage.getSocketTimeout(),
+                redisFingerprintStorage.getUsername(), redisFingerprintStorage.getPassword(),
+                redisFingerprintStorage.getDatabase(), redisFingerprintStorage.getSsl());
+    }
+
+    private synchronized void createJedisPool(
+            String host, int port, int connectionTimeout, int socketTimeout, String username, String password,
+            int database, boolean ssl) {
+
+        if (jedisPool != null) {
+            jedisPool.close();
+        }
+        jedisPool = new JedisPool(new JedisPoolConfig(), host, port, connectionTimeout, socketTimeout, username,
+                password, database, "Jenkins", ssl);
+    }
+
+    @NonNull Jedis getJedis(RedisFingerprintStorage redisFingerprintStorage) throws JedisException {
+        if (jedisPool == null) {
+            createJedisPoolFromConfig(redisFingerprintStorage);
+        }
+        return jedisPool.getResource();
+    }
+
+}

plugin/src/main/java/io/jenkins/plugins/redis/RedisFingerprintStorage.java

@@ -23,6 +23,7 @@
  */
 package io.jenkins.plugins.redis;
 
+import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials;
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.NonNull;
 
@@ -40,11 +41,12 @@
 import java.util.logging.Logger;
 import java.util.logging.Level;
 
+import org.jenkinsci.Symbol;
 import org.jenkinsci.main.modules.instance_identity.InstanceIdentity;
 
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
 import redis.clients.jedis.Jedis;
-import redis.clients.jedis.JedisPool;
-import redis.clients.jedis.JedisPoolConfig;
 import redis.clients.jedis.Transaction;
 import redis.clients.jedis.exceptions.JedisException;
 
@@ -55,36 +57,19 @@
  */
 
 @Extension
+@Symbol("redis")
 public class RedisFingerprintStorage extends FingerprintStorage {
 
     private final String instanceId;
     private static final Logger LOGGER = Logger.getLogger(Fingerprint.class.getName());
-    private volatile JedisPool jedisPool;
 
     public static RedisFingerprintStorage get() {
-        return ExtensionList.lookup(RedisFingerprintStorage.class).get(0);
+        return ExtensionList.lookupSingleton(RedisFingerprintStorage.class);
     }
 
+    @DataBoundConstructor
     public RedisFingerprintStorage() throws IOException {
         instanceId = Util.getDigestOf(new ByteArrayInputStream(InstanceIdentity.get().getPublic().getEncoded()));
-        createJedisPoolFromConfig();
-    }
-
-    void createJedisPoolFromConfig() {
-        GlobalRedisConfiguration config = GlobalRedisConfiguration.get();
-        createJedisPool(config.getHost(), config.getPort(), config.getConnectionTimeout(), config.getSocketTimeout(),
-                config.getUsername(), config.getPassword(), config.getDatabase(), config.getSsl());
-    }
-
-    void createJedisPool(
-            String host, int port, int connectionTimeout, int socketTimeout, String username, String password,
-            int database, boolean ssl) {
-        jedisPool = new JedisPool(new JedisPoolConfig(), host, port, connectionTimeout, socketTimeout, username,
-                password, database, "Jenkins", ssl);
-    }
-
-    private @NonNull Jedis getJedis() throws JedisException{
-        return jedisPool.getResource();
     }
 
     /**
@@ -93,7 +78,8 @@ void createJedisPool(
     public synchronized void save(Fingerprint fp) throws JedisException {
         StringWriter writer = new StringWriter();
         Fingerprint.getXStream().toXML(fp, writer);
-        try (Jedis jedis = getJedis()) {
+        JedisPoolManager jedisPoolManager = JedisPoolManager.INSTANCE;
+        try (Jedis jedis = jedisPoolManager.getJedis(this)) {
             Transaction transaction = jedis.multi();
             transaction.set(instanceId + fp.getHashString(), writer.toString());
             transaction.sadd(instanceId, fp.getHashString());
@@ -109,8 +95,9 @@ public synchronized void save(Fingerprint fp) throws JedisException {
      */
     public @CheckForNull Fingerprint load(@NonNull String id) throws IOException, JedisException {
         String loadedData;
+        JedisPoolManager jedisPoolManager = JedisPoolManager.INSTANCE;
 
-        try (Jedis jedis = getJedis()) {
+        try (Jedis jedis = jedisPoolManager.getJedis(this)) {
             loadedData = jedis.get(instanceId + id);
         } catch (JedisException e) {
             LOGGER.log(Level.WARNING, "Jedis failed in loading fingerprint: " + id, e);
@@ -138,7 +125,8 @@ public synchronized void save(Fingerprint fp) throws JedisException {
      * Deletes the fingerprint with the given id.
      */
     public void delete(@NonNull String id) throws JedisException {
-        try (Jedis jedis = getJedis()) {
+        JedisPoolManager jedisPoolManager = JedisPoolManager.INSTANCE;
+        try (Jedis jedis = jedisPoolManager.getJedis(this)) {
             Transaction transaction = jedis.multi();
             transaction.del(instanceId + id);
             transaction.srem(instanceId, id);
@@ -153,12 +141,106 @@ public void delete(@NonNull String id) throws JedisException {
      * Returns true if there's some data in the fingerprint database.
      */
     public boolean isReady() {
-        try (Jedis jedis = getJedis()) {
+        JedisPoolManager jedisPoolManager = JedisPoolManager.INSTANCE;
+        try (Jedis jedis = jedisPoolManager.getJedis(this)) {
             return jedis.smembers(instanceId).size() != 0;
         } catch (JedisException e) {
             LOGGER.log(Level.WARNING, "Failed to connect to Jedis", e);
             throw e;
         }
     }
 
+    private String host = RedisFingerprintStorageDescriptor.DEFAULT_HOST;
+    private int port = RedisFingerprintStorageDescriptor.DEFAULT_PORT;
+    private int database = RedisFingerprintStorageDescriptor.DEFAULT_DATABASE;
+    private boolean ssl = RedisFingerprintStorageDescriptor.DEFAULT_SSL;
+    private int connectionTimeout = RedisFingerprintStorageDescriptor.DEFAULT_CONNECTION_TIMEOUT;
+    private int socketTimeout = RedisFingerprintStorageDescriptor.DEFAULT_SOCKET_TIMEOUT;
+    private String credentialsId = RedisFingerprintStorageDescriptor.DEFAULT_CREDENTIALS_ID;
+
+    public String getHost() {
+        return host;
+    }
+
+    @DataBoundSetter
+    public void setHost(String host) {
+        this.host = host;
+        JedisPoolManager.INSTANCE.createJedisPoolFromConfig(this);
+    }
+
+    public int getPort() {
+        return port;
+    }
+
+    @DataBoundSetter
+    public void setPort(int port) {
+        this.port = port;
+        JedisPoolManager.INSTANCE.createJedisPoolFromConfig(this);
+    }
+
+    public int getDatabase() {
+        return database;
+    }
+
+    @DataBoundSetter
+    public void setDatabase(int database) {
+        this.database = database;
+        JedisPoolManager.INSTANCE.createJedisPoolFromConfig(this);
+    }
+
+    public boolean getSsl() {
+        return this.ssl;
+    }
+
+    @DataBoundSetter
+    public void setSsl(boolean ssl) {
+        this.ssl = ssl;
+        JedisPoolManager.INSTANCE.createJedisPoolFromConfig(this);
+    }
+
+    public int getConnectionTimeout() {
+        return connectionTimeout;
+    }
+
+    @DataBoundSetter
+    public void setConnectionTimeout(int connectionTimeout) {
+        this.connectionTimeout = connectionTimeout;
+        JedisPoolManager.INSTANCE.createJedisPoolFromConfig(this);
+    }
+
+    public int getSocketTimeout() {
+        return socketTimeout;
+    }
+
+    @DataBoundSetter
+    public void setSocketTimeout(int socketTimeout) {
+        this.socketTimeout = socketTimeout;
+        JedisPoolManager.INSTANCE.createJedisPoolFromConfig(this);
+    }
+
+    public String getCredentialsId() {
+        return credentialsId;
+    }
+
+    @DataBoundSetter
+    public void setCredentialsId(String credentialsId) {
+        this.credentialsId = credentialsId;
+        JedisPoolManager.INSTANCE.createJedisPoolFromConfig(this);
+    }
+
+    public @NonNull String getUsername() {
+        StandardUsernamePasswordCredentials credential = CredentialHelper.getCredential(credentialsId);
+        return CredentialHelper.getUsernameFromCredential(credential);
+    }
+
+    public @NonNull String getPassword() {
+        StandardUsernamePasswordCredentials credential = CredentialHelper.getCredential(credentialsId);
+        return CredentialHelper.getPasswordFromCredential(credential);
+    }
+
+    @Extension
+    public static class DescriptorImpl extends RedisFingerprintStorageDescriptor {
+
+    }
+
 }