Make object store service info creation independent from plan

IvanBorislavovDimitrov · IvanBorislavovDimitrov · commit 1e3f7174ff99 · 2024-01-12T10:34:48.000+02:00
diff --git a/multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/Constants.java b/multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/Constants.java
@@ -18,4 +18,20 @@ private Constants() {
     public static final long OAUTH_TOKEN_RETENTION_TIME_IN_SECONDS = TimeUnit.MINUTES.toSeconds(2);
     public static final long BASIC_TOKEN_RETENTION_TIME_IN_SECONDS = TimeUnit.MINUTES.toSeconds(6);
 
+    // Object Store
+    public static final String ACCESS_KEY_ID = "access_key_id";
+    public static final String SECRET_ACCESS_KEY = "secret_access_key";
+    public static final String BUCKET = "bucket";
+    public static final String REGION = "region";
+    public static final String ENDPOINT = "endpoint";
+    public static final String ACCOUNT_NAME = "account_name";
+    public static final String SAS_TOKEN = "sas_token";
+    public static final String CONTAINER_NAME = "container_name";
+    public static final String CONTAINER_URI = "container_uri";
+    public static final String BASE_64_ENCODED_PRIVATE_KEY_DATA = "base64EncodedPrivateKeyData";
+
+    public static final String AWS_S_3 = "aws-s3";
+    public static final String AZUREBLOB = "azureblob";
+    public static final String ALIYUN_OSS = "aliyun-oss";
+    public static final String GOOGLE_CLOUD_STORAGE_CUSTOM = "google-cloud-storage-custom";
 }
diff --git a/multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/Messages.java b/multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/Messages.java
@@ -18,7 +18,6 @@ public final class Messages {
     public static final String ERROR_FROM_REMOTE_MTAR_ENDPOINT = "Error from remote MTAR endpoint {0} with status code {1}, message: {2}";
     public static final String MTAR_ENDPOINT_NOT_SECURE = "Remote MTAR endpoint is not a secure connection. HTTPS required";
     public static final String CANNOT_PARSE_CONTAINER_URI_OF_OBJECT_STORE = "Cannot parse container_uri of object store";
-    public static final String UNSUPPORTED_SERVICE_PLAN_FOR_OBJECT_STORE = "Unsupported service plan for object store!";
     public static final String REQUEST_0_1_FAILED_WITH_2 = "Request \"{0} {1}\" failed with \"{2}\"";
     public static final String ERROR_OCCURRED_WHILE_DELETING_JOB_ENTRY = "Error occurred while deleting job entry";
     public static final String JOB_0_HAS_NOT_BEEN_UPDATED_FOR_15_MINUTES = "Job {0} has not been updated for 15 minutes.";
@@ -48,6 +47,7 @@ public final class Messages {
     public static final String JOB_IS_NOT_BEING_EXECUTED = "Job is not being executed";
     public static final String JOB_0_EXISTS_IN_STATE_1_BUT_DOES_NOT_EXISTS_IN_THE_RUNNING_TASKS = "Job \"{0}\" exists in state \"{1}\" but does not exists in the running tasks";
     public static final String JOB_THREAD_IS_NOT_RUNNING_BUT_STATE_IS_STILL_IN_PROGRESS_UPLOAD_FAILED = "Job thread is not running but state is still in progress. Upload failed";
+    public static final String ERROR_BUILDING_OBJECT_STORE_CONFIGURATION = "Error while building object store configuration.";
 
     // WARN log messages
     public static final String THE_JOB_EXISTS_BUT_IT_IS_NOT_RUNNING_DELETING = "The job exists but it is not running. Deleting";
@@ -61,6 +61,10 @@ public final class Messages {
     public static final String OBJECTSTORE_FOR_BINARIES_STORAGE = "Objectstore will be used for binaries storage";
     public static final String CLEARING_LOCK_OWNER = "Clearing lock owner {0}...";
     public static final String CLEARED_LOCK_OWNER = "Cleared lock owner {0}";
+    public static final String CREATING_OBJECT_STORE_FOR_ALI_CLOUD = "Creating object store for Ali Cloud";
+    public static final String CREATING_OBJECT_STORE_FOR_AWS = "Creating object store for AWS";
+    public static final String CREATING_OBJECT_STORE_FOR_AZURE = "Creating object store for Azure";
+    public static final String CREATING_OBJECT_STORE_FOR_GCP = "Creating object store for GCP";
 
     // DEBUG log messages
     public static final String RECEIVED_UPLOAD_REQUEST = "Received upload request on URI: {}";
diff --git a/multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/configuration/service/ObjectStoreServiceInfoCreator.java b/multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/configuration/service/ObjectStoreServiceInfoCreator.java
@@ -6,57 +6,78 @@
 import java.util.Base64;
 import java.util.Map;
 
+import org.cloudfoundry.multiapps.controller.web.Constants;
 import org.cloudfoundry.multiapps.controller.web.Messages;
 import org.jclouds.domain.Credentials;
 import org.jclouds.googlecloud.GoogleCredentialsFromJson;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import com.google.common.base.Supplier;
 
 import io.pivotal.cfenv.core.CfService;
 
 public class ObjectStoreServiceInfoCreator {
 
-    private static final String OBJECT_STORE_AWS_PLAN = "s3-standard";
-    private static final String OBJECT_STORE_AZURE_PLAN = "azure-standard";
-    private static final String OBJECT_STORE_ALICLOUD_PLAN = "oss-standard";
-    private static final String OBJECT_STORE_GCP_PLAN = "gcs-standard";
+    private static final Logger LOGGER = LoggerFactory.getLogger(ObjectStoreServiceInfoCreator.class);
 
     public ObjectStoreServiceInfo createServiceInfo(CfService service) {
-        String plan = service.getPlan();
         Map<String, Object> credentials = service.getCredentials()
                                                  .getMap();
-        switch (plan) {
-            case OBJECT_STORE_AWS_PLAN:
-                return createServiceInfoForAws(credentials);
-            case OBJECT_STORE_AZURE_PLAN:
-                return createServiceInfoForAzure(credentials);
-            case OBJECT_STORE_ALICLOUD_PLAN:
-                return createServiceInfoForAliCloud(credentials);
-            case OBJECT_STORE_GCP_PLAN:
-                return createServiceInfoForGcpCloud(credentials);
-            default:
-                throw new IllegalStateException(Messages.UNSUPPORTED_SERVICE_PLAN_FOR_OBJECT_STORE);
+        if (isAliCloudIaas(credentials)) {
+            LOGGER.info(Messages.CREATING_OBJECT_STORE_FOR_ALI_CLOUD);
+            return createServiceInfoForAliCloud(credentials);
         }
+        if (isAwsIaas(credentials)) {
+            LOGGER.info(Messages.CREATING_OBJECT_STORE_FOR_AWS);
+            return createServiceInfoForAws(credentials);
+        }
+        if (isAzureIaas(credentials)) {
+            LOGGER.info(Messages.CREATING_OBJECT_STORE_FOR_AZURE);
+            return createServiceInfoForAzure(credentials);
+        }
+        if (isGcpIaas(credentials)) {
+            LOGGER.info(Messages.CREATING_OBJECT_STORE_FOR_GCP);
+            return createServiceInfoForGcpCloud(credentials);
+        }
+        throw new IllegalStateException(Messages.ERROR_BUILDING_OBJECT_STORE_CONFIGURATION);
+    }
+
+    private boolean isAwsIaas(Map<String, Object> credentials) {
+        // @formatter:off
+        return credentials.containsKey(Constants.ACCESS_KEY_ID) &&
+               credentials.containsKey(Constants.SECRET_ACCESS_KEY) &&
+               credentials.containsKey(Constants.BUCKET);
+        // @formatter:on
     }
 
     private ObjectStoreServiceInfo createServiceInfoForAws(Map<String, Object> credentials) {
-        String accessKeyId = (String) credentials.get("access_key_id");
-        String secretAccessKey = (String) credentials.get("secret_access_key");
-        String bucket = (String) credentials.get("bucket");
+        String accessKeyId = (String) credentials.get(Constants.ACCESS_KEY_ID);
+        String secretAccessKey = (String) credentials.get(Constants.SECRET_ACCESS_KEY);
+        String bucket = (String) credentials.get(Constants.BUCKET);
         return ImmutableObjectStoreServiceInfo.builder()
-                                              .provider("aws-s3")
+                                              .provider(Constants.AWS_S_3)
                                               .identity(accessKeyId)
                                               .credential(secretAccessKey)
                                               .container(bucket)
                                               .build();
     }
 
+    private boolean isAzureIaas(Map<String, Object> credentials) {
+        // @formatter:off
+        return credentials.containsKey(Constants.ACCOUNT_NAME) &&
+               credentials.containsKey(Constants.SAS_TOKEN) &&
+               credentials.containsKey(Constants.CONTAINER_NAME) &&
+               credentials.containsKey(Constants.CONTAINER_URI);
+        // @formatter:on
+    }
+
     private ObjectStoreServiceInfo createServiceInfoForAzure(Map<String, Object> credentials) {
-        String accountName = (String) credentials.get("account_name");
-        String sasToken = (String) credentials.get("sas_token");
-        String containerName = (String) credentials.get("container_name");
+        String accountName = (String) credentials.get(Constants.ACCOUNT_NAME);
+        String sasToken = (String) credentials.get(Constants.SAS_TOKEN);
+        String containerName = (String) credentials.get(Constants.CONTAINER_NAME);
         return ImmutableObjectStoreServiceInfo.builder()
-                                              .provider("azureblob")
+                                              .provider(Constants.AZUREBLOB)
                                               .identity(accountName)
                                               .credential(sasToken)
                                               .endpoint(getContainerUriEndpoint(credentials).toString())
@@ -66,21 +87,31 @@ private ObjectStoreServiceInfo createServiceInfoForAzure(Map<String, Object> cre
 
     private URL getContainerUriEndpoint(Map<String, Object> credentials) {
         try {
-            URL containerUri = new URL((String) credentials.get("container_uri"));
+            URL containerUri = new URL((String) credentials.get(Constants.CONTAINER_URI));
             return new URL(containerUri.getProtocol(), containerUri.getHost(), containerUri.getPort(), "");
         } catch (MalformedURLException e) {
             throw new IllegalStateException(Messages.CANNOT_PARSE_CONTAINER_URI_OF_OBJECT_STORE, e);
         }
     }
 
+    private boolean isAliCloudIaas(Map<String, Object> credentials) {
+        // @formatter:off
+        return credentials.containsKey(Constants.ACCESS_KEY_ID) &&
+               credentials.containsKey(Constants.SECRET_ACCESS_KEY) &&
+               credentials.containsKey(Constants.BUCKET) &&
+               credentials.containsKey(Constants.REGION) &&
+               credentials.containsKey(Constants.ENDPOINT);
+        // @formatter:on
+    }
+
     private ObjectStoreServiceInfo createServiceInfoForAliCloud(Map<String, Object> credentials) {
-        String accessKeyId = (String) credentials.get("access_key_id");
-        String secretAccessKey = (String) credentials.get("secret_access_key");
-        String bucket = (String) credentials.get("bucket");
-        String region = (String) credentials.get("region");
-        String endpoint = (String) credentials.get("endpoint");
+        String accessKeyId = (String) credentials.get(Constants.ACCESS_KEY_ID);
+        String secretAccessKey = (String) credentials.get(Constants.SECRET_ACCESS_KEY);
+        String bucket = (String) credentials.get(Constants.BUCKET);
+        String region = (String) credentials.get(Constants.REGION);
+        String endpoint = (String) credentials.get(Constants.ENDPOINT);
         return ImmutableObjectStoreServiceInfo.builder()
-                                              .provider("aliyun-oss")
+                                              .provider(Constants.ALIYUN_OSS)
                                               .identity(accessKeyId)
                                               .credential(secretAccessKey)
                                               .container(bucket)
@@ -89,19 +120,31 @@ private ObjectStoreServiceInfo createServiceInfoForAliCloud(Map<String, Object>
                                               .build();
     }
 
+    private boolean isGcpIaas(Map<String, Object> credentials) {
+        // @formatter:off
+        return credentials.containsKey(Constants.BUCKET) &&
+               credentials.containsKey(Constants.REGION) &&
+               credentials.containsKey(Constants.BASE_64_ENCODED_PRIVATE_KEY_DATA);
+        // @formatter:on
+    }
+
     private ObjectStoreServiceInfo createServiceInfoForGcpCloud(Map<String, Object> credentials) {
-        String bucket = (String) credentials.get("bucket");
-        String region = (String) credentials.get("region");
-        byte[] decodedKey = Base64.getDecoder()
-                                  .decode((String) credentials.get("base64EncodedPrivateKeyData"));
-        String decodedCredential = new String(decodedKey, StandardCharsets.UTF_8);
-        Supplier<Credentials> credentialsSupplier = new GoogleCredentialsFromJson(decodedCredential);
+        String bucket = (String) credentials.get(Constants.BUCKET);
+        String region = (String) credentials.get(Constants.REGION);
+        Supplier<Credentials> credentialsSupplier = getGcpCredentialsSupplier(credentials);
         return ImmutableObjectStoreServiceInfo.builder()
-                                              .provider("google-cloud-storage-custom")
+                                              .provider(Constants.GOOGLE_CLOUD_STORAGE_CUSTOM)
                                               .credentialsSupplier(credentialsSupplier)
                                               .container(bucket)
                                               .region(region)
                                               .build();
     }
 
+    protected Supplier<Credentials> getGcpCredentialsSupplier(Map<String, Object> credentials) {
+        byte[] decodedKey = Base64.getDecoder()
+                                  .decode((String) credentials.get(Constants.BASE_64_ENCODED_PRIVATE_KEY_DATA));
+        String decodedCredential = new String(decodedKey, StandardCharsets.UTF_8);
+        return new GoogleCredentialsFromJson(decodedCredential);
+    }
+
 }
diff --git a/multiapps-controller-web/src/test/java/org/cloudfoundry/multiapps/controller/web/configuration/service/ObjectStoreServiceInfoCreatorTest.java b/multiapps-controller-web/src/test/java/org/cloudfoundry/multiapps/controller/web/configuration/service/ObjectStoreServiceInfoCreatorTest.java
