Skip to main content

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

Project description

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

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.


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

  • TODO

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 the plugin is installed, you can generate BDD reports in an HTML file using the command

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

In alternative you can save only the raw tests informations in a JSON file using the command

$ pytest --bdd-json

Contributing

Contributions are very welcome. Tests can be run with pytest, please ensure the coverage at least stays the same before you submit a pull request.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_bdd_report-1.0.0.tar.gz (19.7 kB view hashes)

Uploaded Source

Built Distribution

pytest_bdd_report-1.0.0-py3-none-any.whl (29.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page