venom-report 0.1.0__tar.gz

venom_report-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+.venv/
+build/
+dist/
+*.egg-info/
+uv.lock

venom_report-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

venom_report-0.1.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.5
+Name: venom-report
+Version: 0.1.0
+Summary: A static HTML report for any venom run, like coverage html.
+Project-URL: Homepage, https://github.com/pfrayer/venom-report
+Project-URL: Issues, https://github.com/pfrayer/venom-report/issues
+Author: Pierre Frayer
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: html,junit,report,testing,venom
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Provides-Extra: yaml
+Requires-Dist: pyyaml; extra == 'yaml'
+Description-Content-Type: text/markdown
+
+# venom-report
+
+A static HTML report for any [venom](https://github.com/ovh/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.
+
+```sh
+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
+
+| venom writes | when | gives |
+|---|---|---|
+| `test_results_*.xml` | `format: xml` (default) | suites, testcases, pass/fail/skip, failure messages |
+| `test_results_*.json` | `format: json` | same, plus every step with its request/response, no dump needed |
+| `*.dump.json` | `-vvv` / `verbosity: 3` | each step: the request sent and the full response |
+
+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
+
+| option | default | |
+|---|---|---|
+| `-o FILE` | `OUTPUT_DIR/report/index.html` | where to write |
+| `--title T` | `venom · <parent dir>` | page title |
+| `--expected-reds FILE` | none | YAML list of reds that are known and accepted, shown apart from regressions (needs PyYAML) |
+| `--redact REGEX` | `authorization\|token\|secret\|passw(or)?d\|cookie\|api[-_]?key\|credential` | keys and headers whose values are masked |
+| `--max-body N` | `100000` | bodies longer than N chars are truncated |
+| `--open` | | open the report in a browser |
+
+`--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
+
+```sh
+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](LICENSE)

venom_report-0.1.0/README.md

@@ -0,0 +1,67 @@
+# venom-report
+
+A static HTML report for any [venom](https://github.com/ovh/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.
+
+```sh
+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
+
+| venom writes | when | gives |
+|---|---|---|
+| `test_results_*.xml` | `format: xml` (default) | suites, testcases, pass/fail/skip, failure messages |
+| `test_results_*.json` | `format: json` | same, plus every step with its request/response, no dump needed |
+| `*.dump.json` | `-vvv` / `verbosity: 3` | each step: the request sent and the full response |
+
+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
+
+| option | default | |
+|---|---|---|
+| `-o FILE` | `OUTPUT_DIR/report/index.html` | where to write |
+| `--title T` | `venom · <parent dir>` | page title |
+| `--expected-reds FILE` | none | YAML list of reds that are known and accepted, shown apart from regressions (needs PyYAML) |
+| `--redact REGEX` | `authorization\|token\|secret\|passw(or)?d\|cookie\|api[-_]?key\|credential` | keys and headers whose values are masked |
+| `--max-body N` | `100000` | bodies longer than N chars are truncated |
+| `--open` | | open the report in a browser |
+
+`--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
+
+```sh
+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](LICENSE)

venom_report-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "venom-report"
+dynamic = ["version"]
+description = "A static HTML report for any venom run, like coverage html."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [{ name = "Pierre Frayer" }]
+keywords = ["venom", "testing", "report", "html", "junit"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Testing",
+]
+
+[project.optional-dependencies]
+yaml = ["pyyaml"]
+
+[project.scripts]
+venom-report = "venom_report.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/pfrayer/venom-report"
+Issues = "https://github.com/pfrayer/venom-report/issues"
+
+[dependency-groups]
+dev = ["pytest", "pyyaml", "ruff"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.targets.sdist]
+include = ["src", "tests", "README.md", "LICENSE"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

venom_report-0.1.0/src/venom_report/__init__.py

@@ -0,0 +1,8 @@
+"""Turn a venom output directory into a single static HTML report."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("venom-report")
+except PackageNotFoundError:  # running from a source tree that was never installed
+    __version__ = "0.0.0"

venom_report-0.1.0/src/venom_report/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from .cli import main
+
+sys.exit(main())

venom_report-0.1.0/src/venom_report/cli.py

@@ -0,0 +1,245 @@
+"""Turn a venom output directory into a single static HTML report.
+
+    venom-report [OUTPUT_DIR] [-o index.html] [--expected-reds FILE]
+
+Reads what venom writes, whatever the suite:
+  - test_results_*.xml (format: xml) or test_results_*.json (format: json)
+  - *.dump.json, one per executed step, when venom ran with -vvv / verbosity: 3
+
+Stdlib only. The report never reflects the test status in its exit code: venom
+already does that.
+"""
+
+from __future__ import annotations
+
+import argparse
+import json
+import re
+import sys
+import webbrowser
+import xml.etree.ElementTree as ET
+from datetime import datetime, timezone
+from importlib.resources import files
+from pathlib import Path
+from typing import Any
+
+from . import __version__
+from .readers import (
+    Redactor,
+    Suite,
+    Testcase,
+    attach_dumps,
+    index_dumps,
+    read_json,
+    read_xml,
+    resolve_statuses,
+    run_windows,
+)
+
+DEFAULT_REDACT = r"authorization|token|secret|passw(or)?d|cookie|api[-_]?key|credential"
+
+
+# --------------------------------------------------------------------------- expected reds
+
+
+def load_expected(path: Path | None) -> list[dict[str, Any]]:
+    if not path:
+        return []
+    try:
+        import yaml  # type: ignore[import-untyped]
+    except ImportError:
+        print("warning: PyYAML missing, --expected-reds ignored", file=sys.stderr)
+        return []
+    doc = yaml.safe_load(path.read_text()) or {}
+    entries = doc.get("expected_reds", []) if isinstance(doc, dict) else doc
+    return [e if isinstance(e, dict) else {"testcase": str(e)} for e in entries or []]
+
+
+def _norm(s: str) -> str:
+    return re.sub(r"[^a-z0-9]+", "-", s.lower()).strip("-")
+
+
+def match_expected(suite: Suite, tc: Testcase, entries: list[dict[str, Any]]) -> dict[str, Any] | None:
+    for e in entries:
+        if e.get("suite") and Path(str(e["suite"])).name not in (
+            Path(suite.file).name,
+            suite.stem,
+        ):
+            continue
+        if _norm(str(e.get("testcase") or e.get("class") or "")) == _norm(tc.name):
+            return {k: e[k] for k in ("divergence", "why") if k in e}
+    return None
+
+
+# --------------------------------------------------------------------------- output
+
+
+def _truncate(s: Any, limit: int) -> Any:
+    if isinstance(s, str) and len(s) > limit:
+        return s[:limit] + f"\n\n… truncated by venom-report ({len(s)} bytes, --max-body {limit})"
+    return s
+
+
+def serialize(suites: list[Suite], redactor: Redactor, max_body: int) -> list[dict[str, Any]]:
+    out = []
+    for s in suites:
+        tcs = []
+        for tc in s.testcases:
+            steps = []
+            for st in tc.steps:
+                http = None
+                if st.http:
+                    http = redactor.obj(st.http)
+                    http["reqBody"] = _truncate(http["reqBody"], max_body)
+                    http["respBody"] = _truncate(http["respBody"], max_body)
+                raw = redactor.obj(st.raw)
+                raw_s = raw if isinstance(raw, str) else json.dumps(raw, indent=2, ensure_ascii=False, default=str)
+                steps.append(
+                    {
+                        "n": st.n,
+                        "r": st.r,
+                        "type": st.type,
+                        "name": st.name,
+                        "status": st.status,
+                        "errors": [redactor.text(e) for e in st.errors],
+                        "assertions": redactor.obj(st.assertions),
+                        "http": http,
+                        "hasDump": st.has_dump,
+                        "systemout": _truncate(redactor.text(st.systemout.strip()), max_body),
+                        "systemerr": _truncate(redactor.text(st.systemerr.strip()), max_body),
+                        "raw": _truncate(raw_s, max_body) if st.raw else "",
+                    }
+                )
+            tcs.append(
+                {
+                    "name": tc.name,
+                    "index": tc.index,
+                    "status": tc.status,
+                    "time": tc.time,
+                    "messages": [redactor.text(m) for m in tc.messages],
+                    "skipReason": redactor.text(tc.skip_reason),
+                    "systemout": _truncate(redactor.text(tc.systemout), max_body),
+                    "steps": steps,
+                    "expected": tc.expected,
+                }
+            )
+        out.append(
+            {
+                "name": s.name,
+                "file": s.file,
+                "source": s.source,
+                "time": s.time,
+                "end": s.end,
+                "testcases": tcs,
+            }
+        )
+    return out
+
+
+def build(
+    out_dir: Path,
+    expected_path: Path | None,
+    redact: str,
+    max_body: int,
+    title: str | None,
+) -> tuple[str, dict]:
+    redactor = Redactor(redact)
+    suites: dict[str, Suite] = {}
+    for p in sorted(out_dir.glob("test_results*.xml")) + sorted(out_dir.glob("test_results*.json")):
+        try:
+            found = read_xml(p) if p.suffix == ".xml" else read_json(p, redactor)
+        except (ET.ParseError, ValueError, OSError) as exc:
+            print(f"warning: {p.name} skipped ({exc})", file=sys.stderr)
+            continue
+        for s in found:  # the same suite run twice (dir vs file spelling): keep the newest
+            key = s.file or s.name
+            if key not in suites or s.end > suites[key].end:
+                suites[key] = s
+    idx = index_dumps(out_dir)
+    entries = load_expected(expected_path)
+    dumps = 0
+    run_windows(list(suites.values()))
+    for s in suites.values():
+        dumps += attach_dumps(s, idx, redactor)
+        for tc in s.testcases:
+            resolve_statuses(tc)
+            if tc.status == "fail":
+                tc.expected = match_expected(s, tc, entries)
+    ordered = sorted(suites.values(), key=lambda s: s.file or s.name)
+    meta = {
+        "title": title or f"venom · {out_dir.resolve().parent.name}",
+        "outputDir": str(out_dir.resolve()),
+        "generated": datetime.now(timezone.utc).isoformat(timespec="seconds"),
+        "dumps": dumps,
+        "expectedReds": bool(entries),
+    }
+    data = {"meta": meta, "suites": serialize(ordered, redactor, max_body)}
+    payload = json.dumps(data, ensure_ascii=False, separators=(",", ":")).replace("<", "\\u003c")
+    template = (
+        files(__package__).joinpath("template.html").read_text().replace("__TITLE__", _html_escape(meta["title"]))
+    )
+    html = template.replace("/*__DATA__*/", payload)
+    return html, data
+
+
+def _html_escape(s: str) -> str:
+    return s.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;")
+
+
+def main(argv: list[str] | None = None) -> int:
+    ap = argparse.ArgumentParser(
+        prog="venom-report", description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
+    )
+    ap.add_argument(
+        "output_dir",
+        nargs="?",
+        default="output",
+        type=Path,
+        help="venom output dir (default: ./output)",
+    )
+    ap.add_argument(
+        "-o",
+        "--out",
+        type=Path,
+        help="report file (default: OUTPUT_DIR/report/index.html)",
+    )
+    ap.add_argument("--title", help="page title")
+    ap.add_argument(
+        "--expected-reds",
+        type=Path,
+        help="YAML list of reds known to be expected (needs PyYAML)",
+    )
+    ap.add_argument(
+        "--redact",
+        default=DEFAULT_REDACT,
+        help=f"regex of sensitive keys (default: {DEFAULT_REDACT})",
+    )
+    ap.add_argument(
+        "--max-body",
+        type=int,
+        default=100_000,
+        help="truncate bodies above N chars (default: 100000)",
+    )
+    ap.add_argument("--open", action="store_true", help="open the report in a browser")
+    ap.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
+    args = ap.parse_args(argv)
+    if not args.output_dir.is_dir():
+        print(f"error: {args.output_dir} is not a directory", file=sys.stderr)
+        return 2
+    html, data = build(args.output_dir, args.expected_reds, args.redact, args.max_body, args.title)
+    if not data["suites"]:
+        print(f"error: no test_results_*.xml|json in {args.output_dir}", file=sys.stderr)
+        return 2
+    out = args.out or args.output_dir / "report" / "index.html"
+    out.parent.mkdir(parents=True, exist_ok=True)
+    out.write_text(html)
+    tcs = [tc for s in data["suites"] for tc in s["testcases"]]
+    count = {k: sum(tc["status"] == k for tc in tcs) for k in ("pass", "fail", "skip")}
+    print(
+        f"{len(data['suites'])} suites · {len(tcs)} testcases · {count['pass']} passed · "
+        f"{count['fail']} failed · {count['skip']} skipped · {data['meta']['dumps']} step dumps"
+    )
+    print(f"report: {out.resolve()}")
+    if args.open:
+        webbrowser.open(out.resolve().as_uri())
+    return 0