Single responsibility per test in PyTest - Framework Patterns

Framework Mode - Single responsibility per test

Folder Structure

project-root/
├── tests/
│   ├── test_login.py
│   ├── test_registration.py
│   └── test_profile_update.py
├── src/
│   ├── app/
│   │   ├── __init__.py
│   │   └── user.py
│   └── utils/
│       └── helpers.py
├── conftest.py
├── pytest.ini
└── requirements.txt
    

Test Framework Layers

• Test Cases Layer: Individual test functions in tests/ folder, each testing one specific behavior or feature.
• Fixtures Layer: conftest.py provides setup and teardown code reusable across tests.
• Application Code Layer: src/app/ contains the main application logic being tested.
• Utilities Layer: src/utils/ holds helper functions to support tests and app code.
• Configuration Layer: pytest.ini configures pytest options and markers.

Configuration Patterns

• pytest.ini: Configure markers, test paths, and addopts for verbosity or parallel runs.
• conftest.py: Define fixtures for environment setup, like database connections or test data.
• Environment Variables: Use os.environ or pytest command line options to switch between test environments (dev, staging, prod).
• Secrets Management: Store credentials securely outside code, inject via environment variables or CI secrets.

Test Reporting and CI/CD Integration

• Use pytest built-in reports with --junitxml=report.xml to generate XML reports readable by CI tools.
• Integrate with CI pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests on each commit or pull request.
• Fail fast on test failures to quickly catch issues.
• Use pytest plugins like pytest-html for human-friendly HTML reports.

Best Practices for Single Responsibility per Test

1. One Assert per Test: Each test should verify one behavior or outcome to keep failures clear.
2. Clear Test Names: Name tests to describe exactly what they check, e.g., test_login_with_valid_credentials.
3. Isolate Tests: Avoid dependencies between tests; each test should run independently.
4. Use Fixtures for Setup: Keep test code focused on assertions by moving setup to fixtures.
5. Keep Tests Small: Short tests are easier to read, maintain, and debug.

Self Check

Where in this framework structure would you add a new test that checks the password reset feature with a single responsibility?

Key Result

Each test function should focus on one specific behavior to keep tests clear and maintainable.

Practice

1. What is the main reason to write a test with a single responsibility in pytest?

easy

A. To run all tests faster at once

B. To make the test easier to understand and fix when it fails

C. To combine many checks in one test for efficiency

D. To avoid writing multiple test functions

Solution

1. Step 1: Understand test clarity

   Tests with one responsibility focus on one behavior, making it clear what failed.

2. Step 2: Benefits of single responsibility

   This clarity helps developers quickly find and fix issues without confusion.

3. Final Answer:

   To make the test easier to understand and fix when it fails -> Option B

4. Quick Check:

   Single responsibility = clarity and easier fixes [OK]

Hint: One test, one check, easy to read and fix [OK]

Common Mistakes:

• Trying to test many things in one test
• Ignoring test readability
• Using unclear test names

2. Which of the following pytest test function names best follows the single responsibility principle?

easy

A. test_user_login_and_profile_update

B. test_all_user_functions

C. test_user_login_with_valid_credentials

D. test_user_actions

Solution

1. Step 1: Analyze test names for specificity

   Names should describe one clear behavior or feature being tested.

2. Step 2: Compare options

   test_user_login_with_valid_credentials clearly states it tests login with valid credentials only, so it has a single responsibility.

3. Final Answer:

   test_user_login_with_valid_credentials -> Option C

4. Quick Check:

   Clear, specific test name = single responsibility [OK]

Hint: Pick the test name that describes one clear action [OK]

Common Mistakes:

• Using vague or combined test names
• Testing multiple features in one test
• Ignoring descriptive naming

3. Given this pytest code, what will be the test result?

def test_example():
    x = 5
    assert x == 5
    assert x > 0

medium

A. Test passes because both assertions are true

B. Test fails because multiple assertions are not allowed

C. Test fails because x is not defined

D. Test passes but only the first assertion is checked

Solution

1. Step 1: Check variable and assertions

   Variable x is set to 5, which satisfies both assertions: x == 5 and x > 0.

2. Step 2: Understand pytest assertion behavior

   Pytest allows multiple assertions; all are checked unless one fails first. Here both pass.

3. Final Answer:

   Test passes because both assertions are true -> Option A

4. Quick Check:

   All assertions true = test passes [OK]

Hint: Check each assertion truth; all must pass for test pass [OK]

Common Mistakes:

• Thinking multiple assertions cause failure
• Assuming only first assertion runs
• Confusing variable scope

4. Identify the problem in this pytest test function that violates single responsibility:

def test_user():
    assert login('user') == True
    assert update_profile('user', 'new info') == True

medium

A. The test has syntax errors

B. The test uses invalid function calls

C. The test misses setup code

D. The test checks two different features in one function

Solution

1. Step 1: Review test actions

   The test checks login and profile update in the same function, two separate features.

2. Step 2: Understand single responsibility principle

   Each test should check only one behavior to keep tests clear and focused.

3. Final Answer:

   The test checks two different features in one function -> Option D

4. Quick Check:

   Multiple features in one test = violation [OK]

Hint: One test, one feature; multiple features break single responsibility [OK]

Common Mistakes:

• Ignoring multiple assertions as multiple responsibilities
• Assuming syntax errors cause failure here
• Confusing setup with test logic

5. You have a test that checks user registration, login, and logout all in one function. How should you refactor it to follow single responsibility in pytest?

hard

A. Split the test into three separate tests: one for registration, one for login, and one for logout

B. Keep all checks in one test but add comments to separate them

C. Remove login and logout checks and test only registration

D. Combine registration and login in one test, logout in another

Solution

1. Step 1: Identify responsibilities in the test

   The test currently checks three different user actions: registration, login, and logout.

2. Step 2: Apply single responsibility principle

   Each test should focus on one action to improve clarity and maintainability.

3. Step 3: Refactor approach

   Splitting into three tests ensures each test checks only one feature clearly.

4. Final Answer:

   Split the test into three separate tests: one for registration, one for login, and one for logout -> Option A

5. Quick Check:

   One test per feature = better clarity and easier fixes [OK]

Hint: Split combined tests into single-feature tests [OK]

Common Mistakes:

• Keeping multiple features in one test with comments
• Removing features instead of splitting
• Partially splitting tests inconsistently