Installing and managing plugins in PyTest - Framework Setup Guide

Framework Mode - Installing and managing plugins

Folder Structure of a Pytest Project

pytest-project/
├── tests/
│   ├── test_example.py
│   └── test_login.py
├── plugins/
│   └── custom_plugin.py
├── conftest.py
├── pytest.ini
└── requirements.txt
  

Test Framework Layers

• Tests: Located in tests/ folder, contains test scripts like test_example.py.
• Plugins: Custom plugins placed in plugins/ folder or installed via pip.
• Configuration: pytest.ini for plugin settings and options.
• Fixtures & Hooks: Defined in conftest.py to share setup/teardown and extend pytest behavior.
• Dependencies: Managed in requirements.txt including plugins.

Configuration Patterns for Plugins

Use pytest.ini to enable and configure plugins. Example:

[pytest]
addopts = -ra -q
markers =
    smoke: quick smoke tests
    regression: full regression suite

# Plugin specific options
filterwarnings = ignore::DeprecationWarning
  

Install plugins via pip install and list them in requirements.txt:

pytest
pytest-cov
pytest-xdist
  

Use conftest.py to register hooks or fixtures that plugins can use or extend.

Test Reporting and CI/CD Integration

• Use plugins like pytest-html or pytest-cov for HTML reports and coverage reports.
• Configure reports in pytest.ini or command line options.
• Integrate pytest runs in CI/CD pipelines (GitHub Actions, Jenkins) by installing plugins and running tests with reporting options.
• Example command for CI: pytest --html=report.html --self-contained-html

Best Practices for Installing and Managing Plugins

• Keep plugins listed in requirements.txt for easy environment setup.
• Use pytest.ini to centralize plugin configurations and avoid command line clutter.
• Write custom plugins in plugins/ folder and register them via conftest.py if needed.
• Regularly update plugins to get bug fixes and new features.
• Test plugin compatibility when upgrading pytest or other dependencies.

Self Check

Where would you add a new custom plugin that provides extra test reporting features in this framework structure?

Key Result

Manage pytest plugins by installing via pip, configuring in pytest.ini, and organizing custom plugins in a dedicated folder with conftest.py hooks.

Practice

1. What is the primary purpose of plugins in pytest?

easy

A. To add extra features without changing pytest's core code

B. To replace pytest's core functionality completely

C. To uninstall pytest from the system

D. To write test cases automatically

Solution

1. Step 1: Understand what plugins do in pytest

   Plugins add new features or extend existing ones without modifying pytest's main code.

2. Step 2: Compare options with this understanding

   Only To add extra features without changing pytest's core code correctly describes this purpose; others describe unrelated or incorrect actions.

3. Final Answer:

   To add extra features without changing pytest's core code -> Option A

4. Quick Check:

   Plugins extend features = C [OK]

Hint: Plugins add features without changing core code [OK]

Common Mistakes:

• Thinking plugins replace pytest core
• Confusing plugins with uninstall commands
• Believing plugins auto-write tests

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

easy

A. pytest install pytest-cov

B. pip install pytest-cov

C. pip uninstall pytest-cov

D. pytest --install pytest-cov

Solution

1. Step 1: Identify the standard way to install Python packages

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

2. Step 2: Match the command to install pytest-cov

   Only pip install pytest-cov uses the correct pip install syntax; others are invalid commands.

3. Final Answer:

   pip install pytest-cov -> Option B

4. Quick Check:

   Use pip install for plugins = A [OK]

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

Common Mistakes:

• Using pytest commands to install plugins
• Confusing uninstall with install
• Adding extra flags not supported

3. What will be the output of the command pytest --trace-config when run in a project with plugins installed?

medium

A. The pytest version number only

B. An error saying the command is invalid

C. A list of all test cases found in the project

D. A list showing all active plugins and their configuration details

Solution

1. Step 1: Understand the purpose of pytest --trace-config

   This command shows detailed information about pytest's configuration, including active plugins and their settings.

2. Step 2: Evaluate the options based on this purpose

   A list showing all active plugins and their configuration details matches the expected output; others describe unrelated outputs or errors.

3. Final Answer:

   A list showing all active plugins and their configuration details -> Option D

4. Quick Check:

   --trace-config shows plugins = A [OK]

Hint: Use --trace-config to see active plugins and settings [OK]

Common Mistakes:

• Expecting test case list from --trace-config
• Thinking it shows version only
• Assuming command causes error

4. You tried to uninstall a pytest plugin using pip uninstall pytest-cov but the plugin still appears in pytest --trace-config. What is the most likely cause?

medium

A. The plugin cannot be uninstalled once installed

B. You need to restart your computer to complete uninstallation

C. You have multiple Python environments and uninstalled in the wrong one

D. The command should be pytest uninstall pytest-cov

Solution

1. Step 1: Understand Python environments and plugin installation

   Python packages can be installed in different environments (like virtualenvs). Uninstalling in one environment doesn't affect others.

2. Step 2: Analyze why plugin still appears after uninstall

   If the plugin still shows, likely it was uninstalled in a different environment than the one pytest uses.

3. Final Answer:

   You have multiple Python environments and uninstalled in the wrong one -> Option C

4. Quick Check:

   Multiple envs cause uninstall confusion = B [OK]

Hint: Check Python environment when uninstalling plugins [OK]

Common Mistakes:

• Believing plugins can't be uninstalled
• Thinking restart is needed
• Using wrong uninstall command

5. You want to install a plugin and ensure it is active for your pytest runs without affecting other projects. Which approach is best?

hard

A. Create a virtual environment, activate it, then run pip install plugin-name

B. Install the plugin globally using pip install plugin-name without a virtual environment

C. Copy plugin files manually into your project folder

D. Run pytest --install plugin-name inside your project

Solution

1. Step 1: Understand isolation of plugin installations

   Using a virtual environment keeps plugin installations isolated per project, avoiding conflicts.

2. Step 2: Evaluate installation methods

   Create a virtual environment, activate it, then run pip install plugin-name uses a virtual environment and pip install, which is best practice. Others either install globally or use invalid methods.

3. Final Answer:

   Create a virtual environment, activate it, then run pip install plugin-name -> Option A

4. Quick Check:

   Use virtualenv for isolated installs = D [OK]

Hint: Use virtualenv to isolate plugin installs per project [OK]

Common Mistakes:

• Installing plugins globally causing conflicts
• Trying to copy plugin files manually
• Using invalid pytest commands to install