casperbox 0.2.1__tar.gz → 0.2.2__tar.gz

{casperbox-0.2.1 → casperbox-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: casperbox
-Version: 0.2.1
+Version: 0.2.2
 Summary: Build and run CASPER toolflow development containers with rootless podman
 Requires-Python: >=3.11
 Requires-Dist: typer>=0.12
@@ -17,7 +17,7 @@ mlib_devel, device-tree-xlnx and Scilab. Vivado and the license are mounted from
 
 | Version | Base image | Vivado | Python | mlib_devel | device-tree-xlnx | Scilab |
 |---|---|---|---|---|---|---|
-| m2021a | Ubuntu 20.04 | 2021.1 | 3.14 | [liuweiseu/mlib_devel](https://github.com/liuweiseu/mlib_devel) `scilab-dev-ai` | xlnx_rel_v2021.1 | 2024.1.0 |
+| m2021a | Ubuntu 20.04 | 2021.1 | 3.14 | scilab-dev-ai | xlnx_rel_v2021.1 | 2024.1.0 |
 
 ## Host requirements
 
@@ -27,30 +27,12 @@ mlib_devel, device-tree-xlnx and Scilab. Vivado and the license are mounted from
 
 ## Host setup
 
-Log in directly (SSH or desktop) as the user that runs podman (do not switch with `su`), then run:
+Log in directly (SSH or desktop) as the user that runs podman, then run:
 
 ```bash
-loginctl enable-linger "$(id -un)"          # keep the user's systemd running, also after logout
-grep "^$(id -un):" /etc/subuid /etc/subgid  # should print one line each; otherwise ask an admin
-podman system migrate
-ls /run/user/$(id -u)/bus                   # the user's systemd bus must exist
-podman run --rm docker.io/library/ubuntu:20.04 true   # must succeed with no WARN/ERROR
-```
-
-If the last command fails with `sd-bus call: Access denied` (no user systemd session, e.g. after `su`),
-either point the shell at the user's bus:
-
-```bash
-export XDG_RUNTIME_DIR=/run/user/$(id -u)
-export DBUS_SESSION_BUS_ADDRESS=unix:path=$XDG_RUNTIME_DIR/bus
-```
-
-or stop podman from using systemd for cgroups:
-
-```bash
-mkdir -p ~/.config/containers
-printf '[engine]\ncgroup_manager = "cgroupfs"\nevents_logger = "file"\n' >> ~/.config/containers/containers.conf
+loginctl enable-linger "$(id -un)"
 podman system migrate
+podman run --rm docker.io/library/ubuntu:20.04 true   # check: must finish without errors
 ```
 
 ## Install
@@ -159,8 +141,11 @@ the interface exists only in the container's network namespace, so reusing the h
 
 | Change | Action |
 |---|---|
-| Directories, ports, passwords, MAC, mounts | `casperbox up` |
-| `container.user`, or a different host user (UID/GID changed) | `casperbox build`, then `casperbox up` |
+| Anything | `casperbox up` |
+
+`casperbox up` rebuilds the image automatically when it is out of date: when the build files
+(Dockerfile, scripts, `software.list`), the toolflow version, `container.user` or the host UID/GID
+changed since the last build. `casperbox status` shows whether the image is up to date.
 
 ## Development
 
@@ -182,7 +167,7 @@ uv run casperbox --help
 uv tool install -e .           # installed casperbox uses this source tree
 ```
 
-Adding apt packages: add one per line to `assets/common/packages/software.list`, then `casperbox build`.
+Adding apt packages: add one per line to `assets/common/packages/software.list`, then `casperbox up` (the image is rebuilt automatically).
 
 Adding a toolflow version: copy `assets/versions/m2021a` to `assets/versions/<new>`, edit
 `toolflow.toml` (`TOOLFLOW_VERSION` must match the directory name) and the Dockerfile as needed.

{casperbox-0.2.1 → casperbox-0.2.2}/README.md

@@ -9,7 +9,7 @@ mlib_devel, device-tree-xlnx and Scilab. Vivado and the license are mounted from
 
 | Version | Base image | Vivado | Python | mlib_devel | device-tree-xlnx | Scilab |
 |---|---|---|---|---|---|---|
-| m2021a | Ubuntu 20.04 | 2021.1 | 3.14 | [liuweiseu/mlib_devel](https://github.com/liuweiseu/mlib_devel) `scilab-dev-ai` | xlnx_rel_v2021.1 | 2024.1.0 |
+| m2021a | Ubuntu 20.04 | 2021.1 | 3.14 | scilab-dev-ai | xlnx_rel_v2021.1 | 2024.1.0 |
 
 ## Host requirements
 
@@ -19,30 +19,12 @@ mlib_devel, device-tree-xlnx and Scilab. Vivado and the license are mounted from
 
 ## Host setup
 
-Log in directly (SSH or desktop) as the user that runs podman (do not switch with `su`), then run:
+Log in directly (SSH or desktop) as the user that runs podman, then run:
 
 ```bash
-loginctl enable-linger "$(id -un)"          # keep the user's systemd running, also after logout
-grep "^$(id -un):" /etc/subuid /etc/subgid  # should print one line each; otherwise ask an admin
-podman system migrate
-ls /run/user/$(id -u)/bus                   # the user's systemd bus must exist
-podman run --rm docker.io/library/ubuntu:20.04 true   # must succeed with no WARN/ERROR
-```
-
-If the last command fails with `sd-bus call: Access denied` (no user systemd session, e.g. after `su`),
-either point the shell at the user's bus:
-
-```bash
-export XDG_RUNTIME_DIR=/run/user/$(id -u)
-export DBUS_SESSION_BUS_ADDRESS=unix:path=$XDG_RUNTIME_DIR/bus
-```
-
-or stop podman from using systemd for cgroups:
-
-```bash
-mkdir -p ~/.config/containers
-printf '[engine]\ncgroup_manager = "cgroupfs"\nevents_logger = "file"\n' >> ~/.config/containers/containers.conf
+loginctl enable-linger "$(id -un)"
 podman system migrate
+podman run --rm docker.io/library/ubuntu:20.04 true   # check: must finish without errors
 ```
 
 ## Install
@@ -151,8 +133,11 @@ the interface exists only in the container's network namespace, so reusing the h
 
 | Change | Action |
 |---|---|
-| Directories, ports, passwords, MAC, mounts | `casperbox up` |
-| `container.user`, or a different host user (UID/GID changed) | `casperbox build`, then `casperbox up` |
+| Anything | `casperbox up` |
+
+`casperbox up` rebuilds the image automatically when it is out of date: when the build files
+(Dockerfile, scripts, `software.list`), the toolflow version, `container.user` or the host UID/GID
+changed since the last build. `casperbox status` shows whether the image is up to date.
 
 ## Development
 
@@ -174,7 +159,7 @@ uv run casperbox --help
 uv tool install -e .           # installed casperbox uses this source tree
 ```
 
-Adding apt packages: add one per line to `assets/common/packages/software.list`, then `casperbox build`.
+Adding apt packages: add one per line to `assets/common/packages/software.list`, then `casperbox up` (the image is rebuilt automatically).
 
 Adding a toolflow version: copy `assets/versions/m2021a` to `assets/versions/<new>`, edit
 `toolflow.toml` (`TOOLFLOW_VERSION` must match the directory name) and the Dockerfile as needed.

{casperbox-0.2.1 → casperbox-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "casperbox"
-version = "0.2.1"
+version = "0.2.2"
 description = "Build and run CASPER toolflow development containers with rootless podman"
 readme = "README.md"
 requires-python = ">=3.11"

{casperbox-0.2.1 → casperbox-0.2.2}/src/casperbox/cli.py

@@ -176,9 +176,13 @@ def up(ctx: typer.Context, config: ConfigOpt = None) -> None:
         podman.check_owner(cfg, own)
     podman.check_ports_free(cfg, own)
 
-    if not podman.image_exists(cfg.toolflow.image):
+    state = podman.image_state(cfg)
+    if state == "missing":
         info(f"Image {cfg.toolflow.image} not found, building it")
         _build(cfg)
+    elif state == "outdated":
+        info(f"Image {cfg.toolflow.image} is out of date (build files, toolflow version or user changed), rebuilding it")
+        _build(cfg)
     podman.check_image_matches(cfg)
 
     if not cfg.work_dir.exists():
@@ -237,8 +241,14 @@ def shell(ctx: typer.Context, config: ConfigOpt = None) -> None:
 
 @app.command()
 def status(ctx: typer.Context, config: ConfigOpt = None) -> None:
-    """Show the container status."""
+    """Show the image and container status."""
     cfg = _prepare(ctx, config)
+    image_note = {
+        "missing": "not built",
+        "outdated": "out of date, `casperbox up` or `casperbox build` will rebuild it",
+        "current": "up to date",
+    }[podman.image_state(cfg)]
+    typer.echo(f"{cfg.toolflow.image}: {image_note}")
     own = podman.get_container(cfg.name)
     if not own:
         typer.echo(f"{cfg.name}: not created")

{casperbox-0.2.1 → casperbox-0.2.2}/src/casperbox/podman.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import hashlib
 import json
 import os
 import shutil
@@ -18,6 +19,8 @@ from .versions import assets_dir
 LABEL_MANAGED = "casperbox.managed"
 LABEL_CONFIG = "casperbox.config"
 LABEL_TOOLFLOW = "casperbox.toolflow"
+# Label put on images: hash of the build inputs, used to detect outdated images
+LABEL_BUILD_HASH = "casperbox.build-hash"
 
 # Environment passed to the container. Values are put in podman's own environment
 # and referenced by name (-e NAME), so passwords never appear on a command line.
@@ -73,22 +76,56 @@ def image_labels(image: str) -> dict[str, str]:
     return json.loads(out) or {}
 
 
-def build_args(cfg: Config, no_cache: bool = False) -> list[str]:
-    args = {
+def _build_arg_values(cfg: Config) -> dict[str, str]:
+    return {
         **cfg.toolflow.params,
         "CONTAINER_USER": cfg.user,
         "USER_UID": str(os.getuid()),
         "USER_GID": str(os.getgid()),
     }
-    cmd = ["podman", "build", "-f", str(cfg.toolflow.dockerfile), "-t", cfg.toolflow.image]
+
+
+def build_hash(cfg: Config) -> str:
+    """Hash of everything the image is built from: build args, the version's
+    Dockerfile/toolflow.toml and all shared build files under assets/common."""
+    h = hashlib.sha256()
+    for k, v in sorted(_build_arg_values(cfg).items()):
+        h.update(f"arg {k}={v}\n".encode())
+    root = assets_dir()
+    version_dir = cfg.toolflow.dockerfile.parent
+    files = sorted(
+        p for d in (root / "common", version_dir) for p in d.rglob("*")
+        if p.is_file() and "__pycache__" not in p.parts
+    )
+    for p in files:
+        h.update(f"file {p.relative_to(root).as_posix()}\n".encode())
+        h.update(p.read_bytes())
+        h.update(b"\n")
+    return h.hexdigest()
+
+
+def build_args(cfg: Config, no_cache: bool = False) -> list[str]:
+    cmd = [
+        "podman", "build", "-f", str(cfg.toolflow.dockerfile), "-t", cfg.toolflow.image,
+        "--label", f"{LABEL_BUILD_HASH}={build_hash(cfg)}",
+    ]
     if no_cache:
         cmd.append("--no-cache")
-    for k, v in args.items():
+    for k, v in _build_arg_values(cfg).items():
         cmd += ["--build-arg", f"{k}={v}"]
     cmd.append(str(assets_dir()))
     return cmd
 
 
+def image_state(cfg: Config) -> str:
+    """'missing', 'outdated' or 'current'."""
+    if not image_exists(cfg.toolflow.image):
+        return "missing"
+    if image_labels(cfg.toolflow.image).get(LABEL_BUILD_HASH) != build_hash(cfg):
+        return "outdated"
+    return "current"
+
+
 def check_image_matches(cfg: Config) -> None:
     """The image user must match the config, otherwise mounted directories get wrong permissions."""
     labels = image_labels(cfg.toolflow.image)

{casperbox-0.2.1 → casperbox-0.2.2}/tests/test_config.py

@@ -170,3 +170,27 @@ def test_port_check_reports_all_conflicts(env, monkeypatch):
     assert f"{ssh}/tcp (ports.ssh): already in use" in msg
     assert "45999/tcp (ports.vnc): used by container other" in msg
     assert f"{extra}/tcp (extra_ports[0]): already in use" in msg
+
+
+def test_build_hash_tracks_build_inputs(env, monkeypatch, tmp_path):
+    import shutil
+
+    from casperbox import podman, versions
+
+    # work on a copy of the assets so the test can modify build files
+    assets = tmp_path / "assets"
+    shutil.copytree(versions.assets_dir(), assets)
+    monkeypatch.setattr(versions, "assets_dir", lambda: assets)
+    monkeypatch.setattr(podman, "assets_dir", lambda: assets)
+
+    cfg = env()
+    h1 = podman.build_hash(cfg)
+    assert podman.build_hash(cfg) == h1  # deterministic
+    assert f"casperbox.build-hash={h1}" in podman.build_args(cfg)
+
+    with (assets / "common" / "packages" / "software.list").open("a") as f:
+        f.write("htop\n")
+    h2 = podman.build_hash(cfg)
+    assert h2 != h1  # build file changed
+
+    assert podman.build_hash(env(container__user="alice")) != h2  # build arg changed

{casperbox-0.2.1 → casperbox-0.2.2}/uv.lock

@@ -13,7 +13,7 @@ wheels = [
 
 [[package]]
 name = "casperbox"
-version = "0.2.1"
+version = "0.2.2"
 source = { editable = "." }
 dependencies = [
     { name = "typer" },