Why plugins extend PyTest capabilities - Automation Benefits in Action

Verify PyTest plugin extends test reporting

Preconditions (2)

Step 1: Create a simple test file with one passing test

Step 2: Run PyTest with the plugin enabled to generate an HTML report

Step 3: Open the generated report file

Step 4: Verify the report contains the test name and status

✅ Expected Result: The HTML report shows the test name and status, demonstrating the plugin extends PyTest reporting capabilities

Automation Requirements - pytest

Assertions Needed:

Verify test passes

Verify the HTML report file is created

Verify the report file contains the test name and status

Best Practices:

Use fixtures for setup and teardown if needed

Use pytest's built-in assertion rewriting

Use temporary directories for report files to avoid clutter

Automated Solution

PyTest

import os
import pytest

def test_sample():
    assert 1 + 1 == 2

@pytest.fixture(scope='session')
def report_path(tmp_path_factory):
    return tmp_path_factory.mktemp('reports') / 'report.html'

@pytest.mark.usefixtures('report_path')
def test_generate_report(report_path):
    # Run pytest programmatically with html plugin to generate report
    import subprocess
    result = subprocess.run([
        'pytest',
        '--html=' + str(report_path),
        '--self-contained-html',
        '--maxfail=1',
        '--disable-warnings'
    ], capture_output=True, text=True)
    # Check pytest run was successful
    assert result.returncode == 0, f"Pytest failed: {result.stdout} {result.stderr}"
    # Check report file exists
    assert os.path.exists(report_path), "Report file was not created"
    # Check report content includes test name and status
    with open(report_path, 'r', encoding='utf-8') as f:
        content = f.read()
    assert 'test_sample' in content, "Test name not found in report"
    assert 'passed' in content.lower(), "Test status 'passed' not found in report"

This script defines a simple test test_sample that always passes.

The report_path fixture creates a temporary directory for the HTML report to avoid cluttering the project folder.

The test_generate_report test runs PyTest programmatically with the pytest-html plugin enabled to generate an HTML report file.

Assertions check that PyTest ran successfully, the report file was created, and the report content includes the test name and the word 'passed'.

This shows how plugins extend PyTest by adding new features like HTML reporting, which is not available in PyTest by default.

Common Mistakes - 3 Pitfalls

{'mistake': 'Not installing the plugin before running tests', 'why_bad': "The plugin features won't be available, so the test will fail or not generate the expected report", 'correct_approach': "Ensure the plugin is installed using pip before running tests, e.g., 'pip install pytest-html'"}

Hardcoding report file paths in the project directory

{'mistake': 'Not checking the PyTest run return code', 'why_bad': "If PyTest fails, the test might still pass if you don't verify the run was successful", 'correct_approach': 'Check the subprocess return code to ensure PyTest completed without errors'}

Bonus Challenge

Now add data-driven testing with 3 different simple tests and verify the plugin reports all results

Show Hint