Arrange-Act-Assert pattern in PyTest - Framework Patterns

Framework Mode - Arrange-Act-Assert pattern

Folder Structure

project-root/
├── tests/
│   ├── test_example.py
│   ├── test_user.py
│   └── __init__.py
├── src/
│   ├── calculator.py
│   └── __init__.py
├── conftest.py
├── pytest.ini
└── requirements.txt

Test Framework Layers

• Arrange: Setup test data and environment. Usually done inside test functions or fixtures in conftest.py.
• Act: Execute the action or function under test, e.g., calling a function from src/calculator.py.
• Assert: Verify the outcome using assert statements in test functions inside tests/.
• Utilities: Helper functions or fixtures in conftest.py or separate utility modules.
• Configuration: Settings in pytest.ini and environment variables.

Configuration Patterns

• pytest.ini: Configure pytest options like markers, test paths, and logging.
• Environment Variables: Store sensitive data like credentials outside code, accessed via os.environ.
• Fixtures: Use @pytest.fixture in conftest.py to setup reusable test data or states.
• Command Line Options: Use pytest --browser=chrome or similar to select test parameters dynamically.

Test Reporting and CI/CD Integration

• pytest built-in reports: Use pytest -v for verbose output showing pass/fail per test.
• Plugins: Use pytest-html to generate HTML reports for easy sharing.
• CI/CD: Integrate pytest runs in pipelines (GitHub Actions, Jenkins) to run tests on every commit.
• Fail Fast: Use --maxfail=1 to stop on first failure during CI runs.

Best Practices for Arrange-Act-Assert in pytest

• Clear Separation: Keep arrange, act, and assert steps clearly separated in test functions for readability.
• Use Fixtures: Use pytest fixtures to handle arrange steps and keep tests clean.
• Single Assert per Test: Prefer one main assert per test to isolate failures clearly.
• Descriptive Test Names: Name tests to describe the behavior being tested.
• Keep Tests Independent: Each test should not depend on others; arrange all needed data inside or via fixtures.

Self Check

Where in this framework structure would you add a new fixture to prepare test data for user login tests?

Key Result

Arrange-Act-Assert pattern organizes tests into clear setup, action, and verification steps for clarity and maintainability.

Practice

1. What is the main purpose of the Arrange-Act-Assert pattern in pytest?

easy

A. To speed up test execution time

B. To organize tests into clear steps for better readability

C. To automatically generate test data

D. To replace the need for assertions in tests

Solution

1. Step 1: Understand the pattern's goal

   The Arrange-Act-Assert pattern structures tests into three parts: setup, action, and verification.

2. Step 2: Identify the main benefit

   This structure makes tests easier to read and maintain by clearly separating steps.

3. Final Answer:

   To organize tests into clear steps for better readability -> Option B

4. Quick Check:

   Arrange-Act-Assert = Organize tests clearly [OK]

Hint: Remember: Arrange sets up, Act performs, Assert checks [OK]

Common Mistakes:

• Thinking it speeds up test execution
• Confusing it with test data generation
• Believing it removes the need for assertions

2. Which of the following is the correct order of steps in the Arrange-Act-Assert pattern?

easy

A. Act, Arrange, Assert

B. Assert, Arrange, Act

C. Arrange, Act, Assert

D. Act, Assert, Arrange

Solution

1. Step 1: Recall the pattern sequence

   The pattern always starts with Arrange (setup), then Act (perform action), and finally Assert (check results).

2. Step 2: Match the correct order

   Only Arrange, Act, Assert follows this exact sequence.

3. Final Answer:

   Arrange, Act, Assert -> Option C

4. Quick Check:

   Order is Arrange -> Act -> Assert [OK]

Hint: Think: Prepare, Do, Check in that order [OK]

Common Mistakes:

• Mixing up the order of steps
• Starting with Assert before Act
• Confusing Act and Arrange steps

3. Given the following pytest test code, what will be the test result?

def test_sum():
    # Arrange
    numbers = [1, 2, 3]
    expected = 6

    # Act
    result = sum(numbers)

    # Assert
    assert result == expected

medium

A. Test will pass because sum(numbers) equals expected

B. Test will fail because sum is not defined

C. Test will fail because expected is incorrect

D. Test will error due to syntax mistake

Solution

1. Step 1: Analyze the Arrange step

   List numbers is [1, 2, 3] and expected sum is 6, which is correct.

2. Step 2: Check the Act and Assert steps

   sum(numbers) calculates 6, matching expected. The assertion will pass.

3. Final Answer:

   Test will pass because sum(numbers) equals expected -> Option A

4. Quick Check:

   sum([1,2,3]) = 6, assertion true [OK]

Hint: Check if actual equals expected in Assert step [OK]

Common Mistakes:

• Assuming sum is undefined
• Thinking expected value is wrong
• Looking for syntax errors where none exist

4. Identify the error in this pytest test using Arrange-Act-Assert pattern:

def test_uppercase():
    # Arrange
    text = "hello"

    # Act
    result = text.upper

    # Assert
    assert result == "HELLO"

medium

A. Missing parentheses in Act step calling upper()

B. Incorrect expected value in Assert step

C. Variable text is not defined in Arrange step

D. Assert statement syntax is invalid

Solution

1. Step 1: Review the Act step

   text.upper is a method reference, missing parentheses to call it.

2. Step 2: Understand the impact on Assert

   Without calling upper(), result is a method, not a string, so assertion fails.

3. Final Answer:

   Missing parentheses in Act step calling upper() -> Option A

4. Quick Check:

   Call methods with () to get results [OK]

Hint: Remember to call methods with parentheses () [OK]

Common Mistakes:

• Thinking expected value is wrong
• Assuming variable is undefined
• Believing assert syntax is incorrect

5. You want to test a function divide(a, b) that returns the division of two numbers. Using Arrange-Act-Assert, which test correctly checks that dividing by zero raises a ZeroDivisionError?

hard

A. def test_divide_zero():
# Arrange
a, b = 10, 0
# Act
result = divide(a, b)
# Assert
assert result == 0

B. def test_divide_zero():
# Arrange
a, b = 10, 0
# Act
result = divide(a, b)
# Assert
assert result is None

C. def test_divide_zero():
# Arrange
a, b = 10, 0
# Act
divide(a, b)
# Assert
assert True

D. def test_divide_zero():
# Arrange
a, b = 10, 0
# Act & Assert
with pytest.raises(ZeroDivisionError):
divide(a, b)

Solution

1. Step 1: Understand the test goal

   The test must verify that dividing by zero raises a ZeroDivisionError exception.

2. Step 2: Identify correct pytest usage

   Using with pytest.raises(ZeroDivisionError): correctly checks for the exception during Act step.

3. Final Answer:

   Using pytest.raises to check for ZeroDivisionError -> Option D

4. Quick Check:

   Use pytest.raises to test exceptions [OK]

Hint: Use pytest.raises to assert exceptions in tests [OK]

Common Mistakes:

• Ignoring exception and asserting wrong result
• Not using pytest.raises for exception testing
• Asserting True without checking error