Add support for S3

Author: KodaiD

.github/workflows/object-storage-adapter-check.yaml

@@ -0,0 +1,93 @@
+name: Test Object Storage Adapter
+
+on:
+  workflow_dispatch:
+    inputs:
+      INT_TEST_JAVA_RUNTIME_VERSION:
+        description: JDK version used to run the integration test
+        type: choice
+        required: false
+        default: '8'
+        options:
+          - '8'
+          - '11'
+          - '17'
+          - '21'
+      INT_TEST_JAVA_RUNTIME_VENDOR:
+        description: Vendor of the JDK used to run the integration test
+        type: choice
+        required: false
+        default: 'temurin'
+        options:
+          - 'corretto'
+          - 'microsoft'
+          - 'oracle'
+          - 'temurin'
+
+env:
+  TERM: dumb
+  JAVA_VERSION: '8'
+  JAVA_VENDOR: 'temurin'
+  INT_TEST_JAVA_RUNTIME_VERSION: "${{ github.event_name != 'workflow_dispatch' && '8' || inputs.INT_TEST_JAVA_RUNTIME_VERSION }}"
+  INT_TEST_JAVA_RUNTIME_VENDOR: "${{ github.event_name != 'workflow_dispatch' && 'temurin' || inputs.INT_TEST_JAVA_RUNTIME_VENDOR }}"
+  # Gradle will parse 'ORG_GRADLE_PROJECT_<project_property_name>' environment variables as project properties.
+  # The following variables configure the 'com.scalar.db.jdk-configuration' Gradle plugin.
+  ORG_GRADLE_PROJECT_javaVersion: '8'
+  ORG_GRADLE_PROJECT_javaVendor: 'temurin'
+  ORG_GRADLE_PROJECT_integrationTestJavaRuntimeVersion: "${{ github.event_name != 'workflow_dispatch' && '8' || inputs.INT_TEST_JAVA_RUNTIME_VERSION }}"
+  ORG_GRADLE_PROJECT_integrationTestJavaRuntimeVendor: "${{ github.event_name != 'workflow_dispatch' && 'temurin' || inputs.INT_TEST_JAVA_RUNTIME_VENDOR }}"
+  # This variable evaluates to: if {!(Temurin JDK 8) && !(Oracle JDK)} then {true} else {false}
+  # Oracle JDK that are linux compatible and publicly available through direct download exist for all LTS versions
+  SET_UP_INT_TEST_RUNTIME_NON_ORACLE_JDK: "${{ (github.event_name == 'workflow_dispatch' && !(inputs.INT_TEST_JAVA_RUNTIME_VERSION == '8' && inputs.INT_TEST_JAVA_RUNTIME_VENDOR == 'temurin') && !(inputs.INT_TEST_JAVA_RUNTIME_VENDOR == 'oracle')) && 'true' || 'false' }}"
+  INT_TEST_GRADLE_OPTIONS_FOR_GROUP_COMMIT: '"-Dscalardb.consensus_commit.coordinator.group_commit.enabled=true" "-Dscalardb.consensus_commit.coordinator.group_commit.old_group_abort_timeout_millis=15000" --tests "**.ConsensusCommit**"'
+  AWS_ACCESS_KEY_ID: ${{ secrets.S3_ACCESS_KEY }}
+  AWS_SECRET_ACCESS_KEY: ${{ secrets.S3_SECRET_ACCESS_KEY }}
+  S3_REGION: ap-northeast-1
+  S3_BUCKET_NAME: scalardb-test-bucket
+
+jobs:
+  integration-test-s3:
+    name: S3 integration test (${{ matrix.mode.label }})
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up JDK ${{ env.JAVA_VERSION }} (${{ env.JAVA_VENDOR }})
+        uses: actions/setup-java@v5
+        with:
+          java-version: ${{ env.JAVA_VERSION }}
+          distribution: ${{ env.JAVA_VENDOR }}
+
+      - name: Set up JDK ${{ env.INT_TEST_JAVA_RUNTIME_VERSION }} (${{ env.INT_TEST_JAVA_RUNTIME_VENDOR }}) to run integration test
+        uses: actions/setup-java@v5
+        if: ${{ env.SET_UP_INT_TEST_RUNTIME_NON_ORACLE_JDK == 'true'}}
+        with:
+          java-version: ${{ env.INT_TEST_JAVA_RUNTIME_VERSION }}
+          distribution: ${{ env.INT_TEST_JAVA_RUNTIME_VENDOR }}
+
+      - name: Login to Oracle container registry
+        uses: docker/login-action@v3
+        if: ${{ env.INT_TEST_JAVA_RUNTIME_VENDOR == 'oracle' }}
+        with:
+          registry: container-registry.oracle.com
+          username: ${{ secrets.OCR_USERNAME }}
+          password: ${{ secrets.OCR_TOKEN }}
+
+      - name: Set up JDK ${{ env.INT_TEST_JAVA_RUNTIME_VERSION }} (oracle) to run the integration test
+        if: ${{ env.INT_TEST_JAVA_RUNTIME_VENDOR == 'oracle' }}
+        run: |
+          container_id=$(docker create "container-registry.oracle.com/java/jdk:${{ env.INT_TEST_JAVA_RUNTIME_VERSION }}")
+          docker cp -L "$container_id:/usr/java/default" /usr/lib/jvm/oracle-jdk && docker rm "$container_id"
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v5
+
+      - name: Execute Gradle 'integrationTestObjectStorage' task
+        run: ./gradlew integrationTestObjectStorage -Dscalardb.object_storage.storage=s3 -Dscalardb.object_storage.endpoint=${{ env.S3_REGION }}/${{ env.S3_BUCKET_NAME }} ${{ matrix.mode.group_commit_enabled && env.INT_TEST_GRADLE_OPTIONS_FOR_GROUP_COMMIT || '' }}
+
+      - name: Upload Gradle test reports
+        if: always()
+        uses: actions/upload-artifact@v5
+        with:
+          name: cassandra_3.0_integration_test_reports_${{ matrix.mode.label }}
+          path: core/build/reports/tests/integrationTestObjectStorage

core/build.gradle

@@ -174,6 +174,8 @@ dependencies {
     implementation platform("software.amazon.awssdk:bom:${awssdkVersion}")
     implementation 'software.amazon.awssdk:applicationautoscaling'
     implementation 'software.amazon.awssdk:dynamodb'
+    implementation 'software.amazon.awssdk:s3'
+    implementation 'software.amazon.awssdk:aws-crt-client'
     testImplementation 'software.amazon.awssdk:iam'
     testImplementation 'software.amazon.awssdk:iam-policy-builder'
     implementation "org.apache.commons:commons-dbcp2:${commonsDbcp2Version}"

core/src/integration-test/java/com/scalar/db/storage/objectstorage/ObjectStorageEnv.java

@@ -7,10 +7,12 @@
 import java.util.Properties;
 
 public class ObjectStorageEnv {
+  private static final String PROP_OBJECT_STORAGE_STORAGE = "scalardb.object_storage.storage";
   private static final String PROP_OBJECT_STORAGE_ENDPOINT = "scalardb.object_storage.endpoint";
   private static final String PROP_OBJECT_STORAGE_USERNAME = "scalardb.object_storage.username";
   private static final String PROP_OBJECT_STORAGE_PASSWORD = "scalardb.object_storage.password";
 
+  private static final String DEFAULT_OBJECT_STORAGE_STORAGE = BlobStorageConfig.STORAGE_NAME;
   private static final String DEFAULT_OBJECT_STORAGE_ENDPOINT =
       "http://localhost:10000/test/test-container";
   private static final String DEFAULT_OBJECT_STORAGE_USERNAME = "test";
@@ -19,6 +21,8 @@ public class ObjectStorageEnv {
   private ObjectStorageEnv() {}
 
   public static Properties getProperties(String testName) {
+    String storage =
+        System.getProperty(PROP_OBJECT_STORAGE_STORAGE, DEFAULT_OBJECT_STORAGE_STORAGE);
     String accountName =
         System.getProperty(PROP_OBJECT_STORAGE_USERNAME, DEFAULT_OBJECT_STORAGE_USERNAME);
     String accountKey =
@@ -30,7 +34,7 @@ public static Properties getProperties(String testName) {
     properties.setProperty(DatabaseConfig.CONTACT_POINTS, endpoint);
     properties.setProperty(DatabaseConfig.USERNAME, accountName);
     properties.setProperty(DatabaseConfig.PASSWORD, accountKey);
-    properties.setProperty(DatabaseConfig.STORAGE, BlobStorageConfig.STORAGE_NAME);
+    properties.setProperty(DatabaseConfig.STORAGE, storage);
     properties.setProperty(DatabaseConfig.CROSS_PARTITION_SCAN, "true");
     properties.setProperty(DatabaseConfig.CROSS_PARTITION_SCAN_FILTERING, "true");
     properties.setProperty(DatabaseConfig.CROSS_PARTITION_SCAN_ORDERING, "false");

core/src/integration-test/java/com/scalar/db/storage/objectstorage/ObjectStorageWrapperIntegrationTest.java

@@ -156,7 +156,7 @@ public void update_NonExistingObjectKeyGiven_ShouldThrowPreconditionFailedExcept
   }
 
   @Test
-  public void update_WrongVersionGiven_ShouldThrowPreconditionFailedException() throws Exception {
+  public void update_WrongVersionGiven_ShouldThrowPreconditionFailedException() {
     // Arrange
     String wrongVersion = "wrong-version";
 
@@ -279,9 +279,16 @@ public void deleteByPrefix_WithNonExistingPrefix_ShouldDoNothing() throws Except
 
   @Test
   public void close_ShouldNotThrowException() {
-    // Arrange
+    try {
+      // Arrange
 
-    // Act Assert
-    assertThatCode(() -> wrapper.close()).doesNotThrowAnyException();
+      // Act Assert
+      assertThatCode(() -> wrapper.close()).doesNotThrowAnyException();
+    } finally {
+      Properties properties = getProperties(TEST_NAME);
+      ObjectStorageConfig objectStorageConfig =
+          ObjectStorageUtils.getObjectStorageConfig(new DatabaseConfig(properties));
+      wrapper = ObjectStorageWrapperFactory.create(objectStorageConfig);
+    }
   }
 }

core/src/main/java/com/scalar/db/storage/objectstorage/ConflictOccurredException.java

@@ -0,0 +1,8 @@
+package com.scalar.db.storage.objectstorage;
+
+public class ConflictOccurredException extends ObjectStorageWrapperException {
+
+  public ConflictOccurredException(String message, Throwable cause) {
+    super(message, cause);
+  }
+}

core/src/main/java/com/scalar/db/storage/objectstorage/ObjectStorageConfig.java

@@ -9,13 +9,6 @@ public interface ObjectStorageConfig {
    */
   String getStorageName();
 
-  /**
-   * Returns the endpoint for the object storage service.
-   *
-   * @return the endpoint
-   */
-  String getEndpoint();
-
   /**
    * Returns the username for authentication.
    *

core/src/main/java/com/scalar/db/storage/objectstorage/ObjectStorageUtils.java

@@ -2,6 +2,7 @@
 
 import com.scalar.db.config.DatabaseConfig;
 import com.scalar.db.storage.objectstorage.blobstorage.BlobStorageConfig;
+import com.scalar.db.storage.objectstorage.s3.S3Config;
 import java.util.Objects;
 
 public class ObjectStorageUtils {
@@ -19,6 +20,8 @@ public static String getObjectKey(String namespace, String table) {
   public static ObjectStorageConfig getObjectStorageConfig(DatabaseConfig databaseConfig) {
     if (Objects.equals(databaseConfig.getStorage(), BlobStorageConfig.STORAGE_NAME)) {
       return new BlobStorageConfig(databaseConfig);
+    } else if (Objects.equals(databaseConfig.getStorage(), S3Config.STORAGE_NAME)) {
+      return new S3Config(databaseConfig);
     } else {
       throw new IllegalArgumentException(
           "Unsupported Object Storage: " + databaseConfig.getStorage());

core/src/main/java/com/scalar/db/storage/objectstorage/ObjectStorageWrapperException.java

@@ -2,10 +2,6 @@
 
 public class ObjectStorageWrapperException extends Exception {
 
-  public ObjectStorageWrapperException(String message) {
-    super(message);
-  }
-
   public ObjectStorageWrapperException(String message, Throwable cause) {
     super(message, cause);
   }

core/src/main/java/com/scalar/db/storage/objectstorage/ObjectStorageWrapperFactory.java

@@ -2,6 +2,8 @@
 
 import com.scalar.db.storage.objectstorage.blobstorage.BlobStorageConfig;
 import com.scalar.db.storage.objectstorage.blobstorage.BlobStorageWrapper;
+import com.scalar.db.storage.objectstorage.s3.S3Config;
+import com.scalar.db.storage.objectstorage.s3.S3Wrapper;
 import java.util.Objects;
 
 public class ObjectStorageWrapperFactory {
@@ -10,6 +12,9 @@ public static ObjectStorageWrapper create(ObjectStorageConfig objectStorageConfi
     if (Objects.equals(objectStorageConfig.getStorageName(), BlobStorageConfig.STORAGE_NAME)) {
       assert objectStorageConfig instanceof BlobStorageConfig;
       return new BlobStorageWrapper((BlobStorageConfig) objectStorageConfig);
+    } else if (Objects.equals(objectStorageConfig.getStorageName(), S3Config.STORAGE_NAME)) {
+      assert objectStorageConfig instanceof S3Config;
+      return new S3Wrapper((S3Config) objectStorageConfig);
     } else {
       throw new IllegalArgumentException(
           "Unsupported Object Storage: " + objectStorageConfig.getStorageName());

core/src/main/java/com/scalar/db/storage/objectstorage/PreconditionFailedException.java

@@ -2,10 +2,6 @@
 
 public class PreconditionFailedException extends ObjectStorageWrapperException {
 
-  public PreconditionFailedException(String message) {
-    super(message);
-  }
-
   public PreconditionFailedException(String message, Throwable cause) {
     super(message, cause);
   }