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.2.0.tar.gz (4.9 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.2.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytest_visionspec-0.2.0.tar.gz
  • Upload date:
  • Size: 4.9 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.2.0.tar.gz
Algorithm Hash digest
SHA256 3d9425e3a1afaa727ba92329b37e2f356dcd642459223c2f567d221e7080b51a
MD5 cdfd8e944aa05221eec49e38eeba7c34
BLAKE2b-256 014b2dcb861a9691baac78d2e31a2d6bc661bcf2248c9033b4a4f42feee7a499

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pytest_visionspec-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 69ad6277e5ad446cdbcb6d6965bef43c9970bc809c69871036be5bbd956f088a
MD5 3e99b5ffeb3824e32ed743924bea2b17
BLAKE2b-256 1892a787a4f044ee67a148dfb0e7b0b4c3b9dca883c258fc24f6b0701d616d96

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