Comparing values (equality, inequality) in PyTest - Framework Patterns

Framework Mode - Comparing values (equality, inequality)

Folder Structure

project-root/
├── tests/
│   ├── test_values.py       # Test cases for value comparisons
│   ├── __init__.py
├── src/
│   ├── __init__.py
│   └── value_utils.py        # Helper functions if needed
├── conftest.py              # Fixtures and setup
├── pytest.ini               # Pytest configuration
└── requirements.txt         # Dependencies
  

Test Framework Layers

• Tests Layer: Contains test files like test_values.py where assertions for equality and inequality are written using assert statements.
• Utilities Layer: Optional helper functions in value_utils.py to prepare or transform data before comparison.
• Fixtures Layer: conftest.py holds reusable setup code or test data fixtures.
• Configuration Layer: pytest.ini configures pytest behavior such as markers or test paths.

Configuration Patterns

Use pytest.ini to configure test runs, for example:

[pytest]
addopts = -v --maxfail=3
markers =
    equality: tests for equality comparisons
    inequality: tests for inequality comparisons
  

Use conftest.py to define fixtures that provide test data for different environments or scenarios.

For example, a fixture providing sample values to compare:

import pytest

@pytest.fixture
def samp_values():
    return 10, 20
  

Test Reporting and CI/CD Integration

• Pytest outputs test results in the console with clear pass/fail status for each assertion.
• Use plugins like pytest-html to generate detailed HTML reports.
• Integrate pytest runs into CI/CD pipelines (e.g., GitHub Actions, Jenkins) to run tests automatically on code changes.
• Failing assertions on equality or inequality comparisons will cause the test to fail, making it easy to spot issues.

Best Practices

1. Use simple assert statements for equality (==) and inequality (!=) checks to keep tests readable.
2. Write clear test names describing what values are compared and expected results.
3. Use fixtures to provide consistent test data and avoid duplication.
4. Keep tests small and focused on one comparison per test function.
5. Use descriptive assertion messages if needed to clarify failures.

Self Check

Where in this folder structure would you add a new test that checks if two strings are not equal?

Key Result

Organize pytest tests in a clear folder structure using simple assert statements for equality and inequality comparisons, supported by fixtures and configuration for maintainability.

Practice

1. Which operator in pytest assertions checks if two values are equal?

easy

A. <

B. !=

C. >

D. ==

Solution

1. Step 1: Understand equality operator

   The operator == is used to check if two values are equal in Python and pytest assertions.

2. Step 2: Differentiate from inequality

   The operator != checks if values are not equal, so it is not the correct choice for equality.

3. Final Answer:

   == -> Option D

4. Quick Check:

   Equality check = == [OK]

Hint: Use == for equality, != for inequality [OK]

Common Mistakes:

• Confusing == with !=
• Using > or < for equality
• Forgetting to use assertion keyword

2. Which of the following is the correct syntax to assert that variable a is not equal to b in pytest?

easy

A. assert a != b

B. assert a =! b

C. assert a ==! b

D. assert a = b

Solution

1. Step 1: Identify correct inequality syntax

   The correct operator for inequality is !=, so the assertion should be assert a != b.

2. Step 2: Check syntax correctness

   Options with =! or ==! are invalid syntax and will cause errors.

3. Final Answer:

   assert a != b -> Option A

4. Quick Check:

   Inequality assertion = assert a != b [OK]

Hint: Remember: inequality is !=, not =! or ==! [OK]

Common Mistakes:

• Using =! instead of !=
• Using = instead of ==
• Mixing equality and inequality operators

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

def test_numbers():
    x = 10
    y = 5 + 5
    assert x == y

medium

A. Syntax error in assertion

B. Test fails because 10 does not equal 5

C. Test passes because 10 equals 10

D. Test fails because variables are different

Solution

1. Step 1: Calculate values of variables

   Variable x is 10, and y is calculated as 5 + 5, which equals 10.

2. Step 2: Evaluate assertion condition

   The assertion assert x == y checks if 10 equals 10, which is true, so the test passes.

3. Final Answer:

   Test passes because 10 equals 10 -> Option C

4. Quick Check:

   10 == 10 is True [OK]

Hint: Add values before comparing for equality [OK]

Common Mistakes:

• Assuming variables differ without calculation
• Confusing syntax errors with logic errors
• Ignoring that 5 + 5 equals 10

4. Identify the error in this pytest assertion:

def test_strings():
    s1 = "hello"
    s2 = "Hello"
    assert s1 != s2

medium

A. No error, test passes because strings differ in case

B. Syntax error due to missing parentheses

C. Assertion should use == instead of !=

D. Variables s1 and s2 are not defined

Solution

1. Step 1: Compare string values with case sensitivity

   Strings "hello" and "Hello" differ in case, so they are not equal.

2. Step 2: Check assertion correctness

   The assertion assert s1 != s2 correctly checks that the strings are not equal, so the test passes without error.

3. Final Answer:

   No error, test passes because strings differ in case -> Option A

4. Quick Check:

   "hello" != "Hello" is True [OK]

Hint: String comparison is case-sensitive by default [OK]

Common Mistakes:

• Assuming strings are equal ignoring case
• Expecting syntax error without parentheses in assert
• Confusing == and != in assertions

5. You want to write a pytest test to check that a function get_status() returns a value that is not equal to None. Which assertion is the best choice?

hard

A. assert get_status() == None

B. assert get_status() is not None

C. assert get_status() != None

D. assert get_status() is None

Solution

1. Step 1: Understand None comparison best practice

   In Python, to check if a value is not None, the recommended way is to use is not None rather than != None.

2. Step 2: Evaluate options for correctness

   assert get_status() == None checks equality to None (wrong for this case). assert get_status() != None uses != None (works but not best practice). assert get_status() is not None uses is not None which is best practice. assert get_status() is None checks if value is None (opposite of requirement).

3. Final Answer:

   assert get_status() is not None -> Option B

4. Quick Check:

   Use 'is not None' for None checks [OK]

Hint: Use 'is not None' to check for non-None values [OK]

Common Mistakes:

• Using == None instead of is None
• Using != None instead of is not None
• Confusing equality with identity for None