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

Practice

1. Why do we use plugins with PyTest?

easy

A. To add extra features like better reports and integration

B. To make Python code run faster

C. To replace the Python interpreter

D. To write tests without any code

Solution

1. Step 1: Understand PyTest plugins purpose

   Plugins extend PyTest by adding new features such as improved reports and integration with other tools.

2. Step 2: Eliminate unrelated options

   Options about speeding Python or replacing the interpreter are unrelated to PyTest plugins.

3. Final Answer:

   To add extra features like better reports and integration -> Option A

4. Quick Check:

   Plugins add features [OK]

Hint: Plugins add features to PyTest, not change Python itself [OK]

Common Mistakes:

• Thinking plugins speed up Python code
• Confusing plugins with Python interpreter
• Believing plugins remove the need to write tests

2. Which command correctly installs a PyTest plugin named pytest-cov?

easy

A. pip install pytest-cov

B. pytest install pytest-cov

C. pip pytest install cov

D. install pytest-cov

Solution

1. Step 1: Recall standard Python package installation

   Python packages, including PyTest plugins, are installed using pip install package-name.

2. Step 2: Check each option's syntax

   Only pip install pytest-cov matches the correct syntax for installing a plugin.

3. Final Answer:

   pip install pytest-cov -> Option A

4. Quick Check:

   Use pip install for plugins [OK]

Hint: Use 'pip install plugin-name' to add PyTest plugins [OK]

Common Mistakes:

• Using pytest command to install plugins
• Mixing pip and pytest commands incorrectly
• Omitting 'pip' in the install command

3. What will be the output when running pytest --cov=my_module after installing pytest-cov plugin?

medium

A. Syntax error because --cov is invalid

B. PyTest runs tests but ignores coverage

C. PyTest runs tests and shows code coverage report for my_module

D. PyTest installs the plugin automatically

Solution

1. Step 1: Understand the effect of --cov option

   The --cov option is provided by the pytest-cov plugin to measure code coverage.

2. Step 2: Predict output after running the command

   With the plugin installed, PyTest runs tests and shows a coverage report for the specified module.

3. Final Answer:

   PyTest runs tests and shows code coverage report for my_module -> Option C

4. Quick Check:

   --cov shows coverage report [OK]

Hint: Installed plugins enable their options like --cov for coverage [OK]

Common Mistakes:

• Assuming --cov causes syntax error
• Thinking PyTest installs plugins automatically
• Believing coverage is ignored without plugin

4. You installed pytest-html plugin but running pytest --html=report.html gives an error. What is the likely cause?

medium

A. You must write HTML report code manually

B. Plugin not installed properly or missing dependencies

C. The command syntax is incorrect; --html is invalid

D. PyTest does not support HTML reports

Solution

1. Step 1: Understand plugin usage requirements

   Plugins like pytest-html require proper installation and dependencies to work.

2. Step 2: Analyze error cause

   If the command errors, it usually means the plugin is not installed correctly or dependencies are missing, not that PyTest lacks support.

3. Final Answer:

   Plugin not installed properly or missing dependencies -> Option B

4. Quick Check:

   Errors often mean plugin install issues [OK]

Hint: Check plugin installation and dependencies if options error [OK]

Common Mistakes:

• Assuming PyTest never supports HTML reports
• Thinking command syntax is wrong when plugin missing
• Believing manual HTML coding is needed for reports

5. You want to speed up your test suite by running tests in parallel. Which plugin should you install and how do you run tests using it?

hard

A. Install pytest-cov and run pytest --parallel=4

B. No plugin needed; PyTest runs tests in parallel by default

C. Install pytest-html and run pytest --html-parallel

D. Install pytest-xdist and run pytest -n 4 to run 4 tests in parallel

Solution

1. Step 1: Identify the plugin for parallel test execution

   pytest-xdist is the plugin that enables running tests in parallel.

2. Step 2: Understand the command to run tests in parallel

   Using pytest -n 4 runs tests using 4 parallel workers.

3. Final Answer:

   Install pytest-xdist and run pytest -n 4 to run 4 tests in parallel -> Option D

4. Quick Check:

   pytest-xdist + -n runs parallel tests [OK]

Hint: Use pytest-xdist and -n option for parallel tests [OK]

Common Mistakes:

• Confusing coverage or HTML plugins for parallelism
• Using wrong command options for parallel runs
• Assuming PyTest parallel runs without plugins