Storage uses plain Object Storage URLs (#66)

anders-swanson · web-flow · commit 38c5b268ba0e · 2024-07-15T13:04:57.000-07:00
* OCI Storage uses plain object storage URLs

Signed-off-by: Anders Swanson &lt;anders.swanson@oracle.com&gt;

---------

Signed-off-by: Anders Swanson &lt;anders.swanson@oracle.com&gt;
diff --git a/docs/src/main/asciidoc/storage.adoc b/docs/src/main/asciidoc/storage.adoc
@@ -37,7 +37,7 @@ The `Storage` bean (link[Javadoc]) can be used to list, create, update or delete
 private Storage storage;
 
 public void createBucketAndUploadFile() {
-    Bucket bucket = storage.createBucket("my-bucket")
+    Bucket bucket = storage.createBucket("my-bucket");
 
     storage.upload("my-bucket", "my-file.txt", inputStream, StorageObjectMetadata.builder().contentType("text/plain").build());
 }
@@ -46,19 +46,19 @@ public void createBucketAndUploadFile() {
 === Cloud Storage Objects Spring Resources
 
 https://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html[Spring Resources] are an abstraction for several low-level resources, such as file system files, classpath files, servlet context-relative files, etc.
-Spring Cloud OCI adds a new resource type: an Oracle Cloud Storage (OCS) object.
+Spring Cloud OCI adds a new resource type for Oracle Cloud Object Storage.
 
-The Spring Resource Abstraction for Oracle Cloud Storage allows OCS objects to be accessed by their OCS URL using the `@Value` annotation or the Spring application context:
+The Spring Resource Abstraction for Oracle Cloud Storage allows Object Storage objects to be accessed by their URL using the `@Value` annotation or the Spring application context:
 
 [source,java]
 ----
-@Value("ocs://[YOUR_OCS_BUCKET]/[OCS_FILE_NAME]")
-private Resource ocsResource;
+@Value("https://objectstorage.us-chicago-1.oraclecloud.com/n/${OCI_NAMESPACE}/b/${OCI_BUCKET}/o/${OCI_OBJECT}")
+private Resource myObjectResource;
 ----
 
 [source,java]
 ----
-SpringApplication.run(...).getResource("ocs://[YOUR_OCS_BUCKET]/[OCS_FILE_NAME]");
+SpringApplication.run(...).getResource("Object Storage URL");
 ----
 
 This creates a `Resource` object that can be used to read the object, among https://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html#resources-resource[other possible operations].
diff --git a/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/main/java/com/oracle/cloud/spring/sample/storage/springcloudocistoragesample/ImageController.java b/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/main/java/com/oracle/cloud/spring/sample/storage/springcloudocistoragesample/ImageController.java
@@ -54,10 +54,6 @@ ResponseEntity<Resource> download(@Parameter(required = true, example = "new-buc
     @PostMapping(value = "/{bucketName}", consumes = MULTIPART_FORM_DATA_VALUE)
     ResponseEntity<?> upload(@Parameter(required = true) @RequestPart(required = true, name = "file") MultipartFile multipartFile,
                              @Parameter(required = true, example = "new-bucket") @PathVariable String bucketName) throws IOException {
-        //if (!IMAGE_JPEG.toString().equals(multipartFile.getContentType())) {
-          //  return ResponseEntity.badRequest().body("Invalid image file");
-       // }
-
         try (InputStream is = multipartFile.getInputStream()) {
             storage.upload(bucketName, multipartFile.getOriginalFilename(), is,
                     StorageObjectMetadata.builder().contentType(multipartFile.getContentType()).build());
diff --git a/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/main/java/com/oracle/cloud/spring/sample/storage/springcloudocistoragesample/ObjectController.java b/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/main/java/com/oracle/cloud/spring/sample/storage/springcloudocistoragesample/ObjectController.java
@@ -11,6 +11,7 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
+import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -33,18 +34,11 @@ public class ObjectController {
     @Autowired
     ResourceLoader loader;
 
-    @Value("ocs://your-bucket/555.json")
-    Object myObject;
+    @Value("https://objectstorage.us-chicago-1.oraclecloud.com/n/${OCI_NAMESPACE}/b/${OCI_BUCKET}/o/${OCI_OBJECT}")
+    Resource myObject;
 
     @GetMapping("/")
-    String hello() throws IOException {
-        // Note: This is the sample piece of code to access 
-        // OCI Storage Object with resource URI as ocs://<bucket>/<object-name>
-
-        // Object obj = loader.getResource("ocs://your-bucket/object-name");
-        // Scanner s = new Scanner(((OracleStorageResource)obj).getInputStream()).useDelimiter("\\A");
-        // String result = s.hasNext() ? s.next() : "";
-        // System.out.println(result);
+    String hello() {
         return "Hello World ";
     }
 
diff --git a/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/main/resources/application.properties b/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/main/resources/application.properties
diff --git a/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/main/resources/application.yaml b/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/main/resources/application.yaml
@@ -0,0 +1,9 @@
+spring:
+  cloud:
+    oci:
+      compartment:
+        static: ${OCI_COMPARTMENT}
+      config:
+        type: file
+      region:
+        static: us-chicago-1
diff --git a/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/test/java/com/oracle/cloud/spring/sample/storage/springcloudocistoragesample/SpringCloudOciStorageSampleApplicationTests.java b/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/test/java/com/oracle/cloud/spring/sample/storage/springcloudocistoragesample/SpringCloudOciStorageSampleApplicationTests.java
@@ -5,30 +5,43 @@
 
 package com.oracle.cloud.spring.sample.storage.springcloudocistoragesample;
 
-import com.oracle.cloud.spring.sample.common.base.SpringCloudSampleApplicationTestBase;
 import com.oracle.cloud.spring.storage.Storage;
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.condition.EnabledIfSystemProperty;
+import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.test.context.TestPropertySource;
+import org.springframework.core.io.Resource;
 
 import java.io.IOException;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 @SpringBootTest
-@EnabledIfSystemProperty(named = "it.storage", matches = "true")
-@TestPropertySource(locations="classpath:application-test.properties")
-class SpringCloudOciStorageSampleApplicationTests extends SpringCloudSampleApplicationTestBase {
-    static final String TEST_BUCKET = "bucketName";
+@EnabledIfEnvironmentVariable(named = "OCI_NAMESPACE", matches = ".+")
+@EnabledIfEnvironmentVariable(named = "OCI_BUCKET", matches = ".+")
+@EnabledIfEnvironmentVariable(named = "OCI_OBJECT", matches = ".+")
+@EnabledIfEnvironmentVariable(named = "OCI_COMPARTMNET", matches = ".+")
+class SpringCloudOciStorageSampleApplicationTests {
 
-    static final String testBucket = System.getProperty(TEST_BUCKET) != null ? System.getProperty(TEST_BUCKET) :
-            System.getenv().get(TEST_BUCKET);
+    static final String testBucket = System.getenv("OCI_BUCKET");
 
     @Autowired
     Storage storage;
 
+    @Autowired
+    ObjectController objectController;
+
+    @Test
+    void resourceIsLoaded() throws IOException {
+        Resource myObject = objectController.myObject;
+        assertThat(myObject).isNotNull();
+        assertThat(myObject.getContentAsByteArray()).hasSizeGreaterThan(1);
+    }
+
     @Test
-    void testFileUpload() throws IOException {
+    @Disabled
+    void storePOJO() throws IOException {
         ActivityInfo ainfo = new ActivityInfo("Hello from Storage integration test");
         storage.store(testBucket, ainfo.getFileName(), ainfo);
     }
diff --git a/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/test/resources/application-test.properties b/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/src/test/resources/application-test.properties
diff --git a/spring-cloud-oci-storage/src/main/java/com/oracle/cloud/spring/storage/OracleStorageProtocolResolver.java b/spring-cloud-oci-storage/src/main/java/com/oracle/cloud/spring/storage/OracleStorageProtocolResolver.java
@@ -69,7 +69,7 @@ public void setResourceLoader(ResourceLoader resourceLoader) {
             ((DefaultResourceLoader) resourceLoader).addProtocolResolver(this);
         } else {
             LOGGER.warn("The provided delegate resource loader is not an implementation "
-                    + "of DefaultResourceLoader. Custom Protocol using ocs:// prefix will not be enabled.");
+                    + "of DefaultResourceLoader. Custom OCI Object Storage prefix will not be enabled.");
         }
     }
 
diff --git a/spring-cloud-oci-storage/src/main/java/com/oracle/cloud/spring/storage/OracleStorageResource.java b/spring-cloud-oci-storage/src/main/java/com/oracle/cloud/spring/storage/OracleStorageResource.java
@@ -11,10 +11,12 @@
 import com.oracle.bmc.objectstorage.responses.GetNamespaceResponse;
 import com.oracle.bmc.objectstorage.responses.GetObjectResponse;
 import org.springframework.core.io.AbstractResource;
+import org.springframework.core.io.WritableResource;
 import org.springframework.lang.Nullable;
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStream;
 
 /**
  * Default OCI Storage resource implementation of Spring Resource.
@@ -40,9 +42,9 @@ public static OracleStorageResource create(String location, ObjectStorageClient
         return null;
     }
 
-    public OracleStorageResource(String bucketName, String objectName, String version,
+    public OracleStorageResource(String bucketName, String objectName,
                                  ObjectStorageClient osClient) {
-        this(new StorageLocation(bucketName, objectName, version), osClient);
+        this(new StorageLocation(bucketName, objectName), osClient);
     }
 
     public OracleStorageResource(StorageLocation location, ObjectStorageClient osClient) {
@@ -76,7 +78,6 @@ public InputStream getInputStream() throws IOException {
                                 .namespaceName(namespaceName)
                                 .bucketName(location.getBucket())
                                 .objectName(location.getObject())
-                                .versionId(location.getVersion())
                                 .build());
         return getResponse.getInputStream();
     }
diff --git a/spring-cloud-oci-storage/src/main/java/com/oracle/cloud/spring/storage/StorageImpl.java b/spring-cloud-oci-storage/src/main/java/com/oracle/cloud/spring/storage/StorageImpl.java
@@ -65,7 +65,7 @@ public OracleStorageResource download(String bucketName, String key, String vers
         Assert.notNull(bucketName, ERROR_BUCKET_NAME_REQUIRED);
         Assert.notNull(key, ERROR_KEY_REQUIRED);
 
-        return new OracleStorageResource(bucketName, key, version, osClient);
+        return new OracleStorageResource(bucketName, key, osClient);
     }
 
     /**
diff --git a/spring-cloud-oci-storage/src/main/java/com/oracle/cloud/spring/storage/StorageLocation.java b/spring-cloud-oci-storage/src/main/java/com/oracle/cloud/spring/storage/StorageLocation.java
@@ -5,19 +5,20 @@
 
 package com.oracle.cloud.spring.storage;
 
+import java.util.regex.Pattern;
+
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
- * Storage location parser for ocs:// protocol URI.
+ * Storage location parser for Object Storage URI.
  */
 public class StorageLocation {
+    private static final Pattern URL_PATTERN = Pattern.compile("(https://)?(.+?\\.)?objectstorage\\.(.+?)\\.(oraclecloud\\.com|oci\\.customer-oci\\.com)(.+?)");
 
-    private static final String OCS_PROTOCOL_PREFIX = "ocs://";
-
-    private static final String PATH_DELIMITER = "/";
+    private static final String BUCKET_DELIMITER = "/b/";
 
-    private static final String VERSION_DELIMITER = "^";
+    private static final String OBJECT_DELIMITER = "/o/";
 
     static final String ERROR_BUCKET_REQUIRED = "bucket is required";
 
@@ -29,20 +30,12 @@ public class StorageLocation {
 
     private final String object;
 
-    @Nullable
-    private final String version;
-
     StorageLocation(String bucket, String object) {
-        this(bucket, object, null);
-    }
-
-    StorageLocation(String bucket, String object, @Nullable String version) {
         Assert.notNull(bucket, ERROR_BUCKET_REQUIRED);
         Assert.notNull(object, ERROR_OBJECT_REQUIRED);
 
         this.bucket = bucket;
         this.object = object;
-        this.version = version;
     }
 
     String getBucket() {
@@ -53,15 +46,9 @@ String getObject() {
         return object;
     }
 
-    @Nullable
-    String getVersion() {
-        return version;
-    }
-
     @Override
     public String toString() {
-        return "Location{" + "bucket='" + bucket + '\'' + ", object='" + object + '\'' + ", version='" + version + '\''
-                + '}';
+        return String.format("Location{bucket='%s', object='%s'}", bucket, object);
     }
 
     /**
@@ -72,63 +59,37 @@ public String toString() {
     @Nullable
     public static StorageLocation resolve(String location) {
         if (isSimpleStorageResource(location)) {
-            return new StorageLocation(resolveBucketName(location), resolveObjectName(location), resolveVersionId(location));
+            return new StorageLocation(resolveBucketName(location), resolveObjectName(location));
         }
 
         return null;
     }
 
     /**
-     * Checks whether the location URI starts with protocol prefix (oci://).
-     * @param location String contains storage URI.
+     * Checks whether the location URI is an OCI Object Storage URI.
+     * @param location Resource location.
      * @return Boolean
      */
     static boolean isSimpleStorageResource(String location) {
         Assert.notNull(location, "Location must not be null");
-        return location.toLowerCase().startsWith(OCS_PROTOCOL_PREFIX);
+        return URL_PATTERN.matcher(location).matches();
     }
 
     public static String resolveBucketName(String location) {
-        int bucketEndIndex = location.indexOf(PATH_DELIMITER, OCS_PROTOCOL_PREFIX.length());
-        if (bucketEndIndex == -1 || bucketEndIndex == OCS_PROTOCOL_PREFIX.length()) {
+        int bucketStartIndex = location.indexOf(BUCKET_DELIMITER);
+        int bucketEndIndex = location.indexOf(OBJECT_DELIMITER);
+        if (bucketStartIndex == -1 || location.length() < BUCKET_DELIMITER.length()) {
             throw new IllegalArgumentException("The location :'" + location + "' " + ERROR_INVALID_BUCKET);
         }
-        return location.substring(OCS_PROTOCOL_PREFIX.length(), bucketEndIndex);
+        return location.substring(bucketStartIndex + BUCKET_DELIMITER.length(), bucketEndIndex == -1 ? location.length() - 1 : bucketEndIndex);
     }
 
     public static String resolveObjectName(String location) {
-        int bucketEndIndex = location.indexOf(PATH_DELIMITER, OCS_PROTOCOL_PREFIX.length());
-        if (bucketEndIndex == -1 || bucketEndIndex == OCS_PROTOCOL_PREFIX.length()) {
-            throw new IllegalArgumentException("The location :'" + location + "' " + ERROR_INVALID_BUCKET);
-        }
-
-        if (location.contains(VERSION_DELIMITER)) {
-            return resolveObjectName(location.substring(0, location.indexOf(VERSION_DELIMITER)));
-        }
-
-        int endIndex = location.length();
-        if (location.endsWith(PATH_DELIMITER)) {
-            endIndex--;
-        }
-
-        if (bucketEndIndex >= endIndex) {
-            return "";
-        }
-
-        return location.substring(++bucketEndIndex, endIndex);
-    }
-
-    @Nullable
-    public static String resolveVersionId(String location) {
-        int objectNameEndIndex = location.indexOf(VERSION_DELIMITER, OCS_PROTOCOL_PREFIX.length());
-        if (objectNameEndIndex == -1 || location.endsWith(VERSION_DELIMITER)) {
-            return null;
-        }
+        int objectStartIndex = location.indexOf(OBJECT_DELIMITER);
 
-        if (objectNameEndIndex == OCS_PROTOCOL_PREFIX.length()) {
-            throw new IllegalArgumentException("The location :'" + location + "' " + ERROR_INVALID_BUCKET);
+        if (objectStartIndex == -1 || location.length() < OBJECT_DELIMITER.length()) {
+            throw new IllegalArgumentException(ERROR_OBJECT_REQUIRED);
         }
-
-        return location.substring(++objectNameEndIndex, location.length());
+        return location.substring(objectStartIndex + OBJECT_DELIMITER.length());
     }
 }
diff --git a/spring-cloud-oci-storage/src/test/java/com/oracle/cloud/spring/storage/OracleStorageProtocolResolverTests.java b/spring-cloud-oci-storage/src/test/java/com/oracle/cloud/spring/storage/OracleStorageProtocolResolverTests.java
@@ -36,7 +36,7 @@ public void testGetStorageClient() {
     @Test
     public void testResolve() {
         try (MockedStatic mock = mockStatic(OracleStorageResource.class)) {
-            oracleStorageProtocolResolver.resolve("ocs://test", new DefaultResourceLoader());
+            oracleStorageProtocolResolver.resolve("https://objectstorage.us-chicago-1.oraclecloud.com/n/namespace/b/mybucket/o/myobject", new DefaultResourceLoader());
         }
     }
 }
diff --git a/spring-cloud-oci-storage/src/test/java/com/oracle/cloud/spring/storage/OracleStorageResourceTests.java b/spring-cloud-oci-storage/src/test/java/com/oracle/cloud/spring/storage/OracleStorageResourceTests.java
@@ -19,12 +19,12 @@
 
 public class OracleStorageResourceTests {
     final ObjectStorageClient osClient = mock(ObjectStorageClient.class);
-    final OracleStorageResource oracleStorageResource = new OracleStorageResource("testBucket", "testObject", "1.0", osClient);
+    final OracleStorageResource oracleStorageResource = new OracleStorageResource("testBucket", "testObject", osClient);
 
     @Test
     public void testCreate() {
         try (MockedStatic mock = mockStatic(StorageLocation.class)) {
-            OracleStorageResource.create("ocs://test/bucket", osClient);
+            OracleStorageResource.create("https://objectstorage.us-chicago-1.oraclecloud.com/n/namespace/b/mybucket/o/myobject", osClient);
         }
     }
 
diff --git a/spring-cloud-oci-storage/src/test/java/com/oracle/cloud/spring/storage/StorageLocationTests.java b/spring-cloud-oci-storage/src/test/java/com/oracle/cloud/spring/storage/StorageLocationTests.java

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public void setResourceLoader(ResourceLoader resourceLoader) {`
`69`	`69`	`((DefaultResourceLoader) resourceLoader).addProtocolResolver(this);`
`70`	`70`	`} else {`
`71`	`71`	`LOGGER.warn("The provided delegate resource loader is not an implementation "`
`72`		`- + "of DefaultResourceLoader. Custom Protocol using ocs:// prefix will not be enabled.");`
	`72`	`+ + "of DefaultResourceLoader. Custom OCI Object Storage prefix will not be enabled.");`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public OracleStorageResource download(String bucketName, String key, String vers`
`65`	`65`	`Assert.notNull(bucketName, ERROR_BUCKET_NAME_REQUIRED);`
`66`	`66`	`Assert.notNull(key, ERROR_KEY_REQUIRED);`
`67`	`67`
`68`		`- return new OracleStorageResource(bucketName, key, version, osClient);`
	`68`	`+ return new OracleStorageResource(bucketName, key, osClient);`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`