hector-cli 0.6.0__tar.gz → 0.7.0__tar.gz

{hector_cli-0.6.0 → hector_cli-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hector-cli
-Version: 0.6.0
+Version: 0.7.0
 Summary: YAML-driven Renode + Verilator simulation orchestrator for embedded hardware CI
 Home-page: https://hector-ci.com
 Author: Nemesis
@@ -210,7 +210,7 @@ the CLI natively with `pip` and let hector launch real per-step containers.
 | `hector run --renode-dir /cache/renode` | Use/cache the Renode source checkout at this path (only fetched when needed) |
 | `hector run --renode-integration-dir /cache/integration` | Likewise for the verilator-integration checkout |
 | `hector run --no-docker` | Use locally installed `renode` / `renode-test` instead of Docker |
-| `hector run --workspace-mount /mnt` | Override the container path the project root is mounted at |
+| `hector run --workspace-mount /mnt` | Mount the hectorfile's folder at this container path and execute there |
 | `hector run --snapshot path/to/snapshot.save` | Load a snapshot instead of booting from the resc |
 | `hector run --snapshot snap.save --renode-version 1.16.1` | Load a snapshot without a `.hector.yaml` |
 | `hector test` | Run the `tests:` section; exit 1 on any failure |
@@ -487,7 +487,7 @@ hector run --renode-args '--hide-log --config my.conf'
 
 Everything a hectorfile executes — `build:` steps, `shell` tests, Renode and `renode-test` — runs **in the hectorfile's folder**, and paths written in the file (`firmware:`, `platform:`, module `source:`, test `file:` / `snapshot:`, `file:` mappings, `artifacts:`, paths inside scripts and `commands:`) are **relative to that folder**. So `hector test -f boards/nucleo/.hector.yaml` behaves the same as running `hector test` inside `boards/nucleo/`.
 
-The directory you run hector from is mounted into the container (at the same path), and the container's working directory (`-w`) is the hectorfile's folder. If the hectorfile lives **outside** the directory you run from (`hector test -f ../other/.hector.yaml`), its folder is mounted as well, at its own path. A path like `../shared/board.repl` works as long as it lands inside one of those mounts — for anything else, add a mount with [`docker_args`](#extra-docker-flags---docker-args). Under `--no-docker` the processes simply run with the hectorfile's folder as their cwd.
+The directory you run hector from is mounted into the container (at the same path), and the container's working directory (`-w`) is the hectorfile's folder. If the hectorfile lives **outside** the directory you run from (`hector test -f ../other/.hector.yaml`), its folder is mounted as well, at its own path. (With [`--workspace-mount`](#overriding-the-workspace-mount-path---workspace-mount) the hectorfile's folder is mounted at the given path instead.) A path like `../shared/board.repl` works as long as it lands inside one of those mounts — for anything else, add a mount with [`docker_args`](#extra-docker-flags---docker-args). Under `--no-docker` the processes simply run with the hectorfile's folder as their cwd.
 
 Paths given on the **command line** (`--output`, `--snapshot`, `--test-file`, `--artifacts`, `--renode-dir`, …) stay relative to where you run hector, and `.hector/` is still created there.
 
@@ -572,12 +572,15 @@ An existing directory is reused as-is; a missing one is cloned into. The locatio
 
 #### Overriding the workspace mount path (`--workspace-mount`)
 
-By default the project root is bind-mounted into the container at the **same absolute path** as on the host (e.g. `/home/user/projects/myboard`), so paths look identical inside and outside the container. Override this only if the host path is unavailable at that location inside the image:
+By default everything is bind-mounted into the container at the **same absolute path** as on the host (e.g. `/home/user/projects/myboard`), so paths look identical inside and outside the container. `--workspace-mount PATH` instead mounts the **hectorfile's folder** at `PATH`, and that's where every step, Renode and `renode-test` execute:
 
 ```bash
-hector run --workspace-mount /workspace
+hector run --workspace-mount /workspace                              # . → /workspace
+hector test -f boards/nucleo/.hector.yaml --workspace-mount /workspace  # boards/nucleo → /workspace
 ```
 
+When you run from a different folder than the hectorfile's (the second line), that folder — where `.hector/` and `--output` live — is additionally mounted at its own path, unless it's already inside the hectorfile's folder.
+
 **Cannot be combined with `--no-docker`** — if you are running locally there is no container mount to configure.
 
 ### Selecting a matrix combination (`--job`)

{hector_cli-0.6.0 → hector_cli-0.7.0}/README.md

@@ -180,7 +180,7 @@ the CLI natively with `pip` and let hector launch real per-step containers.
 | `hector run --renode-dir /cache/renode` | Use/cache the Renode source checkout at this path (only fetched when needed) |
 | `hector run --renode-integration-dir /cache/integration` | Likewise for the verilator-integration checkout |
 | `hector run --no-docker` | Use locally installed `renode` / `renode-test` instead of Docker |
-| `hector run --workspace-mount /mnt` | Override the container path the project root is mounted at |
+| `hector run --workspace-mount /mnt` | Mount the hectorfile's folder at this container path and execute there |
 | `hector run --snapshot path/to/snapshot.save` | Load a snapshot instead of booting from the resc |
 | `hector run --snapshot snap.save --renode-version 1.16.1` | Load a snapshot without a `.hector.yaml` |
 | `hector test` | Run the `tests:` section; exit 1 on any failure |
@@ -457,7 +457,7 @@ hector run --renode-args '--hide-log --config my.conf'
 
 Everything a hectorfile executes — `build:` steps, `shell` tests, Renode and `renode-test` — runs **in the hectorfile's folder**, and paths written in the file (`firmware:`, `platform:`, module `source:`, test `file:` / `snapshot:`, `file:` mappings, `artifacts:`, paths inside scripts and `commands:`) are **relative to that folder**. So `hector test -f boards/nucleo/.hector.yaml` behaves the same as running `hector test` inside `boards/nucleo/`.
 
-The directory you run hector from is mounted into the container (at the same path), and the container's working directory (`-w`) is the hectorfile's folder. If the hectorfile lives **outside** the directory you run from (`hector test -f ../other/.hector.yaml`), its folder is mounted as well, at its own path. A path like `../shared/board.repl` works as long as it lands inside one of those mounts — for anything else, add a mount with [`docker_args`](#extra-docker-flags---docker-args). Under `--no-docker` the processes simply run with the hectorfile's folder as their cwd.
+The directory you run hector from is mounted into the container (at the same path), and the container's working directory (`-w`) is the hectorfile's folder. If the hectorfile lives **outside** the directory you run from (`hector test -f ../other/.hector.yaml`), its folder is mounted as well, at its own path. (With [`--workspace-mount`](#overriding-the-workspace-mount-path---workspace-mount) the hectorfile's folder is mounted at the given path instead.) A path like `../shared/board.repl` works as long as it lands inside one of those mounts — for anything else, add a mount with [`docker_args`](#extra-docker-flags---docker-args). Under `--no-docker` the processes simply run with the hectorfile's folder as their cwd.
 
 Paths given on the **command line** (`--output`, `--snapshot`, `--test-file`, `--artifacts`, `--renode-dir`, …) stay relative to where you run hector, and `.hector/` is still created there.
 
@@ -542,12 +542,15 @@ An existing directory is reused as-is; a missing one is cloned into. The locatio
 
 #### Overriding the workspace mount path (`--workspace-mount`)
 
-By default the project root is bind-mounted into the container at the **same absolute path** as on the host (e.g. `/home/user/projects/myboard`), so paths look identical inside and outside the container. Override this only if the host path is unavailable at that location inside the image:
+By default everything is bind-mounted into the container at the **same absolute path** as on the host (e.g. `/home/user/projects/myboard`), so paths look identical inside and outside the container. `--workspace-mount PATH` instead mounts the **hectorfile's folder** at `PATH`, and that's where every step, Renode and `renode-test` execute:
 
 ```bash
-hector run --workspace-mount /workspace
+hector run --workspace-mount /workspace                              # . → /workspace
+hector test -f boards/nucleo/.hector.yaml --workspace-mount /workspace  # boards/nucleo → /workspace
 ```
 
+When you run from a different folder than the hectorfile's (the second line), that folder — where `.hector/` and `--output` live — is additionally mounted at its own path, unless it's already inside the hectorfile's folder.
+
 **Cannot be combined with `--no-docker`** — if you are running locally there is no container mount to configure.
 
 ### Selecting a matrix combination (`--job`)

{hector_cli-0.6.0 → hector_cli-0.7.0}/hector/commands/base.py

@@ -110,8 +110,8 @@ def add_common_arguments(parser):
     )
     docker_mode.add_argument(
         "--workspace-mount", metavar="PATH", dest="workspace_mount", default=None,
-        help="Container path where the project root is bind-mounted "
-             "(default: same absolute path as on the host).",
+        help="Mount the hectorfile's folder at this container path and execute there "
+             "(default: everything is mounted at its own host path).",
     )
 
 

{hector_cli-0.6.0 → hector_cli-0.7.0}/hector/core.py

@@ -67,7 +67,7 @@ class Registry:
 # ==========================================================================
 # CONSTANTS
 # ==========================================================================
-TOOL_VERSION = "0.6.0"
+TOOL_VERSION = "0.7.0"
 SUPPORTED_SCHEMA_VERSIONS = {"0.1"}
 
 RENODE_REPO_URL = "https://github.com/renode/renode.git"
@@ -78,7 +78,10 @@ ARTIFACTS_DIR = ".hector"          # everything we generate/clone lives here (gi
 # hosts we mirror the host cwd, so paths look identical in and out; on Windows the host
 # path (C:\...) is not a valid Linux path, so use a fixed POSIX mount point and translate.
 WORKSPACE_MOUNT = "/workspace" if os.name == "nt" else os.getcwd()
-NO_DOCKER = False                  # when True, call renode/renode-test directly on host
+# Host directory bind-mounted at WORKSPACE_MOUNT. None = the cwd; --workspace-mount
+# sets it to the config's directory, so the mount point is where execution happens.
+WORKSPACE_ROOT = None
+NO_DOCKER = False                 # when True, call renode/renode-test directly on host
 EXTRA_MOUNTS = []                  # dep dirs outside the workspace, bind-mounted 1:1 into every container
 DOCKER_ARGS = []                   # user flags (docker_args: + --docker-args) added to every `docker run`
 # Host directory of the config file being executed. Paths written in the config resolve
@@ -124,12 +127,17 @@ def host_uid_gid():
     return None
 
 
+def workspace_root():
+    """Host directory mounted at WORKSPACE_MOUNT (see WORKSPACE_ROOT)."""
+    return os.path.realpath(WORKSPACE_ROOT or os.getcwd())
+
+
 def to_container_path(host_path):
     abs_path = os.path.realpath(host_path)
-    root = os.path.realpath(os.getcwd())
+    root = workspace_root()
     if os.path.commonpath([abs_path, root]) != root:
-        # Out-of-tree dirs registered in EXTRA_MOUNTS (the config's dir, a shared
-        # Renode cache) are mounted 1:1, so their paths are valid as-is.
+        # Dirs outside the workspace registered in EXTRA_MOUNTS (the config's dir or the
+        # cwd, a shared Renode cache) are mounted 1:1, so their paths are valid as-is.
         for m in EXTRA_MOUNTS:
             if os.path.commonpath([abs_path, m]) == m:
                 return abs_path
@@ -150,13 +158,12 @@ def register_dependency_mount(host_dir):
     Dirs under the workspace are already covered by the workspace mount, so they map via
     to_container_path. An out-of-tree dir (e.g. a shared cache) is registered in
     EXTRA_MOUNTS and used at its own absolute path inside the container."""
-    abs_dir = os.path.realpath(host_dir)
-    root = os.path.realpath(os.getcwd())
-    if os.path.commonpath([abs_dir, root]) == root:
-        return to_container_path(host_dir)
-    if abs_dir not in EXTRA_MOUNTS:
+    try:
+        return to_container_path(host_dir)    # already reachable through some mount
+    except ValueError:
+        abs_dir = os.path.realpath(host_dir)
         EXTRA_MOUNTS.append(abs_dir)
-    return abs_dir
+        return abs_dir
 
 
 def container_path_for(host_path):
@@ -176,8 +183,8 @@ def container_to_host(container_path):
     if container_path != WORKSPACE_MOUNT and not container_path.startswith(WORKSPACE_MOUNT + "/"):
         raise ValueError(f"'{container_path}' is not under {WORKSPACE_MOUNT}.")
     rel = posixpath.relpath(container_path, WORKSPACE_MOUNT).replace("/", os.sep)
-    host = os.path.realpath(os.path.join(os.getcwd(), rel))
-    root = os.path.realpath(os.getcwd())
+    root = workspace_root()
+    host = os.path.realpath(os.path.join(root, rel))
     if os.path.commonpath([host, root]) != root:
         raise ValueError(f"'{container_path}' maps outside the project root.")
     return host

{hector_cli-0.6.0 → hector_cli-0.7.0}/hector/docker.py

@@ -48,7 +48,7 @@ def _user_flags():
 
 
 def _workspace_mount():
-    return ["-v", f"{os.getcwd()}:{core.WORKSPACE_MOUNT}", "-w", core.execution_dir()]
+    return ["-v", f"{core.workspace_root()}:{core.WORKSPACE_MOUNT}", "-w", core.execution_dir()]
 
 
 def _extra_mounts():

{hector_cli-0.6.0 → hector_cli-0.7.0}/hector/pipeline.py

@@ -47,6 +47,9 @@ from .validator import print_issues, validate_config
 # The config file every command reads/writes. Overridable with -f/--file; set by
 # apply_global_flags before any config is loaded.
 CONFIG_PATH = ".hector.yaml"
+# --workspace-mount given: mount the config's directory (where execution happens) at
+# that path, instead of the cwd. Set by apply_global_flags, applied once the config loads.
+MOUNT_CONFIG_DIR = False
 
 
 def apply_global_flags(args):
@@ -60,7 +63,9 @@ def apply_global_flags(args):
         global CONFIG_PATH
         CONFIG_PATH = path
     if getattr(args, "workspace_mount", None):
+        global MOUNT_CONFIG_DIR
         _core.WORKSPACE_MOUNT = args.workspace_mount
+        MOUNT_CONFIG_DIR = True
     if getattr(args, "no_docker", False) or os.environ.get("HECTOR_NO_DOCKER"):
         _core.NO_DOCKER = True
         _core.WORKSPACE_MOUNT = os.getcwd()
@@ -110,10 +115,18 @@ def load_config_or_exit():
 
 def _set_config_dir(config_path):
     """Make the config's directory the base for its paths and the working directory of
-    everything executed (see core.CONFIG_DIR). The cwd stays the workspace mount; a
-    config outside it gets its directory bind-mounted 1:1 as well, so it's reachable."""
+    everything executed (see core.CONFIG_DIR), and make sure both it and the cwd (where
+    .hector/ and --output live) are reachable from the container.
+
+    By default the cwd is the workspace mount and a config dir outside it is mounted
+    1:1 as well. With --workspace-mount, the config dir is mounted at that path instead
+    (so execution happens there) and a cwd outside it is the one mounted 1:1."""
     _core.CONFIG_DIR = os.path.realpath(os.path.dirname(os.path.abspath(config_path)))
-    _core.register_dependency_mount(_core.CONFIG_DIR)
+    if MOUNT_CONFIG_DIR:
+        _core.WORKSPACE_ROOT = _core.CONFIG_DIR
+        _core.register_dependency_mount(os.getcwd())
+    else:
+        _core.register_dependency_mount(_core.CONFIG_DIR)
 
 
 _VERSION_TAG_RE = re.compile(r"^v?\d+\.\d+\.\d+$")

{hector_cli-0.6.0 → hector_cli-0.7.0}/hector_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hector-cli
-Version: 0.6.0
+Version: 0.7.0
 Summary: YAML-driven Renode + Verilator simulation orchestrator for embedded hardware CI
 Home-page: https://hector-ci.com
 Author: Nemesis
@@ -210,7 +210,7 @@ the CLI natively with `pip` and let hector launch real per-step containers.
 | `hector run --renode-dir /cache/renode` | Use/cache the Renode source checkout at this path (only fetched when needed) |
 | `hector run --renode-integration-dir /cache/integration` | Likewise for the verilator-integration checkout |
 | `hector run --no-docker` | Use locally installed `renode` / `renode-test` instead of Docker |
-| `hector run --workspace-mount /mnt` | Override the container path the project root is mounted at |
+| `hector run --workspace-mount /mnt` | Mount the hectorfile's folder at this container path and execute there |
 | `hector run --snapshot path/to/snapshot.save` | Load a snapshot instead of booting from the resc |
 | `hector run --snapshot snap.save --renode-version 1.16.1` | Load a snapshot without a `.hector.yaml` |
 | `hector test` | Run the `tests:` section; exit 1 on any failure |
@@ -487,7 +487,7 @@ hector run --renode-args '--hide-log --config my.conf'
 
 Everything a hectorfile executes — `build:` steps, `shell` tests, Renode and `renode-test` — runs **in the hectorfile's folder**, and paths written in the file (`firmware:`, `platform:`, module `source:`, test `file:` / `snapshot:`, `file:` mappings, `artifacts:`, paths inside scripts and `commands:`) are **relative to that folder**. So `hector test -f boards/nucleo/.hector.yaml` behaves the same as running `hector test` inside `boards/nucleo/`.
 
-The directory you run hector from is mounted into the container (at the same path), and the container's working directory (`-w`) is the hectorfile's folder. If the hectorfile lives **outside** the directory you run from (`hector test -f ../other/.hector.yaml`), its folder is mounted as well, at its own path. A path like `../shared/board.repl` works as long as it lands inside one of those mounts — for anything else, add a mount with [`docker_args`](#extra-docker-flags---docker-args). Under `--no-docker` the processes simply run with the hectorfile's folder as their cwd.
+The directory you run hector from is mounted into the container (at the same path), and the container's working directory (`-w`) is the hectorfile's folder. If the hectorfile lives **outside** the directory you run from (`hector test -f ../other/.hector.yaml`), its folder is mounted as well, at its own path. (With [`--workspace-mount`](#overriding-the-workspace-mount-path---workspace-mount) the hectorfile's folder is mounted at the given path instead.) A path like `../shared/board.repl` works as long as it lands inside one of those mounts — for anything else, add a mount with [`docker_args`](#extra-docker-flags---docker-args). Under `--no-docker` the processes simply run with the hectorfile's folder as their cwd.
 
 Paths given on the **command line** (`--output`, `--snapshot`, `--test-file`, `--artifacts`, `--renode-dir`, …) stay relative to where you run hector, and `.hector/` is still created there.
 
@@ -572,12 +572,15 @@ An existing directory is reused as-is; a missing one is cloned into. The locatio
 
 #### Overriding the workspace mount path (`--workspace-mount`)
 
-By default the project root is bind-mounted into the container at the **same absolute path** as on the host (e.g. `/home/user/projects/myboard`), so paths look identical inside and outside the container. Override this only if the host path is unavailable at that location inside the image:
+By default everything is bind-mounted into the container at the **same absolute path** as on the host (e.g. `/home/user/projects/myboard`), so paths look identical inside and outside the container. `--workspace-mount PATH` instead mounts the **hectorfile's folder** at `PATH`, and that's where every step, Renode and `renode-test` execute:
 
 ```bash
-hector run --workspace-mount /workspace
+hector run --workspace-mount /workspace                              # . → /workspace
+hector test -f boards/nucleo/.hector.yaml --workspace-mount /workspace  # boards/nucleo → /workspace
 ```
 
+When you run from a different folder than the hectorfile's (the second line), that folder — where `.hector/` and `--output` live — is additionally mounted at its own path, unless it's already inside the hectorfile's folder.
+
 **Cannot be combined with `--no-docker`** — if you are running locally there is no container mount to configure.
 
 ### Selecting a matrix combination (`--job`)

{hector_cli-0.6.0 → hector_cli-0.7.0}/tests/test_pipeline_helpers.py

@@ -46,6 +46,8 @@ def config_in_subdir(tmp_path, monkeypatch):
     monkeypatch.setattr(core, "NO_DOCKER", False)
     monkeypatch.setattr(core, "CONFIG_DIR", None)
     monkeypatch.setattr(core, "EXTRA_MOUNTS", [])
+    monkeypatch.setattr(core, "WORKSPACE_ROOT", None)
+    monkeypatch.setattr(pipeline, "MOUNT_CONFIG_DIR", False)
     (tmp_path / "board").mkdir()
     (tmp_path / "board" / ".hector.yaml").write_text("renode_version: '1.16.1'\n")
     return pipeline, core, tmp_path
@@ -75,6 +77,33 @@ def test_load_config_outside_cwd_is_mounted_too(config_in_subdir, monkeypatch):
     assert core.to_container_path(core.from_config("fw.elf")) == f"{board}/fw.elf"
 
 
+def test_workspace_mount_mounts_config_dir_there(config_in_subdir, monkeypatch):
+    # Run from the parent with --workspace-mount /workspace: the config's dir is what's
+    # mounted there and where execution happens; the cwd (.hector/, --output) is 1:1.
+    pipeline, core, root = config_in_subdir
+    monkeypatch.setattr(core, "WORKSPACE_MOUNT", "/workspace")
+    monkeypatch.setattr(pipeline, "MOUNT_CONFIG_DIR", True)
+    monkeypatch.setattr(pipeline, "CONFIG_PATH", "board/.hector.yaml")
+    pipeline.load_config_or_exit()
+    board, cwd = str((root / "board").resolve()), str(root.resolve())
+    assert core.workspace_root() == board
+    assert core.execution_dir() == "/workspace"
+    assert core.to_container_path(core.from_config("fw/app.elf")) == "/workspace/fw/app.elf"
+    assert core.EXTRA_MOUNTS == [cwd]
+    assert core.to_container_path(".hector/resc/job_1.resc") == f"{cwd}/.hector/resc/job_1.resc"
+
+
+def test_workspace_mount_from_config_dir_needs_no_extra_mount(config_in_subdir, monkeypatch):
+    pipeline, core, root = config_in_subdir
+    monkeypatch.chdir(root / "board")
+    monkeypatch.setattr(core, "WORKSPACE_MOUNT", "/workspace")
+    monkeypatch.setattr(pipeline, "MOUNT_CONFIG_DIR", True)
+    monkeypatch.setattr(pipeline, "CONFIG_PATH", ".hector.yaml")
+    pipeline.load_config_or_exit()
+    assert core.execution_dir() == "/workspace"
+    assert core.EXTRA_MOUNTS == []
+
+
 # ---- apply_docker_args ----
 
 @pytest.mark.parametrize("cfg,flag,expected", [