pytest-enhanced-reports

A pytest plugin to capture screenshots, videos and JS logs (similar to Cypress) and attach them to supported test reports.

Support

Python

• >= 3.7

Browsers

• Fully supported - Chromium based browsers - Chrome, Edge, Brave, Opera, Vivaldi, etc
• Planned in the future - Firefox, Safari

Reporting

• Fully supported - allure-pytest-bdd
• Planned in the future - pytest-html, pytest-testrail-client

Installation

pip install pytest-enhanced-reports

Usage

Setup

The plugin needs a code change to be able to capture data from the webdriver instance. Usually, this is just a few lines added to the webdriver initialization logic.

Before plugin integration

@pytest.fixture
def driver():
    driver = webdriver.Chrome()
    yield driver
    driver.quit()

After plugin integration

@pytest.fixture
def driver(enhance_driver):  # `enhance_driver` is a fixture provided by the plugin
    
    driver = webdriver.Chrome()

    enhanced_driver = None
    try:
        enhanced_driver = enhance_driver(driver)
    except Exception as e:
        logger.error(e)

    yield enhanced_driver if enhanced_driver else driver

    driver.quit()

Configuration

The plugin can be configured through command line arguments and/or environment variables. Either option can be used, but if both are provided for any configuration, the command line argument takes precedence over the environment variable.

The following sets of shell commands are equivalent and do the same thing. These examples ignore any configuration for all other plugins/dependencies.

# Using only command line arguments
pytest --report_screenshot_capture="error-only" --report_screenshot_dir="~/tests/screenshots" --report_browser_console_log_capture="on_failure"

# Using a combination of command line arguments and environment variables
REPORT_SCREENSHOT_DIR="~/tests/screenshots"
pytest --report_screenshot_capture="error-only"  --report_browser_console_log_capture="on_failure"

# Using only environment variables
REPORT_SCREENSHOT_CAPTURE="error-only"
REPORT_SCREENSHOT_DIR="~/tests/screenshots"
REPORT_BROWSER_CONSOLE_LOG_CAPTURE="on_failure"
pytest

The full list of configuration options are listed below.

Screenshots

Video Recording

Browser console outputs

Contributing

Just the standard fork, branch, commit, test, push, pull request workflow. Including specifics for the sake of documentation.

• Create a fork of the repo and clone the fork
• Install all dependencies from requirements.txt
• Make changes
• When committing changes, black and flake8 will be run automatically to ensure code quality
  • In case they don't run automatically, execute black . && flake8
  • black will automatically make changes to fix any issues it identifies, however the changes would need to be staged again and committed
  • Any problems highlighted by flake8 requires manual changes/adjustments
• Run the tests to ensure nothing broke
• Push changes, create a pull request