Assert with messages in PyTest - Framework Patterns

Framework Mode - Assert with messages

Folder Structure

test_project/
├── tests/
│   ├── test_example.py
│   └── test_login.py
├── utils/
│   └── helpers.py
├── conftest.py
└── pytest.ini

This structure keeps tests separate from utility code and configuration.

Test Framework Layers

• Tests: Located in tests/, contain test functions using assert with messages.
• Utilities: Helper functions in utils/ to support tests.
• Configuration: pytest.ini and conftest.py manage test settings and fixtures.

Assertions with messages help explain failures clearly.

Configuration Patterns

• pytest.ini defines test markers and default options.
• conftest.py provides fixtures for setup and teardown.
• Use environment variables or pytest command-line options to select browsers or environments.
• Credentials can be stored securely and accessed via fixtures.

Test Reporting and CI/CD Integration

• Pytest outputs test results with assertion messages on failure.
• Use plugins like pytest-html for readable HTML reports including assertion messages.
• Integrate with CI/CD tools (GitHub Actions, Jenkins) to run tests automatically and collect reports.
• Assertion messages help quickly identify why a test failed in reports.

Best Practices

1. Always add clear, concise messages to assertions to explain the expected outcome.
2. Keep assertion messages simple and focused on what failed.
3. Use assert statements directly in pytest; no need for extra assert functions.
4. Combine assertion messages with test names for better readability in reports.
5. Use fixtures to prepare test data so assertions focus only on validation.

Self Check

Where in this folder structure would you add a new assertion message for a test checking user login success?

Key Result

Use clear assertion messages in pytest tests to explain failures and improve test reports.