1[/ 2 / Copyright (c) 2003 Boost.Test contributors 3 / 4 / Distributed under the Boost Software License, Version 1.0. (See accompanying 5 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 6 /] 7 8[section:section_glossary Glossary] 9 10Here is the list of terms used throughout this documentation. 11 12[#ref_test_module][h3 Test module] 13This is a single binary that performs the test. Physically a test module consists of one or more test source files, 14which can be built into an executable or a dynamic library. A test module that consists of a single test source 15file is called ['single-file test module]. Otherwise 16it's called ['multi-file test module]. Logically, each test module consists of four parts: 17 18# [link test_setup test setup] (or test initialization), 19# [link test_body test body] 20# [link test_cleanup test cleanup] 21# [link test_runner test runner] 22 23The test runner part is optional. If a test module is built as 24an executable, the test runner is built-in. If a test module is built as a dynamic library, it is run by an 25[link boost_test.adv_scenarios.external_test_runner external test runner]. 26 27[warning The test module should have at least one test-case defined, otherwise it is considered as an error.] 28 29[#test_body][h3 Test body] 30This is the part of a test module that actually performs the test. 31Logically test body is a collection of [link test_assertion test assertions] wrapped in 32[link test_case test cases], which are organized in a [link ref_test_tree test tree]. 33 34[#ref_test_tree][h3 Test tree] 35This is a hierarchical structure of [link test_suite test suites] (non-leaf nodes) and 36[link test_case test cases] (leaf nodes). More details can be found [link boost_test.tests_organization here]. 37 38[#ref_test_unit][h3 Test unit] 39This is a collective name when referred to either a [link test_suite test suite] or 40[link test_case test cases]. See [link boost_test.tests_organization this section] for more details. 41 42[#test_assertion][h3 Test assertion] 43This is a single binary condition (binary in a sense that is has two outcomes: pass and fail) checked 44by a test module. 45 46There are different schools of thought on how many test assertions a test case should consist of. Two polar 47positions are the one advocated by TDD followers - one assertion per test case; and opposite of this - all test 48assertions within single test case - advocated by those only interested in the first error in a 49test module. The __UTF__ supports both approaches. 50 51[#test_case][h3 Test case] 52This is an independently monitored function within a test module that 53consists of one or more test assertions. The term ['independently monitored] in the definition above is 54used to emphasize the fact, that all test cases are monitored independently. An uncaught exception or other normal 55test case execution termination doesn't cause the testing to cease. Instead the error is caught by the test 56case execution monitor, reported by the __UTF__ and testing proceeds to the next test case. Later on you are going 57to see that this is on of the primary reasons to prefer multiple small test cases to a single big test function. 58 59 60[#test_suite][h3 Test suite] 61This is a container for one or more test cases. The test suite gives you an ability to group 62test cases into a single referable entity. There are various reasons why you may opt to do so, including: 63 64* To group test cases per subsystems of the unit being tested. 65* To share test case setup/cleanup code. 66* To run selected group of test cases only. 67* To see test report split by groups of test cases. 68* To skip groups of test cases based on the result of another test unit in a test tree. 69 70A test suite can also contain other test suites, thus allowing a hierarchical test tree structure to be formed. 71The __UTF__ requires the test tree to contain at least one test suite with at least one test case. The top level 72test suite - root node of the test tree - is called the master test suite. 73 74 75 76[#test_setup][h3 Test setup] 77This is the part of a test module that is responsible for the test 78preparation. It includes the following operations that take place prior to a start of the test: 79 80* The __UTF__ initialization 81* Test tree construction 82* Global test module setup code 83* ['Per test case] setup code, invoked for every test case it's assigned to, is also attributed to the 84 test initialization, even though it's executed as a part of the test case. 85 86[#test_cleanup][h3 Test cleanup] 87This is the part of test module that is responsible for cleanup operations. 88 89[#test_fixture][h3 Test fixture] 90Matching setup and cleanup operations are frequently united into a single entity called test fixture. 91 92[#test_runner][h3 Test runner] 93This is an ['orchestrator] or a ['driver] that, given the test tree, ensures the test tree is initialized, tests are executed and necessary reports generated. For more information [link boost_test.adv_scenarios.test_module_runner_overview see here]. 94 95[#test_log][h3 Test log] 96This is the record of all events that occur during the testing. 97 98[#test_report][h3 Test report] 99This is the report produced by the __UTF__ after the testing is completed, that indicates which test cases/test 100suites passed and which failed. 101 102 103[endsect] [/ Glossary] 104