pytest-better-report 1.0.0__tar.gz

pytest_better_report-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Avi Zaguri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytest_better_report-1.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include pyproject.toml
+include README.md
+include LICENSE

pytest_better_report-1.0.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: pytest-better-report
+Version: 1.0.0
+Summary: A pytest plugin that writes structured JSON (and optional Markdown) reports of every run, with CI metadata and a CLI to compare two runs.
+Author: Avi Zaguri
+License: MIT
+Project-URL: Homepage, https://github.com/aviz92/pytest-better-report
+Project-URL: Repository, https://github.com/aviz92/pytest-better-report
+Project-URL: Issues, https://github.com/aviz92/pytest-better-report/issues
+Keywords: pytest,plugin,testing,report,json,markdown,ci
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: custom-python-logger>=4.1.0
+Requires-Dist: pytest>=9.2.0
+Requires-Dist: python-base-command>=0.1.8
+Requires-Dist: python-base-toolkit>=1.1.2
+Dynamic: license-file
+
+![PyPI version](https://img.shields.io/pypi/v/pytest-better-report)
+![Python](https://img.shields.io/badge/python->=3.12-blue)
+![Development Status](https://img.shields.io/badge/status-stable-green)
+![Maintenance](https://img.shields.io/maintenance/yes/2026)
+![PyPI](https://img.shields.io/pypi/dm/pytest-better-report)
+![License](https://img.shields.io/pypi/l/pytest-better-report)
+
+---
+
+# 💡 pytest-better-report
+A pytest plugin that writes a structured report of every run: a JSON file per test, a JSON file for the run with CI
+metadata (repo, PR/MR, pipeline, commit), and an optional Markdown summary. Includes a CLI to compare two runs.
+
+---
+
+## 📦 Installation
+```bash
+uv add pytest-better-report
+```
+
+---
+
+## 🚀 Features
+  - ✅ **Structured JSON** — `test_results.json` (one entry per test) and `execution_results.json` (the run)
+  - ✅ **CI traceability** — repo name, PR / MR number, pipeline number and commit in the run report
+  - ✅ **Markdown summary** — a table of every test with status, duration and message
+  - ✅ **Structured failure data** — raise with a JSON object as the message to record it as data
+  - ✅ **Compare two runs** — `better_report_compare` lists missing tests and status differences
+  - ✅ **Plays well with other plugins** — statuses come from pytest's final reports, whatever the plugin order
+  - ✅ **Zero footprint without the flag** — nothing is registered, no hook runs
+
+---
+
+## 🛠️ How to Use
+```bash
+pytest --better-report --md-report --pr-number=123 --commit="$GIT_SHA"
+```
+Files are written to `results_output/` (or `<output-dir>/results_output/`):
+
+| File | Content |
+|---|---|
+| `test_results.json` | One entry per test: name, file, class, parameters, markers, status, times, exception, user properties |
+| `execution_results.json` | The run: status, start / end / duration, CI metadata, environment, optionally the pytest command |
+| `test_report.md` | With `--md-report`: a table of all tests and a summary by status |
+
+---
+
+## ⚙️ Flags
+| Flag | Description |
+|---|---|
+| `--better-report` | Enable the report |
+| `--output-dir=DIR` | Write the files to `DIR/results_output/` |
+| `--md-report` | Also write `test_report.md` |
+| `--traceback` | Add the crash location and traceback frames to each exception |
+| `--repo-name`, `--pr-number`, `--mr-number`, `--pipeline-number`, `--commit` | CI metadata for `execution_results.json` |
+| `--add-parameters` | Add each test parameter as its own field in `test_results.json` |
+| `--pytest-command` | Record the pytest command line in `execution_results.json` |
+| `--pytest-xfail-strict` | Treat an unexpected pass (XPASS) as a failure of the run |
+| `--result-each-test` | Log each test's result after it runs |
+| `--log-collected-tests` | Log every collected test at the start (works without `--better-report` too) |
+
+---
+
+## 📊 Statuses
+Each test gets one status in `test_results.json`.
+The run as a whole gets `execution_info.execution_status` in `execution_results.json`: `failed` if **at least one**
+test has a status marked "Yes" in the last column, otherwise `passed`.
+
+This is the report's own verdict on the run, written into the file. It is separate from pytest's exit code, which this
+plugin doesn't change.
+
+| Test status | Meaning | Makes `execution_status` = `failed` |
+|---|---|---|
+| `passed` | Passed | No |
+| `failed` | Failed or errored in setup, call or teardown | Yes |
+| `skipped` | Skipped (marker, fixture, or a plugin that converted the outcome) | No |
+| `xfailed` | Expected failure | No |
+| `xpassed` | Unexpected pass | Only with `--pytest-xfail-strict` |
+| `collected` | Collected but not run (e.g. the run stopped early) | No |
+
+---
+
+## ▶️ Usage Examples
+### Record structured failure data
+```python
+import json
+
+def test_api():
+    response = call_api()
+    if response.status != 200:
+        raise AssertionError(json.dumps({"status": response.status, "body": response.text}))
+```
+The exception is recorded as `{"status": ..., "body": ...}` instead of plain text.
+
+### Compare two runs
+```bash
+better_report_compare -a main/test_results.json -b branch/test_results.json --fail-on-diff
+```
+Lists tests missing from either side and tests whose status changed; exits non-zero with `--fail-on-diff` when
+there are differences. `--test-file-name` limits the comparison to one test file.
+
+---
+
+## 🔁 Migrating from pytest-plugins
+This plugin was previously `better_report` in `pytest-plugins`. Flags, file names and the JSON schema are unchanged.
+Both register the same options, so don't install them together until you're on a `pytest-plugins` release without it.
+Differences you may notice:
+- A test that errors in teardown is now `failed` (it was reported as passed).
+- The `failed-skipped` status no longer exists; converted failures are `skipped`, with the reason in `test_user_properties`.
+- The logger is named `pytest_better_report`.
+
+---
+
+## 🤝 Contributing
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/my-addition`
+3. Make your changes
+4. Commit your changes: `git commit -m 'Add my addition'`
+5. Push to the branch: `git push origin feature/my-addition`
+6. Open a Pull Request
+
+Additions that promote clean, productive, and maintainable development are always welcome.
+
+---
+
+## 📄 License
+MIT License — see [LICENSE](LICENSE) for details.
+
+---
+
+## 🙏 Thanks
+Thanks for exploring this repository! <br>
+Happy coding!
+
+[![GitHub](https://img.shields.io/badge/GitHub-aviz92-181717?logo=github)](https://github.com/aviz92)
+&nbsp; [![PyPI](https://img.shields.io/badge/PyPI-aviz-3775A9?logo=pypi)](https://pypi.org/user/aviz/)
+&nbsp; [![Blog](https://img.shields.io/badge/Blog-aviz92.github.io-0066CC?logo=googlechrome)](https://aviz92.github.io/)
+&nbsp; [![LinkedIn](https://img.shields.io/badge/LinkedIn-avi--zaguri-0A66C2?logo=linkedin)](https://www.linkedin.com/in/avi-zaguri-41869b11b)

pytest_better_report-1.0.0/README.md

@@ -0,0 +1,138 @@
+![PyPI version](https://img.shields.io/pypi/v/pytest-better-report)
+![Python](https://img.shields.io/badge/python->=3.12-blue)
+![Development Status](https://img.shields.io/badge/status-stable-green)
+![Maintenance](https://img.shields.io/maintenance/yes/2026)
+![PyPI](https://img.shields.io/pypi/dm/pytest-better-report)
+![License](https://img.shields.io/pypi/l/pytest-better-report)
+
+---
+
+# 💡 pytest-better-report
+A pytest plugin that writes a structured report of every run: a JSON file per test, a JSON file for the run with CI
+metadata (repo, PR/MR, pipeline, commit), and an optional Markdown summary. Includes a CLI to compare two runs.
+
+---
+
+## 📦 Installation
+```bash
+uv add pytest-better-report
+```
+
+---
+
+## 🚀 Features
+  - ✅ **Structured JSON** — `test_results.json` (one entry per test) and `execution_results.json` (the run)
+  - ✅ **CI traceability** — repo name, PR / MR number, pipeline number and commit in the run report
+  - ✅ **Markdown summary** — a table of every test with status, duration and message
+  - ✅ **Structured failure data** — raise with a JSON object as the message to record it as data
+  - ✅ **Compare two runs** — `better_report_compare` lists missing tests and status differences
+  - ✅ **Plays well with other plugins** — statuses come from pytest's final reports, whatever the plugin order
+  - ✅ **Zero footprint without the flag** — nothing is registered, no hook runs
+
+---
+
+## 🛠️ How to Use
+```bash
+pytest --better-report --md-report --pr-number=123 --commit="$GIT_SHA"
+```
+Files are written to `results_output/` (or `<output-dir>/results_output/`):
+
+| File | Content |
+|---|---|
+| `test_results.json` | One entry per test: name, file, class, parameters, markers, status, times, exception, user properties |
+| `execution_results.json` | The run: status, start / end / duration, CI metadata, environment, optionally the pytest command |
+| `test_report.md` | With `--md-report`: a table of all tests and a summary by status |
+
+---
+
+## ⚙️ Flags
+| Flag | Description |
+|---|---|
+| `--better-report` | Enable the report |
+| `--output-dir=DIR` | Write the files to `DIR/results_output/` |
+| `--md-report` | Also write `test_report.md` |
+| `--traceback` | Add the crash location and traceback frames to each exception |
+| `--repo-name`, `--pr-number`, `--mr-number`, `--pipeline-number`, `--commit` | CI metadata for `execution_results.json` |
+| `--add-parameters` | Add each test parameter as its own field in `test_results.json` |
+| `--pytest-command` | Record the pytest command line in `execution_results.json` |
+| `--pytest-xfail-strict` | Treat an unexpected pass (XPASS) as a failure of the run |
+| `--result-each-test` | Log each test's result after it runs |
+| `--log-collected-tests` | Log every collected test at the start (works without `--better-report` too) |
+
+---
+
+## 📊 Statuses
+Each test gets one status in `test_results.json`.
+The run as a whole gets `execution_info.execution_status` in `execution_results.json`: `failed` if **at least one**
+test has a status marked "Yes" in the last column, otherwise `passed`.
+
+This is the report's own verdict on the run, written into the file. It is separate from pytest's exit code, which this
+plugin doesn't change.
+
+| Test status | Meaning | Makes `execution_status` = `failed` |
+|---|---|---|
+| `passed` | Passed | No |
+| `failed` | Failed or errored in setup, call or teardown | Yes |
+| `skipped` | Skipped (marker, fixture, or a plugin that converted the outcome) | No |
+| `xfailed` | Expected failure | No |
+| `xpassed` | Unexpected pass | Only with `--pytest-xfail-strict` |
+| `collected` | Collected but not run (e.g. the run stopped early) | No |
+
+---
+
+## ▶️ Usage Examples
+### Record structured failure data
+```python
+import json
+
+def test_api():
+    response = call_api()
+    if response.status != 200:
+        raise AssertionError(json.dumps({"status": response.status, "body": response.text}))
+```
+The exception is recorded as `{"status": ..., "body": ...}` instead of plain text.
+
+### Compare two runs
+```bash
+better_report_compare -a main/test_results.json -b branch/test_results.json --fail-on-diff
+```
+Lists tests missing from either side and tests whose status changed; exits non-zero with `--fail-on-diff` when
+there are differences. `--test-file-name` limits the comparison to one test file.
+
+---
+
+## 🔁 Migrating from pytest-plugins
+This plugin was previously `better_report` in `pytest-plugins`. Flags, file names and the JSON schema are unchanged.
+Both register the same options, so don't install them together until you're on a `pytest-plugins` release without it.
+Differences you may notice:
+- A test that errors in teardown is now `failed` (it was reported as passed).
+- The `failed-skipped` status no longer exists; converted failures are `skipped`, with the reason in `test_user_properties`.
+- The logger is named `pytest_better_report`.
+
+---
+
+## 🤝 Contributing
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/my-addition`
+3. Make your changes
+4. Commit your changes: `git commit -m 'Add my addition'`
+5. Push to the branch: `git push origin feature/my-addition`
+6. Open a Pull Request
+
+Additions that promote clean, productive, and maintainable development are always welcome.
+
+---
+
+## 📄 License
+MIT License — see [LICENSE](LICENSE) for details.
+
+---
+
+## 🙏 Thanks
+Thanks for exploring this repository! <br>
+Happy coding!
+
+[![GitHub](https://img.shields.io/badge/GitHub-aviz92-181717?logo=github)](https://github.com/aviz92)
+&nbsp; [![PyPI](https://img.shields.io/badge/PyPI-aviz-3775A9?logo=pypi)](https://pypi.org/user/aviz/)
+&nbsp; [![Blog](https://img.shields.io/badge/Blog-aviz92.github.io-0066CC?logo=googlechrome)](https://aviz92.github.io/)
+&nbsp; [![LinkedIn](https://img.shields.io/badge/LinkedIn-avi--zaguri-0A66C2?logo=linkedin)](https://www.linkedin.com/in/avi-zaguri-41869b11b)

pytest_better_report-1.0.0/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pytest-better-report"
+version = "1.0.0"
+description = "A pytest plugin that writes structured JSON (and optional Markdown) reports of every run, with CI metadata and a CLI to compare two runs."
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "MIT" }
+authors = [{ name = "Avi Zaguri" },]
+
+keywords = [
+    "pytest",
+    "plugin",
+    "testing",
+    "report",
+    "json",
+    "markdown",
+    "ci",
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Testing",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.12",
+]
+
+dependencies = [
+    "custom-python-logger>=4.1.0",
+    "pytest>=9.2.0",
+    "python-base-command>=0.1.8",
+    "python-base-toolkit>=1.1.2",
+]
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.7.0",
+    "python-base-command>=0.1.8",
+    "setuptools>=84.0.0",
+    "wheel>=0.45.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/aviz92/pytest-better-report"
+Repository = "https://github.com/aviz92/pytest-better-report"
+Issues = "https://github.com/aviz92/pytest-better-report/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["pytest_better_report*"]
+namespaces = false
+
+[project.entry-points.pytest11]
+better_report = "pytest_better_report.plugin"
+
+[project.scripts]
+better_report_compare = "pytest_better_report.compare:main"

pytest_better_report-1.0.0/pytest_better_report/__init__.py

@@ -0,0 +1,3 @@
+from pytest_better_report.const import EXECUTION_RESULTS_FILENAME, LOGGER_NAME, TEST_RESULTS_FILENAME
+
+__all__ = ["EXECUTION_RESULTS_FILENAME", "LOGGER_NAME", "TEST_RESULTS_FILENAME"]

pytest_better_report-1.0.0/pytest_better_report/compare.py

@@ -0,0 +1,191 @@
+"""
+CLI tool to compare two better-report JSON log files.
+
+Checks if all pytest_test_name entries are equal, lists missing tests from each file,
+and for matching tests compares their test_status and lists all diffs.
+
+Usage:
+    python better_report_compare.py -a <file_a.json> -b <file_b.json> [--fail-on-diff]
+"""
+
+import json
+import os
+import sys
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any
+
+from python_base_command import BaseCommand, CommandError, CommandParser
+
+PASS_SYMBOL = "✓"
+FAIL_SYMBOL = "✗"
+DIFF_SYMBOL = "≠"
+
+SEP = "─" * 100
+
+
+def _log_missing(missing: list[str], source: str, target: str) -> None:
+    if missing:
+        print(f"\n{FAIL_SYMBOL}  Tests in {source} but MISSING from {target}  ({len(missing)})")
+        for name in missing:
+            print(f"     - {name}")
+    else:
+        print(f"\n{PASS_SYMBOL}  No tests missing from {target}")
+
+
+def _log_status_diffs(status_diffs: list[tuple[str, str, str]]) -> None:
+    if status_diffs:
+        col_w = max(len(name) for name, _, _ in status_diffs)
+        print(f"\n{DIFF_SYMBOL}  Status differences in common tests  ({len(status_diffs)})")
+        print(f"     {'TEST NAME':<{col_w}}  {'STATUS IN A':<12}  STATUS IN B")
+        print("     " + "-" * (col_w + 28))
+        for name, s_a, s_b in status_diffs:
+            print(f"     {name:<{col_w}}  {s_a:<12}  {s_b}")
+    else:
+        print(f"\n{PASS_SYMBOL}  All common tests have identical statuses")
+
+
+@dataclass(frozen=True)
+class ComparisonSummary:
+    file_a: Path
+    file_b: Path
+    total_a: int
+    total_b: int
+    common_count: int
+    only_in_a: list[str]
+    only_in_b: list[str]
+    status_diffs: list[tuple[str, str, str]]
+    test_file_name: str | None = None
+
+    @property
+    def identical(self) -> bool:
+        return not (self.only_in_a or self.only_in_b or self.status_diffs)
+
+
+def _log_summary(summary: ComparisonSummary) -> None:
+    print(f"\n{SEP}")
+    print("  BETTER-REPORT COMPARISON")
+    print(SEP)
+    print(f"  File A : {summary.file_a}")
+    print(f"  File B : {summary.file_b}")
+    if summary.test_file_name:
+        print(f"  Filter : test_file_name = {summary.test_file_name}")
+    print(f"  Tests  : {summary.total_a} in A  |  {summary.total_b} in B  |  {summary.common_count} in common")
+    print(SEP)
+
+    _log_missing(summary.only_in_a, source="A", target="B")
+    _log_missing(summary.only_in_b, source="B", target="A")
+    _log_status_diffs(summary.status_diffs)
+
+    print(f"\n{SEP}")
+    if not summary.identical:
+        print("  RESULT: DIFFERENCES FOUND")
+    else:
+        print("  RESULT: REPORTS ARE IDENTICAL")
+    print(f"{SEP}\n")
+
+
+def load_report(path: Path, test_file_name: str | None = None) -> dict[str, dict]:
+    with open(path) as f:
+        raw = json.load(f)
+    indexed: dict[str, dict] = {}
+    for entry in raw.values():
+        if test_file_name and entry.get("test_file_name") != test_file_name:
+            continue
+        if pytest_name := entry.get("pytest_test_name"):
+            indexed[pytest_name] = entry
+    return indexed
+
+
+def compare_reports(file_a: Path, file_b: Path, test_file_name: str | None = None) -> bool:
+    report_a = load_report(file_a, test_file_name)
+    report_b = load_report(file_b, test_file_name)
+
+    names_a = set(report_a.keys())
+    names_b = set(report_b.keys())
+
+    only_in_a = sorted(names_a - names_b)
+    only_in_b = sorted(names_b - names_a)
+    common = sorted(names_a & names_b)
+
+    status_diffs = [
+        (name, report_a[name]["test_status"], report_b[name]["test_status"])
+        for name in common
+        if report_a[name].get("test_status") != report_b[name].get("test_status")
+    ]
+
+    summary = ComparisonSummary(
+        file_a=file_a,
+        file_b=file_b,
+        total_a=len(names_a),
+        total_b=len(names_b),
+        common_count=len(common),
+        only_in_a=only_in_a,
+        only_in_b=only_in_b,
+        status_diffs=status_diffs,
+        test_file_name=test_file_name,
+    )
+    _log_summary(summary=summary)
+    return summary.identical
+
+
+class Command(BaseCommand):
+    help = "Compare two better-report JSON log files for test coverage and status differences."
+    version = "1.0.0"
+
+    def add_arguments(self, parser: CommandParser) -> None:
+        parser.add_argument(
+            "-a",
+            "--file-a",
+            type=Path,
+            required=True,
+            help="Path to the first better-report JSON file.",
+        )
+        parser.add_argument(
+            "-b",
+            "--file-b",
+            type=Path,
+            required=True,
+            help="Path to the second better-report JSON file.",
+        )
+        parser.add_argument(
+            "--fail-on-diff",
+            action="store_true",
+            default=False,
+            help="Exit with non-zero code if any differences are found.",
+        )
+        parser.add_argument(
+            "--test-file-name",
+            type=str,
+            required=False,
+            default=None,
+            help="Filter comparison to tests belonging to this test_file_name "
+            "(e.g. test_advertiser_services_missing.py).",
+        )
+
+    def handle(self, **kwargs: Any) -> None:
+        file_a: Path = kwargs["file_a"]
+        file_b: Path = kwargs["file_b"]
+        fail_on_diff: bool = kwargs["fail_on_diff"]
+        test_file_name: str | None = kwargs.get("test_file_name")
+
+        for label, path in (("A", file_a), ("B", file_b)):
+            if not path.exists():
+                raise FileNotFoundError(f"File {label} not found: {path}")
+
+        identical = compare_reports(file_a, file_b, test_file_name)
+
+        if fail_on_diff and not identical:
+            raise CommandError("Reports have differences.")
+
+
+def main() -> None:
+    """Entry point: run the compare command from CLI."""
+    print('Starting "Better Report Compare"')
+
+    os.environ["PYTHON_BASE_COMMAND_LOG_FILE"] = "false"
+    Command().run_from_argv(argv=sys.argv)
+
+
+if __name__ == "__main__":
+    main()

pytest_better_report-1.0.0/pytest_better_report/const.py

@@ -0,0 +1,8 @@
+LOGGER_NAME = "pytest_better_report"
+
+EXECUTION_RESULTS_FILENAME = "execution_results.json"
+TEST_RESULTS_FILENAME = "test_results.json"
+MD_REPORT_FILENAME = "test_report.md"
+OUTPUT_DIR_NAME = "results_output"
+
+REPORTER_PLUGIN_NAME = "better-report-reporter"

pytest_better_report-1.0.0/pytest_better_report/models/__init__.py

@@ -0,0 +1,5 @@
+from pytest_better_report.models.execution_data import ExecutionData
+from pytest_better_report.models.status import ExecutionStatus
+from pytest_better_report.models.test_data import TestData
+
+__all__ = ["ExecutionStatus", "ExecutionData", "TestData"]

pytest_better_report-1.0.0/pytest_better_report/models/environment_data.py

@@ -0,0 +1,7 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class EnvironmentData:
+    python_version: str | None
+    platform: str | None

pytest_better_report-1.0.0/pytest_better_report/models/execution_data.py

@@ -0,0 +1,20 @@
+from dataclasses import dataclass
+
+from pytest_better_report.models.status import ExecutionStatus
+
+
+@dataclass
+class ExecutionData:
+    execution_status: ExecutionStatus
+    revision: str | None
+    execution_start_time: str | None = None
+    execution_end_time: str | None = None
+    execution_duration_sec: str | None = None
+
+    repo_name: str | None = None
+    pull_request_number: str | None = None
+    merge_request_number: str | None = None
+    pipeline_number: str | None = None
+    commit: str | None = None
+
+    test_list: list | None = None

pytest_better_report-1.0.0/pytest_better_report/models/status.py

@@ -0,0 +1,13 @@
+from enum import StrEnum
+
+
+class ExecutionStatus(StrEnum):
+    COLLECTED = "collected"
+    STARTED = "started"
+    PENDING = "pending"
+    PASSED = "passed"
+    FAILED = "failed"
+    XFAIL = "xfailed"
+    XPASS = "xpassed"
+    CANCELLED = "cancelled"
+    SKIPPED = "skipped"

pytest_better_report-1.0.0/pytest_better_report/models/test_data.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass
+
+from pytest_better_report.models.status import ExecutionStatus
+
+
+@dataclass
+class TestData:
+    __test__ = False  # a data model, not a test class (stops pytest from trying to collect it)
+
+    test_file_name: str
+    class_test_name: str | None
+    test_name: str
+    pytest_test_name: str
+    test_full_name: str
+    test_full_path: str
+    test_status: ExecutionStatus = ExecutionStatus.COLLECTED
+    test_parameters: dict[str, object] | None = None
+    test_markers: list | None = None
+    test_start_time: str | None = None
+    test_end_time: str | None = None
+    test_duration_sec: float | None = None  # only for the tst itself, not including fixtures
+    exception_message: dict | None = None
+    run_index: int | None = None
+    test_user_properties: dict[str, object] | None = None