monkeypatch.chdir in PyTest - Build an Automation Script

Test function behavior after changing current working directory using monkeypatch.chdir

Preconditions (2)

Step 1: Use monkeypatch.chdir to change the current working directory to a temporary directory

Step 2: Call the function that returns the current working directory

Step 3: Verify that the returned directory path matches the temporary directory path

✅ Expected Result: The function returns the temporary directory path set by monkeypatch.chdir

Automation Requirements - pytest

Assertions Needed:

Assert that the function returns the temporary directory path after monkeypatch.chdir

Best Practices:

Use pytest's monkeypatch fixture to change directories

Use tmp_path fixture to create a temporary directory

Keep tests isolated and clean up automatically

Automated Solution

PyTest

import os
import pytest

def get_current_directory():
    return os.getcwd()


def test_monkeypatch_chdir(monkeypatch, tmp_path):
    # Change current directory to tmp_path
    monkeypatch.chdir(tmp_path)
    # Call the function that returns current directory
    current_dir = get_current_directory()
    # Assert it matches tmp_path
    assert current_dir == str(tmp_path), f"Expected {tmp_path}, got {current_dir}"

This test uses pytest's monkeypatch.chdir to temporarily change the current working directory to a tmp_path provided by pytest.

The get_current_directory function returns the current directory using os.getcwd().

After changing the directory, the test asserts that the returned directory matches the temporary directory path.

This ensures the function behaves correctly when the working directory changes.

Common Mistakes - 3 Pitfalls

Not using monkeypatch.chdir and instead using os.chdir directly

{'mistake': 'Not using tmp_path fixture and hardcoding directory paths', 'why_bad': 'Hardcoded paths may not exist on all machines and can cause tests to fail or be non-portable.', 'correct_approach': "Use pytest's tmp_path fixture to create a reliable temporary directory for testing."}

Not asserting the directory path as a string

Bonus Challenge

Now add data-driven testing with 3 different temporary directories and verify the function returns each correctly

Show Hint

Practice

1. What is the main purpose of using monkeypatch.chdir in pytest tests?

easy

A. To temporarily change the current working directory during a test

B. To permanently change the system's default directory

C. To mock HTTP requests in tests

D. To patch environment variables permanently

Solution

1. Step 1: Understand the role of monkeypatch in pytest

   Monkeypatch is used to temporarily modify or replace parts of the system during tests without permanent changes.

2. Step 2: Focus on the chdir method

   monkeypatch.chdir specifically changes the current working directory only for the duration of the test.

3. Final Answer:

   To temporarily change the current working directory during a test -> Option A

4. Quick Check:

   monkeypatch.chdir = temporary directory change [OK]

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

Common Mistakes:

• Thinking it changes directories permanently
• Confusing with mocking HTTP requests
• Using it to patch environment variables permanently

2. Which of the following is the correct syntax to change the current directory to '/tmp' using monkeypatch in a pytest test function?

easy

A. monkeypatch.chdir('/tmp')

B. monkeypatch.chdir = '/tmp'

C. monkeypatch.change_dir('/tmp')

D. monkeypatch.chdir('/tmp', permanent=True)

Solution

1. Step 1: Recall the method name and usage

   The correct method to change directory temporarily is monkeypatch.chdir(path).

2. Step 2: Check each option for syntax correctness

   Assignment like chdir = '/tmp' is incorrect; it must be called as a function. change_dir is the wrong method name. Adding permanent=True is unsupported.

3. Final Answer:

   monkeypatch.chdir('/tmp') -> Option A

4. Quick Check:

   Correct method call = monkeypatch.chdir(path) [OK]

Hint: Use monkeypatch.chdir(path) exactly as a function call [OK]

Common Mistakes:

• Assigning instead of calling the method
• Using wrong method names like change_dir
• Adding unsupported arguments

3. Given the following pytest test code, what will be the output of print(os.getcwd()) inside the test?

import os

def test_change_dir(monkeypatch):
    original_dir = os.getcwd()
    monkeypatch.chdir('/tmp')
    print(os.getcwd())
    assert os.getcwd() != original_dir

medium

A. original_dir value

B. /tmp

C. Raises FileNotFoundError

D. Empty string

Solution

1. Step 1: Understand what monkeypatch.chdir does

   It temporarily changes the current working directory to the given path during the test.

2. Step 2: Analyze the print statement after monkeypatch.chdir

   Since monkeypatch.chdir('/tmp') is called, os.getcwd() will return '/tmp' inside the test.

3. Final Answer:

   /tmp -> Option B

4. Quick Check:

   os.getcwd() after monkeypatch.chdir('/tmp') = '/tmp' [OK]

Hint: After monkeypatch.chdir(path), os.getcwd() returns path [OK]

Common Mistakes:

• Expecting original directory instead of changed one
• Thinking it raises an error if directory exists
• Assuming it returns empty string

4. Identify the error in this pytest test using monkeypatch.chdir:

import os

def test_dir_change(monkeypatch):
    monkeypatch.chdir('/nonexistent')
    assert os.getcwd() == '/nonexistent'

medium

A. assert statement syntax is incorrect

B. monkeypatch.chdir should be called without arguments

C. The directory '/nonexistent' may not exist, causing an error

D. os.getcwd() cannot be used inside tests

Solution

1. Step 1: Check the directory path used in monkeypatch.chdir

   The path '/nonexistent' likely does not exist on the system, which causes an error when changing directory.

2. Step 2: Understand monkeypatch.chdir behavior with invalid paths

   It tries to change directory and will raise FileNotFoundError if the path is invalid.

3. Final Answer:

   The directory '/nonexistent' may not exist, causing an error -> Option C

4. Quick Check:

   Invalid path in monkeypatch.chdir causes error [OK]

Hint: Ensure directory exists before monkeypatch.chdir call [OK]

Common Mistakes:

• Thinking monkeypatch.chdir works without a valid path
• Believing os.getcwd() is invalid in tests
• Misreading assert syntax

5. You want to test a function that reads a file named 'data.txt' in the current directory. How can you use monkeypatch.chdir to test this function with a temporary test folder '/tmp/testfolder' containing 'data.txt' without affecting other tests?

hard

A. Copy 'data.txt' to the original directory and run the test there

B. Change directory globally before running all tests

C. Use monkeypatch.chdir('/tmp/testfolder') and set permanent=True

D. Use monkeypatch.chdir('/tmp/testfolder') inside the test to change directory temporarily

Solution

1. Step 1: Understand the need for isolation in tests

   Tests should not affect global state or other tests, so changing directory temporarily is best.

2. Step 2: Use monkeypatch.chdir to change directory only during the test

   Calling monkeypatch.chdir('/tmp/testfolder') changes the current directory only inside the test, isolating file access.

3. Final Answer:

   Use monkeypatch.chdir('/tmp/testfolder') inside the test to change directory temporarily -> Option D

4. Quick Check:

   Temporary directory change isolates test file access [OK]

Hint: Use monkeypatch.chdir(path) to isolate file-based tests [OK]

Common Mistakes:

• Changing directory globally affecting other tests
• Copying files unnecessarily
• Using unsupported permanent argument