Chris@16: // (C) Copyright Gennadiy Rozental 2001-2008. Chris@16: // Distributed under the Boost Software License, Version 1.0. Chris@16: // (See accompanying file LICENSE_1_0.txt or copy at Chris@16: // http://www.boost.org/LICENSE_1_0.txt) Chris@16: Chris@16: // See http://www.boost.org/libs/test for the library home page. Chris@16: // Chris@16: // File : $RCSfile$ Chris@16: // Chris@101: // Version : $Revision$ Chris@16: // Chris@16: // Description : simple implementation for Unit Test Framework parameter Chris@16: // handling routines. May be rewritten in future to use some kind of Chris@16: // command-line arguments parsing facility and environment variable handling Chris@16: // facility Chris@16: // *************************************************************************** Chris@16: Chris@16: #ifndef BOOST_TEST_UNIT_TEST_PARAMETERS_IPP_012205GER Chris@16: #define BOOST_TEST_UNIT_TEST_PARAMETERS_IPP_012205GER Chris@16: Chris@16: // Boost.Test Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: Chris@16: // Boost.Runtime.Param Chris@16: #include Chris@16: #include Chris@16: Chris@16: namespace rt = boost::runtime; Chris@16: namespace cla = rt::cla; Chris@16: Chris@16: Chris@16: #ifndef UNDER_CE Chris@16: #include Chris@16: Chris@16: namespace env = rt::env; Chris@16: #endif Chris@16: Chris@16: Chris@16: // Boost Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: Chris@16: // STL Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: Chris@16: #include Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: # ifdef BOOST_NO_STDC_NAMESPACE Chris@16: namespace std { using ::getenv; using ::strncmp; using ::strcmp; } Chris@16: # endif Chris@16: Chris@16: namespace boost { Chris@16: Chris@16: namespace unit_test { Chris@16: Chris@16: // ************************************************************************** // Chris@16: // ************** input operations for unit_test's enums ************** // Chris@16: // ************************************************************************** // Chris@16: Chris@16: std::istream& Chris@16: operator>>( std::istream& in, unit_test::log_level& ll ) Chris@16: { Chris@16: static fixed_mapping > log_level_name( Chris@16: "all" , log_successful_tests, Chris@16: "success" , log_successful_tests, Chris@16: "test_suite" , log_test_units, Chris@16: "unit_scope" , log_test_units, Chris@16: "message" , log_messages, Chris@16: "warning" , log_warnings, Chris@16: "error" , log_all_errors, Chris@16: "cpp_exception" , log_cpp_exception_errors, Chris@16: "system_error" , log_system_errors, Chris@16: "fatal_error" , log_fatal_errors, Chris@16: "nothing" , log_nothing, Chris@16: Chris@16: invalid_log_level Chris@16: ); Chris@16: Chris@16: std::string val; Chris@16: in >> val; Chris@16: Chris@16: ll = log_level_name[val]; Chris@16: BOOST_TEST_SETUP_ASSERT( ll != unit_test::invalid_log_level, "invalid log level " + val ); Chris@16: Chris@16: return in; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: std::istream& Chris@16: operator>>( std::istream& in, unit_test::report_level& rl ) Chris@16: { Chris@16: fixed_mapping > report_level_name ( Chris@16: "confirm", CONFIRMATION_REPORT, Chris@16: "short", SHORT_REPORT, Chris@16: "detailed", DETAILED_REPORT, Chris@16: "no", NO_REPORT, Chris@16: Chris@16: INV_REPORT_LEVEL Chris@16: ); Chris@16: Chris@16: std::string val; Chris@16: in >> val; Chris@16: Chris@16: rl = report_level_name[val]; Chris@16: BOOST_TEST_SETUP_ASSERT( rl != INV_REPORT_LEVEL, "invalid report level " + val ); Chris@16: Chris@16: return in; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: std::istream& Chris@16: operator>>( std::istream& in, unit_test::output_format& of ) Chris@16: { Chris@16: fixed_mapping > output_format_name ( Chris@16: "HRF", unit_test::CLF, Chris@16: "CLF", unit_test::CLF, Chris@16: "XML", unit_test::XML, Chris@16: Chris@16: unit_test::INV_OF Chris@16: ); Chris@16: Chris@16: std::string val; Chris@16: in >> val; Chris@16: Chris@16: of = output_format_name[val]; Chris@16: BOOST_TEST_SETUP_ASSERT( of != unit_test::INV_OF, "invalid output format " + val ); Chris@16: Chris@16: return in; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: // ************************************************************************** // Chris@16: // ************** runtime_config ************** // Chris@16: // ************************************************************************** // Chris@16: Chris@16: namespace runtime_config { Chris@16: Chris@16: namespace { Chris@16: Chris@16: // framework parameters and corresponding command-line arguments Chris@16: std::string AUTO_START_DBG = "auto_start_dbg"; Chris@16: std::string BREAK_EXEC_PATH = "break_exec_path"; Chris@16: std::string BUILD_INFO = "build_info"; Chris@16: std::string CATCH_SYS_ERRORS = "catch_system_errors"; Chris@16: std::string DETECT_FP_EXCEPT = "detect_fp_exceptions"; Chris@16: std::string DETECT_MEM_LEAKS = "detect_memory_leaks"; Chris@16: std::string LOG_FORMAT = "log_format"; Chris@16: std::string LOG_LEVEL = "log_level"; Chris@16: std::string LOG_SINK = "log_sink"; Chris@16: std::string OUTPUT_FORMAT = "output_format"; Chris@16: std::string RANDOM_SEED = "random"; Chris@16: std::string REPORT_FORMAT = "report_format"; Chris@16: std::string REPORT_LEVEL = "report_level"; Chris@16: std::string REPORT_SINK = "report_sink"; Chris@16: std::string RESULT_CODE = "result_code"; Chris@16: std::string TESTS_TO_RUN = "run_test"; Chris@16: std::string SAVE_TEST_PATTERN = "save_pattern"; Chris@16: std::string SHOW_PROGRESS = "show_progress"; Chris@16: std::string USE_ALT_STACK = "use_alt_stack"; Chris@16: Chris@16: fixed_mapping parameter_2_env_var( Chris@16: AUTO_START_DBG , "BOOST_TEST_AUTO_START_DBG", Chris@16: BREAK_EXEC_PATH , "BOOST_TEST_BREAK_EXEC_PATH", Chris@16: BUILD_INFO , "BOOST_TEST_BUILD_INFO", Chris@16: CATCH_SYS_ERRORS , "BOOST_TEST_CATCH_SYSTEM_ERRORS", Chris@16: DETECT_FP_EXCEPT , "BOOST_TEST_DETECT_FP_EXCEPTIONS", Chris@16: DETECT_MEM_LEAKS , "BOOST_TEST_DETECT_MEMORY_LEAK", Chris@16: LOG_FORMAT , "BOOST_TEST_LOG_FORMAT", Chris@16: LOG_LEVEL , "BOOST_TEST_LOG_LEVEL", Chris@16: LOG_SINK , "BOOST_TEST_LOG_SINK", Chris@16: OUTPUT_FORMAT , "BOOST_TEST_OUTPUT_FORMAT", Chris@16: RANDOM_SEED , "BOOST_TEST_RANDOM", Chris@16: REPORT_FORMAT , "BOOST_TEST_REPORT_FORMAT", Chris@16: REPORT_LEVEL , "BOOST_TEST_REPORT_LEVEL", Chris@16: REPORT_SINK , "BOOST_TEST_REPORT_SINK", Chris@16: RESULT_CODE , "BOOST_TEST_RESULT_CODE", Chris@16: TESTS_TO_RUN , "BOOST_TESTS_TO_RUN", Chris@16: SAVE_TEST_PATTERN , "BOOST_TEST_SAVE_PATTERN", Chris@16: SHOW_PROGRESS , "BOOST_TEST_SHOW_PROGRESS", Chris@16: USE_ALT_STACK , "BOOST_TEST_USE_ALT_STACK", Chris@16: Chris@16: "" Chris@16: ); Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: // storage for the CLAs Chris@16: cla::parser s_cla_parser; Chris@16: std::string s_empty; Chris@16: Chris@16: output_format s_report_format; Chris@16: output_format s_log_format; Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: template Chris@16: T Chris@16: retrieve_parameter( const_string parameter_name, cla::parser const& s_cla_parser, T const& default_value = T(), T const& optional_value = T() ) Chris@16: { Chris@16: rt::const_argument_ptr arg = s_cla_parser[parameter_name]; Chris@16: if( arg ) { Chris@16: if( rtti::type_id() == rtti::type_id() || Chris@16: !static_cast( arg->p_formal_parameter.get() ).p_optional_value ) Chris@16: return s_cla_parser.get( parameter_name ); Chris@16: Chris@16: optional val = s_cla_parser.get >( parameter_name ); Chris@16: if( val ) Chris@16: return *val; Chris@16: else Chris@16: return optional_value; Chris@16: } Chris@16: Chris@16: boost::optional v; Chris@16: Chris@16: #ifndef UNDER_CE Chris@16: env::get( parameter_2_env_var[parameter_name], v ); Chris@16: #endif Chris@16: Chris@16: if( v ) Chris@16: return *v; Chris@16: else Chris@16: return default_value; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: } // local namespace Chris@16: Chris@16: void Chris@16: init( int& argc, char** argv ) Chris@16: { Chris@16: using namespace cla; Chris@16: Chris@16: try { Chris@16: s_cla_parser - cla::ignore_mismatch Chris@16: << cla::dual_name_parameter( AUTO_START_DBG + "|d" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Automatically starts debugger if system level error (signal) occurs") Chris@16: << cla::named_parameter( BREAK_EXEC_PATH ) Chris@16: - (cla::prefix = "--",cla::separator = "=",cla::guess_name,cla::optional, Chris@16: cla::description = "For the exception safety testing allows to break at specific execution path") Chris@16: << cla::dual_name_parameter( BUILD_INFO + "|i" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Shows library build information" ) Chris@16: << cla::dual_name_parameter( CATCH_SYS_ERRORS + "|s" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Allows to switch between catching and ignoring system errors (signals)") Chris@16: << cla::named_parameter( DETECT_FP_EXCEPT ) Chris@16: - (cla::prefix = "--",cla::separator = "=",cla::guess_name,cla::optional, Chris@16: cla::description = "Allows to switch between catching and ignoring floating point exceptions") Chris@16: << cla::named_parameter( DETECT_MEM_LEAKS ) Chris@16: - (cla::prefix = "--",cla::separator = "=",cla::guess_name,cla::optional, Chris@16: cla::description = "Allows to switch between catching and ignoring memory leaks") Chris@16: << cla::dual_name_parameter( LOG_FORMAT + "|f" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Specifies log format") Chris@16: << cla::dual_name_parameter( LOG_LEVEL + "|l" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Specifies log level") Chris@16: << cla::dual_name_parameter( LOG_SINK + "|k" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Specifies log sink:stdout(default),stderr or file name") Chris@16: << cla::dual_name_parameter( OUTPUT_FORMAT + "|o" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Specifies output format (both log and report)") Chris@16: << cla::dual_name_parameter( RANDOM_SEED + "|a" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional,cla::optional_value, Chris@16: cla::description = "Allows to switch between sequential and random order of test units execution.\n" Chris@16: "Optionally allows to specify concrete seed for random number generator") Chris@16: << cla::dual_name_parameter( REPORT_FORMAT + "|m" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Specifies report format") Chris@16: << cla::dual_name_parameter(REPORT_LEVEL + "|r") Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Specifies report level") Chris@16: << cla::dual_name_parameter( REPORT_SINK + "|e" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Specifies report sink:stderr(default),stdout or file name") Chris@16: << cla::dual_name_parameter( RESULT_CODE + "|c" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Allows to disable test modules's result code generation") Chris@16: << cla::dual_name_parameter( TESTS_TO_RUN + "|t" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Allows to filter which test units to run") Chris@16: << cla::named_parameter( SAVE_TEST_PATTERN ) Chris@16: - (cla::prefix = "--",cla::separator = "=",cla::guess_name,cla::optional, Chris@16: cla::description = "Allows to switch between saving and matching against test pattern file") Chris@16: << cla::dual_name_parameter( SHOW_PROGRESS + "|p" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=| ",cla::guess_name,cla::optional, Chris@16: cla::description = "Turns on progress display") Chris@16: << cla::named_parameter( USE_ALT_STACK ) Chris@16: - (cla::prefix = "--",cla::separator = "=",cla::guess_name,cla::optional, Chris@16: cla::description = "Turns on/off usage of an alternative stack for signal handling") Chris@16: Chris@16: << cla::dual_name_parameter( "help|?" ) Chris@16: - (cla::prefix = "--|-",cla::separator = "=",cla::guess_name,cla::optional, Chris@16: cla::description = "this help message") Chris@16: ; Chris@16: Chris@16: s_cla_parser.parse( argc, argv ); Chris@16: Chris@16: if( s_cla_parser["help"] ) { Chris@16: s_cla_parser.help( std::cout ); Chris@16: throw framework::nothing_to_test(); Chris@16: } Chris@16: Chris@16: s_report_format = retrieve_parameter( REPORT_FORMAT, s_cla_parser, unit_test::CLF ); Chris@16: s_log_format = retrieve_parameter( LOG_FORMAT, s_cla_parser, unit_test::CLF ); Chris@16: Chris@16: unit_test::output_format of = retrieve_parameter( OUTPUT_FORMAT, s_cla_parser, unit_test::INV_OF ); Chris@16: Chris@16: if( of != unit_test::INV_OF ) Chris@16: s_report_format = s_log_format = of; Chris@16: } Chris@16: catch( rt::logic_error const& ex ) { Chris@16: std::ostringstream err; Chris@16: Chris@16: err << "Fail to process runtime parameters: " << ex.msg() << std::endl; Chris@16: s_cla_parser.usage( err ); Chris@16: Chris@16: throw framework::setup_error( err.str() ); Chris@16: } Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: unit_test::log_level Chris@16: log_level() Chris@16: { Chris@16: return retrieve_parameter( LOG_LEVEL, s_cla_parser, unit_test::log_all_errors ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: bool Chris@16: no_result_code() Chris@16: { Chris@16: return !retrieve_parameter( RESULT_CODE, s_cla_parser, true ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: unit_test::report_level Chris@16: report_level() Chris@16: { Chris@16: return retrieve_parameter( REPORT_LEVEL, s_cla_parser, unit_test::CONFIRMATION_REPORT ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: const_string Chris@16: test_to_run() Chris@16: { Chris@16: static std::string s_test_to_run = retrieve_parameter( TESTS_TO_RUN, s_cla_parser, s_empty ); Chris@16: Chris@16: return s_test_to_run; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: const_string Chris@16: break_exec_path() Chris@16: { Chris@16: static std::string s_break_exec_path = retrieve_parameter( BREAK_EXEC_PATH, s_cla_parser, s_empty ); Chris@16: Chris@16: return s_break_exec_path; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: bool Chris@16: save_pattern() Chris@16: { Chris@16: return retrieve_parameter( SAVE_TEST_PATTERN, s_cla_parser, false ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: bool Chris@16: show_progress() Chris@16: { Chris@16: return retrieve_parameter( SHOW_PROGRESS, s_cla_parser, false ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: bool Chris@16: show_build_info() Chris@16: { Chris@16: return retrieve_parameter( BUILD_INFO, s_cla_parser, false ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: bool Chris@16: catch_sys_errors() Chris@16: { Chris@16: return retrieve_parameter( CATCH_SYS_ERRORS, s_cla_parser, Chris@16: #ifdef BOOST_TEST_DEFAULTS_TO_CORE_DUMP Chris@16: false Chris@16: #else Chris@16: true Chris@16: #endif Chris@16: ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: bool Chris@16: auto_start_dbg() Chris@16: { Chris@16: // !! set debugger as an option Chris@16: return retrieve_parameter( AUTO_START_DBG, s_cla_parser, false ); Chris@16: ; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: bool Chris@16: use_alt_stack() Chris@16: { Chris@16: return retrieve_parameter( USE_ALT_STACK, s_cla_parser, true ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: bool Chris@16: detect_fp_exceptions() Chris@16: { Chris@16: return retrieve_parameter( DETECT_FP_EXCEPT, s_cla_parser, false ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: output_format Chris@16: report_format() Chris@16: { Chris@16: return s_report_format; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: output_format Chris@16: log_format() Chris@16: { Chris@16: return s_log_format; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: std::ostream* Chris@16: report_sink() Chris@16: { Chris@16: std::string sink_name = retrieve_parameter( REPORT_SINK, s_cla_parser, s_empty ); Chris@16: Chris@16: if( sink_name.empty() || sink_name == "stderr" ) Chris@16: return &std::cerr; Chris@16: Chris@16: if( sink_name == "stdout" ) Chris@16: return &std::cout; Chris@16: Chris@16: static std::ofstream log_file( sink_name.c_str() ); Chris@16: return &log_file; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: std::ostream* Chris@16: log_sink() Chris@16: { Chris@16: std::string sink_name = retrieve_parameter( LOG_SINK, s_cla_parser, s_empty ); Chris@16: Chris@16: if( sink_name.empty() || sink_name == "stdout" ) Chris@16: return &std::cout; Chris@16: Chris@16: if( sink_name == "stderr" ) Chris@16: return &std::cerr; Chris@16: Chris@16: static std::ofstream report_file( sink_name.c_str() ); Chris@16: return &report_file; Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: long Chris@16: detect_memory_leaks() Chris@16: { Chris@16: return retrieve_parameter( DETECT_MEM_LEAKS, s_cla_parser, static_cast(1) ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: int Chris@16: random_seed() Chris@16: { Chris@16: return retrieve_parameter( RANDOM_SEED, s_cla_parser, 0, 1 ); Chris@16: } Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: } // namespace runtime_config Chris@16: Chris@16: } // namespace unit_test Chris@16: Chris@16: } // namespace boost Chris@16: Chris@16: //____________________________________________________________________________// Chris@16: Chris@16: #include Chris@16: Chris@16: #endif // BOOST_TEST_UNIT_TEST_PARAMETERS_IPP_012205GER