Unit Testing with unittest

Unit testing is a method of testing individual units of code to ensure they work as expected. Python’s unittest module is a built-in library for creating and running unit tests.

In this lesson, you’ll learn how to create and execute unit tests using the unittest framework.

What Is Unit Testing?

Unit testing involves testing individual functions or methods in isolation to ensure they behave correctly. It helps catch bugs early in the development process and ensures code reliability.

Setting Up unittest

The unittest module is included in Python’s standard library, so you don’t need to install anything. To use it, import the module and create test cases by subclassing unittest.TestCase.

# Setting up unittest
import unittest

class TestExample(unittest.TestCase):
    def test_addition(self):
        self.assertEqual(1 + 1, 2)  # Passes

if __name__ == '__main__':
    unittest.main()

Writing Test Cases

To write a test case, define a method in your test class. Each method should start with test_ so that the unittest framework can recognize it as a test case.

# Writing test cases
class TestMathOperations(unittest.TestCase):
    def test_multiplication(self):
        self.assertEqual(2 * 3, 6)  # Passes

Running Tests

Run tests by executing the script containing your test cases. The unittest framework will automatically discover and execute all test methods.

# Running tests
# Save this file and run it using:
# python test_script.py

Common Assertions

The unittest module provides several assertion methods:

• assertEqual(a, b): Checks if a is equal to b.
• assertTrue(x): Checks if x is true.
• assertIn(a, b): Checks if a is in b.
• assertRaises(exception): Checks if an exception is raised.

Testing Edge Cases

It’s important to test edge cases, such as empty inputs, large numbers, or invalid data, to ensure the robustness of your code.

# Testing edge cases
class TestEdgeCases(unittest.TestCase):
    def test_empty_input(self):
        self.assertEqual(len([]), 0)  # Passes

Organizing Test Files

For larger projects, organize test cases in a separate folder, typically named tests/, and name test files with the test_ prefix.

Common Mistakes with unittest

Here are some mistakes to avoid:

• Not naming test methods with the test_ prefix.
• Forgetting to handle edge cases in test cases.
• Not running tests regularly during development.

What Did We Learn?

In this lesson, you learned:

• What unit testing is and why it’s important.
• How to use the unittest module to write and execute test cases.
• The common assertions available in the unittest framework.
• Best practices for organizing test files and handling edge cases.

Great job! Let’s move to the next topic.