Project structure for tests in PyTest - Framework Patterns

Framework Mode - Project structure for tests

Folder Structure

project-root/
├── tests/
│   ├── unit/
│   │   ├── test_example_unit.py
│   ├── integration/
│   │   ├── test_example_integration.py
│   ├── e2e/
│   │   ├── test_example_e2e.py
│   ├── utils/
│   ├── __init__.py
│   └── conftest.py
├── src/
│   ├── __init__.py
│   └── application_code.py
├── pytest.ini
├── requirements.txt
└── README.md

Test Framework Layers

• Tests Layer: Contains all test files organized by type (unit, integration, end-to-end).
• Fixtures & Config Layer: conftest.py holds shared setup and fixtures for tests.
• Source Code Layer: src/ folder contains the application code under test.
• Configuration Layer: pytest.ini manages pytest settings and markers.
• Utilities Layer: Helper functions or test utilities can be added inside tests/utils/ if needed.

Configuration Patterns

• pytest.ini: Configure test markers, addopts, and test paths.
• conftest.py: Define fixtures for setup like database connections, test data, or environment variables.
• Environment Handling: Use environment variables or pytest command line options to switch between test environments (dev, staging, prod).
• Credentials: Store sensitive data securely outside the repo, load via environment variables or secret managers.
• Browser or External Service Config: Use fixtures with parameters to select browsers or services dynamically.

Test Reporting and CI/CD Integration

• Use pytest plugins like pytest-html or pytest-cov for HTML reports and coverage reports.
• Integrate tests into CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests automatically on code push.
• Configure test reports to be saved as artifacts or sent via email/slack notifications.
• Use pytest-xdist for parallel test execution to speed up test runs.

Best Practices

• Organize tests by type and feature for clarity and easy navigation.
• Keep conftest.py clean and modular by splitting fixtures into multiple files if needed.
• Use descriptive test names and docstrings to explain test purpose.
• Isolate tests to avoid dependencies and side effects between tests.
• Keep test data and credentials out of source control; use environment variables or secure vaults.

Self Check

Where would you add a new fixture for database connection setup in this pytest project structure?

Key Result

Organize pytest tests in a clear folder structure with conftest.py for fixtures and pytest.ini for configuration.

Practice

1. Why should you place your test files inside a tests/ folder in a pytest project?

easy

A. To avoid writing test functions starting with test_

B. To make the tests run faster automatically

C. Because pytest only runs tests in the root folder

D. To keep test code separate and organized from application code

Solution

1. Step 1: Understand project organization

   Keeping tests in a separate tests/ folder helps keep the project clean and organized.

2. Step 2: Recognize pytest behavior

   pytest can find tests anywhere but organizing them in tests/ is a best practice for clarity and maintenance.

3. Final Answer:

   To keep test code separate and organized from application code -> Option D

4. Quick Check:

   Organized tests = tests/ folder [OK]

Hint: Put tests in a separate folder named tests for clarity [OK]

Common Mistakes:

• Thinking pytest only runs tests in root folder
• Believing tests run faster in tests/ folder
• Ignoring naming conventions for test functions

2. Which of the following is the correct way to name a test file so pytest can discover it automatically?

easy

A. test_example.py

B. mytests.py

C. example.py

D. TestExample.py

Solution

1. Step 1: Recall pytest naming rules

   pytest discovers test files that start with test_ or end with _test.py.

2. Step 2: Check each option

   test_example.py starts with test_, so pytest will find it automatically.

3. Final Answer:

   test_example.py -> Option A

4. Quick Check:

   File starts with test_ = discovered [OK]

Hint: Name test files starting with test_ for pytest discovery [OK]

Common Mistakes:

• Naming files without test_ prefix
• Using uppercase letters at start
• Assuming pytest finds any .py file

3. Given this project structure:

project/
  app.py
  tests/
    test_math.py
    utils/
      test_utils.py

Which files will pytest run by default when you run pytest in the project root?

medium

A. Only tests/utils/test_utils.py

B. Only tests/test_math.py

C. Both tests/test_math.py and tests/utils/test_utils.py

D. No tests run because of subfolder

Solution

1. Step 1: Understand pytest recursive discovery

   pytest looks inside the tests/ folder and all its subfolders for files starting with test_.

2. Step 2: Identify test files

   Both test_math.py and test_utils.py match naming rules and are inside tests/ or its subfolder.

3. Final Answer:

   Both tests/test_math.py and tests/utils/test_utils.py -> Option C

4. Quick Check:

   pytest finds tests recursively in tests/ [OK]

Hint: pytest finds test files recursively inside tests/ folder [OK]

Common Mistakes:

• Thinking pytest ignores subfolders
• Assuming only root tests/ files run
• Believing subfolders need special config

4. You have this test file named test_sample.py inside tests/ folder:

def sample_test():
    assert 1 + 1 == 2

When you run pytest, no tests are found. Why?

medium

A. Function name does not start with test_

B. File name should not start with test_

C. pytest requires tests to be inside root folder only

D. Missing import statement in test file

Solution

1. Step 1: Check function naming convention

   pytest discovers test functions only if their names start with test_.

2. Step 2: Analyze given function name

   The function is named sample_test, which does not start with test_, so pytest ignores it.

3. Final Answer:

   Function name does not start with test_ -> Option A

4. Quick Check:

   Test functions must start with test_ [OK]

Hint: Name test functions starting with test_ to be discovered [OK]

Common Mistakes:

• Assuming file name alone is enough
• Thinking pytest needs imports in test files
• Believing tests run only in root folder

5. In a large pytest project, how can you organize tests to keep them manageable and easy to run selectively?

hard

A. Put all tests in one big file named test_all.py

B. Use subfolders inside tests/ and add pytest.ini to configure test discovery

C. Name test functions randomly and rely on pytest to find them

D. Avoid using any configuration files to keep it simple

Solution

1. Step 1: Understand project scaling needs

   Large projects benefit from organizing tests in subfolders to separate features or modules.

2. Step 2: Use configuration files

   Adding a pytest.ini file helps customize test discovery and running specific groups of tests easily.

3. Final Answer:

   Use subfolders inside tests/ and add pytest.ini to configure test discovery -> Option B

4. Quick Check:

   Subfolders + pytest.ini = manageable large projects [OK]

Hint: Organize tests in subfolders and use pytest.ini config [OK]

Common Mistakes:

• Putting all tests in one file causing confusion
• Ignoring naming conventions for test functions
• Avoiding config files limits flexibility