Basic assert statement in PyTest - Framework Patterns

Framework Mode - Basic assert statement

Folder Structure

my_pytest_project/
├── tests/
│   ├── test_example.py
│   └── __init__.py
├── conftest.py
├── pytest.ini
└── README.md

This is a simple pytest project structure. The tests/ folder contains test files. conftest.py holds shared fixtures or hooks. pytest.ini configures pytest options.

Test Framework Layers

• Tests: Test functions using assert statements to verify expected outcomes.
• Fixtures (conftest.py): Setup and teardown code shared across tests.
• Utilities: Helper functions or data used by tests (optional in basic setups).
• Configuration: pytest.ini file to set test options like markers or test paths.

Configuration Patterns

Use pytest.ini to configure pytest behavior:

[pytest]
minversion = 7.0
addopts = -ra -q
testpaths = tests

For environment variables or credentials, use OS environment variables or pytest fixtures in conftest.py. This keeps sensitive data out of code.

Test Reporting and CI/CD Integration

Pytest outputs test results in the console by default. For better reports, use plugins like pytest-html to generate HTML reports.

Example command to generate report:

pytest --html=report.html

Integrate pytest in CI/CD pipelines (GitHub Actions, Jenkins) by running tests and collecting reports automatically.

Best Practices

• Use simple assert statements to check expected results clearly.
• Write one assertion per test function to isolate failures.
• Keep tests independent and repeatable.
• Use descriptive test function names to explain what is tested.
• Use fixtures for setup to avoid duplication.

Self Check

Where in this folder structure would you add a new test file for checking user login functionality?

Key Result

Organize pytest tests in a tests/ folder using simple assert statements and fixtures for setup.

Practice

1. What does the assert statement do in a pytest test?

easy

A. Skips the test without running it

B. Runs the test multiple times automatically

C. Prints a message to the console

D. Checks if a condition is true and stops the test if false

Solution

1. Step 1: Understand the purpose of assert

   The assert statement checks if a condition is true during a test.

2. Step 2: Know the effect of assert failing

   If the condition is false, the test stops and reports failure.

3. Final Answer:

   Checks if a condition is true and stops the test if false -> Option D

4. Quick Check:

   Assert = condition check [OK]

Hint: Assert stops test on false condition [OK]

Common Mistakes:

• Thinking assert runs tests multiple times
• Confusing assert with print statements
• Believing assert skips tests

2. Which of the following is the correct syntax for an assert statement in pytest?

easy

A. assert(x == 5; "x should be 5")

B. assert x == 5, "x should be 5"

C. assert x = 5, "x should be 5"

D. assert x == 5 then "x should be 5"

Solution

1. Step 1: Review correct assert syntax

   In Python, assert is followed by a condition, optionally a comma and a message string.

2. Step 2: Identify syntax errors in options

   assert x == 5, "x should be 5" uses correct syntax: assert condition, message. Others have wrong punctuation or assignment.

3. Final Answer:

   assert x == 5, "x should be 5" -> Option B

4. Quick Check:

   assert condition, message [OK]

Hint: Use comma after condition for message [OK]

Common Mistakes:

• Using assignment (=) instead of comparison (==)
• Adding parentheses incorrectly
• Using wrong keywords like 'then'

3. What will be the result of this pytest assertion?

def test_value():
    x = 10
    assert x < 5, "x is not less than 5"

medium

A. Test passes silently

B. Test is skipped

C. Test fails with message 'x is not less than 5'

D. SyntaxError occurs

Solution

1. Step 1: Evaluate the condition in assert

   The condition is x < 5, but x is 10, so 10 < 5 is false.

2. Step 2: Understand assert failure behavior

   Since condition is false, the test fails and shows the message after the comma.

3. Final Answer:

   Test fails with message 'x is not less than 5' -> Option C

4. Quick Check:

   False condition triggers failure [OK]

Hint: False assert condition fails test with message [OK]

Common Mistakes:

• Assuming test passes when condition is false
• Expecting syntax error for valid assert
• Thinking test skips on failure

4. Identify the error in this pytest assertion:

def test_sum():
    total = 3 + 4
    assert total = 7, "Sum should be 7"

medium

A. Using assignment (=) instead of comparison (==) in assert

B. Missing parentheses around assert condition

C. Incorrect indentation of assert statement

D. Wrong message format after assert

Solution

1. Step 1: Check assert condition syntax

   The assert condition must use comparison (==), not assignment (=).

2. Step 2: Identify the error in the code

   Here, 'assert total = 7' uses assignment, which is invalid syntax.

3. Final Answer:

   Using assignment (=) instead of comparison (==) in assert -> Option A

4. Quick Check:

   Use '==' for comparison in assert [OK]

Hint: Use '==' not '=' in assert condition [OK]

Common Mistakes:

• Confusing assignment with comparison
• Adding unnecessary parentheses
• Misplacing the error in indentation

5. You want to check if a list items contains exactly 3 elements using pytest assert. Which is the best assert statement?

hard

A. assert len(items) == 3, "List does not have 3 elements"

B. assert items == 3, "List length check failed"

C. assert items.length == 3, "Wrong length"

D. assert len(items) = 3, "Length must be 3"

Solution

1. Step 1: Understand how to get list length in Python

   Use the built-in function len() to get the number of elements in a list.

2. Step 2: Check correct assert syntax for length comparison

   Compare len(items) with 3 using '==', and provide a clear message after a comma.

3. Final Answer:

   assert len(items) == 3, "List does not have 3 elements" -> Option A

4. Quick Check:

   len(list) == number [OK]

Hint: Use len() and '==' to check list size [OK]

Common Mistakes:

• Comparing list directly to number
• Using JavaScript style .length property
• Using assignment '=' instead of '=='