Add ClientService for hash store abstraction (#255)

Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com>

Author: jnmt

.github/workflows/scalar.yml

@@ -156,6 +156,40 @@ jobs:
           name: integration_test_reports_for_generic_contracts
           path: generic-contracts/build/reports/tests/integrationTest
 
+  integration-test-for-hash-store:
+    name: Integration test for hash store
+    runs-on: ubuntu-latest
+
+    services:
+      mysql:
+        image: mysql:8.1
+        env:
+          MYSQL_ROOT_PASSWORD: mysql
+        ports:
+          - 3306:3306
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v5
+        with:
+          distribution: 'temurin'
+          java-version: '8'
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Run integration tests
+        run:  ./gradlew :hash-store:integrationTest
+
+      - name: Upload Gradle test reports
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: integration_test_reports_for_hash_store
+          path: hash-store/build/reports/tests/integrationTest
+
   integration-test-for-table-store:
     name: Integration test for table store
     runs-on: ubuntu-latest

common-test/src/main/java/com/scalar/dl/ledger/LedgerEndToEndTestBase.java

@@ -36,6 +36,10 @@ public abstract class LedgerEndToEndTestBase {
   private static final String ASSET_TABLE = "asset";
   private static final String ASSET_METADATA_TABLE = "asset_metadata";
   private static final String LEDGER_SCHEMA_PATH = "/../schema-loader/ledger-schema.json";
+  private static final String FUNCTION_DB_SCHEMA_PATH =
+      "/../generic-contracts/scripts/objects-table-schema.json";
+  private static final String FUNCTION_NAMESPACE = "test";
+  private static final String FUNCTION_TABLE = "objects";
 
   private static final String JDBC_TRANSACTION_MANAGER = "jdbc";
   private static final String PROP_STORAGE = "scalardb.storage";
@@ -79,6 +83,7 @@ public abstract class LedgerEndToEndTestBase {
   private Properties props;
   private Map<String, String> creationOptions = new HashMap<>();
   private Path ledgerSchemaPath;
+  private Path databaseSchemaPath;
   private DistributedStorage storage;
   private DistributedStorageAdmin storageAdmin;
 
@@ -89,7 +94,9 @@ public void setUpBeforeClass() throws Exception {
     storage = factory.getStorage();
     storageAdmin = factory.getStorageAdmin();
     ledgerSchemaPath = Paths.get(System.getProperty("user.dir") + LEDGER_SCHEMA_PATH);
+    databaseSchemaPath = Paths.get(System.getProperty("user.dir") + FUNCTION_DB_SCHEMA_PATH);
     SchemaLoader.load(props, ledgerSchemaPath, creationOptions, true);
+    SchemaLoader.load(props, databaseSchemaPath, creationOptions, true);
     createServer(new LedgerConfig(props));
   }
 
@@ -99,6 +106,7 @@ public void tearDownAfterClass() throws SchemaLoaderException, InterruptedExcept
     storage.close();
     storageAdmin.close();
     SchemaLoader.unload(props, ledgerSchemaPath, true);
+    SchemaLoader.unload(props, databaseSchemaPath, true);
   }
 
   @BeforeEach
@@ -108,6 +116,7 @@ public void setUp() {}
   public void tearDown() throws ExecutionException {
     storageAdmin.truncateTable(SCALAR_NAMESPACE, ASSET_TABLE);
     storageAdmin.truncateTable(SCALAR_NAMESPACE, ASSET_METADATA_TABLE);
+    storageAdmin.truncateTable(FUNCTION_NAMESPACE, FUNCTION_TABLE);
   }
 
   private Properties createLedgerProperties() {
@@ -160,4 +169,28 @@ protected ClientConfig createClientConfig(String entity) throws IOException {
     props.put(ClientConfig.DS_PRIVATE_KEY_PEM, SOME_PRIVATE_KEY);
     return new ClientConfig(props);
   }
+
+  protected DistributedStorage getStorage() {
+    return storage;
+  }
+
+  protected DistributedStorageAdmin getStorageAdmin() {
+    return storageAdmin;
+  }
+
+  protected String getScalarNamespace() {
+    return SCALAR_NAMESPACE;
+  }
+
+  protected String getAssetTable() {
+    return ASSET_TABLE;
+  }
+
+  protected String getFunctionNamespace() {
+    return FUNCTION_NAMESPACE;
+  }
+
+  protected String getFunctionTable() {
+    return FUNCTION_TABLE;
+  }
 }

…ient/model/StatementExecutionResult.java …lar/dl/ledger/model/ExecutionResult.javatable-store/src/main/java/com/scalar/dl/tablestore/client/model/StatementExecutionResult.java renamed to common/src/main/java/com/scalar/dl/ledger/model/ExecutionResult.java table-store/src/main/java/com/scalar/dl/tablestore/client/model/StatementExecutionResult.java renamed to common/src/main/java/com/scalar/dl/ledger/model/ExecutionResult.java

@@ -1,40 +1,38 @@
-package com.scalar.dl.tablestore.client.model;
+package com.scalar.dl.ledger.model;
 
 import com.google.common.collect.ImmutableList;
-import com.scalar.dl.ledger.model.ContractExecutionResult;
 import com.scalar.dl.ledger.proof.AssetProof;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
 import javax.annotation.concurrent.Immutable;
 
 /**
- * The result of statement execution. It contains the result of the statement execution along with a
- * list of {@link AssetProof}s from Ledger and Auditor.
+ * The result of an operation execution in Ledger. It contains the result of the internal contract
+ * execution along with a list of {@link AssetProof}s from Ledger and Auditor.
  */
 @Immutable
 // non-final for mocking
-public class StatementExecutionResult {
+public class ExecutionResult {
   private final String result;
   private final ImmutableList<AssetProof> ledgerProofs;
   private final ImmutableList<AssetProof> auditorProofs;
 
   /**
-   * Constructs a {@code StatementExecutionResult} using the specified {@code
-   * ContractExecutionResult}
+   * Constructs a {@code ExecutionResult} using the specified {@code ContractExecutionResult}
    *
    * @param contractExecutionResult a {@code ContractExecutionResult}
    */
-  public StatementExecutionResult(ContractExecutionResult contractExecutionResult) {
+  public ExecutionResult(ContractExecutionResult contractExecutionResult) {
     this.result = contractExecutionResult.getContractResult().orElse(null);
     this.ledgerProofs = ImmutableList.copyOf(contractExecutionResult.getLedgerProofs());
     this.auditorProofs = ImmutableList.copyOf(contractExecutionResult.getAuditorProofs());
   }
 
   /**
-   * Returns the result of statement execution.
+   * Returns the result of an operation execution in Ledger.
    *
-   * @return the result of statement execution
+   * @return the result of an operation execution in Ledger
    */
   public Optional<String> getResult() {
     return Optional.ofNullable(result);
@@ -73,7 +71,7 @@ public int hashCode() {
    * equal if it is the same instance or if:
    *
    * <ul>
-   *   <li>it is also an {@code StatementExecutionResult} and
+   *   <li>it is also an {@code ExecutionResult} and
    *   <li>both instances have the same result and proofs.
    * </ul>
    *
@@ -85,10 +83,10 @@ public boolean equals(Object o) {
     if (o == this) {
       return true;
     }
-    if (!(o instanceof StatementExecutionResult)) {
+    if (!(o instanceof ExecutionResult)) {
       return false;
     }
-    StatementExecutionResult other = (StatementExecutionResult) o;
+    ExecutionResult other = (ExecutionResult) o;
     return Objects.equals(this.result, other.result)
         && this.ledgerProofs.equals(other.ledgerProofs)
         && this.auditorProofs.equals(other.auditorProofs);

hash-store/build.gradle

@@ -0,0 +1,104 @@
+plugins {
+    id 'net.ltgt.errorprone' version "${errorpronePluginVersion}"
+    id "com.github.spotbugs" version "${spotbugsPluginVersion}"
+}
+
+apply plugin:'application'
+startScripts.enabled = false
+
+sourceSets {
+    integrationTest {
+        java {
+            compileClasspath += main.output + test.output
+            runtimeClasspath += main.output + test.output
+            srcDir file('src/integration-test/java')
+        }
+        resources.srcDir file('src/integration-test/resources')
+    }
+}
+
+configurations {
+    integrationTestImplementation.extendsFrom testImplementation
+    integrationTestRuntimeOnly.extendsFrom testRuntimeOnly
+    integrationTestCompileOnly.extendsFrom testCompileOnly
+}
+
+dependencies {
+    implementation project(':client')
+    implementation project(':generic-contracts')
+    implementation project(':ledger') // to use JacksonBasedContract
+    implementation group: 'info.picocli', name: 'picocli', version: "${picoCliVersion}"
+    implementation group: 'org.partiql', name: 'partiql-parser', version: "${partiqlVersion}"
+
+    // for test
+    testImplementation project(':common-test')
+    integrationTestImplementation project(':common-test')
+    integrationTestImplementation group: 'com.scalar-labs', name: 'scalardb-schema-loader', version: "${scalarDbVersion}"
+
+    // for Error Prone
+    errorprone "com.google.errorprone:error_prone_core:${errorproneVersion}"
+    errorproneJavac "com.google.errorprone:javac:${errorproneJavacVersion}"
+
+    // for SpotBugs
+    spotbugs "com.github.spotbugs:spotbugs:${spotbugsVersion}"
+    compileOnly "com.github.spotbugs:spotbugs-annotations:${spotbugsVersion}"
+    testCompileOnly "com.github.spotbugs:spotbugs-annotations:${spotbugsVersion}"
+}
+
+task HashStore(type: CreateStartScripts) {
+    mainClass = 'com.scalar.dl.hashstore.client.tool.HashStoreCommandLine'
+    applicationName = 'scalardl-hash-store'
+    outputDir = new File(project.buildDir, 'tmp')
+    classpath = jar.outputs.files + project.configurations.runtimeClasspath
+}
+
+applicationDistribution.into('bin') {
+    from(HashStore)
+    fileMode = 0755
+}
+
+task integrationTest(type: Test) {
+    useJUnitPlatform()
+    description 'Runs the integration tests.'
+    group 'verification'
+    testClassesDirs = sourceSets.integrationTest.output.classesDirs
+    classpath = sourceSets.integrationTest.runtimeClasspath
+    outputs.upToDateWhen { false } // ensures integration tests are run every time when called
+    shouldRunAfter test
+    options {
+        systemProperties(System.getProperties().findAll{it.key.toString().startsWith("scalar")})
+    }
+}
+
+spotless {
+    java {
+        target 'src/*/java/**/*.java'
+        importOrder()
+        removeUnusedImports()
+        googleJavaFormat('1.7')
+    }
+}
+
+spotbugs {
+    ignoreFailures = false
+    showStackTraces = true
+    showProgress = true
+    effort = 'default'
+    reportLevel = 'default'
+    maxHeapSize = '1g'
+    extraArgs = [ '-nested:false' ]
+    jvmArgs = [ '-Duser.language=en' ]
+}
+
+spotbugsMain.reports {
+    html.enabled = true
+}
+
+spotbugsTest.reports {
+    html.enabled = true
+}
+
+task sourcesJar(type: Jar) {
+    classifier = 'sources'
+    from sourceSets.main.allSource
+}