bugcap 0.4.0__tar.gz → 0.5.0__tar.gz

{bugcap-0.4.0/src/bugcap.egg-info → bugcap-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bugcap
-Version: 0.4.0
+Version: 0.5.0
 Summary: Local-first, agent-readable bug capture: annotated screenshots + notes, stored locally, synced to trackers on your own schedule.
 Author: Konrad Tagnon Amen ALAHASSA
 License: MIT

{bugcap-0.4.0 → bugcap-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bugcap"
-version = "0.4.0"
+version = "0.5.0"
 description = "Local-first, agent-readable bug capture: annotated screenshots + notes, stored locally, synced to trackers on your own schedule."
 readme = "README.md"
 requires-python = ">=3.10"

bugcap-0.5.0/src/bugcap/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.5.0"

{bugcap-0.4.0 → bugcap-0.5.0}/src/bugcap/cli.py

@@ -152,12 +152,8 @@ def cmd_list(args: argparse.Namespace) -> int:
     return 0
 
 
-def cmd_show(args: argparse.Namespace) -> int:
-    with Store() as store:
-        report = resolve_report(store, args.id)
-        if report is None:
-            return 1
-
+def print_report(report) -> None:
+    """The multi-line details of one report, as `bugcap show` prints them."""
     print(f"#{report.id}  {report.title}")
     print(f"  created_at: {report.created_at}")
     print(f"  status:     {report.status}")
@@ -181,6 +177,15 @@ def cmd_show(args: argparse.Namespace) -> int:
             print(f"    - {tracker}: {ref}")
     else:
         print("    (not synced to any tracker yet)")
+
+
+def cmd_show(args: argparse.Namespace) -> int:
+    with Store() as store:
+        report = resolve_report(store, args.id)
+        if report is None:
+            return 1
+
+    print_report(report)
     return 0
 
 
@@ -574,6 +579,8 @@ def cmd_attach(args: argparse.Namespace) -> int:
         print(f"Attached {shot_path} to report #{args.id}")
     elif note and added:
         print(f"Added note to report #{args.id}")
+    print()
+    print_report(current)
     return 1 if rejected or (note and not added) else 0
 
 

{bugcap-0.4.0 → bugcap-0.5.0}/src/bugcap/ingest.py

@@ -1,11 +1,13 @@
 """Bring existing images into the store: local paths, globs and http(s) URLs.
 
 Every input is validated by its magic bytes (never its extension or Content-Type), copied
-into the images directory under a fresh name (the original path is not kept), and written
-atomically. Network access is limited to plain http(s) GETs with no credentials."""
+into the images directory under a name derived from its content (the original path is not
+kept) and written atomically. The same image is therefore stored once, however many reports
+use it. Network access is limited to plain http(s) GETs with no credentials."""
 from __future__ import annotations
 
 import glob
+import hashlib
 import os
 import socket
 import urllib.error
@@ -32,6 +34,7 @@ class StoredFile:
     mime: str
     size_bytes: int
     source: str
+    reused: bool = False  # the content was already in the store; no new file was written
 
 
 @dataclass
@@ -70,10 +73,16 @@ def sniff_image(data: bytes) -> str:
     raise ServiceError("invalid_image", "not an image (PNG, JPEG, GIF or WebP expected)")
 
 
+def content_name(data: bytes, mime: str) -> str:
+    return f"{hashlib.sha256(data).hexdigest()}{_EXT[mime]}"
+
+
 def _store(data: bytes, source: str) -> StoredFile:
     mime = sniff_image(data)
-    dest = images_dir() / f"{uuid.uuid4()}{_EXT[mime]}"
-    tmp = dest.with_name(dest.name + ".part")
+    dest = images_dir() / content_name(data, mime)
+    if dest.is_file() and dest.stat().st_size == len(data):
+        return StoredFile(to_data_relative(dest), dest, mime, len(data), source, reused=True)
+    tmp = dest.with_name(f"{dest.name}.{uuid.uuid4().hex}.part")
     try:
         tmp.write_bytes(data)
         os.replace(tmp, dest)
@@ -82,6 +91,29 @@ def _store(data: bytes, source: str) -> StoredFile:
     return StoredFile(to_data_relative(dest), dest, mime, len(data), source)
 
 
+def adopt(path) -> Path:
+    """Give a screenshot the capture tool already saved in the store its content-derived
+    name. If the same image is stored already, the new copy is dropped and the existing
+    path returned. Anything that is not a recognisable image, or sits outside the store, is
+    left where it is."""
+    path = Path(path)
+    if path.parent != images_dir():
+        return path
+    try:
+        data = path.read_bytes()
+        mime = sniff_image(data)
+    except (OSError, ServiceError):
+        return path
+    dest = images_dir() / content_name(data, mime)
+    if dest == path:
+        return path
+    if dest.is_file() and dest.stat().st_size == len(data):
+        path.unlink(missing_ok=True)
+        return dest
+    os.replace(path, dest)
+    return dest
+
+
 def import_local(path: Path) -> StoredFile:
     path = Path(path).expanduser()
     if path.is_dir():

{bugcap-0.4.0 → bugcap-0.5.0}/src/bugcap/service.py

@@ -81,6 +81,8 @@ class AddResult:
 
 def _discard(stored_files) -> None:
     for stored in stored_files:
+        if stored.reused:  # shared with other media; not ours to delete
+            continue
         try:
             stored.abs_path.unlink()
         except OSError:
@@ -158,6 +160,7 @@ def create_report(
         with store.transaction():
             report = store.add(title=title, notes="", tags=tags, repo=repo, body=body, status=status)
             if captured is not None:
+                captured = str(ingest.adopt(captured))
                 result.added.append(
                     store.insert_media(report.id, kind="image", path=captured,
                                        label=captured_label or None, source="captured")
@@ -194,7 +197,7 @@ def delete_report(store: Store, report_id: int) -> Report:
     report = _require(store, report_id)
     store.delete(report_id)
     for item in report.media:
-        _delete_files(item)
+        _delete_files(store, item)
     return report
 
 
@@ -202,6 +205,7 @@ def attach_captured(store: Store, report_id: int, path: str, label: Optional[str
     """Attach a screenshot the capture tool already saved in the store (no copy)."""
     report = _require(store, report_id)
     _check_new_labels(report.media, [label])
+    path = ingest.adopt(path)
     return store.insert_media(report_id, kind="image", path=str(path), label=label or None, source="captured")
 
 
@@ -343,14 +347,18 @@ def remove_media(store: Store, report_id: int, ref: str, force: bool = False) ->
         notes, count = refs.rewrite_references_counted(report.notes, mapping)
         if count:
             store.update(report_id, notes=notes)
-    _delete_files(item)
+    _delete_files(store, item)
     return count
 
 
-def _delete_files(item: Media) -> None:
+def _delete_files(store: Store, item: Media) -> None:
+    """Delete an item's files unless another media item still uses them (identical images
+    are stored once and shared). Call after the item's rows are gone."""
     paths = [item.path] if item.path else []
     paths += [f.path for f in item.frames]
     for rel in paths:
+        if store.path_in_use(rel):
+            continue
         try:
             os.unlink(resolve_data_path(rel))
         except (ValueError, OSError):

{bugcap-0.4.0 → bugcap-0.5.0}/src/bugcap/store.py

@@ -425,6 +425,14 @@ class Store:
         ).fetchall()
         return [self._load_media(r) for r in rows]
 
+    def path_in_use(self, path: str) -> bool:
+        """Whether any media item or frame still points at this stored file."""
+        row = self._conn.execute(
+            "SELECT EXISTS(SELECT 1 FROM media WHERE path = ?) OR EXISTS(SELECT 1 FROM media_frames WHERE path = ?)",
+            (path, path),
+        ).fetchone()
+        return bool(row[0])
+
     def get_media(self, media_id: int) -> Optional[Media]:
         row = self._conn.execute("SELECT * FROM media WHERE id = ?", (media_id,)).fetchone()
         return self._load_media(row) if row else None

{bugcap-0.4.0 → bugcap-0.5.0/src/bugcap.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bugcap
-Version: 0.4.0
+Version: 0.5.0
 Summary: Local-first, agent-readable bug capture: annotated screenshots + notes, stored locally, synced to trackers on your own schedule.
 Author: Konrad Tagnon Amen ALAHASSA
 License: MIT

{bugcap-0.4.0 → bugcap-0.5.0}/tests/test_cli_attach.py

@@ -169,3 +169,77 @@ def test_pull_ask_flow_appends_note(bugcap_home, monkeypatch, tmp_path):
         sync._attach_answer(store, rid, None)
         report = store.get(rid)
     assert len(report.media) == 2 and report.notes.endswith("@i1: seen on pull")
+
+
+# --- details after attach / shared storage -----------------------------------------------
+
+def test_attach_prints_the_bug_details_after_the_usual_output(bugcap_home, tmp_path, capsys):
+    with Store() as store:
+        rid = store.add("Login fails", tags=["auth"]).id
+    img = tmp_path / "new.png"
+    img.write_bytes(png_bytes())
+    assert cli.main(["attach", str(rid), "--image", str(img), "--note", "see this"]) == 0
+    out = capsys.readouterr().out
+    assert out.index("added @i1") < out.index(f"#{rid}  Login fails")
+    assert "tags:       auth" in out and "see this" in out and "media:" in out and "i1" in out
+
+
+def test_attach_with_a_rejected_image_still_shows_the_unchanged_bug(bugcap_home, tmp_path, capsys):
+    with Store() as store:
+        rid = store.add("Bug").id
+    assert cli.main(["attach", str(rid), "--image", str(tmp_path / "missing.png")]) == 1
+    captured = capsys.readouterr()
+    assert "skipped" in captured.err and f"#{rid}  Bug" in captured.out and "media:" not in captured.out
+
+
+def test_attach_unknown_id_prints_no_details(bugcap_home, capsys):
+    assert cli.main(["attach", "999", "--image", "x.png"]) == 1
+    assert capsys.readouterr().out == ""
+
+
+def test_same_image_on_two_bugs_is_stored_once(bugcap_home, tmp_path):
+    from bugcap.paths import images_dir
+
+    with Store() as store:
+        a, b = store.add("A").id, store.add("B").id
+    img = tmp_path / "same.png"
+    img.write_bytes(png_bytes())
+    assert cli.main(["attach", str(a), "--image", str(img)]) == 0
+    assert cli.main(["attach", str(b), "--image", str(img)]) == 0
+    with Store() as store:
+        pa, pb = store.get(a).media[0].path, store.get(b).media[0].path
+    assert pa == pb and len(list(images_dir().iterdir())) == 1
+
+
+def test_shared_file_survives_until_its_last_user_is_gone(bugcap_home, tmp_path):
+    from bugcap import service
+
+    with Store() as store:
+        a, b = store.add("A").id, store.add("B").id
+    img = tmp_path / "same.png"
+    img.write_bytes(png_bytes())
+    for rid in (a, b):
+        assert cli.main(["attach", str(rid), "--image", str(img)]) == 0
+    with Store() as store:
+        path = store.get(a).media[0].abs_path
+        service.remove_media(store, a, "i1")
+        assert __import__("os").path.isfile(path)  # B still uses it
+        service.delete_report(store, b)
+    assert not __import__("os").path.exists(path)
+
+
+def test_same_image_twice_in_one_attach_and_failed_attach_keep_shared_file(bugcap_home, tmp_path):
+    from bugcap import service
+
+    with Store() as store:
+        a, b = store.add("A").id, store.add("B").id
+        img = tmp_path / "same.png"
+        img.write_bytes(png_bytes())
+        service.add_media(store, a, [str(img)])
+        # B asks for the same image with a label that cannot be used: nothing may be deleted
+        with pytest.raises(Exception):
+            service.add_media(store, b, [str(img)], labels=["i1"])
+        path = store.get(a).media[0].abs_path
+        assert __import__("os").path.isfile(path)
+        res = service.add_media(store, b, [str(img), str(img)])
+        assert len(res.added) == 2 and len({m.path for m in res.added}) == 1

{bugcap-0.4.0 → bugcap-0.5.0}/tests/test_live_session.py

@@ -97,7 +97,7 @@ def test_save_combines_images_and_a_video_in_order(session):
     assert report.title == "Login broken" and report.repo == "owner/proj"
     assert report.tags == ["auth", "proj"] and report.status == "in-progress"
     assert [(m.idx, m.kind) for m in report.media] == [(1, "image"), (2, "video"), (3, "image")]
-    assert first.exists()  # captured files live on in the store, not copied away
+    assert all(Path(m.abs_path).is_file() for m in report.media)  # captured files stay in the store
 
 
 def test_two_reports_in_a_row(session):

bugcap-0.4.0/src/bugcap/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.4.0"