|> The Unit Test Framework > User's guide >
Table of Contents
Without further ado, let's define terms regularly used by the UTF.
|This is a single binary that performs the test. Physically a test module consists of one or more test source files, which can be built into an executable or a dynamic library. A test module that consists of a single test source file is called single-file test module. Otherwise it's called multi-file test module. Logically a test module consists of four parts: test setup (or test initialization), test body, test cleanup and test runner. The test runner part is optional. If a test module is built as an executable the test runner is built-in. If a test module is built as a dynamic library, it is run by an external test runner.
|This is the part of a test module that actually performs the test. Logically test body is a collection of test assertions wrapped in test cases, which are organized in a test tree .
|This is a hierarchical structure of test suites (non-leaf nodes) and test cases (leaf nodes).
|This is a collective name when referred to either test suite or test case
This is a single binary condition (binary in a sense that is has two outcomes: pass and fail) checked by a test module.
There are different schools of thought on how many test assertions a test case should consist of. Two polar positions are the one advocated by TDD followers - one assertion per test case; and opposite of this - all test assertions within single test case - advocated by those only interested in the first error in a test module. The UTF supports both approaches.
|This is an independently monitored function within a test module that consists of one or more test assertions. The term "independently monitored" in the definition above is used to emphasize the fact, that all test cases are monitored independently. An uncaught exception or other normal test case execution termination doesn't cause the testing to cease. Instead the error is caught by the test case execution monitor, reported by the UTF and testing proceeds to the next test case. Later on you are going to see that this is on of the primary reasons to prefer multiple small test cases to a single big test function.
This is a container for one or more test cases. The test suite gives you an ability to group test cases into a single referable entity. There are various reasons why you may opt to do so, including:
A test suite can also contain other test suites, thus allowing a hierarchical test tree structure to be formed. The UTF requires the test tree to contain at least one test suite with at least one test case. The top level test suite - root node of the test tree - is called the master test suite.
This is the part of a test module that is responsible for the test preparation. It includes the following operations that take place prior to a start of the test:
Per test case" setup code, invoked for every test case it's assigned to, is also attributed to the test initialization, even though it's executed as a part of the test case.
|This is the part of test module that is responsible for cleanup operations.
|Matching setup and cleanup operations are frequently united into a single entity called test fixture.
This is an "executive manager" that runs the show. The test runner's functionality should include the following interfaces and operations:
An advanced test runner may provide additional features, including interactive GUI interfaces, test coverage and profiling support.
|This is the record of all events that occur during the testing.
|This is the report produced by the UTF after the testing is completed, that indicates which test cases/test suites passed and which failed.