Testpaths configuration in PyTest - Framework Patterns

Framework Mode - Testpaths configuration

Folder Structure

tests/
├── unit/
│   ├── test_example1.py
│   └── test_example2.py
├── integration/
│   └── test_integration.py
├── e2e/
│   └── test_end_to_end.py
├── __init__.py
conftest.py
pytest.ini

Test Framework Layers

• Test Files: Organized under tests/ by type (unit, integration, e2e).
• Fixtures and Hooks: Defined in conftest.py for setup and teardown.
• Configuration: pytest.ini controls test discovery and testpaths.
• Utilities: Helper functions or modules can be placed in a utils/ folder if needed.

Configuration Patterns

Use pytest.ini to specify testpaths to tell pytest where to look for tests.

[pytest]
testpaths = tests/unit tests/integration

# This limits pytest to only look inside these folders for tests.

Other config options can include markers, addopts, and python_files patterns.

Use conftest.py for shared fixtures and environment setup.

Test Reporting and CI/CD Integration

• Use pytest plugins like pytest-html or pytest-cov for HTML reports and coverage reports.
• Configure CI pipelines (GitHub Actions, Jenkins, GitLab CI) to run pytest commands using the pytest.ini config.
• Reports can be saved as artifacts and viewed after test runs.
• Fail the build if tests fail to ensure quality gates.

Best Practices

1. Organize tests by type: Keep unit, integration, and e2e tests in separate folders for clarity.
2. Use testpaths in pytest.ini: This speeds up test discovery and avoids running unwanted files.
3. Keep conftest.py clean: Only put shared fixtures and hooks here to avoid confusion.
4. Use descriptive test file names: Start with test_ or end with _test.py for pytest to find them easily.
5. Integrate reporting in CI: Always generate readable reports and fail builds on test failures.

Self Check

Where would you add a new test file for API integration tests in this framework structure?

Key Result

Use pytest.ini's testpaths to control where pytest looks for tests, organizing tests clearly by type.

Practice

1. What is the main purpose of the testpaths setting in a pytest.ini file?

easy

A. To configure the test report format

B. To specify which folders pytest should look in for test files

C. To set the timeout for each test

D. To define the order in which tests run

Solution

1. Step 1: Understand the role of testpaths

   The testpaths setting tells pytest where to find test files by listing directories.

2. Step 2: Compare with other options

   Other options like test order, timeout, or report format are configured differently, not with testpaths.

3. Final Answer:

   To specify which folders pytest should look in for test files -> Option B

4. Quick Check:

   testpaths = test folders [OK]

Hint: testpaths lists folders to find tests [OK]

Common Mistakes:

• Confusing testpaths with test order settings
• Thinking testpaths sets test timeouts
• Assuming testpaths changes report style

2. Which of the following is the correct syntax to set testpaths in pytest.ini to look in folders tests and integration?

easy

A. [pytest]
testpaths = tests integration

B. [pytest]
testpaths = ['tests', 'integration']

C. [pytest]
testpaths = tests,integration

D. [pytest]
testpaths = "tests integration"

Solution

1. Step 1: Check pytest.ini syntax for testpaths

   In pytest.ini, testpaths lists folders separated by spaces without quotes or commas.

2. Step 2: Validate each option

   [pytest] testpaths = tests integration uses space-separated folder names correctly. Options A and D use quotes or brackets incorrectly. [pytest] testpaths = tests,integration uses commas which pytest does not accept here.

3. Final Answer:

   [pytest] testpaths = tests integration -> Option A

4. Quick Check:

   Space-separated folder names, no quotes [OK]

Hint: Use space-separated folder names without quotes [OK]

Common Mistakes:

• Using commas instead of spaces
• Adding quotes or brackets around folder names
• Placing testpaths outside [pytest] section

3. Given this pytest.ini content:

[pytest]
testpaths = tests integration

And this folder structure:

project/
  tests/
    test_alpha.py
  integration/
    test_beta.py
  docs/
    test_docs.py

Which test files will pytest discover and run?

medium

A. Only test_docs.py

B. test_alpha.py, test_beta.py, and test_docs.py

C. Only test_alpha.py

D. test_alpha.py and test_beta.py only

Solution

1. Step 1: Identify folders listed in testpaths

   The testpaths setting includes tests and integration folders only.

2. Step 2: Match test files in those folders

   Files test_alpha.py in tests and test_beta.py in integration will be found. test_docs.py is in docs, which is not listed.

3. Final Answer:

   test_alpha.py and test_beta.py only -> Option D

4. Quick Check:

   Only testpaths folders' tests run [OK]

Hint: Only tests in testpaths folders run [OK]

Common Mistakes:

• Assuming all test files in project run
• Including tests from folders not in testpaths
• Confusing folder names with test file names

4. You set testpaths = tests in pytest.ini but pytest still discovers tests in other folders. What is the most likely cause?

medium

A. There is another config file overriding testpaths

B. You forgot to restart pytest after editing pytest.ini

C. testpaths only filters test names, not folders

D. pytest ignores testpaths by default

Solution

1. Step 1: Understand pytest config precedence

   pytest can read multiple config files like tox.ini or setup.cfg that may override pytest.ini.

2. Step 2: Check for conflicting configs

   If tests outside tests run, likely another config file sets different testpaths or disables it.

3. Final Answer:

   There is another config file overriding testpaths -> Option A

4. Quick Check:

   Multiple configs can override testpaths [OK]

Hint: Check for multiple config files overriding settings [OK]

Common Mistakes:

• Assuming pytest.ini changes apply without reload
• Thinking testpaths filters test names only
• Believing pytest ignores testpaths by default

5. You want pytest to only run tests in unit_tests and api_tests folders, but exclude api_tests/slow. How can you configure pytest.ini using testpaths and other settings to achieve this?

hard

A. [pytest]
testpaths = unit_tests
norecursedirs = api_tests/slow

B. [pytest]
testpaths = unit_tests api_tests/slow
norecursedirs = api_tests

C. [pytest]
testpaths = unit_tests api_tests
norecursedirs = api_tests/slow

D. [pytest]
testpaths = unit_tests api_tests
ignore = api_tests/slow

Solution

1. Step 1: Use testpaths to include desired folders

   Set testpaths = unit_tests api_tests to include both folders.

2. Step 2: Exclude the slow subfolder with norecursedirs

   Use norecursedirs = api_tests/slow to prevent pytest from searching inside that subfolder.

3. Step 3: Verify other options are incorrect

   [pytest] testpaths = unit_tests api_tests/slow norecursedirs = api_tests includes the slow folder in testpaths, which is wrong. [pytest] testpaths = unit_tests norecursedirs = api_tests/slow excludes api_tests entirely. [pytest] testpaths = unit_tests api_tests ignore = api_tests/slow uses ignore which is not a valid pytest.ini setting.

4. Final Answer:

   [pytest] testpaths = unit_tests api_tests norecursedirs = api_tests/slow -> Option C

5. Quick Check:

   Include folders with testpaths, exclude subfolders with norecursedirs [OK]

Hint: Use testpaths to include, norecursedirs to exclude subfolders [OK]

Common Mistakes:

• Including excluded folders in testpaths
• Using invalid config keys like ignore
• Excluding whole folders instead of subfolders