capfd for file descriptors in PyTest - Framework Patterns

Framework Mode - capfd for file descriptors

Folder Structure

tests/
├── test_example.py
├── conftest.py
utilities/
├── file_helpers.py
pytest.ini

This structure keeps tests separate from utility code. tests/ holds test files using capfd. conftest.py can hold shared fixtures.

Test Framework Layers

• Test Layer: Test functions in tests/ use capfd to capture output from file descriptors (stdout, stderr).
• Utility Layer: Helper functions to process or validate captured output in utilities/.
• Configuration Layer: pytest.ini and conftest.py for test settings and fixtures.

Configuration Patterns

• pytest.ini to configure pytest options like test paths and markers.
• conftest.py for shared fixtures, e.g., setup for tests that use capfd.
• Use environment variables or pytest command line options to switch test modes if needed.

Test Reporting and CI/CD Integration

• Use pytest's built-in reporting with --tb=short for concise tracebacks.
• Integrate with CI tools (GitHub Actions, Jenkins) to run tests automatically on code push.
• Generate JUnit XML reports with --junitxml=report.xml for CI dashboards.
• Capture capfd output in test logs for debugging failed tests.

Best Practices

• Use capfd fixture to capture output from file descriptors (stdout, stderr) safely and cleanly.
• Keep tests small and focused on one behavior, asserting on captured output clearly.
• Use utility functions to parse or normalize captured output to avoid duplication.
• Do not rely on print statements outside tests; use logging with configurable levels for production code.
• Run tests in isolation to avoid output interference between tests.

Self Check

Where in this folder structure would you add a new test that verifies error messages printed to stderr using capfd?

Key Result

Use pytest's capfd fixture in tests/ to capture and assert file descriptor output cleanly and reliably.