Rework tscli command mechanism.

This separates the parsing/invoking of the commands into subclasses of cli::Command,
achieving separation of parsing and actual method, which are moved to tscli/lib

PiperOrigin-RevId: 750640308
Change-Id: I446bcb2eb00db604841f7be9d597191c9419ec13

Author: laramiel

tensorstore/tscli/BUILD

@@ -1,90 +1,92 @@
-load("//bazel:tensorstore.bzl", "tensorstore_cc_binary", "tensorstore_cc_library", "tensorstore_cc_test")
+load(
+    "//bazel:tensorstore.bzl",
+    "tensorstore_cc_binary",
+    "tensorstore_cc_library",
+)
 
 package(default_visibility = ["//visibility:public"])
 
 licenses(["notice"])
 
-tensorstore_cc_test(
-    name = "args_test",
-    srcs = ["args_test.cc"],
+tensorstore_cc_binary(
+    name = "tscli",
+    srcs = [
+        "main.cc",
+    ],
     deps = [
-        ":tsclilib",
-        "@com_google_googletest//:gtest_main",
+        ":command",
+        ":tscli_commands",
+        "//tensorstore:context",
+        "//tensorstore/internal/metrics:collect",
+        "//tensorstore/internal/metrics:registry",
+        "//tensorstore/util:json_absl_flag",
+        "//tensorstore/util:span",
+        "@com_google_absl//absl/base:log_severity",
+        "@com_google_absl//absl/base:no_destructor",
+        "@com_google_absl//absl/flags:flag",
+        "@com_google_absl//absl/flags:parse",
+        "@com_google_absl//absl/log:globals",
+        "@com_google_absl//absl/log:initialize",
+        "@com_google_absl//absl/status",
     ],
 )
 
 tensorstore_cc_library(
-    name = "tsclilib",
+    name = "tscli_commands",
     srcs = [
-        "args.cc",
-        "kvstore_copy.cc",
-        "kvstore_list.cc",
-        "ts_print_spec.cc",
-        "ts_print_stats.cc",
-        "ts_search.cc",
+        "copy_command.cc",
+        "list_command.cc",
+        "print_spec_command.cc",
+        "print_stats_command.cc",
+        "search_command.cc",
     ],
     hdrs = [
-        "args.h",
-        "cli.h",
+        "copy_command.h",
+        "list_command.h",
+        "print_spec_command.h",
+        "print_stats_command.h",
+        "search_command.h",
     ],
     deps = [
-        "//tensorstore",
-        "//tensorstore:array_storage_statistics",
+        ":command",
         "//tensorstore:box",
         "//tensorstore:context",
         "//tensorstore:json_serialization_options_base",
-        "//tensorstore:open",
-        "//tensorstore:open_mode",
         "//tensorstore:spec",
-        "//tensorstore/index_space:dim_expression",
-        "//tensorstore/internal:path",
         "//tensorstore/internal/json_binding",
         "//tensorstore/internal/json_binding:bindable",
         "//tensorstore/kvstore",
-        "//tensorstore/kvstore:generation",
-        "//tensorstore/kvstore:key_range",
-        "//tensorstore/util:division",
-        "//tensorstore/util:executor",
-        "//tensorstore/util:future",
-        "//tensorstore/util:iterate",
+        "//tensorstore/tscli/lib:kvstore_copy",
+        "//tensorstore/tscli/lib:kvstore_list",
+        "//tensorstore/tscli/lib:ts_print_spec",
+        "//tensorstore/tscli/lib:ts_print_stats",
+        "//tensorstore/tscli/lib:ts_search",
         "//tensorstore/util:json_absl_flag",
-        "//tensorstore/util:quote_string",
-        "//tensorstore/util:result",
-        "//tensorstore/util:span",
-        "//tensorstore/util:status",
-        "@com_github_nlohmann_json//:json",
-        "@com_google_absl//absl/container:flat_hash_map",
-        "@com_google_absl//absl/container:flat_hash_set",
-        "@com_google_absl//absl/flags:parse",
-        "@com_google_absl//absl/functional:function_ref",
-        "@com_google_absl//absl/log",
         "@com_google_absl//absl/status",
         "@com_google_absl//absl/strings",
         "@com_google_absl//absl/strings:str_format",
-        "@com_google_absl//absl/strings:string_view",
-        "@com_google_absl//absl/synchronization",
-        "@com_google_re2//:re2",
     ],
 )
 
-tensorstore_cc_binary(
-    name = "tscli",
+tensorstore_cc_library(
+    name = "command",
     srcs = [
-        "main.cc",
+        "command.cc",
+        "command_parser.cc",
+    ],
+    hdrs = [
+        "command.h",
+        "command_parser.h",
     ],
     deps = [
-        ":tsclilib",
         "//tensorstore:context",
-        "//tensorstore/driver:all_drivers",
-        "//tensorstore/internal/metrics:collect",
-        "//tensorstore/internal/metrics:registry",
-        "//tensorstore/kvstore:all_drivers",
-        "//tensorstore/util:json_absl_flag",
-        "@com_google_absl//absl/base:log_severity",
-        "@com_google_absl//absl/flags:flag",
-        "@com_google_absl//absl/flags:parse",
-        "@com_google_absl//absl/log:globals",
-        "@com_google_absl//absl/log:initialize",
+        "//tensorstore/util:span",
+        "//tensorstore/util:status",
+        "@com_google_absl//absl/container:flat_hash_map",
+        "@com_google_absl//absl/container:flat_hash_set",
+        "@com_google_absl//absl/log:absl_check",
         "@com_google_absl//absl/status",
+        "@com_google_absl//absl/strings",
+        "@com_google_absl//absl/strings:string_view",
     ],
 )

tensorstore/tscli/args.h

@@ -0,0 +1,26 @@
+// Copyright 2025 The TensorStore Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "tensorstore/tscli/command.h"
+
+#include <string_view>
+
+namespace tensorstore {
+namespace cli {
+
+Command::Command(std::string_view name, std::string_view short_description)
+    : parser_(name, short_description) {}
+
+}  // namespace cli
+}  // namespace tensorstore

tensorstore/tscli/command.cc

@@ -0,0 +1,75 @@
+// Copyright 2025 The TensorStore Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef TENSORSTORE_TSCLI_COMMAND_H_
+#define TENSORSTORE_TSCLI_COMMAND_H_
+
+#include <algorithm>
+#include <string_view>
+#include <vector>
+
+#include "absl/status/status.h"
+#include "tensorstore/context.h"
+#include "tensorstore/tscli/command_parser.h"
+
+namespace tensorstore {
+namespace cli {
+
+// Command encapsulates the option parsing and execution logic for a
+// single command.
+class Command {
+ public:
+  // Constructs a command with the given `name` and `usage`.  The name
+  // is what the user types on the command line, and is later
+  // available through the `name()` method.  The `usage` text is free
+  // form English text describing the command.
+  Command(std::string_view name, std::string_view short_description);
+
+  Command(const Command&) = delete;
+  Command& operator=(const Command&) = delete;
+  virtual ~Command() = default;
+
+  // Name of the command.
+  std::string_view name() const { return parser().name(); }
+
+  // Returns whether the command matches the name.
+  bool MatchesCommand(std::string_view command) const {
+    if (name() == command) return true;
+    return std::find(aliases_.begin(), aliases_.end(), command) !=
+           aliases_.end();
+  }
+
+  // Executes the command, returning a `Status` indicating OK or the
+  // nature of the failure.  The `Command` will log any error
+  // returned.  Derived classes must implement this.
+  //
+  // TODO: Add RunOptions struct to allow for more flexibility in how the
+  // command is run.
+  virtual absl::Status Run(Context::Spec context_spec) = 0;
+
+  CommandParser& parser() { return parser_; }
+  const CommandParser& parser() const { return parser_; }
+
+ protected:
+  void AddAlias(std::string_view alias) { aliases_.push_back(alias); }
+
+ private:
+  CommandParser parser_;
+  std::vector<std::string_view> aliases_;
+};
+
+}  // namespace cli
+}  // namespace tensorstore
+
+#endif  // TENSORSTORE_TSCLI_COMMAND_H_