unittest

Overview

The unittest module is Python's built-in unit testing framework. Inspired by JUnit, it offers a structured way to write and organize test cases. Key components include: test fixtures (setup/teardown), test cases (individual tests), test suites (collections of tests), and test runners (execution and reporting). It supports test automation, sharing setup and shutdown code, aggregating tests, and independence from reporting frameworks. Using TestCase classes, developers can define test methods that assert expected outcomes using methods like assertEqual, assertTrue, and assertRaises. The framework includes a command-line interface for running tests and provides options for verbosity, buffering output, and fail-fast execution. Integration with CI/CD systems like Buildbot and Jenkins is common for automated testing in production environments, ensuring code quality and reliability.

Common tasks

Unit Testing Test Automation Regression Testing

FAQ

View all

What is a test fixture?

A test fixture represents the preparation needed to perform one or more tests, and any associated cleanup actions. This may involve, for example, creating temporary or proxy databases, directories, or starting a server process.

What is a test case?

A test case is the individual unit of testing. It checks for a specific response to a particular set of inputs. unittest provides a base class, TestCase, which may be used to create new test cases.

What is a test suite?

A test suite is a collection of test cases, test suites, or both. It is used to aggregate tests that should be executed together.

What is a test runner?

A test runner is a component which orchestrates the execution of tests and provides the outcome to the user. The runner may use a graphical interface, a textual interface, or return a special value to indicate the results of executing the tests.