Data providers pattern in Selenium Python - Framework Patterns

Framework Mode - Data providers pattern

Folder Structure

my_selenium_project/
├── tests/
│   ├── test_login.py          # Test files using data providers
│   └── test_search.py
├── pages/
│   ├── login_page.py          # Page Object classes
│   └── search_page.py
├── data/
│   └── test_data.py           # Data provider functions or data sets
├── utils/
│   └── helpers.py             # Utility functions
├── config/
│   └── config.py              # Environment and browser configs
├── conftest.py                # Pytest fixtures and hooks
└── requirements.txt

Test Framework Layers

• Test Layer: Contains test scripts that use data providers to run tests multiple times with different inputs.
• Page Object Layer: Classes representing web pages with methods to interact with UI elements.
• Data Provider Layer: Functions or variables that supply test data, often in data/test_data.py.
• Utility Layer: Helper functions for common tasks like reading files or formatting data.
• Configuration Layer: Holds environment settings, browser options, and credentials.
• Fixtures: In conftest.py, setup and teardown logic, including browser setup.

Configuration Patterns

• Environment Config: Use config/config.py to define URLs, timeouts, and environment variables.
• Browser Config: Parameterize browser choice via command line or config file, e.g., Chrome or Firefox.
• Credentials: Store sensitive data securely, e.g., environment variables or encrypted files, not hardcoded.
• Data Providers: Keep test data separate from tests, load from data/test_data.py or external files (CSV, JSON).
• Pytest Integration: Use fixtures and @pytest.mark.parametrize to connect data providers with tests.

Test Reporting and CI/CD Integration

• Use pytest with plugins like pytest-html or allure-pytest for readable test reports showing which data sets passed or failed.
• Integrate tests into CI/CD pipelines (GitHub Actions, Jenkins) to run tests automatically on code changes.
• Reports help quickly identify which input data caused failures.
• Use logs and screenshots on failure for easier debugging.

Best Practices

• Separate Data from Tests: Keep test data in dedicated files or functions, not inside test scripts.
• Use Pytest Parametrize: Leverage @pytest.mark.parametrize to run tests with multiple data sets cleanly.
• Readable Data Format: Use simple structures like lists of tuples or dictionaries for data providers.
• Maintainable Data: Organize data logically by test case or feature for easy updates.
• Secure Sensitive Data: Never hardcode passwords or secrets in data providers; use environment variables.

Self Check

Where in this folder structure would you add a new data provider for testing the "Forgot Password" feature?

Key Result

Use separate data provider functions or files to supply multiple test inputs, combined with pytest parametrize for clean, reusable test automation.

Practice

1. What is the main purpose of using the data providers pattern in Selenium Python tests?

easy

A. To generate test reports in different formats

B. To speed up the browser loading time

C. To create new test cases automatically

D. To run the same test multiple times with different input data

Solution

1. Step 1: Understand the data providers pattern

   The data providers pattern allows running one test repeatedly with different sets of data.

2. Step 2: Identify the main benefit

   This helps find more bugs by testing various inputs without writing separate tests.

3. Final Answer:

   To run the same test multiple times with different input data -> Option D

4. Quick Check:

   Data providers = run test many times with different data [OK]

Hint: Remember: data providers = repeat test with new data [OK]

Common Mistakes:

• Thinking data providers speed up browser loading
• Confusing data providers with automatic test creation
• Believing data providers generate reports

2. Which of the following is the correct syntax to use a data provider in pytest for Selenium Python?

easy

A. @pytest.mark.parametrize('input', ['data1', 'data2'])

B. @pytest.run_with_data(['data1', 'data2'])

C. @pytest.test_data(['data1', 'data2'])

D. @pytest.data_provider(['data1', 'data2'])

Solution

1. Step 1: Recall pytest data provider syntax

   Pytest uses @pytest.mark.parametrize to supply multiple data sets to a test function.

2. Step 2: Match the correct syntax

   @pytest.mark.parametrize('input', ['data1', 'data2']) correctly shows @pytest.mark.parametrize('input', ['data1', 'data2']).

3. Final Answer:

   @pytest.mark.parametrize('input', ['data1', 'data2']) -> Option A

4. Quick Check:

   Pytest data provider = @pytest.mark.parametrize [OK]

Hint: Look for @pytest.mark.parametrize for data providers [OK]

Common Mistakes:

• Using non-existent decorators like @pytest.data_provider
• Confusing parametrize with test_data or run_with_data
• Missing quotes around parameter names

3. What will be the output of the following pytest test using data providers?

import pytest

@pytest.mark.parametrize('num', [1, 2, 3])
def test_is_positive(num):
    assert num > 0

medium

A. All tests pass

B. All tests fail

C. Only the test with num=1 passes

D. Syntax error occurs

Solution

1. Step 1: Analyze the test logic

   The test asserts that the input number is greater than zero.

2. Step 2: Check each data value

   Values 1, 2, and 3 are all greater than zero, so all assertions pass.

3. Final Answer:

   All tests pass -> Option A

4. Quick Check:

   All nums > 0, so tests pass [OK]

Hint: Check if all inputs satisfy the assertion [OK]

Common Mistakes:

• Assuming some inputs fail without checking values
• Thinking syntax error due to parametrize
• Ignoring that all numbers are positive

4. Identify the error in this pytest data provider usage:

@pytest.mark.parametrize('input', [1, 2, 3])
def test_example():
    assert input > 0

medium

A. Wrong decorator name

B. Missing parameter in test function definition

C. List of inputs should be strings

D. Assertion syntax is incorrect

Solution

1. Step 1: Check test function parameters

   The test function must accept the parameter named in parametrize, here 'input'.

2. Step 2: Identify missing parameter

   The function test_example() has no parameters, so 'input' is undefined inside it.

3. Final Answer:

   Missing parameter in test function definition -> Option B

4. Quick Check:

   Parametrize param must match function argument [OK]

Hint: Function must accept all parametrize arguments [OK]

Common Mistakes:

• Forgetting to add parameter to test function
• Using wrong decorator name
• Thinking input list must be strings
• Misreading assertion syntax

5. You want to test a login form with multiple username and password pairs using data providers in pytest. Which approach correctly handles multiple parameters?

hard

A. @pytest.mark.parametrize('username', ['user1', 'user2'])
@pytest.mark.parametrize('password', ['pass1', 'pass2'])
def test_login(username, password):
assert username and password

B. @pytest.mark.parametrize('username_password', [('user1', 'pass1'), ('user2', 'pass2')])
def test_login(username_password):
assert username_password[0] and username_password[1]

C. @pytest.mark.parametrize(('username', 'password'), [('user1', 'pass1'), ('user2', 'pass2')])
def test_login(username, password):
assert username and password

D. @pytest.mark.parametrize('username', ['user1', 'user2'], 'password', ['pass1', 'pass2'])
def test_login(username, password):
assert username and password

Solution

1. Step 1: Understand multiple parameter usage in parametrize

   To pass multiple parameters together, use a tuple of parameter names and a list of tuples with values.

2. Step 2: Identify correct syntax

   @pytest.mark.parametrize(('username', 'password'), [('user1', 'pass1'), ('user2', 'pass2')]) def test_login(username, password): assert username and password uses @pytest.mark.parametrize(('username', 'password'), [('user1', 'pass1'), ('user2', 'pass2')]), which is correct.

3. Final Answer:

   Use tuple of parameter names and list of tuples for values -> Option C

4. Quick Check:

   Multiple params = tuple names + list of tuples [OK]

Hint: Use tuple of names and list of tuples for multiple params [OK]

Common Mistakes:

• Stacking multiple parametrize decorators incorrectly
• Passing multiple parameters in one string without tuple
• Wrong syntax with multiple lists in one decorator