Merge pull request #515 from NVIDIA/am/check-input-files

Verify if input path exist on argparse level

Author: amaslenn

src/cloudai/cli/cli.py

@@ -26,6 +26,13 @@
 )
 
 
+def existing_path(filepath: str) -> Path:
+    fpath = Path(filepath)
+    if not fpath.exists():
+        raise argparse.ArgumentTypeError(f"Path '{fpath}' does not exist.")
+    return fpath
+
+
 class CloudAICLI:
     """Command-line argument parser for CloudAI and derivatives."""
 
@@ -68,18 +75,25 @@ def add_command(
         self.handlers[name] = handler
         if system_config is not None:
             p.add_argument(
-                "--system-config", help="Path to the system configuration file.", required=system_config, type=Path
+                "--system-config",
+                help="Path to the system configuration file.",
+                required=system_config,
+                type=existing_path,
             )
         if tests_dir is not None:
             p.add_argument(
-                "--tests-dir", help="Path to the test configuration directory.", required=tests_dir, type=Path
+                "--tests-dir", help="Path to the test configuration directory.", required=tests_dir, type=existing_path
             )
         if test_scenario is not None:
-            p.add_argument("--test-scenario", help="Path to the test scenario file.", required=test_scenario, type=Path)
+            p.add_argument(
+                "--test-scenario", help="Path to the test scenario file.", required=test_scenario, type=existing_path
+            )
         if output_dir is not None:
             p.add_argument("--output-dir", help="Path to the output directory.", required=output_dir, type=Path)
         if result_dir is not None:
-            p.add_argument("--result-dir", help="Path to the result directory.", required=result_dir, type=Path)
+            p.add_argument(
+                "--result-dir", help="Path to the result directory.", required=result_dir, type=existing_path
+            )
 
         return p
 

tests/test_cli.py

@@ -139,11 +139,11 @@ def test_add_command_all_required():
         [
             "test",
             "--system-config",
-            "system_config",
+            f"{Path(__file__)}",
             "--tests-dir",
-            "tests_dir",
+            f"{Path.cwd()}",
             "--test-scenario",
-            "test_scenario",
+            f"{Path(__file__)}",
             "--output-dir",
             "output_dir",
         ]
@@ -152,9 +152,9 @@ def test_add_command_all_required():
         log_file="debug.log",
         log_level="INFO",
         mode="test",
-        system_config=Path("system_config"),
-        tests_dir=Path("tests_dir"),
-        test_scenario=Path("test_scenario"),
+        system_config=Path(__file__),
+        tests_dir=Path.cwd(),
+        test_scenario=Path(__file__),
         output_dir=Path("output_dir"),
     )
 
@@ -194,18 +194,18 @@ def test_install_uninstall_modes(self, cli: CloudAICLI):
                 [
                     mode,
                     "--system-config",
-                    "system_config",
+                    f"{Path(__file__)}",
                     "--tests-dir",
-                    "tests_dir",
+                    f"{Path.cwd()}",
                 ]
             )
 
             assert args == argparse.Namespace(
                 log_file="debug.log",
                 log_level="INFO",
                 mode=mode,
-                system_config=Path("system_config"),
-                tests_dir=Path("tests_dir"),
+                system_config=Path(__file__),
+                tests_dir=Path.cwd(),
                 test_scenario=None,
                 output_dir=None,
             )
@@ -214,12 +214,12 @@ def test_verify_all_configs_mode(self, cli: CloudAICLI):
         assert "verify-configs" in cli.handlers
         assert cli.handlers["verify-configs"] is handle_verify_all_configs
 
-        args = cli.parser.parse_args(["verify-configs", "--tests-dir", "tests_dir", "configs_dir"])
+        args = cli.parser.parse_args(["verify-configs", "--tests-dir", f"{Path.cwd()}", "configs_dir"])
         assert args == argparse.Namespace(
             log_file="debug.log",
             log_level="INFO",
             mode="verify-configs",
-            tests_dir=Path("tests_dir"),
+            tests_dir=Path.cwd(),
             strict=False,
             **{"configs_dir": Path("configs_dir")},
         )
@@ -242,23 +242,23 @@ def test_report_generation_mode(self, cli: CloudAICLI):
             [
                 "generate-report",
                 "--system-config",
-                "system_config",
+                f"{Path(__file__)}",
                 "--tests-dir",
-                "tests_dir",
+                f"{Path.cwd()}",
                 "--test-scenario",
-                "test_scenario",
+                f"{Path(__file__)}",
                 "--result-dir",
-                "result_dir",
+                f"{Path.cwd()}",
             ]
         )
         assert args == argparse.Namespace(
             log_file="debug.log",
             log_level="INFO",
             mode="generate-report",
-            test_scenario=Path("test_scenario"),
-            result_dir=Path("result_dir"),
-            system_config=Path("system_config"),
-            tests_dir=Path("tests_dir"),
+            test_scenario=Path(__file__),
+            result_dir=Path.cwd(),
+            system_config=Path(__file__),
+            tests_dir=Path.cwd(),
         )
 
     def test_run_dry_run_modes(self, cli: CloudAICLI):
@@ -270,21 +270,21 @@ def test_run_dry_run_modes(self, cli: CloudAICLI):
                 [
                     mode,
                     "--system-config",
-                    "system_config",
+                    f"{Path(__file__)}",
                     "--tests-dir",
-                    "tests_dir",
+                    f"{Path.cwd()}",
                     "--test-scenario",
-                    "test_scenario",
+                    f"{Path(__file__)}",
                 ]
             )
 
             assert args == argparse.Namespace(
                 log_file="debug.log",
                 log_level="INFO",
                 mode=mode,
-                system_config=Path("system_config"),
-                tests_dir=Path("tests_dir"),
-                test_scenario=Path("test_scenario"),
+                system_config=Path(__file__),
+                tests_dir=Path.cwd(),
+                test_scenario=Path(__file__),
                 output_dir=None,
                 enable_cache_without_check=False,
             )
@@ -306,9 +306,9 @@ def test_required_args(
         self, mode_and_missing_options: tuple[str, list[str]], cli: CloudAICLI, capsys: pytest.CaptureFixture[str]
     ):
         opts = {
-            "--system-config": "system_config",
-            "--tests-dir": "tests_dir",
-            "--test-scenario": "test_scenario",
+            "--system-config": f"{Path(__file__)}",
+            "--tests-dir": f"{Path.cwd()}",
+            "--test-scenario": f"{Path(__file__)}",
             "--output-dir": "output_dir",
         }
         mode, missing_options = mode_and_missing_options