Cache network list and availability info

Author: olivergondza

plugin/src/main/java/jenkins/plugins/openstack/compute/auth/AbstractOpenstackCredential.java

@@ -1,6 +1,7 @@
 package jenkins.plugins.openstack.compute.auth;
 
 import com.cloudbees.plugins.credentials.CredentialsScope;
+import com.cloudbees.plugins.credentials.common.PasswordCredentials;
 import com.cloudbees.plugins.credentials.impl.BaseStandardCredentials;
 import hudson.ExtensionPoint;
 
@@ -11,5 +12,6 @@ public abstract class AbstractOpenstackCredential extends BaseStandardCredential
 
     public AbstractOpenstackCredential(@CheckForNull CredentialsScope scope, @CheckForNull String id, @CheckForNull String description) {
         super(scope, id, description);
+        assert this instanceof PasswordCredentials;
     }
 }

plugin/src/main/java/jenkins/plugins/openstack/compute/internal/Openstack.java

@@ -130,6 +130,17 @@ public class Openstack {
     // Store the OS session token so clients can be created from it per all threads using this.
     private final ClientProvider clientProvider;
 
+    private static final @Nonnull Cache<Openstack, List<? extends Network>> networksCache
+            = Caffeine.newBuilder().expireAfterWrite(10, TimeUnit.MINUTES).build()
+    ;
+
+    // The time to cache here is questionable as the information can get outdated based on activity out of our reach.
+    // Caching this for few seconds will smooth spikes provisioning many VMs at the time, although it might cause some
+    // of provisioning attempts to fail in case the number fo the VMs is larger than number of free IPs in the pool with most free IPs.
+    private static final @Nonnull Cache<Openstack, List<? extends NetworkIPAvailability>> networkIpAvailabilityCache
+            = Caffeine.newBuilder().expireAfterWrite(5, TimeUnit.SECONDS).build()
+    ;
+
     private Openstack(@Nonnull String endPointUrl, boolean ignoreSsl, @Nonnull OpenstackCredential auth, @CheckForNull String region) {
 
         final IOSClientBuilder<? extends OSClient<?>, ?> builder = auth.getBuilder(endPointUrl);
@@ -150,7 +161,7 @@ private Openstack(@Nonnull String endPointUrl, boolean ignoreSsl, @Nonnull Opens
         debug("Openstack client created for \"{0}\", \"{1}\".", auth.toString(), region);
     }
 
-    /*exposed for testing*/
+    @VisibleForTesting
     public Openstack(@Nonnull final OSClient<?> client) {
         this.clientProvider = new ClientProvider() {
             @Override public @Nonnull OSClient<?> get() {
@@ -178,8 +189,11 @@ public Openstack(@Nonnull final OSClient<?> client) {
     }
 
     @VisibleForTesting
-    public  @Nonnull List<? extends Network> _listNetworks() {
-        return clientProvider.get().networking().network().list();
+    public @Nonnull List<? extends Network> _listNetworks() {
+        return Objects.requireNonNull(networksCache.get(
+                this,
+                (os) -> os.clientProvider.get().networking().network().list()
+        ));
     }
 
     /**
@@ -223,7 +237,7 @@ public Openstack(@Nonnull final OSClient<?> client) {
 
         List<String> declaredIds = declaredNetworks.values().stream().map(Network::getId).collect(Collectors.toList());
 
-        List<? extends NetworkIPAvailability> networkIPAvailabilities = clientProvider.get().networking().networkIPAvailability().get();
+        List<? extends NetworkIPAvailability> networkIPAvailabilities = getNetworkIPAvailability();
 
         return networkIPAvailabilities.stream().filter( // Those we care for
                 n -> declaredIds.contains(n.getNetworkId())
@@ -233,6 +247,13 @@ public Openstack(@Nonnull final OSClient<?> client) {
         ));
     }
 
+    public List<? extends NetworkIPAvailability> getNetworkIPAvailability() {
+        return Objects.requireNonNull(networkIpAvailabilityCache.get(
+                this,
+                (os) -> os.clientProvider.get().networking().networkIPAvailability().get()
+        ));
+    }
+
     /**
      * Finds all {@link Image}s.
      *
@@ -868,11 +889,6 @@ public static abstract class FactoryEP implements ExtensionPoint {
         public static @Nonnull Openstack get(
                 @Nonnull final String endPointUrl, final boolean ignoreSsl, @Nonnull final OpenstackCredential auth, @CheckForNull final String region
         ) throws FormValidation {
-            final String fingerprint = Util.getDigestOf(endPointUrl +  '\n'
-                    + ignoreSsl + '\n'
-                    + auth.toString() + '\n'
-                    + (auth instanceof PasswordCredentials ? ((PasswordCredentials) auth).getPassword().getEncryptedValue() + '\n' : "")
-                    + region);
             final FactoryEP ep = ExtensionList.lookup(FactoryEP.class).get(0);
             final Function<String, Openstack> cacheMissFunction = (String unused) -> {
                 try {
@@ -882,6 +898,7 @@ public static abstract class FactoryEP implements ExtensionPoint {
                 }
             };
 
+            final String fingerprint = getCloudConnectionFingerprint(endPointUrl, ignoreSsl, auth, region);
             try {
                 // cacheMissFunction is guaranteed to return nonnull
                 return Objects.requireNonNull(ep.cache.get(fingerprint, cacheMissFunction));
@@ -913,6 +930,23 @@ public static abstract class FactoryEP implements ExtensionPoint {
         }
     }
 
+    /**
+     * Get a string unique per cloud connection.
+     *
+     * This is used as caching identifier.
+     */
+    @Nonnull
+    private static String getCloudConnectionFingerprint(
+            @Nonnull String endPointUrl, boolean ignoreSsl, @Nonnull OpenstackCredential auth, @CheckForNull String region
+    ) {
+        String pwd = auth instanceof PasswordCredentials
+                ? ((PasswordCredentials) auth).getPassword().getEncryptedValue()
+                : ""
+        ;
+        String plain = String.join("::", endPointUrl, Boolean.toString(ignoreSsl), auth.toString(), pwd, region);
+        return Util.getDigestOf(plain);
+    }
+
     @Extension
     public static final class Factory extends FactoryEP {
         public @Nonnull Openstack getOpenstack(@Nonnull String endPointUrl, boolean ignoreSsl, @Nonnull OpenstackCredential auth, @CheckForNull String region) throws FormValidation {

plugin/src/test/java/jenkins/plugins/openstack/PluginTestRule.java

@@ -3,6 +3,7 @@
 import com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey;
 import com.cloudbees.plugins.credentials.CredentialsScope;
 import com.cloudbees.plugins.credentials.SystemCredentialsProvider;
+import com.cloudbees.plugins.credentials.common.PasswordCredentials;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableList.Builder;
 
@@ -27,6 +28,7 @@
 import hudson.slaves.OfflineCause;
 import hudson.util.FormValidation;
 import hudson.util.ProcessTree;
+import hudson.util.Secret;
 import hudson.util.StreamTaskListener;
 import jenkins.model.Jenkins;
 import jenkins.plugins.openstack.compute.JCloudsCleanupThread;
@@ -150,8 +152,9 @@ public static NodeProperty<Node> mkNodeProperty(int number) {
         }
     }
 
-    public static class DummyOpenstackCredentials extends AbstractOpenstackCredential {
+    public static class DummyOpenstackCredentials extends AbstractOpenstackCredential implements PasswordCredentials {
         private static final long serialVersionUID = -6458476198187349017L;
+        public static final Secret SECRET = Secret.fromString("");
 
         private DummyOpenstackCredentials() {
             super(CredentialsScope.SYSTEM, "my-id", "testCredentials");
@@ -161,6 +164,12 @@ private DummyOpenstackCredentials() {
         public @Nonnull IOSClientBuilder<? extends OSClient<?>, ?> getBuilder(String endPointUrl) {
             throw new AuthenticationException(getClass().getSimpleName() + " can not be use to create client", -1);
         }
+
+        @Nonnull
+        @Override
+        public Secret getPassword() {
+            return SECRET;
+        }
     }
 
     public String dummyCredentials() {