fix(cli): always resolve paths passed via the cli to handle relative paths

Author: mikonse

packages/debmagic/src/debmagic/cli/_config.py

@@ -1,8 +1,8 @@
 import argparse
 from pathlib import Path
-from typing import ClassVar
+from typing import Annotated, ClassVar
 
-from pydantic import Field
+from pydantic import AfterValidator, Field
 from pydantic_settings import (
     BaseSettings,
     CliApp,
@@ -14,19 +14,23 @@
 from ._build_driver.config import BuildDriverConfig
 
 
-# TODO: figure out how to get cli_avoid_json with the nested driver struct to work properly
+def resolve_path(p: Path) -> Path:
+    return p.resolve()
+
+
 class DebmagicConfig(BaseSettings, cli_kebab_case=True, cli_avoid_json=True):
     _config_file_paths: ClassVar[list[Path]] = []
 
     driver_config: BuildDriverConfig = BuildDriverConfig()
 
-    temp_build_dir: Path = Field(
-        default=Path("/tmp/debmagic"),
-        description="Temporary directory on the local machine used as root directory for all package builds",
-    )
+    temp_build_dir: Annotated[
+        Path,
+        Field(description="Temporary directory on the local machine used as root directory for all package builds"),
+        AfterValidator(resolve_path),
+    ] = Path("/tmp/debmagic")
 
-    dry_run: bool = Field(
-        default=False, description="don't actually run anything that changes the system/package state"
+    dry_run: Annotated[bool, Field(description="don't actually run anything that changes the system/package state")] = (
+        False
     )
 
     @classmethod

packages/debmagic/src/debmagic/cli/_main.py

@@ -10,6 +10,10 @@
 from ._version import VERSION
 
 
+def arg_resolved_path(arg: str) -> Path:
+    return Path(arg).resolve()
+
+
 def _create_parser() -> argparse.ArgumentParser:
     cli = argparse.ArgumentParser(description="Debmagic")
     sp = cli.add_subparsers(dest="operation")
@@ -19,31 +23,27 @@ def _create_parser() -> argparse.ArgumentParser:
     sp.add_parser("version", help="Print the version information and exit")
 
     common_cli = get_config_argparser()
-    common_cli.add_argument("-c", "--config", type=Path, help="Path to a config file")
+    common_cli.add_argument("-c", "--config", type=arg_resolved_path, help="Path to a config file")
 
     build_cli = sp.add_parser(
         "build", parents=[common_cli], help="Build a debian package with the selected containerization driver"
     )
     build_cli.add_argument("--driver", choices=SUPPORTED_BUILD_DRIVERS, required=True)
-    build_cli.add_argument("-s", "--source-dir", type=Path, default=Path.cwd())
-    build_cli.add_argument("-o", "--output-dir", type=Path, default=Path.cwd())
+    build_cli.add_argument("-s", "--source-dir", type=arg_resolved_path, default=Path.cwd())
+    build_cli.add_argument("-o", "--output-dir", type=arg_resolved_path, default=Path.cwd())
 
     sp.add_parser("check", parents=[common_cli], help="Run linters (e.g. lintian)")
 
     shell_cli = sp.add_parser("shell", parents=[common_cli], help="Attach a shell to a running debmagic build")
-    shell_cli.add_argument("-s", "--source-dir", type=Path, default=Path.cwd())
+    shell_cli.add_argument("-s", "--source-dir", type=arg_resolved_path, default=Path.cwd())
 
     sp.add_parser("test", parents=[common_cli], help="Run package tests")
     return cli
 
 
 def main(passed_args: Sequence[str] | None = None):
     cli = _create_parser()
-    args, unknown_args = cli.parse_known_args(passed_args)
-
-    if len(unknown_args) > 0 and args.operation != "build":
-        # TODO: proper validation and printout -> maybe differentiate between build subcommand and others???
-        raise RuntimeError("unknown arguments passed")
+    args = cli.parse_args(passed_args)
 
     config_file_paths: list[Path] = []
     if args.config: