pytest-bdd-report 1.2.2

A pytest-bdd plugin for generating useful and informative BDD test reports

The pytest-bdd-report plugin is a useful extension for the pytest-bdd library that allows you to generate useful and informative reports for BDD (Behavior-Driven Development) tests developed using the pytest-bdd framework. This plugin facilitates the generation of clear and effective HTML reports, providing a comprehensible view of BDD test executions within the project.

For more, check out the Documentation

---

This pytest plugin was generated with Cookiecutter along with @hackebrot’s cookiecutter-pytest-plugin template.

Features

• Detailed BDD Reports: The pytest-bdd-report plugin enables the generation of detailed reports for BDD tests executed using pytest-bdd. These reports clearly show the executed steps, tested scenarios, and obtained results.

• HTML Format: The generated reports are presented in an intuitive and interactive HTML format. This allows developers, testers, and other team members to easily view the status of BDD tests.

• Easy Installation: Installing the plugin is simple and fast. You can install it using the command pip install pytest-bdd-report.

Requirements

• Jinja2

• pytest

• pytest-bdd

Installation

1. Ensure that you have pytest and pytest-bdd installed in your development environment.

2. Open a terminal window.

3. Execute the following command to install the pytest-bdd-report plugin via pip from PyPI

$ pip install pytest-bdd-report

Usage

Once installed, you can generate BDD reports in an HTML file using the following command:

$ pytest --bdd-report="report.html"

Attach a screenshot to the HTML report generated by pytest-bdd-report, by using the provided attach.screenshot() method.

This helper function lets you attach screenshots either from raw bytes (e.g. page.screenshot() in Playwright) or from a file path on disk. The screenshot will automatically appear inside the corresponding Feature → Scenario section of the final report.

Example with Playwright

from pytest_bdd_report import attach

@pytest.hookimpl(hookwrapper=True)
def pytest_bdd_step_error(request, feature, scenario, step, step_func, step_func_args, exception):
    yield
    for fixture in step_func_args.values():
        page = getattr(fixture, "page", None)
        if page:
            # Attach screenshot from bytes
            screenshot_bytes = page.screenshot()

            attach.screenshot(screenshot_bytes, feature.name, scenario.name) # pytest-bdd-report code to attach the screenshot

            # Attach screenshot from image path
            screenshot_path = "screenshot_path/test.png"
            page.screenshot(path=screenshot_path)

            attach.screenshot(screenshot_path, feature.name, scenario.name) # pytest-bdd-report code to attach the screenshot

Parameters

Parameter	Type	Description
image	bytes | str | Path	Screenshot content. Can be raw bytes or a file path to the image to attach.
feature_name	str	The name of the feature to which the screenshot belongs.
scenario_name	str	The name of the scenario to which the screenshot belongs.

Run tests

To run tests:

1. Create a virtual environment

2. Install the required packages:

$ pip install -r requirements.txt
$ playwright install

3. Install the plugin locally:

$ pip install -e .

4. Run the unit tests:

$ python -m pytest --ignore=tests/bdd/

5. Run the BDD UI tests with pytest-bdd:

$ python -m pytest tests/bdd

6. Want a report for the Playwright BDD tests? use the –bdd-report flag!

$ python -m pytest tests/bdd --bdd-report="report.html"

Contributing

Contributions are very welcome. Tests can be run with pytest as shown.

License

Distributed under the terms of the MIT license, “pytest-bdd-report” is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.