withcache 0.8.7__tar.gz → 0.8.9__tar.gz

{withcache-0.8.7 → withcache-0.8.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: withcache
-Version: 0.8.7
+Version: 0.8.9
 Summary: Operator-curated, URL-keyed artifact cache for a small lab (CUDA/ROCm/DOCA/firmware)
 Project-URL: Homepage, https://github.com/safl/withcache
 Author-email: "Simon A. F. Lund" <safl@safl.dk>

{withcache-0.8.7 → withcache-0.8.9}/deploy/Containerfile

@@ -1,6 +1,7 @@
-# withcache cache-host. Build context is the repo root:
+# withcache cache-host. From-source build (rare; the reference
+# compose.yml uses the published ``ghcr.io/safl/withcache:latest``
+# image instead). Build context is the repo root:
 #   podman build -f deploy/Containerfile -t withcache .
-# (deploy/compose.yml sets the context for you.)
 FROM python:3.12-slim
 
 # Install the package (no third-party deps) to get the withcache-server command.

withcache-0.8.9/deploy/compose.local-build.yml

@@ -0,0 +1,11 @@
+# Overlay compose file for from-source dev iteration:
+#   podman compose -f deploy/compose.yml -f deploy/compose.local-build.yml up -d --build
+# The reference deploy/compose.yml uses the published image
+# ``ghcr.io/safl/withcache:latest``; this overlay swaps in a local
+# build from the repo root's Containerfile.
+services:
+  withcache:
+    build:
+      context: ..
+      dockerfile: deploy/Containerfile
+    image: withcache:local

withcache-0.8.9/deploy/compose.yml

@@ -0,0 +1,23 @@
+# Reference compose stack for withcache.
+#
+# Usage:
+#   cp envvars.example envvars && "${EDITOR:-vi}" envvars   # set the knobs
+#   podman compose --env-file envvars up -d
+#   #   http://<host>:8081/   (operator UI)
+services:
+  withcache:
+    image: ghcr.io/safl/withcache:latest
+    restart: unless-stopped
+    container_name: withcache
+    environment:
+      WITHCACHE_ADMIN_PASSWORD: "${WITHCACHE_ADMIN_PASSWORD:-}"
+      WITHCACHE_SESSION_SECRET: "${WITHCACHE_SESSION_SECRET:-}"
+      WITHCACHE_CATALOG_URL: "${WITHCACHE_CATALOG_URL:-}"
+    ports:
+      - "${HOST_HTTP_PORT:-8081}:8081"
+    volumes:
+      # Persistent: blob store + cache.db + session-secret survive restarts.
+      - withcache-data:/data
+
+volumes:
+  withcache-data:

withcache-0.8.9/deploy/envvars.example

@@ -0,0 +1,17 @@
+# Copy to ``envvars`` and edit. The compose stack reads this via --env-file.
+
+# Gate the operator UI + control-plane writes. Empty = open (logs a
+# startup warning; only safe on a LAN-internal withcache).
+WITHCACHE_ADMIN_PASSWORD=
+
+# Optional: pin the signed-cookie HMAC key. Unset = auto-generate a
+# fresh 64-hex key at first start and persist it under /data. Set
+# explicitly to keep cookies valid across a container rebuild that
+# wipes the data volume, or to rotate the secret on demand.
+#WITHCACHE_SESSION_SECRET=
+
+# Optional: pin the image-catalog URL. When set, the env value wins
+# over any /admin/catalog_set_url operator override so a locked-down
+# deploy stays locked. Unset uses the default (safl/nosi's
+# ``catalog.toml`` on GitHub).
+#WITHCACHE_CATALOG_URL=

{withcache-0.8.7 → withcache-0.8.9}/shim/build.zig.zon

@@ -2,7 +2,7 @@
     .name = .withcache_shim,
     // Zig requires a literal here; keep it in lockstep with the project's
     // single source (src/withcache/__init__.py) via `make bump` / `make version-check`.
-    .version = "0.8.7",
+    .version = "0.8.9",
     .fingerprint = 0xd7d96c5ed212ccaa,
     .minimum_zig_version = "0.16.0",
     .paths = .{

{withcache-0.8.7 → withcache-0.8.9}/src/withcache/__init__.py

@@ -17,6 +17,6 @@ All modules are stdlib-only and self-contained.
 from . import oras
 from .client import blob_url, cache_base, is_cached, serve_url
 
-__version__ = "0.8.7"
+__version__ = "0.8.9"
 
 __all__ = ["__version__", "blob_url", "cache_base", "is_cached", "oras", "serve_url"]

{withcache-0.8.7 → withcache-0.8.9}/src/withcache/server.py

@@ -826,6 +826,8 @@ class DownloadManager:
     reports progress and honors a per-job cancel flag. Jobs are in-memory
     (completed artifacts persist as blobs); restarting drops in-flight jobs."""
 
+    _STOP = -1
+
     def __init__(self, store: Store, workers: int = 2):
         self.store = store
         self._jobs: dict[int, Job] = {}
@@ -833,8 +835,24 @@ class DownloadManager:
         self._lock = threading.Lock()
         self._q: queue.Queue[int] = queue.Queue()
         self._ids = itertools.count(1)
+        self._threads: list[threading.Thread] = []
         for _ in range(max(1, workers)):
-            threading.Thread(target=self._worker, daemon=True).start()
+            t = threading.Thread(target=self._worker, daemon=True)
+            t.start()
+            self._threads.append(t)
+
+    def close(self, timeout: float = 3.0) -> None:
+        """Ask each worker to exit and wait for them. Pushes one
+        ``_STOP`` sentinel per worker so an idle ``queue.get()``
+        unblocks; running workers finish their current job first.
+        The daemon=True flag lets ``main()`` exit without calling
+        this, but test fixtures + explicit shutdowns should call
+        it to avoid the sqlite3 finalizer warnings that leaked
+        worker threads produce."""
+        for _ in self._threads:
+            self._q.put(self._STOP)
+        for t in self._threads:
+            t.join(timeout=timeout)
 
     def enqueue(self, url: str, headers: dict | None = None) -> Job:
         with self._lock:
@@ -872,6 +890,8 @@ class DownloadManager:
     def _worker(self):
         while True:
             jid = self._q.get()
+            if jid == self._STOP:
+                return
             with self._lock:
                 job = self._jobs.get(jid)
                 if job is None or job.status != "queued":
@@ -1801,7 +1821,14 @@ class Handler(http.server.BaseHTTPRequestHandler):
                 '<progress id="spin" class="htmx-indicator ms-1" '
                 'style="width:4rem;height:.4rem;"></progress></div>'
             )
-        return f'<div class="subnav-strip"><div class="container">{left}{right}</div></div>'
+        # <nav class="navbar subnav-strip"> matches bty's canonical
+        # subnav shape (bty/src/bty/web/_templates/ui/_subnav.html);
+        # ``.navbar`` gets the Bootstrap subnav-strip vertical rhythm,
+        # aria-label + <nav> give screen readers a landmark.
+        return (
+            '<nav class="navbar subnav-strip" aria-label="Section sub-navigation">'
+            f'<div class="container">{left}{right}</div></nav>'
+        )
 
     # ---- Cached page -----------------------------------------------------
     def _cached_body_html(self) -> str:
@@ -2249,6 +2276,10 @@ def main():
         httpd.serve_forever()
     except KeyboardInterrupt:
         print("\nbye", flush=True)
+    finally:
+        # Drain workers on shutdown so the sqlite finalizer warnings
+        # from leaked threads stop appearing on Ctrl-C.
+        mgr.close()
 
 
 if __name__ == "__main__":

{withcache-0.8.7 → withcache-0.8.9}/tests/test_withcache.py

@@ -178,6 +178,7 @@ class TestStoreFromOrigin(unittest.TestCase):
         self.store = server.Store(tempfile.mkdtemp(), keep_query=False)
 
     def tearDown(self):
+        getattr(self.httpd, "mgr", None) and self.httpd.mgr.close()
         self.httpd.shutdown()
         self.httpd.server_close()
 
@@ -266,6 +267,7 @@ class TestTruncatedDownloadRejected(unittest.TestCase):
         self.store = server.Store(tempfile.mkdtemp(), keep_query=False)
 
     def tearDown(self):
+        getattr(self.httpd, "mgr", None) and self.httpd.mgr.close()
         self.httpd.shutdown()
         self.httpd.server_close()
 
@@ -384,6 +386,7 @@ class TestRangeResumeOnTruncation(unittest.TestCase):
         self.store = server.Store(tempfile.mkdtemp(), keep_query=False)
 
     def tearDown(self):
+        getattr(self.httpd, "mgr", None) and self.httpd.mgr.close()
         self.httpd.shutdown()
         self.httpd.server_close()
 
@@ -843,6 +846,7 @@ class TestFetchWithHeaders(unittest.TestCase):
         self.store = server.Store(tempfile.mkdtemp(), keep_query=False)
 
     def tearDown(self):
+        getattr(self.httpd, "mgr", None) and self.httpd.mgr.close()
         self.httpd.shutdown()
         self.httpd.server_close()
 
@@ -1095,6 +1099,7 @@ class TestMultiPageNavigation(unittest.TestCase):
         self.base = f"http://127.0.0.1:{self.httpd.server_address[1]}"
 
     def tearDown(self):
+        getattr(self.httpd, "mgr", None) and self.httpd.mgr.close()
         self.httpd.shutdown()
         self.httpd.server_close()
 
@@ -1196,6 +1201,7 @@ class TestCatalogAdminEndpoints(unittest.TestCase):
     def tearDown(self):
         self.origin.shutdown()
         self.origin.server_close()
+        getattr(self.httpd, "mgr", None) and self.httpd.mgr.close()
         self.httpd.shutdown()
         self.httpd.server_close()
 
@@ -1316,6 +1322,88 @@ class TestCatalogAdminEndpoints(unittest.TestCase):
         httpd2.server_close()
 
 
+class TestAddOrasEntryFormatMapping(unittest.TestCase):
+    """CatalogState.add_oras_entry derives ``format`` from the resolved
+    layer title's suffix and ``arch`` from the tag suffix. The
+    happy-path test in TestCatalogAdminEndpoints only covers the
+    unreachable-registry branch (fmt stays ''); this class exercises
+    the title -> format mapping (all five known suffixes + fallback)
+    and the arch extraction."""
+
+    def setUp(self):
+        self.tmpdir = tempfile.mkdtemp()
+        self.catalog = server.CatalogState(
+            url="http://localhost/catalog.toml",
+            persist_path=os.path.join(self.tmpdir, "catalog.toml"),
+        )
+        # Patch oras.resolve_ref for the duration of the tests; every
+        # test sets a fake_resolver with the shape it needs.
+        self._original_resolve = server.oras.resolve_ref
+
+    def tearDown(self):
+        server.oras.resolve_ref = self._original_resolve
+
+    def _stub_resolve(self, title, size=1234):
+        def _r(ref):
+            return types.SimpleNamespace(title=title, size=size, digest="sha256:abc")
+
+        server.oras.resolve_ref = _r
+
+    def test_title_ends_with_img_zst(self):
+        self._stub_resolve("debian-13-headless.img.zst")
+        ok, _ = self.catalog.add_oras_entry("oras://ghcr.io/x/demo:v1")
+        self.assertTrue(ok)
+        self.assertEqual(self.catalog.entries[-1]["format"], "img.zst")
+
+    def test_title_ends_with_img_gz(self):
+        self._stub_resolve("release.img.gz")
+        ok, _ = self.catalog.add_oras_entry("oras://ghcr.io/x/demo:v1")
+        self.assertTrue(ok)
+        self.assertEqual(self.catalog.entries[-1]["format"], "img.gz")
+
+    def test_title_ends_with_img_xz(self):
+        self._stub_resolve("release.img.xz")
+        ok, _ = self.catalog.add_oras_entry("oras://ghcr.io/x/demo:v1")
+        self.assertTrue(ok)
+        self.assertEqual(self.catalog.entries[-1]["format"], "img.xz")
+
+    def test_title_ends_with_bare_img(self):
+        self._stub_resolve("raw.img")
+        ok, _ = self.catalog.add_oras_entry("oras://ghcr.io/x/demo:v1")
+        self.assertTrue(ok)
+        self.assertEqual(self.catalog.entries[-1]["format"], "img")
+
+    def test_title_ends_with_iso(self):
+        self._stub_resolve("bootable.iso")
+        ok, _ = self.catalog.add_oras_entry("oras://ghcr.io/x/demo:v1")
+        self.assertTrue(ok)
+        self.assertEqual(self.catalog.entries[-1]["format"], "iso")
+
+    def test_title_no_known_suffix_leaves_format_unset(self):
+        self._stub_resolve("something.tar")
+        ok, _ = self.catalog.add_oras_entry("oras://ghcr.io/x/demo:v1")
+        self.assertTrue(ok)
+        self.assertNotIn("format", self.catalog.entries[-1])
+
+    def test_tag_suffix_extracts_arch_x86_64(self):
+        self._stub_resolve("release.img.zst")
+        ok, _ = self.catalog.add_oras_entry("oras://ghcr.io/x/demo:v1-x86_64")
+        self.assertTrue(ok)
+        self.assertEqual(self.catalog.entries[-1]["arch"], "x86_64")
+
+    def test_tag_suffix_extracts_arch_arm64(self):
+        self._stub_resolve("release.img.zst")
+        ok, _ = self.catalog.add_oras_entry("oras://ghcr.io/x/demo:v1-arm64")
+        self.assertTrue(ok)
+        self.assertEqual(self.catalog.entries[-1]["arch"], "arm64")
+
+    def test_unknown_arch_suffix_leaves_arch_unset(self):
+        self._stub_resolve("release.img.zst")
+        ok, _ = self.catalog.add_oras_entry("oras://ghcr.io/x/demo:v1-mips")
+        self.assertTrue(ok)
+        self.assertNotIn("arch", self.catalog.entries[-1])
+
+
 class TestReadFormDuplicateKeys(unittest.TestCase):
     """read_form rejects duplicate form keys so a first-value-wins
     collapse can't hide a payload silently -- mirrors nbdmux's
@@ -1327,6 +1415,7 @@ class TestReadFormDuplicateKeys(unittest.TestCase):
         self.port = self.httpd.server_address[1]
 
     def tearDown(self):
+        getattr(self.httpd, "mgr", None) and self.httpd.mgr.close()
         self.httpd.shutdown()
         self.httpd.server_close()
 

withcache-0.8.7/deploy/compose.yml

@@ -1,28 +0,0 @@
-# Single-host deploy (run from the repo root):
-#   WITHCACHE_ADMIN_PASSWORD=secret podman compose -f deploy/compose.yml up -d
-# (or: docker compose -f deploy/compose.yml up -d)
-services:
-  cache-host:
-    build:
-      context: ..
-      dockerfile: deploy/Containerfile
-    image: withcache:latest
-    container_name: withcache
-    ports:
-      - "8081:8081"
-    environment:
-      # Protect the operator UI. Unset => UI is open (a warning is logged).
-      - WITHCACHE_ADMIN_PASSWORD=${WITHCACHE_ADMIN_PASSWORD:-}
-      # Optional: pin the session-signing key (else persisted under /data).
-      - WITHCACHE_SESSION_SECRET=${WITHCACHE_SESSION_SECRET:-}
-      # Optional: pin the image-catalog URL. When set, the env value
-      # wins over any /admin/catalog_set_url operator override so a
-      # locked-down deploy stays locked. Unset uses the default
-      # (safl/nosi's ``catalog.toml`` on GitHub).
-      - WITHCACHE_CATALOG_URL=${WITHCACHE_CATALOG_URL:-}
-    volumes:
-      - withcache-data:/data
-    restart: unless-stopped
-
-volumes:
-  withcache-data: