venom-report

A static HTML report for any venom run, like coverage html: every suite, testcase and step, the HTTP call made (method, URL, headers, body), the response, the assertions (the failing one in red), and why a testcase was skipped.

pipx install venom-report          # or: uv tool install venom-report
venom-report path/to/output        # -> path/to/output/report/index.html
venom-report output --open         # and open it

No dependency (Python ≥ 3.10); pip install 'venom-report[yaml]' adds PyYAML for --expected-reds. The page is one self-contained file that opens over file://.

What it reads

Without dumps (xml, no -vvv), the report falls back on the JUnit system-out and says so.

venom never cleans output/: dumps from older runs sit next to fresh ones. A dump is used only if it was written during the run that produced the report (from its mtime). If the same suite was reported twice (e.g. venom run tests/ then venom run tests/x.yml), the newest report wins.

Options

--expected-reds accepts a list, or a mapping with an expected_reds: list, of entries {testcase, suite?, divergence?, why?} or bare testcase names. Names match loosely (TC8 foo bar = TC8-foo-bar).

Secrets

Values under a sensitive key (in dumps, headers, venom vars, venom secrets) are masked, then every other occurrence of those values is masked too (URLs, bodies, logs), as is any Bearer … / Basic …. The venom variables block is never embedded. Still, check a report before sharing it outside your team.

Tests

uv run pytest

The fixtures are real venom v1.3.0 outputs of tests/fixtures/suite_a.yml.

Release

Publish a GitHub release with a vX.Y.Z tag: the version comes from the tag, and the Release workflow uploads to PyPI (trusted publishing, no token).

License

Apache-2.0