Skip to content

mattiamonti/pytest-bdd-report

Repository files navigation

pytest-bdd-report

Python versions PyPI version GitHub Workflow Status (with event) GitHub Workflow Status (with event) GitHub Workflow Status (with event)

PyPI - Downloads PePy total downloads

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"

Run tests

To run tests:

  1. Create a virtual environment
  2. Install the required packages:
$ pip install -r requirements.txt
  1. Install the plugin locally:
$ pip install -e .
  1. Run the unit tests:
$ python -m pytest
  1. Run the UI tests with Robot Framework:
$ cd tests/ui_testing
$ ./execute_all_ui_tests.sh

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.