pytest-visionspec 0.2.0__tar.gz → 0.3.0__tar.gz

{pytest_visionspec-0.2.0 → pytest_visionspec-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-visionspec
-Version: 0.2.0
+Version: 0.3.0
 Summary: Pytest plugin that auto-reports test results with screenshots to VisionSpec
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
@@ -46,8 +46,24 @@ The plugin automatically:
 
 ## Markers
 
-- `@pytest.mark.vs("journey-id")` — link test to a VisionSpec journey spec
+- `@pytest.mark.vs("journey-id")` — link test to a VisionSpec V1 journey spec
 - `@pytest.mark.vs_surface("mobile")` — override the reported surface (default: `desktop`)
+- `@pytest.mark.vs_v2("spec-slug", jtbd="jtbd-slug")` — link test to a VisionSpec V2 spec (chapters model). Results are buffered and POSTed in one batch at session end to `/api/v2/results`.
+
+## V2 usage (chapters model)
+
+For V2 projects, tag tests with `vs_v2` — no screenshot capture, batched reporting:
+
+```python
+@pytest.mark.vs_v2("verdict-returns-200", jtbd="get-verdict")
+def test_verdict():
+    r = client.get("/verdict")
+    assert r.status_code == 200
+```
+
+Get your project's `VS_API_KEY` via the V2 MCP tool `get_project(project)` (returns `test_reporting.env_vars`) or from the "CI / Test runner" tab in V2 project settings.
+
+Results POST once per pytest session. Coverage in V2 `get_doc`'s `summary` field then shows `tested` / `passing` / `failing` counts per spec.
 
 ## Page fixture detection
 

{pytest_visionspec-0.2.0 → pytest_visionspec-0.3.0}/README.md

@@ -37,8 +37,24 @@ The plugin automatically:
 
 ## Markers
 
-- `@pytest.mark.vs("journey-id")` — link test to a VisionSpec journey spec
+- `@pytest.mark.vs("journey-id")` — link test to a VisionSpec V1 journey spec
 - `@pytest.mark.vs_surface("mobile")` — override the reported surface (default: `desktop`)
+- `@pytest.mark.vs_v2("spec-slug", jtbd="jtbd-slug")` — link test to a VisionSpec V2 spec (chapters model). Results are buffered and POSTed in one batch at session end to `/api/v2/results`.
+
+## V2 usage (chapters model)
+
+For V2 projects, tag tests with `vs_v2` — no screenshot capture, batched reporting:
+
+```python
+@pytest.mark.vs_v2("verdict-returns-200", jtbd="get-verdict")
+def test_verdict():
+    r = client.get("/verdict")
+    assert r.status_code == 200
+```
+
+Get your project's `VS_API_KEY` via the V2 MCP tool `get_project(project)` (returns `test_reporting.env_vars`) or from the "CI / Test runner" tab in V2 project settings.
+
+Results POST once per pytest session. Coverage in V2 `get_doc`'s `summary` field then shows `tested` / `passing` / `failing` counts per spec.
 
 ## Page fixture detection
 

{pytest_visionspec-0.2.0 → pytest_visionspec-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pytest-visionspec"
-version = "0.2.0"
+version = "0.3.0"
 description = "Pytest plugin that auto-reports test results with screenshots to VisionSpec"
 readme = "README.md"
 requires-python = ">=3.9"

{pytest_visionspec-0.2.0 → pytest_visionspec-0.3.0}/pytest_visionspec/__init__.py

@@ -3,13 +3,13 @@
 Usage:
     pip install pytest-visionspec
     Set env vars: VS_API_KEY, VS_API_URL
-    Tag tests: @pytest.mark.vs("journey-id")
+    Tag tests: @pytest.mark.vs("journey-id", revision="slug")
 
 The plugin:
-1. Detects @pytest.mark.vs("journey-id") tags on tests
+1. Detects @pytest.mark.vs("journey-id", revision="slug") tags on tests
 2. After each test, captures a Playwright screenshot (if a page fixture exists)
 3. Uploads screenshots to VisionSpec storage
-4. Posts the result (pass/fail + screenshot_urls + screenshot_labels) to VisionSpec
+4. Posts the result (pass/fail + screenshot_urls + screenshot_metadata) to VisionSpec
 
 Labeled screenshots:
     Use the vs_screenshot fixture to capture labeled screenshots mid-test:
@@ -20,7 +20,9 @@ Labeled screenshots:
         vs_screenshot("dark mode")    # captures + labels
 """
 
+import hashlib
 import os
+import struct
 import sys
 import glob
 from pathlib import Path
@@ -35,6 +37,10 @@ _VERBOSE = os.environ.get("VS_VERBOSE", "").lower() in ("1", "true", "yes")
 # Default fixture names; overridden by [tool.pytest-visionspec] page_fixtures in pyproject.toml
 _PAGE_FIXTURES = ["page"]
 
+# Session-scoped buffer for V2 spec results (@pytest.mark.vs_v2). Flushed
+# in pytest_sessionfinish with a single batched POST to /api/v2/results.
+_V2_BUFFER: list = []
+
 
 def pytest_addoption(parser):
     parser.addini("vs_page_fixtures",
@@ -46,6 +52,10 @@ def pytest_addoption(parser):
 def pytest_configure(config):
     config.addinivalue_line("markers", "vs(journey_id): link test to a VisionSpec journey")
     config.addinivalue_line("markers", "vs_surface(surface): override the reported surface (api, desktop, mobile)")
+    config.addinivalue_line(
+        "markers",
+        "vs_v2(spec_slug, jtbd=None): report V2 spec test result to /api/v2/results",
+    )
 
     global _PAGE_FIXTURES
     _PAGE_FIXTURES = list(config.getini("vs_page_fixtures"))
@@ -95,6 +105,10 @@ def pytest_runtest_makereport(item, call):
     if call.when != "call":
         return
 
+    # V2 marker: buffer for session-end batch POST. Independent of the V1
+    # marker path below.
+    _buffer_vs_v2_result(item, report)
+
     markers = list(item.iter_markers("vs"))
     api_key = _API_KEY
     api_url = _API_URL
@@ -124,9 +138,10 @@ def pytest_runtest_makereport(item, call):
     # Upload any captured screenshots/videos
     screenshot_urls = []
     screenshot_labels = []
+    screenshot_metadata = []
     video_url = None
     try:
-        screenshot_urls, screenshot_labels, video_url = _collect_and_upload_artifacts(item, api_key, api_url)
+        screenshot_urls, screenshot_labels, screenshot_metadata, video_url = _collect_and_upload_artifacts(item, api_key, api_url)
     except Exception:
         pass
 
@@ -158,6 +173,7 @@ def pytest_runtest_makereport(item, call):
                     "versions": _get_versions(),
                     "screenshot_urls": screenshot_urls,
                     "screenshot_labels": screenshot_labels,
+                    "screenshot_metadata": screenshot_metadata,
                     "video_url": video_url,
                     "revision_slug": revision,
                 })
@@ -184,22 +200,39 @@ def _safe_filename(name: str) -> str:
     return name.replace("[", "-").replace("]", "").replace("/", "-").replace(":", "-")
 
 
+def _png_dimensions(data: bytes) -> tuple:
+    """Extract width and height from PNG header without Pillow."""
+    if len(data) < 24 or data[:8] != b'\x89PNG\r\n\x1a\n':
+        return (0, 0)
+    # IHDR chunk starts at byte 8: 4 bytes length + 4 bytes "IHDR" + 4 bytes width + 4 bytes height
+    width, height = struct.unpack('>II', data[16:24])
+    return (width, height)
+
+
+def _file_metadata(data: bytes, url: str) -> dict:
+    """Build screenshot_metadata entry from file bytes and uploaded URL."""
+    width, height = _png_dimensions(data)
+    return {
+        "url": url,
+        "width": width,
+        "height": height,
+        "size_bytes": len(data),
+        "sha256": hashlib.sha256(data).hexdigest(),
+    }
+
+
 def _collect_and_upload_artifacts(item, api_key, api_url):
     """Find screenshots/videos in test-results/ and upload them.
 
-    Returns (screenshot_urls, screenshot_labels, video_url).
-    Labels are extracted from filenames: 'labeled-N-some-label.png' -> 'some label'.
-    The final end-of-test screenshot gets label 'end'.
+    Returns (screenshot_urls, screenshot_labels, screenshot_metadata, video_url).
     """
     screenshot_urls = []
     screenshot_labels = []
+    screenshot_metadata = []
     video_url = None
 
     safe_name = _safe_filename(item.name)
 
-    # Get labeled captures from the vs_screenshot fixture (if used)
-    vs_labels = getattr(item, "_vs_screenshot_labels", [])
-
     patterns = [
         f"test-results/{safe_name}/*.png",
         f"test-results/{safe_name}/*.jpg",
@@ -228,9 +261,10 @@ def _collect_and_upload_artifacts(item, api_key, api_url):
                 "webm": "video/webm", "mp4": "video/mp4",
             }.get(ext, "application/octet-stream")
 
+            file_bytes = path.read_bytes()
             upload_r = httpx.post(f"{api_url}/api/upload",
                 headers={"X-API-Key": api_key, "Content-Type": mime, "X-Filename": path.name},
-                content=path.read_bytes(),
+                content=file_bytes,
                 timeout=30)
 
             if upload_r.status_code == 200:
@@ -238,21 +272,20 @@ def _collect_and_upload_artifacts(item, api_key, api_url):
                 if mime.startswith("video/"):
                     video_url = data["url"]
                 else:
-                    screenshot_urls.append(data["url"])
+                    url = data["url"]
+                    screenshot_urls.append(url)
+                    screenshot_metadata.append(_file_metadata(file_bytes, url))
                     # Derive label from filename
                     stem = path.stem
                     if stem.startswith("labeled-") and len(stem.split("-", 2)) >= 3:
-                        # labeled-0-some-label -> some label
                         label = stem.split("-", 2)[2].replace("-", " ")
-                    elif stem == "end":
+                    elif stem in ("end", "after"):
                         label = "end"
-                    elif stem == "after":
-                        label = "end"  # legacy
                     else:
                         label = ""
                     screenshot_labels.append(label)
 
-    return screenshot_urls, screenshot_labels, video_url
+    return screenshot_urls, screenshot_labels, screenshot_metadata, video_url
 
 
 def _get_versions():
@@ -273,3 +306,68 @@ def _get_versions():
     except Exception:
         pass
     return versions
+
+
+# ---------- V2: spec-result reporting via @pytest.mark.vs_v2 ----------
+
+
+def _buffer_vs_v2_result(item, report):
+    """If item is tagged @pytest.mark.vs_v2, append a result dict to
+    _V2_BUFFER for a later session-end batch POST."""
+    vs_v2_markers = list(item.iter_markers(name="vs_v2"))
+    if not vs_v2_markers:
+        return
+    m = vs_v2_markers[0]
+    spec_slug = m.args[0] if m.args else None
+    if not spec_slug:
+        return
+    jtbd_slug = m.kwargs.get("jtbd")
+    duration_ms = int(report.duration * 1000) if report.duration else None
+    error_message = None
+    if not report.passed:
+        error_message = (str(report.longreprtext) if report.longreprtext else "test failed")[:2000]
+    _V2_BUFFER.append({
+        "spec_slug": spec_slug,
+        "jtbd_slug": jtbd_slug,
+        "passed": report.passed,
+        "duration_ms": duration_ms,
+        "error_message": error_message,
+    })
+
+
+def pytest_sessionfinish(session, exitstatus):
+    """Flush buffered V2 results in a single batch POST to /api/v2/results."""
+    if not _V2_BUFFER:
+        return
+    api_key = _API_KEY
+    api_url = _API_URL
+    if not api_key or not api_url:
+        if _VERBOSE:
+            print(
+                f"[visionspec] Skipping V2 results POST: "
+                f"api_key={'set' if api_key else 'MISSING'}, "
+                f"api_url={'set' if api_url else 'MISSING'}",
+                file=sys.stderr,
+            )
+        _V2_BUFFER.clear()
+        return
+    try:
+        r = httpx.post(
+            f"{api_url}/api/v2/results",
+            headers={"X-API-Key": api_key, "Content-Type": "application/json"},
+            json={"results": list(_V2_BUFFER)},
+            timeout=30,
+        )
+        if _VERBOSE:
+            print(
+                f"[visionspec] V2 results POST: status={r.status_code}, "
+                f"buffered={len(_V2_BUFFER)}",
+                file=sys.stderr,
+            )
+        if r.status_code >= 400 and _VERBOSE:
+            print(f"[visionspec] V2 BODY: {r.text[:200]}", file=sys.stderr)
+    except Exception as e:
+        if _VERBOSE:
+            print(f"[visionspec] V2 results POST failed: {e}", file=sys.stderr)
+    finally:
+        _V2_BUFFER.clear()

{pytest_visionspec-0.2.0 → pytest_visionspec-0.3.0}/pytest_visionspec.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-visionspec
-Version: 0.2.0
+Version: 0.3.0
 Summary: Pytest plugin that auto-reports test results with screenshots to VisionSpec
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
@@ -46,8 +46,24 @@ The plugin automatically:
 
 ## Markers
 
-- `@pytest.mark.vs("journey-id")` — link test to a VisionSpec journey spec
+- `@pytest.mark.vs("journey-id")` — link test to a VisionSpec V1 journey spec
 - `@pytest.mark.vs_surface("mobile")` — override the reported surface (default: `desktop`)
+- `@pytest.mark.vs_v2("spec-slug", jtbd="jtbd-slug")` — link test to a VisionSpec V2 spec (chapters model). Results are buffered and POSTed in one batch at session end to `/api/v2/results`.
+
+## V2 usage (chapters model)
+
+For V2 projects, tag tests with `vs_v2` — no screenshot capture, batched reporting:
+
+```python
+@pytest.mark.vs_v2("verdict-returns-200", jtbd="get-verdict")
+def test_verdict():
+    r = client.get("/verdict")
+    assert r.status_code == 200
+```
+
+Get your project's `VS_API_KEY` via the V2 MCP tool `get_project(project)` (returns `test_reporting.env_vars`) or from the "CI / Test runner" tab in V2 project settings.
+
+Results POST once per pytest session. Coverage in V2 `get_doc`'s `summary` field then shows `tested` / `passing` / `failing` counts per spec.
 
 ## Page fixture detection