test-report-vibes 0.2.0__tar.gz

test_report_vibes-0.2.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Oscar Barrios Torrero
+
+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.
+

test_report_vibes-0.2.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: test-report-vibes
+Version: 0.2.0
+Summary: Deterministic HTML summaries of Cucumber test reports
+Author-email: Oscar Barrios Torrero <srbarrios@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/srbarrios/test-report-vibes
+Project-URL: Issues, https://github.com/srbarrios/test-report-vibes/issues
+Keywords: cucumber,testing,report,html
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: ruff>=0.3.0; extra == "dev"
+Dynamic: license-file
+
+# Test Report Vibes
+
+<img width="150" src="https://github.com/user-attachments/assets/2d347d22-b88e-472f-8416-595caaed4524" />
+
+
+**Deterministic HTML summaries of Cucumber test reports.**
+
+`test-report-vibes` turns Cucumber JSON output into a focused, self-contained HTML report so you can quickly review what failed and why.
+
+## What it does
+
+- Filters report data to failing, undefined, and pending steps
+- Keeps scenario context (all steps), plus optional screenshots from embeddings/hooks
+- Groups issues by feature and includes pass/fail stats across the full run
+- Builds a deterministic executive summary (no external AI/LLM calls)
+- Optionally classifies failing scenarios by tags such as `@new_issue` and `@flaky`
+
+## Installation
+
+From source:
+
+```bash
+git clone https://github.com/srbarrios/test-report-vibes.git
+cd test-report-vibes
+pip install -e .
+```
+
+## Quick start
+
+```bash
+test-report-vibes examples/sample_report_with_classifiers.json
+```
+
+This creates `examples/sample_report_with_classifiers.html`.
+
+## CLI usage
+
+```text
+test-report-vibes [OPTIONS] INPUT_FILE
+
+Arguments:
+  INPUT_FILE              Path to Cucumber JSON report [required]
+
+Options:
+  -o, --output PATH       Output HTML file path (default: INPUT_FILE.html)
+  -v, --verbose           Verbose output with detailed exception trace on errors
+  --no-classify           Skip the tag-based classification section
+  --help                  Show this message and exit
+```
+
+Examples:
+
+```bash
+# Default output path: INPUT_FILE.html
+test-report-vibes cucumber-report.json
+
+# Custom output file
+test-report-vibes cucumber-report.json -o report-summary.html
+
+# Disable tag-based classification section
+test-report-vibes cucumber-report.json --no-classify
+
+# Run as module
+python -m test_report_vibes cucumber-report.json
+```
+
+## Input format
+
+The tool expects standard Cucumber JSON (root array of features). At minimum, each feature should include:
+
+- `uri`, `id`, `name`, `keyword`, `elements`
+
+Steps support these statuses:
+
+- `passed`, `failed`, `skipped`, `pending`, `undefined`
+
+Screenshots are supported through base64 embeddings with image mime types (for example `image/png`) on steps and hooks.
+
+## Output report highlights
+
+Generated HTML includes:
+
+- Overall run dashboard (passed/failed/skipped feature percentages)
+- Executive summary cards such as:
+  - Most impacted features
+  - Recurring normalized error patterns
+  - Top error types
+  - Framework gaps (undefined/pending steps)
+  - Slowest failing scenarios and steps
+- Failing features with collapsible scenario details
+- Full step context including status, duration, location, and error text
+- Embedded screenshots when present
+- Optional "Classified features" section from tag-based mapping
+
+## Tag-based classification
+
+When classification is enabled (default), statuses are derived from tags in this priority order:
+
+- `@new_issue` -> `New and reported`
+- `@under_debugging` -> `Debugging`
+- `@bug_reported` -> `Bug reported`
+- `@test_issue` -> `Test Framework issue`
+- `@flaky` -> `Flaky Test`
+- no match -> `Not reported`
+
+## Sample Report
+
+Check out a live example of the generated report:
+
+[View Sample Report](https://srbarrios.github.io/test-report-vibes/examples/sample_report_with_classifiers.html)
+
+## Development
+
+Install dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+Format and lint:
+
+```bash
+black src/
+ruff check src/
+```
+
+## License
+
+This project is licensed under the MIT License. See `LICENSE` for details.
+

test_report_vibes-0.2.0/README.md

@@ -0,0 +1,136 @@
+# Test Report Vibes
+
+<img width="150" src="https://github.com/user-attachments/assets/2d347d22-b88e-472f-8416-595caaed4524" />
+
+
+**Deterministic HTML summaries of Cucumber test reports.**
+
+`test-report-vibes` turns Cucumber JSON output into a focused, self-contained HTML report so you can quickly review what failed and why.
+
+## What it does
+
+- Filters report data to failing, undefined, and pending steps
+- Keeps scenario context (all steps), plus optional screenshots from embeddings/hooks
+- Groups issues by feature and includes pass/fail stats across the full run
+- Builds a deterministic executive summary (no external AI/LLM calls)
+- Optionally classifies failing scenarios by tags such as `@new_issue` and `@flaky`
+
+## Installation
+
+From source:
+
+```bash
+git clone https://github.com/srbarrios/test-report-vibes.git
+cd test-report-vibes
+pip install -e .
+```
+
+## Quick start
+
+```bash
+test-report-vibes examples/sample_report_with_classifiers.json
+```
+
+This creates `examples/sample_report_with_classifiers.html`.
+
+## CLI usage
+
+```text
+test-report-vibes [OPTIONS] INPUT_FILE
+
+Arguments:
+  INPUT_FILE              Path to Cucumber JSON report [required]
+
+Options:
+  -o, --output PATH       Output HTML file path (default: INPUT_FILE.html)
+  -v, --verbose           Verbose output with detailed exception trace on errors
+  --no-classify           Skip the tag-based classification section
+  --help                  Show this message and exit
+```
+
+Examples:
+
+```bash
+# Default output path: INPUT_FILE.html
+test-report-vibes cucumber-report.json
+
+# Custom output file
+test-report-vibes cucumber-report.json -o report-summary.html
+
+# Disable tag-based classification section
+test-report-vibes cucumber-report.json --no-classify
+
+# Run as module
+python -m test_report_vibes cucumber-report.json
+```
+
+## Input format
+
+The tool expects standard Cucumber JSON (root array of features). At minimum, each feature should include:
+
+- `uri`, `id`, `name`, `keyword`, `elements`
+
+Steps support these statuses:
+
+- `passed`, `failed`, `skipped`, `pending`, `undefined`
+
+Screenshots are supported through base64 embeddings with image mime types (for example `image/png`) on steps and hooks.
+
+## Output report highlights
+
+Generated HTML includes:
+
+- Overall run dashboard (passed/failed/skipped feature percentages)
+- Executive summary cards such as:
+  - Most impacted features
+  - Recurring normalized error patterns
+  - Top error types
+  - Framework gaps (undefined/pending steps)
+  - Slowest failing scenarios and steps
+- Failing features with collapsible scenario details
+- Full step context including status, duration, location, and error text
+- Embedded screenshots when present
+- Optional "Classified features" section from tag-based mapping
+
+## Tag-based classification
+
+When classification is enabled (default), statuses are derived from tags in this priority order:
+
+- `@new_issue` -> `New and reported`
+- `@under_debugging` -> `Debugging`
+- `@bug_reported` -> `Bug reported`
+- `@test_issue` -> `Test Framework issue`
+- `@flaky` -> `Flaky Test`
+- no match -> `Not reported`
+
+## Sample Report
+
+Check out a live example of the generated report:
+
+[View Sample Report](https://srbarrios.github.io/test-report-vibes/examples/sample_report_with_classifiers.html)
+
+## Development
+
+Install dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+Format and lint:
+
+```bash
+black src/
+ruff check src/
+```
+
+## License
+
+This project is licensed under the MIT License. See `LICENSE` for details.
+

test_report_vibes-0.2.0/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "test-report-vibes"
+version = "0.2.0"
+description = "Deterministic HTML summaries of Cucumber test reports"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    {name = "Oscar Barrios Torrero", email = "srbarrios@gmail.com"}
+]
+keywords = ["cucumber", "testing", "report", "html"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Testing",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+dependencies = [
+    "click>=8.1.0",
+    "pydantic>=2.0.0",
+    "jinja2>=3.1.0",
+    "rich>=13.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-cov>=4.1.0",
+    "black>=24.0.0",
+    "ruff>=0.3.0",
+]
+
+[project.scripts]
+test-report-vibes = "test_report_vibes.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/srbarrios/test-report-vibes"
+Issues = "https://github.com/srbarrios/test-report-vibes/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools]
+license-files = ["LICENSE"]
+
+[tool.black]
+line-length = 100
+target-version = ["py310", "py311", "py312"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]

test_report_vibes-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

test_report_vibes-0.2.0/src/test_report_vibes/__init__.py

@@ -0,0 +1,26 @@
+"""Test Report Vibes - deterministic HTML summaries of Cucumber test reports."""
+
+__version__ = "0.2.0"
+__author__ = "Test Report Vibes Contributors"
+__description__ = "Deterministic HTML summaries of Cucumber test reports"
+
+from .parser import parse_cucumber_json
+from .filter import filter_issues, calculate_summary_stats, group_issues_by_feature
+from .html_generator import generate_html_report, build_default_executive_summary
+from .classifier import classify_features, build_classification_summary_html
+from .models import Feature, Scenario, Step, FilteredIssue
+
+__all__ = [
+    "parse_cucumber_json",
+    "filter_issues",
+    "calculate_summary_stats",
+    "group_issues_by_feature",
+    "generate_html_report",
+    "build_default_executive_summary",
+    "classify_features",
+    "build_classification_summary_html",
+    "Feature",
+    "Scenario",
+    "Step",
+    "FilteredIssue",
+]

test_report_vibes-0.2.0/src/test_report_vibes/__main__.py

@@ -0,0 +1,6 @@
+"""Entry point for running test-report-vibes as a module."""
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()

test_report_vibes-0.2.0/src/test_report_vibes/classifier.py

@@ -0,0 +1,187 @@
+"""Tag-based issue classification for Cucumber test results.
+
+Classifies failing scenarios by their tags and highlights the first failing
+scenario per feature as the most important one to review.
+"""
+
+import html
+from typing import Dict, List, Any, Optional
+
+# Default mapping from Cucumber tags to human-readable status labels.
+# Priority is determined by order: the first matching tag wins.
+DEFAULT_TAG_MAPPING: Dict[str, str] = {
+    "@new_issue": "New and reported",
+    "@under_debugging": "Debugging",
+    "@bug_reported": "Bug reported",
+    "@test_issue": "Test Framework issue",
+    "@flaky": "Flaky Test",
+}
+
+NOT_REPORTED = "Not reported"
+
+
+def classify_status(tags: List[str], tag_mapping: Optional[Dict[str, str]] = None) -> str:
+    """Return a human-readable status for a set of tags.
+
+    Iterates through *tags* in order and returns the label of the first tag
+    present in *tag_mapping*.  Falls back to ``"Not reported"``.
+    """
+    mapping = tag_mapping or DEFAULT_TAG_MAPPING
+    for tag in tags:
+        if tag in mapping:
+            return mapping[tag]
+    return NOT_REPORTED
+
+
+def classify_features(
+    feature_groups: List[Dict[str, Any]],
+    tag_mapping: Optional[Dict[str, str]] = None,
+) -> Dict[str, Any]:
+    """Classify every failing feature group.
+
+    For each feature group (as produced by ``filter.group_issues_by_feature``),
+    determines:
+
+    * The *first* failing scenario (by position / line number) — this is the
+      most important one to review because later scenarios may cascade.
+    * A classification status derived from the combined feature + scenario tags
+      using ``classify_status``.
+
+    Returns a dict with:
+        ``classified_features`` – list of per-feature classification dicts
+        ``status_counts``       – breakdown ``{status_label: count}``
+        ``total_failed_features`` – number of features with failures
+        ``total_failed_scenarios`` – total failing scenarios across all features
+    """
+    mapping = tag_mapping or DEFAULT_TAG_MAPPING
+
+    classified: List[Dict[str, Any]] = []
+    status_counts: Dict[str, int] = {}
+    total_failed_scenarios = 0
+
+    for group in feature_groups:
+        feature_name: str = group.get("feature_name", "Unknown Feature")
+        feature_tags: List[str] = group.get("feature_tags", [])
+        scenarios: List[Dict[str, Any]] = group.get("scenarios", [])
+
+        first_failing: Optional[Dict[str, Any]] = None
+
+        for scenario in scenarios:
+            # Check if this scenario actually has failures (not just a passing scenario added for context)
+            has_failures = (
+                scenario.get("failed_steps", 0) > 0 or
+                scenario.get("undefined_steps", 0) > 0 or
+                scenario.get("pending_steps", 0) > 0
+            )
+
+            if not has_failures:
+                continue  # Skip passing scenarios
+
+            total_failed_scenarios += 1
+
+            # Merge feature + scenario tags for classification
+            all_tags = feature_tags + scenario.get("tags", [])
+            status = classify_status(all_tags, mapping)
+
+            # Count every failing scenario by status
+            status_counts[status] = status_counts.get(status, 0) + 1
+
+            # The first scenario in the list is by definition the earliest
+            # (group_issues_by_feature sorts by line number).
+            if first_failing is None:
+                first_failing = {
+                    "scenario_name": scenario.get("name", "Unnamed Scenario"),
+                    "status": status,
+                    "tags": all_tags,
+                }
+
+        # Count only scenarios with actual failures
+        failing_count = sum(
+            1 for s in scenarios
+            if s.get("failed_steps", 0) > 0 or s.get("undefined_steps", 0) > 0 or s.get("pending_steps", 0) > 0
+        )
+
+        classified.append({
+            "feature_name": feature_name,
+            "first_failing": first_failing,
+            "failing_scenario_count": failing_count,
+        })
+
+    return {
+        "classified_features": classified,
+        "status_counts": status_counts,
+        "total_failed_features": len(classified),
+        "total_failed_scenarios": total_failed_scenarios,
+    }
+
+
+# ---------------------------------------------------------------------------
+# HTML rendering
+# ---------------------------------------------------------------------------
+
+_STATUS_COLORS: Dict[str, str] = {
+    "New and reported": "#9cf3af",
+    "Debugging": "#3b89f6",
+    "Bug reported": "#ef0000",
+    "Test Framework issue": "#8989ff",
+    "Flaky Test": "#f59e0b",
+    NOT_REPORTED: "#efbb85",
+}
+
+
+def _status_color(status: str) -> str:
+    return _STATUS_COLORS.get(status, "#6b7280")
+
+
+def build_classification_summary_html(classification: Dict[str, Any]) -> str:
+    """Render an HTML ``<section>`` with the tag-based classification summary.
+
+    The section has CSS class ``classification-summary`` and is designed to sit
+    alongside (but independently of) the executive summary.
+    """
+    classified = classification["classified_features"]
+    status_counts = classification["status_counts"]
+    total_features = classification["total_failed_features"]
+    total_scenarios = classification["total_failed_scenarios"]
+
+    if total_features == 0:
+        return (
+            '<section class="classification-summary">'
+            "<h2>Classified features</h2>"
+            "<p>No failing features to classify.</p>"
+            "</section>"
+        )
+
+    # --- Feature list (first failing scenario only) ---
+    list_items = []
+    for entry in classified:
+        fname = html.escape(entry["feature_name"])
+        first = entry.get("first_failing")
+        if first:
+            sname = html.escape(first["scenario_name"])
+            sstatus = html.escape(first["status"])
+            color = _status_color(first["status"])
+            list_items.append(
+                f"<li>"
+                f"<strong>{fname}</strong>"
+                f'<ul><li><span class="cls-pill" style="background:{color};">'
+                f"{sstatus}</span> {sname}</li></ul>"
+                f"</li>"
+            )
+        else:
+            list_items.append(f"<li><strong>{fname}</strong></li>")
+
+    features_html = "\n".join(list_items)
+
+    return (
+        '<section class="classification-summary">\n'
+        "<h2>Classified features</h2>\n"
+        f"<p><strong>Failed Features:</strong> {total_features}</p>\n"
+        f"<p><strong>Failed Scenarios:</strong> {total_scenarios}</p>\n"
+        '<p style="margin-bottom:0.25rem;color:var(--color-text-light);font-size:0.875rem;">'
+        "The first failing scenario in each feature is usually the most important to review, "
+        "later failures may cascade from it.</p>\n"
+        f"<ul>{features_html}</ul>\n"
+        "</section>"
+    )
+