Add new msc config validate command

Author: yingquany

.release_notes/.unreleased.md

@@ -1,4 +1,3 @@
 <!-- To avoid merge conflicts, add items at an arbitrary place in the list. -->
-
-- Added partial file caching with configurable chunk sizes, prefetch control, and source version validation for improved performance on large files
-
+- Add `msc config validate` command.
+- Added partial file caching with configurable chunk sizes, prefetch control, and source version validation for improved performance on large files.

docs/src/user_guide/cli.rst

@@ -23,6 +23,7 @@ The ``msc help`` command displays general help information and available command
    msc help <command>
 
    commands:
+   config   MSC configuration management commands
    glob     Find files using Unix-style wildcard patterns with optional attribute filtering
    help     Display help for commands
    ls       List files and directories with optional attribute filtering
@@ -131,6 +132,49 @@ The ``msc glob`` command finds files in a storage service using Unix-style wildc
    The ``msc glob`` command works by first listing all files in the specified directory using the equivalent of ``msc ls``, then applying the glob pattern as a post-filter to the results. This means that glob patterns are evaluated locally after retrieving the file listing from the storage service.  To reduce number of HEAD requests, either opt in to use metadata provider or use ``msc glob`` for only a specific pattern of files.
 
 
+**********
+msc config
+**********
+
+The ``msc config`` command provides configuration management utilities for MSC. Currently, it supports the ``validate`` subcommand to validate and display the resolved MSC configuration.
+
+.. code-block:: text
+  :caption: config validate command help output
+
+  $ msc config validate --help
+  usage: msc config validate [-h] [--format {json,yaml}]
+                             [--config-file CONFIG_FILE_PATH]
+
+  options:
+    -h, --help            show this help message and exit
+    --format {json,yaml}  Output format (default: yaml)
+    --config-file CONFIG_FILE_PATH
+                          Path to a specific config file (overrides default
+                          search paths)
+
+  examples:
+    # Validate and print resolved MSC configuration based on default search path
+    msc config validate
+
+    # Validate and print resolved MSC configuration based on specific config file
+    msc config validate --config-file /path/to/config.yaml
+
+.. code-block:: text
+  :caption: Validate and display configuration in YAML format
+
+  $ msc config validate
+  profiles:
+    local:
+      storage_provider:
+        type: file
+        options:
+          base_path: /home/user/
+    s3-bucket:
+      storage_provider:
+        type: s3
+        options:
+          base_path: my-bucket
+
 ******
 msc rm
 ******

src/multistorageclient/commands/cli/actions/__init__.py

@@ -14,6 +14,7 @@
 # limitations under the License.
 
 from .action import ActionRegistry, MSCArgumentParser
+from .config import ConfigAction
 from .glob import GlobAction
 from .help import HelpAction
 from .ls import LsAction
@@ -23,6 +24,7 @@
 __all__ = [
     "ActionRegistry",
     "MSCArgumentParser",
+    "ConfigAction",
     "HelpAction",
     "SyncAction",
     "GlobAction",

src/multistorageclient/commands/cli/actions/action.py

@@ -19,7 +19,7 @@
 from typing import Optional
 
 
-class MSCHelpFormatter(argparse.HelpFormatter):
+class MSCHelpFormatter(argparse.RawDescriptionHelpFormatter):
     """
     Help message formatter for MSC CLI.
     """

src/multistorageclient/commands/cli/actions/config.py

@@ -0,0 +1,100 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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.
+
+import argparse
+import json
+import sys
+
+import yaml
+
+from multistorageclient.config import StorageClientConfig
+
+from .action import Action
+
+
+class ConfigAction(Action):
+    """
+    Action for configuration management commands.
+    """
+
+    def name(self) -> str:
+        return "config"
+
+    def help(self) -> str:
+        return "Configuration management commands"
+
+    def setup_parser(self, parser: argparse.ArgumentParser) -> None:
+        # Create subparsers for config subcommands
+        subparsers = parser.add_subparsers(
+            title="available commands",
+            dest="subcommand",
+            required=True,
+        )
+
+        # Add validate subcommand
+        validate_parser = subparsers.add_parser(
+            "validate", help="Validate and print configuration used by MSC", add_help=True
+        )
+
+        # Add options specific to validate subcommand
+        validate_parser.add_argument(
+            "--format",
+            choices=["json", "yaml"],
+            default="yaml",
+            help="Output format (default: yaml)",
+        )
+
+        validate_parser.add_argument(
+            "--config-file",
+            help="Path to a specific config file (overrides default search paths)",
+            default=None,
+            metavar="CONFIG_FILE_PATH",
+        )
+
+        validate_parser.epilog = """examples:
+  # Validate and print resolved MSC configuration based on default search path
+  msc config validate
+
+  # Validate and print resolved MSC configuration based on specific config file
+  msc config validate --config-file /path/to/config.yaml
+"""
+
+    def run(self, args: argparse.Namespace) -> int:
+        """Run the config action with parsed arguments."""
+        if args.subcommand == "validate":
+            return self._run_validate(args)
+        else:
+            print(f"Unknown subcommand: {args.subcommand}")
+            return 1
+
+    def _run_validate(self, args: argparse.Namespace) -> int:
+        """Handle the 'config validate' subcommand."""
+        try:
+            config_file_paths = [args.config_file] if args.config_file else None
+
+            # Get the merged and validated config
+            config_obj = StorageClientConfig.from_file(config_file_paths=config_file_paths)
+            config_dict = config_obj._config_dict
+
+            # Output in requested format
+            if args.format == "json":
+                print(json.dumps(config_dict, indent=2))
+            else:  # yaml
+                print(yaml.dump(config_dict, default_flow_style=False, sort_keys=False))
+            return 0
+
+        except Exception as e:
+            print(f"Error: {str(e)}", file=sys.stderr)
+            return 1

src/multistorageclient/commands/cli/actions/glob.py

@@ -31,8 +31,6 @@ def help(self) -> str:
         return "Find files using Unix-style wildcard patterns with optional attribute filtering"
 
     def setup_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.formatter_class = argparse.RawDescriptionHelpFormatter
-
         parser.add_argument(
             "--attribute-filter-expression",
             "-e",

src/multistorageclient/commands/cli/actions/ls.py

@@ -34,8 +34,6 @@ def help(self) -> str:
         return "List files and directories with optional attribute filtering"
 
     def setup_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.formatter_class = argparse.RawDescriptionHelpFormatter
-
         parser.add_argument(
             "--attribute-filter-expression",
             "-e",

src/multistorageclient/commands/cli/actions/rm.py

@@ -31,8 +31,6 @@ def help(self) -> str:
         return "Delete files or directories"
 
     def setup_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.formatter_class = argparse.RawDescriptionHelpFormatter
-
         parser.add_argument(
             "--debug",
             action="store_true",

src/multistorageclient/commands/cli/actions/sync.py

@@ -32,8 +32,6 @@ def help(self) -> str:
         return "Synchronize files from the source storage to the target storage"
 
     def setup_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.formatter_class = argparse.RawDescriptionHelpFormatter
-
         parser.add_argument(
             "--delete-unmatched-files",
             action="store_true",

src/multistorageclient/commands/cli/main.py

@@ -18,7 +18,16 @@
 
 import multistorageclient as msc
 
-from .actions import ActionRegistry, GlobAction, HelpAction, LsAction, MSCArgumentParser, RmAction, SyncAction
+from .actions import (
+    ActionRegistry,
+    ConfigAction,
+    GlobAction,
+    HelpAction,
+    LsAction,
+    MSCArgumentParser,
+    RmAction,
+    SyncAction,
+)
 
 
 def create_parser() -> MSCArgumentParser:
@@ -49,6 +58,7 @@ def main() -> int:
 
     # Register commands with instances
     registry.register_action(HelpAction(registry))
+    registry.register_action(ConfigAction())
     registry.register_action(SyncAction())
     registry.register_action(GlobAction())
     registry.register_action(LsAction())
@@ -79,8 +89,8 @@ def main() -> int:
     cmd_parser = MSCArgumentParser(prog=f"msc {args.command}", description=action.help())
     action.setup_parser(cmd_parser)
 
-    # Check if --help is in the subcommand arguments
-    if "--help" in args.args or "-h" in args.args:
+    # Check if --help is requested for the parent command (not a subcommand)
+    if args.args == ["--help"] or args.args == ["-h"]:
         cmd_parser.print_help()
         return 0