Subprocess testing in PyTest - Framework Patterns

Framework Mode - Subprocess testing

Folder Structure

tests/
├── test_subprocess.py       # Tests for subprocess calls
├── conftest.py              # Shared fixtures and setup
utils/
├── subprocess_helper.py     # Helper functions to run subprocess commands
config/
├── config.yaml              # Environment and command configurations
reports/
├── pytest_report.html       # Generated test reports

Test Framework Layers

• Test Layer: tests/test_subprocess.py contains test cases that run subprocess commands and verify outputs.
• Helper Layer: utils/subprocess_helper.py has reusable functions to start subprocesses, capture output, and handle errors.
• Configuration Layer: config/config.yaml stores command parameters, environment variables, and settings for different environments.
• Fixtures Layer: conftest.py provides pytest fixtures for setup and teardown, like preparing environment variables.
• Reporting Layer: reports/ stores test execution reports generated by pytest plugins.

Configuration Patterns

• Use config.yaml to define commands, arguments, and environment variables for subprocess calls.
• Load configuration in conftest.py or helper modules to keep tests clean and flexible.
• Support multiple environments (e.g., dev, staging) by having separate config sections or files.
• Use environment variables or pytest command line options to select environment at runtime.
• Keep sensitive data like credentials out of code; use environment variables or secure vaults.

Test Reporting and CI/CD Integration

• Use pytest built-in reporting with options like --junitxml=reports/junit.xml for CI tools.
• Generate HTML reports with plugins like pytest-html for easy visualization.
• Integrate tests into CI pipelines (GitHub Actions, Jenkins) to run subprocess tests on code changes.
• Fail tests clearly when subprocess returns non-zero exit codes or unexpected output.
• Log subprocess stdout and stderr in reports for debugging.

Best Practices

1. Isolate subprocess calls: Use helper functions to run subprocesses and capture output cleanly.
2. Use explicit timeouts: Prevent hanging tests by setting timeouts on subprocess calls.
3. Check exit codes: Always assert subprocess exit codes to detect failures.
4. Mock subprocess in unit tests: For fast tests, mock subprocess calls to avoid real execution.
5. Keep tests independent: Each test should run subprocesses independently without side effects.

Self Check

Where would you add a new helper function to run a subprocess command with a timeout and capture its output?

Key Result

Organize subprocess tests with clear layers: tests, helpers, config, fixtures, and reporting for maintainable automation.