Why mocking isolates code under test in PyTest - Framework Benefits

Framework Mode - Why mocking isolates code under test

Folder Structure

project-root/
├── tests/
│   ├── test_service.py
│   ├── test_repository.py
│   └── __init__.py
├── src/
│   ├── service.py
│   ├── repository.py
│   └── __init__.py
├── conftest.py
├── pytest.ini
└── requirements.txt

Test Framework Layers

• Source Code Layer (src/): Contains the application code such as service.py and repository.py.
• Test Layer (tests/): Contains test files like test_service.py that test the source code.
• Mocking Layer: Uses unittest.mock or pytest-mock to replace real dependencies with mocks during tests.
• Configuration Layer: pytest.ini and conftest.py manage test settings and fixtures.

Configuration Patterns

• Environment Handling: Use pytest.ini or environment variables to set test environment (e.g., dev, staging).
• Mock Setup: Use fixtures in conftest.py to provide reusable mocks for dependencies.
• Credentials: Store sensitive data outside code, inject via environment variables or secure vaults.
• Browser or External Services: Mock external calls to isolate tests from network or UI dependencies.

Test Reporting and CI/CD Integration

• Use pytest built-in reporting with options like --junitxml=report.xml for CI tools.
• Integrate with CI/CD pipelines (GitHub Actions, Jenkins) to run tests on each commit.
• Mocking ensures tests run fast and reliably by isolating code under test from external systems.
• Reports show which tests passed or failed, helping quickly identify issues.

Best Practices for Mocking to Isolate Code Under Test

• Mock Only External Dependencies: Replace calls to databases, APIs, or other services, not the code you want to test.
• Keep Tests Focused: Test one unit of code at a time by isolating it with mocks.
• Use Fixtures for Reusability: Define mocks in fixtures to avoid repetition and improve clarity.
• Verify Behavior: Use assertions to check that mocks were called as expected, confirming correct interaction.
• Avoid Over-Mocking: Mock only what is necessary to keep tests meaningful and maintainable.

Self Check

In the folder structure shown, where would you add a mock for an external API used by service.py?

Key Result

Mocking replaces external dependencies to isolate and test code units independently.