pytest-visionspec 0.1.0__py3-none-any.whl

pytest_visionspec/__init__.py

@@ -0,0 +1,194 @@
+"""pytest-visionspec — auto-report test results with screenshot uploads.
+
+Usage:
+    pip install pytest-visionspec
+    Set env vars: VS_API_KEY, VS_API_URL
+    Tag tests: @pytest.mark.vs("journey-id")
+
+The plugin:
+1. Detects @pytest.mark.vs("journey-id") 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) to VisionSpec
+"""
+
+import os
+import sys
+import glob
+from pathlib import Path
+
+import httpx
+import pytest
+
+_API_KEY = os.environ.get("VS_API_KEY", "")
+_API_URL = os.environ.get("VS_API_URL", "")
+_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"]
+
+
+def pytest_addoption(parser):
+    parser.addini("vs_page_fixtures",
+                  type="args",
+                  default=["page"],
+                  help="Fixture names to check for a Playwright page object (in priority order)")
+
+
+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)")
+
+    global _PAGE_FIXTURES
+    _PAGE_FIXTURES = list(config.getini("vs_page_fixtures"))
+
+
+@pytest.hookimpl(tryfirst=True, hookwrapper=True)
+def pytest_runtest_makereport(item, call):
+    outcome = yield
+    report = outcome.get_result()
+    if call.when != "call":
+        return
+
+    markers = list(item.iter_markers("vs"))
+    api_key = _API_KEY
+    api_url = _API_URL
+    if not markers or not api_key or not api_url:
+        return
+
+    # Determine surface
+    surface_marker = item.get_closest_marker("vs_surface")
+    if surface_marker and surface_marker.args:
+        surface = surface_marker.args[0]
+    else:
+        surface = "desktop"
+
+    # Capture screenshot if a Playwright page fixture is available
+    screenshot_urls = []
+    video_url = None
+    page = _find_page(item)
+    if page:
+        try:
+            safe_name = _safe_filename(item.name)
+            screenshot_dir = Path("test-results") / safe_name
+            screenshot_dir.mkdir(parents=True, exist_ok=True)
+            screenshot_path = screenshot_dir / "after.png"
+            raw = page.raw_page if hasattr(page, "raw_page") else page
+            raw.screenshot(path=str(screenshot_path))
+        except Exception:
+            pass
+
+    # Upload any captured screenshots/videos
+    try:
+        screenshot_urls, video_url = _collect_and_upload_artifacts(item, api_key, api_url)
+    except Exception:
+        pass
+
+    # Report result for each tagged journey
+    headers = {"X-API-Key": api_key, "Content-Type": "application/json"}
+    for marker in markers:
+        journey_id = marker.args[0] if marker.args else None
+        if not journey_id:
+            continue
+
+        # Read revision from marker kwargs or VS_REVISION env var
+        revision = marker.kwargs.get("revision") or os.environ.get("VS_REVISION") or None
+        if not revision:
+            print(f"[visionspec] ERROR: @pytest.mark.vs('{journey_id}', revision='slug') "
+                  f"requires revision parameter — skipping result post", file=sys.stderr)
+            continue
+
+        try:
+            r = httpx.post(f"{api_url}/api/results",
+                headers=headers, timeout=10,
+                json={
+                    "journey_id": journey_id,
+                    "journey_version": 1,
+                    "surface": surface,
+                    "sut_version": os.environ.get("VS_SUT_VERSION", "dev"),
+                    "passed": report.passed,
+                    "steps": [{"action": item.name, "passed": report.passed}],
+                    "source": "pytest-visionspec",
+                    "versions": _get_versions(),
+                    "screenshot_urls": screenshot_urls,
+                    "video_url": video_url,
+                    "revision_slug": revision,
+                })
+            if _VERBOSE:
+                print(f"[visionspec] POST {journey_id}: {r.status_code}", file=sys.stderr)
+            if r.status_code != 200 and _VERBOSE:
+                print(f"[visionspec] BODY: {r.text[:200]}", file=sys.stderr)
+        except Exception as e:
+            if _VERBOSE:
+                print(f"[visionspec] ERROR for {journey_id}: {e}", file=sys.stderr)
+
+
+def _find_page(item):
+    """Find a Playwright page object from test fixtures."""
+    for name in _PAGE_FIXTURES:
+        page = item.funcargs.get(name)
+        if page is not None:
+            return page
+    return None
+
+
+def _safe_filename(name: str) -> str:
+    """Sanitize a test name for use as a directory/file name."""
+    return name.replace("[", "-").replace("]", "").replace("/", "-").replace(":", "-")
+
+
+def _collect_and_upload_artifacts(item, api_key, api_url):
+    """Find screenshots/videos in test-results/ and upload them."""
+    screenshot_urls = []
+    video_url = None
+
+    safe_name = _safe_filename(item.name)
+    patterns = [
+        f"test-results/*{safe_name}*/*.png",
+        f"test-results/*{safe_name}*/*.jpg",
+        f"test-results/*{safe_name}*/*.webm",
+        f"test-results/*{safe_name}*/*.mp4",
+    ]
+
+    for pattern in patterns:
+        for filepath in glob.glob(pattern):
+            path = Path(filepath)
+            ext = path.suffix.lstrip(".")
+            mime = {
+                "png": "image/png", "jpg": "image/jpeg",
+                "webm": "video/webm", "mp4": "video/mp4",
+            }.get(ext, "application/octet-stream")
+
+            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(),
+                timeout=30)
+
+            if upload_r.status_code == 200:
+                data = upload_r.json()
+                if mime.startswith("video/"):
+                    video_url = data["url"]
+                else:
+                    screenshot_urls.append(data["url"])
+
+    return screenshot_urls, video_url
+
+
+def _get_versions():
+    """Build version metadata from environment, plus git commit hash."""
+    import subprocess
+    versions = {}
+    for key in ("VS_VERSION", "VS_FRONTEND_VERSION", "VS_BACKEND_VERSION"):
+        val = os.environ.get(key, "")
+        if val:
+            versions[key.replace("VS_", "").lower()] = val
+    # Auto-capture git commit
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "--short", "HEAD"],
+            capture_output=True, text=True, timeout=5)
+        if result.returncode == 0 and result.stdout.strip():
+            versions["git"] = result.stdout.strip()
+    except Exception:
+        pass
+    return versions

pytest_visionspec-0.1.0.dist-info/METADATA

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: pytest-visionspec
+Version: 0.1.0
+Summary: Pytest plugin that auto-reports test results with screenshots to VisionSpec
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pytest>=7.0
+Requires-Dist: httpx>=0.24
+
+# pytest-visionspec
+
+Pytest plugin that auto-reports test results with screenshots to [VisionSpec](https://visionspec-dev.helpfulhuman.xyz).
+
+## Install
+
+```bash
+pip install pytest-visionspec
+```
+
+## Setup
+
+Set two environment variables:
+
+```bash
+VS_API_KEY=vs_your_project_api_key
+VS_API_URL=https://visionspec-dev.helpfulhuman.xyz
+```
+
+## Usage
+
+Tag tests with `@pytest.mark.vs("journey-id")`:
+
+```python
+@pytest.mark.vs("login-happy-path")
+def test_login(page):
+    page.goto("/login")
+    page.fill("[name=email]", "user@example.com")
+    page.click("button[type=submit]")
+    assert page.url == "/dashboard"
+```
+
+The plugin automatically:
+1. Captures a Playwright screenshot after each test
+2. Uploads it to VisionSpec storage
+3. Posts the result (pass/fail + screenshot URL) to VisionSpec
+
+## Markers
+
+- `@pytest.mark.vs("journey-id")` — link test to a VisionSpec journey spec
+- `@pytest.mark.vs_surface("mobile")` — override the reported surface (default: `desktop`)
+
+## Page fixture detection
+
+By default, the plugin looks for a `page` fixture. Configure custom fixture names in `pyproject.toml`:
+
+```toml
+[tool.pytest.ini_options]
+vs_page_fixtures = ["v2app", "v1app", "page"]
+```
+
+The plugin checks each name in order and uses the first one it finds.
+
+## Environment variables
+
+| Variable | Required | Description |
+|---|---|---|
+| `VS_API_KEY` | Yes | Project API key from VisionSpec |
+| `VS_API_URL` | Yes | VisionSpec server URL |
+| `VS_SUT_VERSION` | No | Version of the system under test |
+| `VS_VERBOSE` | No | Set to `1` for debug logging |
+| `VS_VERSION` | No | App version metadata |
+| `VS_FRONTEND_VERSION` | No | Frontend version metadata |
+| `VS_BACKEND_VERSION` | No | Backend version metadata |

pytest_visionspec-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+pytest_visionspec/__init__.py,sha256=suKHQB71hESOic8EcxsFUsldr32BN-MOUdG1jkfuTdA,6827
+pytest_visionspec-0.1.0.dist-info/METADATA,sha256=JpYaB6Exn30mwD8w7_a0Myw7LKL7Hrg6AUHlb70jJeo,1987
+pytest_visionspec-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pytest_visionspec-0.1.0.dist-info/entry_points.txt,sha256=N7WW51B1dZpnp7ncmivHZOFXdQoHOC5fhTc1HfKKCFY,42
+pytest_visionspec-0.1.0.dist-info/top_level.txt,sha256=uTu3Hekp-czpqItRKrcWp6nyhO8SlQFs1FU2RWAC5FQ,18
+pytest_visionspec-0.1.0.dist-info/RECORD,,

pytest_visionspec-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pytest_visionspec-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+visionspec = pytest_visionspec

pytest_visionspec-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pytest_visionspec