Skip to main content

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

Project description

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.

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.3.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

pytest_bdd_report-1.0.3-py3-none-any.whl (29.9 kB view details)

Uploaded Python 3

File details

Details for the file pytest_bdd_report-1.0.3.tar.gz.

File metadata

  • Download URL: pytest_bdd_report-1.0.3.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for pytest_bdd_report-1.0.3.tar.gz
Algorithm Hash digest
SHA256 814f16bb28a5995aeb76b52ce9a5453ea9d75536b5b509f7ba621ec1e43f852a
MD5 d18c8985981a7f40489a3e0ded7a186c
BLAKE2b-256 9593883bdaf32b888f620e1738bc80736924a9feb864ca0e3b7714e28f90c6ba

See more details on using hashes here.

File details

Details for the file pytest_bdd_report-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_bdd_report-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9291b6de4337a16c3f4349527c38ed44e4a9cfcf522f0e61be4569bb765b24e7
MD5 c87a28e24ac0c000dc118ef3ec2a7dd3
BLAKE2b-256 a1e1ac9bd771e249bad0fcbe5fbd18d22c85c3735f9a2d8e383e3bf250118d46

See more details on using hashes here.

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