Parametrize with IDs in PyTest - Framework Patterns

Framework Mode - Parametrize with IDs

Folder Structure

tests/
├── test_math_operations.py
├── test_user_login.py
└── conftest.py

utils/
├── calculator.py
└── helpers.py

pytest.ini
requirements.txt

This is a simple pytest project structure. All test files are inside the tests/ folder. Utility code is in utils/. The conftest.py file holds shared fixtures and setup.

Test Framework Layers

• Tests: Test functions using @pytest.mark.parametrize with ids to name test cases clearly.
• Fixtures: Shared setup or data in conftest.py for reuse.
• Utilities: Helper functions or classes in utils/ to keep tests clean.
• Configuration: pytest.ini for test options and markers.

Configuration Patterns

• pytest.ini to define markers and default options.
• Use conftest.py to define fixtures that can provide test data or environment setup.
• Parametrize tests with ids to give readable names to each test case, improving test reports.
• Example of parametrization with IDs in test function:

  import pytest
  
  @pytest.mark.parametrize(
      "input,expected",
      [
          (1, 2),
          (3, 4),
          (5, 6),
      ],
      ids=["one_to_two", "three_to_four", "five_to_six"]
  )
  def test_increment(input, expected):
      assert input + 1 == expected
  

Test Reporting and CI/CD Integration

• pytest automatically shows test IDs in the test report when using ids in parametrization.
• Use plugins like pytest-html to generate readable HTML reports showing test case names.
• Integrate pytest runs in CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests automatically on code changes.
• Readable test IDs help quickly identify which test case failed in reports and logs.

Best Practices

• Use descriptive IDs: Give each parameter set a clear, human-readable name to understand test cases easily.
• Keep parameter sets small: Avoid too many parameters in one test to keep tests simple and focused.
• Reuse fixtures: Use conftest.py fixtures to provide common data or setup for parametrized tests.
• Combine with markers: Use pytest markers to group or skip parametrized tests as needed.
• Maintain readability: Use ids to improve test output clarity, especially when parameters are complex objects.

Self Check

Where in this folder structure would you add a new parametrized test for a login feature that uses IDs to name test cases?

Key Result

Use pytest's @pytest.mark.parametrize with descriptive IDs to organize and clearly name test cases for better readability and reporting.

Practice

1. What is the main purpose of using ids in @pytest.mark.parametrize?

easy

A. To change the order of test execution

B. To skip certain test cases during execution

C. To label each test case for easier identification in reports

D. To automatically generate test data

Solution

1. Step 1: Understand the role of ids in parametrize

   The ids parameter assigns names to each test case, making it easier to identify which input caused a failure.

2. Step 2: Compare with other options

   Skipping tests, changing order, or generating data are not functions of ids.

3. Final Answer:

   To label each test case for easier identification in reports -> Option C

4. Quick Check:

   Parametrize ids = labels [OK]

Hint: IDs name test cases for clear failure reports [OK]

Common Mistakes:

• Thinking IDs skip tests
• Believing IDs reorder tests
• Assuming IDs generate data

2. Which of the following is the correct syntax to add IDs to a parametrize decorator in pytest?

easy

A. @pytest.mark.parametrize('x,y', [(1,2), (3,4)], ids=['first', 'second'])

B. @pytest.mark.parametrize('x,y', [(1,2), (3,4)], id=['first', 'second'])

C. @pytest.mark.parametrize('x,y', [(1,2), (3,4)], names=['first', 'second'])

D. @pytest.mark.parametrize('x,y', [(1,2), (3,4)], labels=['first', 'second'])

Solution

1. Step 1: Identify the correct parameter name

   The correct parameter to assign IDs is ids, not id, names, or labels.

2. Step 2: Check the syntax structure

   The syntax uses @pytest.mark.parametrize with the argument names, list of tuples, and ids as a list of strings.

3. Final Answer:

   @pytest.mark.parametrize('x,y', [(1,2), (3,4)], ids=['first', 'second']) -> Option A

4. Quick Check:

   Use ids parameter correctly [OK]

Hint: Use 'ids' keyword exactly for naming test cases [OK]

Common Mistakes:

• Using 'id' instead of 'ids'
• Using 'names' or 'labels' which are invalid
• Forgetting to pass a list for IDs

3. Given the code below, what will be the test ID shown for the second test case?

@pytest.mark.parametrize('num', [10, 20], ids=['ten', 'twenty'])
def test_value(num):
    assert num > 5

medium

A. test_value[twenty]

B. test_value[10]

C. test_value[1]

D. test_value[20]

Solution

1. Step 1: Understand how IDs map to test cases

   The ids list assigns 'ten' to the first input (10) and 'twenty' to the second input (20).

2. Step 2: Identify the second test case ID

   The second test case uses the second ID, which is 'twenty'.

3. Final Answer:

   test_value[twenty] -> Option A

4. Quick Check:

   Second ID label = 'twenty' [OK]

Hint: IDs replace values in test names [OK]

Common Mistakes:

• Assuming default numeric index is used
• Confusing value with ID label
• Ignoring the IDs parameter

4. Identify the error in the following pytest parametrize usage:

@pytest.mark.parametrize('a,b', [(1,2), (3,4)], ids='case1,case2')
def test_sum(a, b):
    assert a + b > 0

medium

A. Tuple values must be strings

B. Parameter names must be a list, not a string

C. Test function must return a value

D. IDs should be a list, not a single string

Solution

1. Step 1: Check the type of ids argument

   The ids parameter expects a list of strings, but here it is given a single string with commas.

2. Step 2: Understand the impact of wrong ids type

   Passing a string instead of a list causes pytest to treat it as an iterable of characters, leading to incorrect IDs or errors.

3. Final Answer:

   IDs should be a list, not a single string -> Option D

4. Quick Check:

   IDs must be list of strings [OK]

Hint: Pass IDs as list, not comma string [OK]

Common Mistakes:

• Passing comma-separated string instead of list
• Using wrong parameter type for IDs
• Confusing parameter names with IDs

5. You want to parametrize a test with inputs [(0, 'zero'), (1, 'one'), (2, 'two')] but want to skip the test case where the number is zero using IDs. Which approach correctly uses ids to help identify the skipped test case?

hard

A. @pytest.mark.parametrize('num,word', [(0,'zero'),(1,'one'),(2,'two')], ids=lambda val: f"skip_{val[0]}" if val[0]==0 else f"num_{val[0]}")

B. @pytest.mark.parametrize('num,word', [(0,'zero'),(1,'one'),(2,'two')], ids=['skip_zero', 'num_one', 'num_two'])

C. @pytest.mark.parametrize('num,word', [(0,'zero'),(1,'one'),(2,'two')], ids=['zero', 'one', 'two'])

D. @pytest.mark.parametrize('num,word', [(0,'zero'),(1,'one'),(2,'two')], ids=['num_0', 'num_1', 'num_2'])

Solution

1. Step 1: Understand the goal of IDs for skipping

   We want to label the zero case clearly as 'skip_zero' to identify it easily in reports.

2. Step 2: Evaluate each option's IDs usage

   @pytest.mark.parametrize('num,word', [(0,'zero'),(1,'one'),(2,'two')], ids=['skip_zero', 'num_one', 'num_two']) uses a list of strings with 'skip_zero' for zero, which is clear and correct. The lambda in @pytest.mark.parametrize('num,word', [(0,'zero'),(1,'one'),(2,'two')], ids=lambda val: f"skip_{val[0]}" if val[0]==0 else f"num_{val[0]}") is corrected to accept a single tuple argument as pytest passes. The options with ids=['num_0', 'num_1', 'num_2'] and ids=['zero', 'one', 'two'] do not label zero as skipped.

3. Final Answer:

   @pytest.mark.parametrize('num,word', [(0,'zero'),(1,'one'),(2,'two')], ids=['skip_zero', 'num_one', 'num_two']) -> Option B

4. Quick Check:

   Use explicit ID list to mark skipped case [OK]

Hint: Use explicit ID list to label skipped cases [OK]

Common Mistakes:

• Using lambda incorrectly for IDs
• Not labeling skipped cases clearly
• Using generic IDs without skip info