boost/test/impl/unit_test_parameters.ipp
// (C) Copyright Gennadiy Rozental 2001-2008.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// See http://www.boost.org/libs/test for the library home page.
//
// File : $RCSfile$
//
// Version : $Revision: 49312 $
//
// Description : simple implementation for Unit Test Framework parameter
// handling routines. May be rewritten in future to use some kind of
// command-line arguments parsing facility and environment variable handling
// facility
// ***************************************************************************
#ifndef BOOST_TEST_UNIT_TEST_PARAMETERS_IPP_012205GER
#define BOOST_TEST_UNIT_TEST_PARAMETERS_IPP_012205GER
// Boost.Test
#include <boost/test/detail/unit_test_parameters.hpp>
#include <boost/test/utils/basic_cstring/basic_cstring.hpp>
#include <boost/test/utils/basic_cstring/compare.hpp>
#include <boost/test/utils/basic_cstring/io.hpp>
#include <boost/test/utils/fixed_mapping.hpp>
#include <boost/test/debug.hpp>
// Boost
#include <boost/config.hpp>
#include <boost/test/detail/suppress_warnings.hpp>
#include <boost/lexical_cast.hpp>
#include <boost/test/detail/enable_warnings.hpp>
// STL
#include <map>
#include <cstdlib>
#include <boost/test/detail/suppress_warnings.hpp>
//____________________________________________________________________________//
# ifdef BOOST_NO_STDC_NAMESPACE
namespace std { using ::getenv; using ::strncmp; using ::strcmp; }
# endif
namespace boost {
namespace unit_test {
namespace {
// framework parameters and there corresponding command-line arguments
literal_string LOG_LEVEL = "BOOST_TEST_LOG_LEVEL";
literal_string NO_RESULT_CODE = "BOOST_TEST_RESULT_CODE";
literal_string REPORT_LEVEL = "BOOST_TEST_REPORT_LEVEL";
literal_string TESTS_TO_RUN = "BOOST_TESTS_TO_RUN";
literal_string SAVE_TEST_PATTERN = "BOOST_TEST_SAVE_PATTERN";
literal_string BUILD_INFO = "BOOST_TEST_BUILD_INFO";
literal_string SHOW_PROGRESS = "BOOST_TEST_SHOW_PROGRESS";
literal_string CATCH_SYS_ERRORS = "BOOST_TEST_CATCH_SYSTEM_ERRORS";
literal_string AUTO_START_DBG = "BOOST_TEST_AUTO_START_DBG";
literal_string USE_ALT_STACK = "BOOST_TEST_USE_ALT_STACK";
literal_string DETECT_FP_EXCEPT = "BOOST_TEST_DETECT_FP_EXCEPTIONS";
literal_string REPORT_FORMAT = "BOOST_TEST_REPORT_FORMAT";
literal_string LOG_FORMAT = "BOOST_TEST_LOG_FORMAT";
literal_string OUTPUT_FORMAT = "BOOST_TEST_OUTPUT_FORMAT";
literal_string DETECT_MEM_LEAK = "BOOST_TEST_DETECT_MEMORY_LEAK";
literal_string RANDOM_SEED = "BOOST_TEST_RANDOM";
literal_string BREAK_EXEC_PATH = "BOOST_TEST_BREAK_EXEC_PATH";
unit_test::log_level s_log_level;
bool s_no_result_code;
unit_test::report_level s_report_level;
const_string s_tests_to_run;
const_string s_exec_path_to_break;
bool s_save_pattern;
bool s_show_build_info;
bool s_show_progress;
bool s_catch_sys_errors;
bool s_auto_start_dbg;
bool s_use_alt_stack;
bool s_detect_fp_except;
output_format s_report_format;
output_format s_log_format;
long s_detect_mem_leaks;
unsigned int s_random_seed;
// ************************************************************************** //
// ************** runtime_config ************** //
// ************************************************************************** //
const_string
retrieve_framework_parameter( const_string parameter_name, int* argc, char** argv )
{
static fixed_mapping<const_string,const_string> parameter_2_cla_name_map(
LOG_LEVEL , "--log_level",
NO_RESULT_CODE , "--result_code",
REPORT_LEVEL , "--report_level",
TESTS_TO_RUN , "--run_test",
SAVE_TEST_PATTERN , "--save_pattern",
BUILD_INFO , "--build_info",
SHOW_PROGRESS , "--show_progress",
CATCH_SYS_ERRORS , "--catch_system_errors",
AUTO_START_DBG , "--auto_start_dbg",
USE_ALT_STACK , "--use_alt_stack",
DETECT_FP_EXCEPT , "--detect_fp_exceptions",
REPORT_FORMAT , "--report_format",
LOG_FORMAT , "--log_format",
OUTPUT_FORMAT , "--output_format",
DETECT_MEM_LEAK , "--detect_memory_leaks",
RANDOM_SEED , "--random",
BREAK_EXEC_PATH , "--break_exec_path",
""
);
// first try to find parameter among command line arguments if present
if( argc ) {
// locate corresponding cla name
const_string cla_name = parameter_2_cla_name_map[parameter_name];
if( !cla_name.is_empty() ) {
for( int i = 1; i < *argc; ++i ) {
if( cla_name == const_string( argv[i], cla_name.size() ) && argv[i][cla_name.size()] == '=' ) {
const_string result = argv[i] + cla_name.size() + 1;
for( int j = i; j < *argc; ++j ) {
argv[j] = argv[j+1];
}
--(*argc);
return result;
}
}
}
}
return std::getenv( parameter_name.begin() );
}
long interpret_long( const_string from )
{
bool negative = false;
long res = 0;
if( first_char( from ) == '-' ) {
negative = true;
from.trim_left( 1 );
}
const_string::iterator it = from.begin();
for( ;it != from.end(); ++it ) {
int d = *it - '0';
res = 10 * res + d;
}
if( negative )
res = -res;
return res;
}
} // local namespace
//____________________________________________________________________________//
namespace runtime_config {
void
init( int* argc, char** argv )
{
fixed_mapping<const_string,unit_test::log_level,case_ins_less<char const> > log_level_name(
"all" , log_successful_tests,
"success" , log_successful_tests,
"test_suite" , log_test_units,
"unit_scope" , log_test_units,
"message" , log_messages,
"warning" , log_warnings,
"error" , log_all_errors,
"cpp_exception" , log_cpp_exception_errors,
"system_error" , log_system_errors,
"fatal_error" , log_fatal_errors,
"nothing" , log_nothing,
invalid_log_level
);
fixed_mapping<const_string,unit_test::report_level,case_ins_less<char const> > report_level_name (
"confirm", CONFIRMATION_REPORT,
"short", SHORT_REPORT,
"detailed", DETAILED_REPORT,
"no", NO_REPORT,
INV_REPORT_LEVEL
);
fixed_mapping<const_string,output_format,case_ins_less<char const> > output_format_name (
"HRF", CLF,
"CLF", CLF,
"XML", XML,
CLF
);
s_no_result_code = retrieve_framework_parameter( NO_RESULT_CODE, argc, argv ) == "no";
s_save_pattern = retrieve_framework_parameter( SAVE_TEST_PATTERN, argc, argv ) == "yes";
s_show_build_info = retrieve_framework_parameter( BUILD_INFO, argc, argv ) == "yes";
s_show_progress = retrieve_framework_parameter( SHOW_PROGRESS, argc, argv ) == "yes";
#ifdef BOOST_TEST_DEFAULTS_TO_CORE_DUMP
s_catch_sys_errors = retrieve_framework_parameter( CATCH_SYS_ERRORS, argc, argv ) == "yes";
#else
s_catch_sys_errors = retrieve_framework_parameter( CATCH_SYS_ERRORS, argc, argv ) != "no";
#endif
s_use_alt_stack = retrieve_framework_parameter( USE_ALT_STACK, argc, argv ) != "no";
s_detect_fp_except = retrieve_framework_parameter( DETECT_FP_EXCEPT, argc, argv ) == "yes";
s_tests_to_run = retrieve_framework_parameter( TESTS_TO_RUN, argc, argv );
s_exec_path_to_break= retrieve_framework_parameter( BREAK_EXEC_PATH, argc, argv );
const_string rs_str = retrieve_framework_parameter( RANDOM_SEED, argc, argv );
s_random_seed = rs_str.is_empty() ? 0 : lexical_cast<unsigned int>( rs_str );
s_log_level = log_level_name[retrieve_framework_parameter( LOG_LEVEL, argc, argv )];
s_report_level = report_level_name[retrieve_framework_parameter( REPORT_LEVEL, argc, argv )];
s_report_format = output_format_name[retrieve_framework_parameter( REPORT_FORMAT, argc, argv )];
s_log_format = output_format_name[retrieve_framework_parameter( LOG_FORMAT, argc, argv )];
const_string output_format = retrieve_framework_parameter( OUTPUT_FORMAT, argc, argv );
if( !output_format.is_empty() ) {
s_report_format = output_format_name[output_format];
s_log_format = output_format_name[output_format];
}
const_string ml_str = retrieve_framework_parameter( DETECT_MEM_LEAK, argc, argv );
s_detect_mem_leaks = ml_str.is_empty() ? 1 : interpret_long( ml_str );
const_string dbg = retrieve_framework_parameter( AUTO_START_DBG, argc, argv );
if( dbg.is_empty() || dbg == "no" )
s_auto_start_dbg = false;
else {
s_auto_start_dbg = true;
if( dbg != "yes" )
debug::set_debugger( dbg );
}
}
//____________________________________________________________________________//
unit_test::log_level
log_level()
{
return s_log_level;
}
//____________________________________________________________________________//
bool
no_result_code()
{
return s_no_result_code;
}
//____________________________________________________________________________//
unit_test::report_level
report_level()
{
return s_report_level;
}
//____________________________________________________________________________//
const_string
test_to_run()
{
return s_tests_to_run;
}
//____________________________________________________________________________//
const_string
break_exec_path()
{
return s_exec_path_to_break;
}
//____________________________________________________________________________//
bool
save_pattern()
{
return s_save_pattern;
}
//____________________________________________________________________________//
bool
show_progress()
{
return s_show_progress;
}
//____________________________________________________________________________//
bool
show_build_info()
{
return s_show_build_info;
}
//____________________________________________________________________________//
bool
catch_sys_errors()
{
return s_catch_sys_errors;
}
//____________________________________________________________________________//
bool
auto_start_dbg()
{
return s_auto_start_dbg;
}
//____________________________________________________________________________//
bool
use_alt_stack()
{
return s_use_alt_stack;
}
//____________________________________________________________________________//
bool
detect_fp_exceptions()
{
return s_detect_fp_except;
}
//____________________________________________________________________________//
output_format
report_format()
{
return s_report_format;
}
//____________________________________________________________________________//
output_format
log_format()
{
return s_log_format;
}
//____________________________________________________________________________//
long
detect_memory_leaks()
{
return s_detect_mem_leaks;
}
//____________________________________________________________________________//
int
random_seed()
{
return s_random_seed;
}
//____________________________________________________________________________//
} // namespace runtime_config
} // namespace unit_test
} // namespace boost
//____________________________________________________________________________//
#include <boost/test/detail/enable_warnings.hpp>
#endif // BOOST_TEST_UNIT_TEST_PARAMETERS_IPP_012205GER