Marker registration in PyTest - Framework Patterns

Framework Mode - Marker registration

Folder Structure

test_project/
├── tests/
│   ├── test_login.py
│   ├── test_registration.py
│   └── test_payment.py
├── pytest.ini
├── conftest.py
└── utils/
    └── helpers.py

Test Framework Layers

• Tests: Located in tests/ folder, contain test functions using pytest markers to categorize tests.
• Configuration: pytest.ini file registers custom markers and sets pytest options.
• Fixtures & Hooks: conftest.py defines fixtures and hooks used across tests.
• Utilities: Helper functions and reusable code in utils/ folder.

Configuration Patterns

The pytest.ini file is used to register custom markers to avoid warnings and enable marker-based test selection.

[pytest]
markers =
    smoke: mark a test as a smoke test
    regression: mark a test as a regression test
    slow: mark a test as slow running

Use command line options to run tests by marker, e.g., pytest -m smoke.

conftest.py can define fixtures that tests with markers can use.

Test Reporting and CI/CD Integration

• Use pytest's built-in reporting with --junitxml=report.xml to generate XML reports for CI tools.
• Integrate with CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests automatically on commits.
• Use markers to selectively run tests in CI, e.g., run only smoke tests on pull requests.
• Combine with pytest-html plugin for readable HTML reports.

Best Practices

1. Always register custom markers in pytest.ini to avoid warnings and improve clarity.
2. Use descriptive marker names that clearly indicate test purpose (e.g., smoke, regression, slow).
3. Keep marker usage consistent across tests to enable easy filtering and selective runs.
4. Document marker meanings in project README or test documentation for team clarity.
5. Use markers to group tests logically and speed up test runs during development or CI.

Self Check

Where in this folder structure would you add a new marker called api to categorize API tests?

Key Result

Register custom pytest markers in pytest.ini to organize and selectively run tests efficiently.

Practice

1. What is the main purpose of registering markers in pytest.ini?

easy

A. To avoid warnings when using custom markers in tests

B. To automatically run all tests without specifying markers

C. To disable all markers in the test suite

D. To change the default test discovery pattern

Solution

1. Step 1: Understand marker registration role

   Markers must be registered in pytest.ini to inform pytest about custom markers.

2. Step 2: Identify effect of registration

   Without registration, pytest shows warnings about unknown markers; registration prevents these warnings.

3. Final Answer:

   To avoid warnings when using custom markers in tests -> Option A

4. Quick Check:

   Marker registration = avoid warnings [OK]

Hint: Register markers in pytest.ini to stop warnings [OK]

Common Mistakes:

• Thinking registration runs tests automatically
• Believing registration disables markers
• Confusing marker registration with test discovery

2. Which of the following is the correct syntax to register a custom marker named slow in pytest.ini?

easy

A. [pytest]
markers = slow: marks tests as slow

B. [markers]
slow = marks tests as slow

C. [pytest]
marker = slow: marks tests as slow

D. [pytest]
markers = slow marks tests as slow

Solution

1. Step 1: Recall pytest.ini marker syntax

   Markers are registered under the [pytest] section with the key 'markers' followed by marker descriptions.

2. Step 2: Match correct syntax

   [pytest] markers = slow: marks tests as slow correctly uses '[pytest]' section and 'markers = slow: marks tests as slow' format.

3. Final Answer:

   [pytest] markers = slow: marks tests as slow -> Option A

4. Quick Check:

   Correct section and key = [pytest] markers = slow: marks tests as slow [OK]

Hint: Use [pytest] and 'markers =' to register markers [OK]

Common Mistakes:

• Using wrong section name like [markers]
• Misspelling 'markers' key
• Omitting colon after marker name

3. Given the following pytest.ini content and test code, what will be the result when running pytest -m slow?

[pytest]
markers = slow: marks tests as slow

import pytest

@pytest.mark.slow
def test_example():
    assert True

def test_fast():
    assert True

medium

A. Only test_fast runs and passes

B. Both test_example and test_fast run and pass

C. Only test_example runs and passes

D. No tests run due to marker misconfiguration

Solution

1. Step 1: Understand -m slow option

   The -m slow option runs only tests marked with @pytest.mark.slow.

2. Step 2: Identify marked tests

   test_example is marked with @pytest.mark.slow, test_fast is not.

3. Final Answer:

   Only test_example runs and passes -> Option C

4. Quick Check:

   Run with -m slow = only slow tests run [OK]

Hint: -m runs only tests with matching marker [OK]

Common Mistakes:

• Assuming all tests run with -m option
• Confusing marker name with test function name
• Ignoring marker registration effect

4. You added a custom marker database to your tests but pytest shows a warning: PytestUnknownMarkWarning. What is the most likely cause and how to fix it?

medium

A. You must run pytest with --disable-warnings to hide the message

B. You forgot to register the database marker in pytest.ini; add it under [pytest] markers

C. You need to rename the marker to db to avoid warnings

D. You used @pytest.mark.database incorrectly; remove the decorator

Solution

1. Step 1: Identify cause of PytestUnknownMarkWarning

   This warning appears when a custom marker is used but not registered in pytest.ini.

2. Step 2: Fix by registering marker

   Add database marker under the [pytest] section in pytest.ini to register it and remove the warning.

3. Final Answer:

   You forgot to register the database marker in pytest.ini; add it under [pytest] markers -> Option B

4. Quick Check:

   Warning = missing marker registration [OK]

Hint: Register all custom markers in pytest.ini to avoid warnings [OK]

Common Mistakes:

• Ignoring the warning and continuing
• Removing marker decorator instead of registering
• Trying to rename marker instead of registering

5. You want to run tests marked as api but skip those marked as slow. Your pytest.ini contains:

[pytest]
markers =
    api: marks API tests
    slow: marks slow tests

Which command correctly runs only api tests excluding slow tests?

hard

A. pytest -m "not api and slow"

B. pytest -m "api or slow"

C. pytest -m "slow and not api"

D. pytest -m "api and not slow"

Solution

1. Step 1: Understand marker expressions with -m

   The -m option accepts boolean expressions combining markers using and, or, and not.

2. Step 2: Build expression for api tests excluding slow

   We want tests marked api but not slow, so expression is api and not slow.

3. Final Answer:

   pytest -m "api and not slow" -> Option D

4. Quick Check:

   Run api tests excluding slow = pytest -m "api and not slow" [OK]

Hint: Use -m "api and not slow" to include/exclude markers [OK]

Common Mistakes:

• Using 'or' instead of 'and not' excludes wrong tests
• Misplacing 'not' operator
• Confusing marker names in expression