Skip to main content

Pytest plugin that auto-reports test results with screenshots to VisionSpec

Project description

pytest-visionspec

Pytest plugin that auto-reports test results with screenshots to VisionSpec.

Install

pip install pytest-visionspec

Setup

Set two environment variables:

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"):

@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:

[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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_visionspec-0.1.0.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytest_visionspec-0.1.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file pytest_visionspec-0.1.0.tar.gz.

File metadata

  • Download URL: pytest_visionspec-0.1.0.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for pytest_visionspec-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5eb05d9d90b05192b71cf3741f3d14f89d61ca708f04de0ca6e489dbac581a07
MD5 c519bd186f512b35ea984d282d3586de
BLAKE2b-256 a5242748f05e8fedf3dd5a2b077fd0fa009eb4ec5775b9830945eef560f1c894

See more details on using hashes here.

File details

Details for the file pytest_visionspec-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_visionspec-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 243074a30f74ba9dc10030567153a5d0c796c198aabbbc276e9437c4eb1bff00
MD5 4678bcd1e835c412e6e4e7cdb2aff6e0
BLAKE2b-256 d054d8c45edff5b651e18b23b6c483ee5b435cdb79125836218f17742f49c049

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page