Why markers categorize and control tests in PyTest - Framework Benefits

Framework Mode - Why markers categorize and control tests

Folder Structure of a Pytest Project Using Markers

tests/
├── test_login.py
├── test_shopping_cart.py
├── test_checkout.py
├── conftest.py
└── pytest.ini

Test Framework Layers in Pytest with Markers

• Tests: Test files inside tests/ folder, e.g., test_login.py. Markers categorize tests by feature or type.
• Fixtures: Setup and teardown code in conftest.py to prepare test environments.
• Markers: Labels added to tests to group or control execution, e.g., @pytest.mark.smoke.
• Configuration: Marker definitions and test options in pytest.ini.
• Utilities: Helper functions or modules to support tests.

Configuration Patterns for Markers in Pytest

Markers must be declared in pytest.ini or markers.ini to avoid warnings and to document their purpose.

# pytest.ini
[pytest]
markers =
    smoke: quick tests to check basic functionality
    regression: full tests for all features
    login: tests related to login functionality

Run tests by marker using command line options:

pytest -m smoke
pytest -m "not regression"

Use environment variables or config files to control which markers run in different environments.

Test Reporting and CI/CD Integration

• Reports show which markers ran and their results, helping track test coverage by category.
• CI/CD pipelines can run specific marker groups, e.g., smoke tests on every commit, full regression nightly.
• Use plugins like pytest-html or pytest-junitxml to generate readable reports including marker info.
• Markers help control test execution time and focus, improving pipeline speed and feedback.

Best Practices for Using Markers in Pytest

1. Define markers clearly: Always declare markers in pytest.ini with descriptions.
2. Use markers to group tests logically: By feature, priority, or test type (smoke, regression, slow).
3. Control test runs: Use markers to select or exclude tests easily from command line or CI.
4. Keep markers consistent: Avoid overlapping or ambiguous marker names.
5. Document marker usage: Help team members understand test categories and execution control.

Self-Check Question

Where in this framework structure would you add a new marker for tests related to the "payment" feature?

Key Result

Markers in pytest categorize tests to organize and control which tests run, improving test management and execution.

Practice

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

easy

A. To write tests faster by auto-generating code

B. To change the Python version used for tests

C. To automatically fix failing tests

D. To group tests so you can run specific sets easily

Solution

1. Step 1: Understand what markers do in pytest

   Markers are labels you add to tests to group or categorize them.

2. Step 2: Identify the main use of markers

   Markers help you run only certain groups of tests, saving time and focusing effort.

3. Final Answer:

   To group tests so you can run specific sets easily -> Option D

4. Quick Check:

   Markers group tests = B [OK]

Hint: Markers help run selected tests quickly [OK]

Common Mistakes:

• Thinking markers auto-fix tests
• Confusing markers with code generation
• Believing markers change Python version

2. Which of the following is the correct way to mark a test as 'slow' in pytest?

easy

A. @pytest.slow
def test_example(): pass

B. @pytest.mark.slow
def test_example(): pass

C. @slow_mark
def test_example(): pass

D. @mark.slow
def test_example(): pass

Solution

1. Step 1: Recall pytest marker syntax

   Markers are used with @pytest.mark.<marker_name> before the test function.

2. Step 2: Match the correct syntax

   Only '@pytest.mark.slow' is the correct way to mark a test as slow.

3. Final Answer:

   @pytest.mark.slow\ndef test_example(): pass -> Option B

4. Quick Check:

   Use @pytest.mark.marker_name = D [OK]

Hint: Use @pytest.mark.marker_name to mark tests [OK]

Common Mistakes:

• Omitting 'pytest' before 'mark'
• Using wrong decorator names
• Confusing marker syntax with other decorators

3. Given the code below, what tests will run when executing pytest -m "slow and not network"?

@pytest.mark.slow
def test_a(): pass

@pytest.mark.network
def test_b(): pass

@pytest.mark.slow
@pytest.mark.network
def test_c(): pass

def test_d(): pass

medium

A. test_b and test_c

B. test_a and test_c

C. Only test_a

D. test_a, test_b, test_c, and test_d

Solution

1. Step 1: Understand the marker expression

   The command runs tests marked 'slow' but NOT marked 'network'.

2. Step 2: Check each test's markers

   test_a is 'slow' only (runs), test_b is 'network' only (excluded), test_c is both 'slow' and 'network' (excluded), test_d has no markers (excluded).

3. Final Answer:

   Only test_a -> Option C

4. Quick Check:

   Run tests with slow and not network = C [OK]

Hint: Use 'and not' to exclude markers in pytest -m [OK]

Common Mistakes:

• Including tests with 'network' marker
• Running unmarked tests by default
• Misunderstanding boolean logic in marker expressions

4. What is wrong with this pytest marker usage?

@pytest.mark.skipif(sys.platform == 'win32')
def test_func():
    assert True

medium

A. Missing import of sys module

B. Incorrect marker name 'skipif'

C. Missing parentheses after skipif

D. Cannot use conditions in markers

Solution

1. Step 1: Check the code for required imports

   The code uses 'sys.platform' but does not import 'sys'.

2. Step 2: Verify marker syntax

   '@pytest.mark.skipif(condition)' is correct syntax, so no error there.

3. Final Answer:

   Missing import of sys module -> Option A

4. Quick Check:

   Use imports for conditions in markers [OK]

Hint: Always import modules used in marker conditions [OK]

Common Mistakes:

• Forgetting to import modules like sys
• Misnaming skipif marker
• Using skipif without condition parentheses

5. You want to run only tests marked as 'database' but skip those also marked 'slow'. Which pytest command achieves this?

hard

A. pytest -m "database and not slow"

B. pytest -m "slow and not database"

C. pytest -m "database or slow"

D. pytest -m "not database and slow"

Solution

1. Step 1: Understand the requirement

   Run tests with 'database' marker but exclude those with 'slow'.

2. Step 2: Translate to pytest marker expression

   Use 'database and not slow' to select tests marked database but not slow.

3. Final Answer:

   pytest -m "database and not slow" -> Option A

4. Quick Check:

   Use 'and not' to exclude markers [OK]

Hint: Combine markers with 'and not' to exclude tests [OK]

Common Mistakes:

• Swapping marker names in the expression
• Using 'or' instead of 'and not'
• Misunderstanding marker logic in pytest -m