Test classes in PyTest

Introduction

Test classes help organize related tests together. They make tests easier to read and manage.

When you have multiple tests for the same feature or function.

When you want to share setup steps for several tests.

When grouping tests by functionality or module improves clarity.

When you want to reuse code like setup or helper methods across tests.

Syntax

PyTest

class TestClassName:
    def test_method1(self):
        assert condition

    def test_method2(self):
        assert condition

Test classes must start with 'Test' for pytest to find them automatically.

Test methods inside must start with 'test_' to be recognized as tests.

Examples

A simple test class with one test method checking addition.

PyTest

class TestMath:
    def test_add(self):
        assert 1 + 1 == 2

Test class with two tests for string methods.

PyTest

class TestStrings:
    def test_upper(self):
        assert 'hello'.upper() == 'HELLO'

    def test_isupper(self):
        assert 'HELLO'.isupper()

Sample Program

This test class groups two simple math tests. Both tests check basic math operations.

PyTest

class TestCalculator:
    def test_add(self):
        assert 2 + 3 == 5

    def test_subtract(self):
        assert 5 - 3 == 2

Important Notes

Use test classes to keep tests organized and avoid repeating setup code.

Do not add an __init__ method to test classes; pytest creates instances automatically.

Use setup_method(self) if you need to run code before each test method.

Summary

Test classes group related tests for better organization.

Class names must start with 'Test' and methods with 'test_'.

They help share setup and keep tests clean and readable.

Practice

1. What is the main purpose of using test classes in pytest?

easy

A. To avoid writing assertions

B. To group related tests for better organization

C. To make tests run faster

D. To skip tests automatically

Solution

1. Step 1: Understand test grouping

   Test classes help organize related test functions together in one place.

2. Step 2: Recognize benefits

   This grouping improves readability and allows shared setup for tests.

3. Final Answer:

   To group related tests for better organization -> Option B

4. Quick Check:

   Test classes group tests = C [OK]

Hint: Test classes group related tests logically [OK]

Common Mistakes:

• Thinking test classes speed up tests
• Believing test classes skip tests
• Assuming test classes remove need for assertions

2. Which of the following is the correct way to name a pytest test class?

easy

A. class testExample:

B. class ExampleTest:

C. class TestExample:

D. class exampleTest:

Solution

1. Step 1: Recall pytest naming rules

   Pytest requires test classes to start with 'Test' exactly.

2. Step 2: Check options

   Only 'TestExample' starts with 'Test' correctly and follows naming conventions.

3. Final Answer:

   class TestExample: -> Option C

4. Quick Check:

   Class name starts with 'Test' = D [OK]

Hint: Test classes must start with 'Test' exactly [OK]

Common Mistakes:

• Starting class name with lowercase 'test'
• Placing 'Test' at the end of class name
• Using mixed case that doesn't start with 'Test'

3. Given the code below, what will pytest report when running these tests?

class TestMath:
    def test_add(self):
        assert 1 + 1 == 2

    def test_subtract(self):
        assert 5 - 3 == 1

medium

A. 1 test passed, 1 test failed

B. 2 tests passed

C. 2 tests failed

D. Syntax error, tests won't run

Solution

1. Step 1: Check each assertion

   test_add asserts 1+1==2 which is True; test_subtract asserts 5-3==1 which is False.

2. Step 2: Determine test results

   One test passes (test_add), one test fails (test_subtract).

3. Final Answer:

   1 test passed, 1 test failed -> Option A

4. Quick Check:

   Assertions true/false = 1 pass, 1 fail [OK]

Hint: Check each assertion result carefully [OK]

Common Mistakes:

• Assuming both tests pass without checking assertions
• Ignoring that 5 - 3 != 1
• Thinking syntax error due to indentation

4. Identify the error in the following pytest test class:

class TestCalc:
    def test_multiply(self):
        assert 2 * 3 == 6
    
    def multiply_test(self):
        assert 4 * 5 == 20

medium

A. Method 'multiply_test' will not be recognized as a test

B. Class name must not start with 'Test'

C. Missing assert statement in 'test_multiply'

D. Indentation error in method definitions

Solution

1. Step 1: Check method naming rules

   Pytest requires test methods to start with 'test_'. 'multiply_test' does not.

2. Step 2: Understand consequences

   Method 'multiply_test' will be ignored by pytest and not run as a test.

3. Final Answer:

   Method 'multiply_test' will not be recognized as a test -> Option A

4. Quick Check:

   Test methods start with 'test_' = A [OK]

Hint: Test methods must start with 'test_' [OK]

Common Mistakes:

• Thinking class name can't start with 'Test'
• Missing assert in test method
• Assuming indentation error without evidence

5. How can you share setup code for all tests inside a pytest test class?

hard

A. Define a method named 'setup_method' inside the class

B. Use a global variable outside the class

C. Write setup code inside each test method separately

D. Define a method named 'setup_class' inside the class

Solution

1. Step 1: Understand pytest setup methods

   Pytest supports 'setup_class' to run setup once for all tests in a class.

2. Step 2: Compare options

   'setup_method' runs before each test method, not once for all; global variables and repeated code are not best practice.

3. Final Answer:

   Define a method named 'setup_class' inside the class -> Option D

4. Quick Check:

   Class-wide setup uses 'setup_class' = B [OK]

Hint: Use 'setup_class' for one-time class setup [OK]

Common Mistakes:

• Confusing 'setup_method' with class-wide setup
• Using global variables instead of setup methods
• Repeating setup code in every test method