Add hash store CLI (#256)

Author: jnmt

hash-store/src/main/java/com/scalar/dl/hashstore/client/service/HashStoreClientService.java

@@ -345,6 +345,32 @@ public ExecutionResult putObject(
             CONTRACT_PUT, contractArguments, FUNCTION_PUT, functionArguments));
   }
 
+  /**
+   * Stores a new version of an object in the hash store using JsonNode arguments. Expected format:
+   * {"objectId": "...", "hash": "...", "metadata": {...}}
+   *
+   * @param arguments JsonNode containing objectId, hash, and optional metadata
+   * @return {@link ExecutionResult}
+   * @throws ClientException if a request fails for some reason
+   */
+  public ExecutionResult putObject(JsonNode arguments) {
+    return new ExecutionResult(clientService.executeContract(CONTRACT_PUT, arguments));
+  }
+
+  /**
+   * Stores a new version of an object in the hash store and also performs a put operation to a
+   * mutable database using JsonNode arguments.
+   *
+   * @param arguments JsonNode containing objectId, hash, and optional metadata
+   * @param putToMutable JsonNode containing the Put operation data for the mutable database
+   * @return {@link ExecutionResult}
+   * @throws ClientException if a request fails for some reason
+   */
+  public ExecutionResult putObject(JsonNode arguments, JsonNode putToMutable) {
+    return new ExecutionResult(
+        clientService.executeContract(CONTRACT_PUT, arguments, FUNCTION_PUT, putToMutable));
+  }
+
   private JsonNode buildPutObjectArguments(String objectId, String hash, JsonObject metadata) {
     return HashStoreClientUtils.createObjectNode()
         .put(OBJECT_ID, objectId)
@@ -467,6 +493,27 @@ public ExecutionResult compareObjectVersions(String objectId, List<Version> vers
     return new ExecutionResult(clientService.executeContract(CONTRACT_VALIDATE, arguments));
   }
 
+  /**
+   * Compares object versions to detect tampering using JsonNode arguments.
+   *
+   * <p>Options can include:
+   *
+   * <ul>
+   *   <li>"verbose": true - shows detailed validation information
+   *   <li>"all": true - compares all versions including stored versions in the ledger
+   * </ul>
+   *
+   * <p>Example: {"objectId": "obj1", "versions": [{"versionId": "v1", "hash": "hash1"}], "options":
+   * {"all": true, "verbose": true}}
+   *
+   * @param arguments JsonNode containing objectId, versions array, and options
+   * @return {@link ExecutionResult} containing validation results
+   * @throws ClientException if a request fails for some reason
+   */
+  public ExecutionResult compareObjectVersions(JsonNode arguments) {
+    return new ExecutionResult(clientService.executeContract(CONTRACT_VALIDATE, arguments));
+  }
+
   /**
    * Compares specific versions of an object to detect tampering with verbose output option.
    *

hash-store/src/main/java/com/scalar/dl/hashstore/client/tool/AbstractHashStoreCommand.java

@@ -0,0 +1,46 @@
+package com.scalar.dl.hashstore.client.tool;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.scalar.dl.client.config.ClientConfig;
+import com.scalar.dl.client.config.GatewayClientConfig;
+import com.scalar.dl.client.exception.ClientException;
+import com.scalar.dl.client.tool.Common;
+import com.scalar.dl.client.tool.CommonOptions;
+import com.scalar.dl.hashstore.client.service.HashStoreClientService;
+import com.scalar.dl.hashstore.client.service.HashStoreClientServiceFactory;
+import java.io.File;
+import java.util.concurrent.Callable;
+
+public abstract class AbstractHashStoreCommand extends CommonOptions implements Callable<Integer> {
+
+  @Override
+  public Integer call() throws Exception {
+    return call(new HashStoreClientServiceFactory());
+  }
+
+  @VisibleForTesting
+  public final Integer call(HashStoreClientServiceFactory factory) throws Exception {
+    try {
+      HashStoreClientService service =
+          useGateway
+              ? factory.create(new GatewayClientConfig(new File(properties)), false)
+              : factory.create(new ClientConfig(new File(properties)), false);
+      return execute(service);
+    } catch (ClientException e) {
+      Common.printError(e);
+      printStackTrace(e);
+      return 1;
+    } finally {
+      factory.close();
+    }
+  }
+
+  /**
+   * Executes the specific command logic.
+   *
+   * @param service the client service to use for execution.
+   * @return the exit code.
+   * @throws ClientException if the execution fails.
+   */
+  protected abstract Integer execute(HashStoreClientService service) throws ClientException;
+}

hash-store/src/main/java/com/scalar/dl/hashstore/client/tool/Bootstrap.java

@@ -0,0 +1,23 @@
+package com.scalar.dl.hashstore.client.tool;
+
+import com.scalar.dl.client.exception.ClientException;
+import com.scalar.dl.hashstore.client.service.HashStoreClientService;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+
+@Command(
+    name = "bootstrap",
+    description = "Bootstrap the hash store by registering identity and contracts.")
+public class Bootstrap extends AbstractHashStoreCommand {
+
+  public static void main(String[] args) {
+    int exitCode = new CommandLine(new Bootstrap()).execute(args);
+    System.exit(exitCode);
+  }
+
+  @Override
+  protected Integer execute(HashStoreClientService service) throws ClientException {
+    service.bootstrap();
+    return 0;
+  }
+}

hash-store/src/main/java/com/scalar/dl/hashstore/client/tool/CollectionCreation.java

@@ -0,0 +1,35 @@
+package com.scalar.dl.hashstore.client.tool;
+
+import com.scalar.dl.hashstore.client.service.HashStoreClientService;
+import java.util.ArrayList;
+import java.util.List;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+
+@Command(name = "create-collection", description = "Create a new collection.")
+public class CollectionCreation extends AbstractHashStoreCommand {
+
+  @CommandLine.Option(
+      names = {"--collection-id"},
+      required = true,
+      paramLabel = "COLLECTION_ID",
+      description = "The ID of the collection to create.")
+  private String collectionId;
+
+  @CommandLine.Option(
+      names = {"--object-ids"},
+      paramLabel = "OBJECT_ID",
+      description = "Object IDs to include in the collection.")
+  private List<String> objectIds = new ArrayList<>();
+
+  public static void main(String[] args) {
+    int exitCode = new CommandLine(new CollectionCreation()).execute(args);
+    System.exit(exitCode);
+  }
+
+  @Override
+  protected Integer execute(HashStoreClientService service) {
+    service.createCollection(collectionId, objectIds);
+    return 0;
+  }
+}

hash-store/src/main/java/com/scalar/dl/hashstore/client/tool/CollectionGet.java

@@ -0,0 +1,39 @@
+package com.scalar.dl.hashstore.client.tool;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.scalar.dl.client.exception.ClientException;
+import com.scalar.dl.client.tool.Common;
+import com.scalar.dl.hashstore.client.service.HashStoreClientService;
+import com.scalar.dl.ledger.model.ExecutionResult;
+import com.scalar.dl.ledger.util.JacksonSerDe;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+
+@Command(name = "get-collection", description = "Get a collection from the hash store.")
+public class CollectionGet extends AbstractHashStoreCommand {
+
+  @CommandLine.Option(
+      names = {"--collection-id"},
+      required = true,
+      paramLabel = "COLLECTION_ID",
+      description = "The ID of the collection to retrieve.")
+  private String collectionId;
+
+  public static void main(String[] args) {
+    int exitCode = new CommandLine(new CollectionGet()).execute(args);
+    System.exit(exitCode);
+  }
+
+  @Override
+  protected Integer execute(HashStoreClientService service) throws ClientException {
+    JacksonSerDe serde = new JacksonSerDe(new ObjectMapper());
+    ExecutionResult result = service.getCollection(collectionId);
+    if (result.getResult().isPresent()) {
+      System.out.println("Result:");
+      Common.printJson(serde.deserialize(result.getResult().get()));
+    } else {
+      System.out.println("Collection not found.");
+    }
+    return 0;
+  }
+}

hash-store/src/main/java/com/scalar/dl/hashstore/client/tool/CollectionHistoryGet.java

@@ -0,0 +1,49 @@
+package com.scalar.dl.hashstore.client.tool;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.scalar.dl.client.exception.ClientException;
+import com.scalar.dl.client.tool.Common;
+import com.scalar.dl.hashstore.client.service.HashStoreClientService;
+import com.scalar.dl.ledger.model.ExecutionResult;
+import com.scalar.dl.ledger.util.JacksonSerDe;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+
+@Command(name = "get-collection-history", description = "Get the history of a collection.")
+public class CollectionHistoryGet extends AbstractHashStoreCommand {
+
+  @CommandLine.Option(
+      names = {"--collection-id"},
+      required = true,
+      paramLabel = "COLLECTION_ID",
+      description = "The ID of the collection.")
+  private String collectionId;
+
+  @CommandLine.Option(
+      names = {"--limit"},
+      paramLabel = "LIMIT",
+      description = "Maximum number of recent history entries to return.")
+  private Integer limit;
+
+  public static void main(String[] args) {
+    int exitCode = new CommandLine(new CollectionHistoryGet()).execute(args);
+    System.exit(exitCode);
+  }
+
+  @Override
+  protected Integer execute(HashStoreClientService service) throws ClientException {
+    JacksonSerDe serde = new JacksonSerDe(new ObjectMapper());
+    ExecutionResult result;
+    if (limit != null) {
+      result = service.getCollectionHistory(collectionId, limit);
+    } else {
+      result = service.getCollectionHistory(collectionId);
+    }
+
+    if (result.getResult().isPresent()) {
+      System.out.println("Result:");
+      Common.printJson(serde.deserialize(result.getResult().get()));
+    }
+    return 0;
+  }
+}

hash-store/src/main/java/com/scalar/dl/hashstore/client/tool/HashStoreCommandLine.java

@@ -0,0 +1,82 @@
+package com.scalar.dl.hashstore.client.tool;
+
+import static picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_COMMAND_LIST;
+import static picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_COMMAND_LIST_HEADING;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.collect.ImmutableMap;
+import com.scalar.dl.client.tool.CommandGroupRenderer;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+import picocli.CommandLine.HelpCommand;
+
+@Command(
+    name = "scalardl-hash-store",
+    subcommands = {
+      HelpCommand.class,
+      Bootstrap.class,
+      ObjectGet.class,
+      ObjectPut.class,
+      ObjectVersionsComparison.class,
+      CollectionCreation.class,
+      CollectionGet.class,
+      ObjectAdditionToCollection.class,
+      ObjectRemovalFromCollection.class,
+      CollectionHistoryGet.class,
+      LedgerValidation.class,
+    },
+    description = {"These are ScalarDL Hash Store commands used in various situations:"})
+public class HashStoreCommandLine {
+
+  public static void main(String[] args) {
+    CommandLine commandLine = new CommandLine(new HashStoreCommandLine());
+    setupSections(commandLine);
+
+    int exitCode = commandLine.execute(args);
+    System.exit(exitCode);
+  }
+
+  /**
+   * Changes the usage message (a.k.a. help information) of the {@link CommandLine} into the grouped
+   * sections.
+   *
+   * <p>[Note]
+   *
+   * <p>Please set up all the sections in this method.
+   *
+   * <p>Please refer to the [Usage] comment described in {@link CommandGroupRenderer}.
+   *
+   * @param cmd command line of {@link HashStoreCommandLine}
+   */
+  @VisibleForTesting
+  static void setupSections(CommandLine cmd) {
+    // ref. Code to group subcommands from the official documentation.
+    //      https://github.com/remkop/picocli/issues/978#issuecomment-604174211
+
+    ImmutableMap.Builder<String, List<Class<?>>> sections = ImmutableMap.builder();
+    // Section: register identity information.
+    sections.put("%nbootstrap the hash store%n", Collections.singletonList(Bootstrap.class));
+    // Section: manage objects.
+    sections.put(
+        "%nmanage objects%n",
+        Arrays.asList(ObjectGet.class, ObjectPut.class, ObjectVersionsComparison.class));
+    // Section: manage collections.
+    sections.put(
+        "%nmanage collections%n",
+        Arrays.asList(
+            CollectionCreation.class,
+            CollectionGet.class,
+            ObjectAdditionToCollection.class,
+            ObjectRemovalFromCollection.class,
+            CollectionHistoryGet.class));
+    // Section: validate ledger.
+    sections.put("%nvalidate ledger%n", Collections.singletonList(LedgerValidation.class));
+    CommandGroupRenderer renderer = new CommandGroupRenderer(sections.build());
+
+    cmd.getHelpSectionMap().remove(SECTION_KEY_COMMAND_LIST_HEADING);
+    cmd.getHelpSectionMap().put(SECTION_KEY_COMMAND_LIST, renderer);
+  }
+}