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 9[section:runtime_config Runtime parameters] 10 11 12[h4 Boost.Test runtime parameters] 13The __UTF__ supports multiple parameters that affect test module execution. To set the parameter's value you can 14either use a runtime configuration subsystem interface from within the test module initialization function or you can 15specify the value at runtime during test module invocation. 16 17The __UTF__ provides two ways to set a parameter at runtime: by specifying a command line argument and by setting an 18environment variable. The command line argument always overrides the corresponding environment variable. 19 20During test module initialization the __UTF__ parses the command line and excludes all parameters that belong to it and 21their values from the argument list. The rest of command line is forwarded to the test module initialization function 22supplied by you. The command line argument format expected by the __UTF__ is: 23 24[pre 25 --<command_line_argument_name>=<argument_value> 26] 27 28The command line argument name is case sensitive. It is required to match exactly the name in parameter specification. 29There should not be any spaces between '=' and either command line argument name or argument value. 30 31The corresponding environment variable name is also case sensitive and is required to exactly match the name in the 32parameter specification. 33 34All information about the currently supported parameters of the __UTF__ is summarized in 35the [link boost_test.runtime_config.summary summary section]. 36 37[h4 Test filtering] 38The __UTF__ provides an extensive filtering facility making it easy to run a specific test or a subset of tests. The 39[link boost_test.runtime_config.test_unit_filtering section on filtering] gives all the details for the command line interface. 40 41Additionally, [link boost_test.tests_organization.test_tree.test_suite test-suites] and [link boost_test.tests_organization.tests_grouping labels] 42may be used in order to construct subset of tests in an efficient and easy way, while decorators 43(eg. __decorator_disabled__, __decorator_precondition__) can be used to set the default run status of a test case. 44 45[h4 Custom runtime parameters] 46It is possible to extend further the command line interface by providing a custom command line interpretation logic. There are several 47ways on how to integrate this logic in the __UTF__ and this is explained in details in the section 48[link boost_test.runtime_config.custom_command_line_arguments Custom runtime parameters]. 49 50 51[include test_unit_filtering.qbk] 52[include runtime_custom.qbk] 53[include runtime_config_summary.qbk] 54 55[endsect] [/ runtime configuration] 56