monkeypatch fixture in PyTest - Build an Automation Script

Test function behavior with monkeypatched environment variable

Preconditions (2)

Step 1: Use the monkeypatch fixture to set the environment variable 'API_KEY' to 'test123'

Step 2: Call the function that reads 'API_KEY'

Step 3: Verify the function returns 'test123'

✅ Expected Result: The function returns the monkeypatched environment variable value 'test123'

Automation Requirements - pytest

Assertions Needed:

Assert the function returns the monkeypatched environment variable value

Best Practices:

Use the monkeypatch fixture parameter in the test function

Patch environment variables using monkeypatch.setenv

Keep tests isolated and independent

Automated Solution

PyTest

import os
import pytest

def get_api_key():
    return os.getenv('API_KEY')


def test_get_api_key(monkeypatch):
    # Use monkeypatch to set environment variable
    monkeypatch.setenv('API_KEY', 'test123')
    # Call the function that reads the environment variable
    result = get_api_key()
    # Assert the returned value matches the monkeypatched value
    assert result == 'test123'

This test uses pytest's monkeypatch fixture to temporarily set the environment variable API_KEY to test123. The function get_api_key reads this environment variable using os.getenv. The test then asserts that the function returns the monkeypatched value.

Using monkeypatch.setenv ensures the environment variable is only changed during this test and restored afterward, keeping tests isolated and reliable.

Common Mistakes - 3 Pitfalls

{'mistake': 'Not using the monkeypatch fixture parameter in the test function', 'why_bad': 'Without the fixture parameter, monkeypatch methods cannot be used, causing errors.', 'correct_approach': "Always include 'monkeypatch' as a parameter in the test function to access the fixture."}

Setting environment variables globally instead of using monkeypatch

Not asserting the expected value after monkeypatching

Bonus Challenge

Now add data-driven testing with 3 different environment variable values

Show Hint

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