monkeypatch fixture in PyTest - Framework Patterns

Framework Mode - monkeypatch fixture

Folder Structure for Pytest Project Using monkeypatch

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

Test Framework Layers

• Source Code Layer (src/): Contains application code to be tested.
• Test Layer (tests/): Contains test files using pytest, including tests that use the monkeypatch fixture to replace parts of the code during tests.
• Fixtures and Config (conftest.py): Defines shared fixtures and setup code, including reusable monkeypatch setups if needed.
• Configuration (pytest.ini): Holds pytest configuration options like markers and test paths.
• Utilities (optional): Helper functions or mocks used in tests.

Configuration Patterns

Use pytest.ini to configure pytest behavior, such as test discovery and markers.

Use conftest.py to define fixtures that can be shared across tests, including custom monkeypatch setups.

For environment-specific settings or credentials, use environment variables accessed via os.environ and patch them with monkeypatch.setenv() during tests.

Example: monkeypatch.setattr() to replace functions or methods temporarily during a test run.

Test Reporting and CI/CD Integration

• Use pytest's built-in reporting with --junitxml=report.xml to generate XML reports for CI tools.
• Integrate with CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests automatically on code changes.
• Use pytest plugins like pytest-html for readable HTML reports.
• Ensure monkeypatch usage does not affect other tests by proper scoping and cleanup (pytest handles this automatically).

Best Practices for Using monkeypatch Fixture

• Use monkeypatch to replace external dependencies or environment variables to isolate tests.
• Keep monkeypatching limited to the scope of a single test to avoid side effects.
• Prefer patching at the lowest possible level (e.g., patch functions or methods rather than entire modules).
• Use monkeypatch.setenv() to safely modify environment variables during tests.
• Write clear test names and comments explaining what is being patched and why.

Self Check

Where in this folder structure would you add a new monkeypatch fixture that mocks a database connection for multiple tests?

Key Result

Use pytest's monkeypatch fixture in tests/ with scoped patches to isolate and control dependencies during test runs.

Practice

1. What is the primary purpose of the monkeypatch fixture in pytest?

easy

A. To temporarily replace parts of the code during tests

B. To permanently change the source code

C. To speed up the pytest installation

D. To generate test reports automatically

Solution

1. Step 1: Understand monkeypatch usage

   The monkeypatch fixture is used to temporarily replace or modify parts of the code during test execution.

2. Step 2: Differentiate temporary vs permanent changes

   It does not permanently change source code but only affects the test runtime environment.

3. Final Answer:

   To temporarily replace parts of the code during tests -> Option A

4. Quick Check:

   Temporary code replacement = B [OK]

Hint: Remember monkeypatch changes code only during tests [OK]

Common Mistakes:

• Thinking monkeypatch changes code permanently
• Confusing monkeypatch with test report tools
• Assuming monkeypatch speeds up pytest installation

2. Which of the following is the correct way to use monkeypatch to replace a function get_data in a module my_module?

easy

A. monkeypatch.replace('my_module.get_data', lambda: 'mocked')

B. monkeypatch.setattr(my_module.get_data, lambda: 'mocked')

C. monkeypatch.setattr('my_module.get_data', lambda: 'mocked')

D. monkeypatch.patch('my_module.get_data', lambda: 'mocked')

Solution

1. Step 1: Recall monkeypatch syntax

   The correct method to replace an attribute or function is monkeypatch.setattr(target, value) where target is a string path.

2. Step 2: Identify correct target format

   The target must be a string like 'my_module.get_data', not the function object itself.

3. Final Answer:

   monkeypatch.setattr('my_module.get_data', lambda: 'mocked') -> Option C

4. Quick Check:

   Use setattr with string target = A [OK]

Hint: Use setattr with string path to replace functions [OK]

Common Mistakes:

• Passing function object instead of string path
• Using non-existent monkeypatch methods like replace or patch
• Confusing monkeypatch with unittest.mock syntax

3. Given the code below, what will be the output of the test?

def get_value():
    return 10

def test_value(monkeypatch):
    monkeypatch.setattr('__main__.get_value', lambda: 5)
    assert get_value() == ?

medium

A. 10

B. 5

C. AssertionError

D. TypeError

Solution

1. Step 1: Understand monkeypatch effect on get_value

   The monkeypatch replaces get_value in the __main__ module with a lambda returning 5.

2. Step 2: Evaluate the assertion

   Calling get_value() now returns 5, so assert get_value() == 5 passes.

3. Final Answer:

   5 -> Option B

4. Quick Check:

   Patched function returns 5 = A [OK]

Hint: Patched function returns new value, not original [OK]

Common Mistakes:

• Expecting original return value 10
• Thinking monkeypatch causes error
• Confusing module path for patching

4. What is wrong with this test code using monkeypatch?

def test_env(monkeypatch):
    monkeypatch.setenv('API_KEY')
    assert os.getenv('API_KEY') is None

medium

A. monkeypatch cannot patch environment variables

B. os.getenv cannot be used in tests

C. assertion should check for empty string, not None

D. setenv requires two arguments: key and value

Solution

1. Step 1: Check monkeypatch.setenv usage

   The setenv method requires both a key and a value to set an environment variable.

2. Step 2: Identify missing argument

   Here, only the key 'API_KEY' is given, missing the value argument.

3. Final Answer:

   setenv requires two arguments: key and value -> Option D

4. Quick Check:

   setenv needs key and value = C [OK]

Hint: Always provide key and value to setenv [OK]

Common Mistakes:

• Calling setenv with only one argument
• Assuming os.getenv is not usable in tests
• Thinking monkeypatch can't patch env variables

5. You want to test a function that reads a config file using open. How can you use monkeypatch to avoid reading a real file and instead provide fake content?

hard

A. Use monkeypatch.setattr to replace builtins.open with a function returning a StringIO with fake data

B. Use monkeypatch.setenv to set a fake file path environment variable

C. Use monkeypatch.setitem to replace the file path in a dictionary

D. Use monkeypatch.delattr to delete the open function

Solution

1. Step 1: Identify how to fake file reading

   Replacing open with a function returning a StringIO object simulates file reading without disk access.

2. Step 2: Use monkeypatch.setattr on builtins.open

   Monkeypatch can replace builtins.open with a lambda or function returning StringIO containing fake content.

3. Final Answer:

   Use monkeypatch.setattr to replace builtins.open with a function returning a StringIO with fake data -> Option A

4. Quick Check:

   Patch open with StringIO = D [OK]

Hint: Patch builtins.open with StringIO for fake file content [OK]

Common Mistakes:

• Trying to delete open instead of replacing it
• Using setenv which doesn't fake file reading
• Replacing dictionary keys instead of open function