pytest-bdd-report

================= pytest-bdd-report

|python| |pypi| |formatting| |tests| |ui_tests|

|mstats| |total|

.. |total| image:: https://static.pepy.tech/badge/pytest-bdd-report :target: https://pepy.tech/project/pytest-bdd-report :alt: PePy total downloads

.. |pypi| image:: https://img.shields.io/pypi/v/pytest-bdd-report.svg :target: https://pypi.org/project/pytest-bdd-report :alt: PyPI version

.. |python| image:: https://img.shields.io/pypi/pyversions/pytest-bdd-report.svg :target: https://pypi.org/project/pytest-bdd-report :alt: Python versions

.. |formatting| image:: https://img.shields.io/github/actions/workflow/status/mattiamonti/pytest-bdd-report/automated%20tests.yml?logo=GitHub%20actions&label=Formatting :alt: GitHub Workflow Status (with event)

.. |tests| image:: https://img.shields.io/github/actions/workflow/status/mattiamonti/pytest-bdd-report/automated%20tests.yml?logo=pytest&label=Tests :alt: GitHub Workflow Status (with event)

.. |ui_tests| image:: https://img.shields.io/github/actions/workflow/status/mattiamonti/pytest-bdd-report/ui%20automated%20tests.yml?logo=robotframework&label=UI%20Tests :alt: GitHub Workflow Status (with event)

.. |mstats| image:: https://img.shields.io/pypi/dm/pytest-bdd-report :alt: PyPI - Downloads

.. |dstats| image:: https://img.shields.io/pypi/dd/pytest-bdd-report :alt: PyPI - 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

3. Install the plugin locally:

::

$ pip install -e .

4. Run the unit tests:

::

$ python -m pytest

5. 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.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _@hackebrot: https://github.com/hackebrot .. _MIT: http://opensource.org/licenses/MIT .. _BSD-3: http://opensource.org/licenses/BSD-3-Clause .. _GNU GPL v3.0: http://www.gnu.org/licenses/gpl-3.0.txt .. _Apache Software License 2.0: http://www.apache.org/licenses/LICENSE-2.0 .. _cookiecutter-pytest-plugin: https://github.com/pytest-dev/cookiecutter-pytest-plugin .. _file an issue: https://github.com/mattiamonti/pytest-bdd-report/issues .. _pytest: https://github.com/pytest-dev/pytest .. _tox: https://tox.readthedocs.io/en/latest/ .. _pip: https://pypi.org/project/pip/ .. _PyPI: https://pypi.org/project .. _pytest-bdd: https://github.com/pytest-dev/pytest-bdd .. _Documentation: https://mattia-monti.gitbook.io/pytest-bdd-report/