Matching exception messages in PyTest - Framework Patterns

Framework Mode - Matching exception messages

Folder Structure

tests/
├── test_example.py
├── test_utils.py
├── conftest.py
utilities/
├── helpers.py
configs/
├── config.yaml
reports/
├── latest_report.html

Test Framework Layers

• Tests Layer: Contains test files like test_example.py where tests assert exception messages using pytest.raises().
• Utilities Layer: Helper functions or custom assertion utilities to check exception messages precisely.
• Configuration Layer: Holds environment and test settings in configs/config.yaml or conftest.py fixtures.
• Reporting Layer: Generates test reports after execution, showing pass/fail and exception details.

Configuration Patterns

• Use conftest.py to define fixtures for test setup and teardown.
• Store environment-specific data (like error message templates) in configs/config.yaml.
• Use pytest command line options or environment variables to select test environments or verbosity.
• Configure pytest.ini or pyproject.toml for pytest options like markers and logging.

Test Reporting and CI/CD Integration

• Use pytest built-in reporting with --tb=short for concise tracebacks.
• Integrate with plugins like pytest-html to generate readable HTML reports showing exception messages.
• Configure CI pipelines (GitHub Actions, Jenkins) to run tests and publish reports automatically.
• Fail tests clearly when exception messages do not match expected patterns.

Best Practices

1. Use pytest.raises() context manager to catch exceptions and assert their messages.
2. Match exception messages using substring checks or regular expressions for flexibility.
3. Keep error message expectations in test code or external config for maintainability.
4. Write clear, descriptive assertion messages to help debugging when tests fail.
5. Use fixtures to share common setup for tests that check exceptions.

Self Check

Where in this folder structure would you add a helper function to validate exception messages with regex?

Key Result

Use pytest.raises() with message matching and clear folder layers for maintainable exception message testing.