pytest-timeout for time limits - Framework Patterns

Framework Mode - pytest-timeout for time limits

Folder Structure

project-root/
├── tests/
│   ├── test_example.py
│   ├── test_login.py
│   └── __init__.py
├── conftest.py
├── pytest.ini
├── requirements.txt
└── utils/
    └── helpers.py
  

Test Framework Layers

• Tests: Located in tests/, contain test functions using pytest syntax.
• Fixtures & Hooks: Defined in conftest.py for setup and teardown.
• Utilities: Helper functions in utils/ to keep tests clean.
• Configuration: pytest.ini to configure pytest and plugins like pytest-timeout.

Configuration Patterns

Use pytest.ini to set global timeout for tests with pytest-timeout plugin.

[pytest]
addopts = --timeout=5
timeout_method = thread
  

Override timeout per test using decorator:

import pytest

@pytest.mark.timeout(10)
def test_long_running():
    # test code here
    pass
  

Manage environment variables and credentials securely using conftest.py fixtures or external config files.

Test Reporting and CI/CD Integration

• Use pytest's built-in reporting with --junitxml=report.xml for CI systems.
• Timeout failures appear as test failures with clear timeout error messages.
• Integrate with CI tools (GitHub Actions, Jenkins) to run tests with time limits enforced.
• Use pytest plugins like pytest-html for readable HTML reports showing timeout results.

Best Practices

1. Set reasonable global timeout to catch hanging tests early.
2. Use per-test timeout overrides for tests known to take longer.
3. Prefer thread timeout method for compatibility and safety.
4. Keep test code clean by using fixtures for setup and teardown.
5. Integrate timeout failures clearly in CI reports for quick debugging.

Self Check

Where would you add a new test that requires a 15-second timeout override in this framework structure?

Key Result

Use pytest-timeout plugin configured in pytest.ini and per-test decorators to enforce time limits on tests.

Practice

1. What is the main purpose of using pytest-timeout in test cases?

easy

A. To stop tests that run longer than a specified time limit

B. To increase the speed of test execution by skipping tests

C. To automatically retry failed tests

D. To generate detailed test coverage reports

Solution

1. Step 1: Understand pytest-timeout functionality

   pytest-timeout is designed to stop tests that exceed a time limit to prevent long waits.

2. Step 2: Compare options with pytest-timeout purpose

   Only To stop tests that run longer than a specified time limit matches this purpose; others describe different pytest features.

3. Final Answer:

   To stop tests that run longer than a specified time limit -> Option A

4. Quick Check:

   pytest-timeout stops long tests = C [OK]

Hint: Remember: pytest-timeout stops tests running too long [OK]

Common Mistakes:

• Confusing timeout with test retries
• Thinking it speeds up tests by skipping
• Mixing it with coverage reporting

2. Which of the following is the correct way to set a 5-second timeout for a test function using pytest-timeout?

easy

A. @pytest.mark.timeout(seconds=5)
def test_example(): pass

B. @pytest.timeout(5)
def test_example(): pass

C. @pytest.mark.timeout(5)
def test_example(): pass

D. @pytest.timeout(seconds=5)
def test_example(): pass

Solution

1. Step 1: Recall correct pytest-timeout decorator syntax

   The correct decorator is @pytest.mark.timeout(5) using a positional argument.

2. Step 2: Check each option's syntax

   @pytest.mark.timeout(5) def test_example(): pass uses correct syntax with positional argument 5. @pytest.mark.timeout(seconds=5) def test_example(): pass incorrectly uses keyword argument 'seconds=5'. The options using @pytest.timeout use wrong decorator names.

3. Final Answer:

   @pytest.mark.timeout(5) def test_example(): pass -> Option C

4. Quick Check:

   Use @pytest.mark.timeout(5) = A [OK]

Hint: Use @pytest.mark.timeout(5) to set 5 seconds [OK]

Common Mistakes:

• Using @pytest.timeout instead of @pytest.mark.timeout
• Passing seconds as a keyword argument
• Missing the @pytest.mark prefix

3. Given the following test code, what will happen when running pytest?

@pytest.mark.timeout(2)
def test_sleep():
    import time
    time.sleep(3)

medium

A. The test will pass because sleep is allowed

B. The test will raise a syntax error

C. The test will be skipped automatically

D. The test will fail due to exceeding the 2-second timeout

Solution

1. Step 1: Analyze the timeout and sleep duration

   The test has a 2-second timeout but sleeps for 3 seconds, exceeding the limit.

2. Step 2: Understand pytest-timeout behavior on timeout

   pytest-timeout stops the test and marks it as failed if it runs longer than the timeout.

3. Final Answer:

   The test will fail due to exceeding the 2-second timeout -> Option D

4. Quick Check:

   Sleep 3s > timeout 2s = fail [OK]

Hint: If test runs longer than timeout, it fails [OK]

Common Mistakes:

• Assuming test passes despite timeout
• Thinking test is skipped automatically
• Confusing timeout with syntax errors

4. Identify the error in the following pytest test using pytest-timeout:

@pytest.mark.timeout(3)
def test_loop():
    for i in range(5):
        time.sleep(1)

medium

A. Timeout value is too low for the loop

B. Missing import of the time module

C. Incorrect decorator syntax

D. The test will pass without errors

Solution

1. Step 1: Check for missing imports

   The test uses time.sleep(1) but does not import the time module.

2. Step 2: Verify other aspects

   The timeout and decorator syntax are correct. The missing import will cause a NameError.

3. Final Answer:

   Missing import of the time module -> Option B

4. Quick Check:

   Using time.sleep without import = error [OK]

Hint: Always import modules before using their functions [OK]

Common Mistakes:

• Ignoring missing imports
• Assuming timeout causes error instead
• Thinking decorator syntax is wrong

5. You want to apply a 10-second timeout to all tests in a pytest file without adding @pytest.mark.timeout to each test. Which is the best way to do this?

hard

A. Add pytestmark = pytest.mark.timeout(10) at the top of the test file

B. Set timeout=10 in pytest.ini configuration file

C. Use @pytest.mark.timeout(10) on a dummy test and inherit it

D. Add timeout=10 as a command line argument every time

Solution

1. Step 1: Understand pytestmark usage

   Setting pytestmark = pytest.mark.timeout(10) applies the timeout decorator to all tests in the file automatically.

2. Step 2: Evaluate other options

   Adding timeout as a command line argument requires specifying --timeout=10 every time pytest is run; setting timeout in pytest.ini applies it globally to all tests in the project; using a dummy test for inheritance is not a valid pytest feature. pytestmark is best for this specific file.

3. Final Answer:

   Add pytestmark = pytest.mark.timeout(10) at the top of the test file -> Option A

4. Quick Check:

   pytestmark applies decorator to all tests [OK]

Hint: Use pytestmark variable to apply timeout to all tests [OK]

Common Mistakes:

• Trying to set timeout in pytest.ini (global, not file-specific)
• Using dummy test inheritance (not valid)
• Relying on command line timeout argument (inconvenient)