1 // (C) Copyright Gennadiy Rozental 2001.
2 // Distributed under the Boost Software License, Version 1.0.
3 // (See accompanying file LICENSE_1_0.txt or copy at
4 // http://www.boost.org/LICENSE_1_0.txt)
6 // See http://www.boost.org/libs/test for the library home page.
10 // Version : $Revision$
12 // Description : implemets Unit Test Log
13 // ***************************************************************************
15 #ifndef BOOST_TEST_UNIT_TEST_LOG_IPP_012205GER
16 #define BOOST_TEST_UNIT_TEST_LOG_IPP_012205GER
19 #include <boost/test/unit_test_log.hpp>
20 #include <boost/test/unit_test_log_formatter.hpp>
21 #include <boost/test/execution_monitor.hpp>
22 #include <boost/test/framework.hpp>
23 #include <boost/test/unit_test_parameters.hpp>
25 #include <boost/test/utils/basic_cstring/compare.hpp>
26 #include <boost/test/utils/foreach.hpp>
28 #include <boost/test/output/compiler_log_formatter.hpp>
29 #include <boost/test/output/xml_log_formatter.hpp>
30 #include <boost/test/output/junit_log_formatter.hpp>
33 #include <boost/shared_ptr.hpp>
34 #include <boost/io/ios_state.hpp>
35 typedef ::boost::io::ios_base_all_saver io_saver_type;
37 #include <boost/test/detail/suppress_warnings.hpp>
39 //____________________________________________________________________________//
44 // ************************************************************************** //
45 // ************** entry_value_collector ************** //
46 // ************************************************************************** //
50 entry_value_collector const&
51 entry_value_collector::operator<<( lazy_ostream const& v ) const
58 //____________________________________________________________________________//
60 entry_value_collector const&
61 entry_value_collector::operator<<( const_string v ) const
68 //____________________________________________________________________________//
70 entry_value_collector::~entry_value_collector()
73 unit_test_log << log::end();
76 //____________________________________________________________________________//
78 } // namespace ut_detail
80 // ************************************************************************** //
81 // ************** unit_test_log ************** //
82 // ************************************************************************** //
87 struct unit_test_log_data_helper_impl {
88 typedef boost::shared_ptr<unit_test_log_formatter> formatter_ptr;
89 typedef boost::shared_ptr<io_saver_type> saver_ptr;
92 output_format m_format;
93 std::ostream* m_stream;
94 saver_ptr m_stream_state_saver;
95 formatter_ptr m_log_formatter;
96 bool m_entry_in_progress;
98 unit_test_log_data_helper_impl(unit_test_log_formatter* p_log_formatter, output_format format, bool enabled = false)
99 : m_enabled( enabled )
101 , m_stream( &std::cout )
102 , m_stream_state_saver( new io_saver_type( std::cout ) )
104 , m_entry_in_progress( false )
106 m_log_formatter.reset(p_log_formatter);
107 m_log_formatter->set_log_level(log_all_errors);
111 std::ostream& stream()
116 log_level get_log_level() const
118 return m_log_formatter->get_log_level();
122 struct unit_test_log_impl {
126 m_log_formatter_data.push_back( unit_test_log_data_helper_impl(new output::compiler_log_formatter, OF_CLF, true) ); // only this one is active by default,
127 m_log_formatter_data.push_back( unit_test_log_data_helper_impl(new output::xml_log_formatter, OF_XML, false) );
128 m_log_formatter_data.push_back( unit_test_log_data_helper_impl(new output::junit_log_formatter, OF_JUNIT, false) );
131 typedef std::vector<unit_test_log_data_helper_impl> v_formatter_data_t;
132 v_formatter_data_t m_log_formatter_data;
135 log_entry_data m_entry_data;
137 bool has_entry_in_progress() const {
138 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl const&, current_logger_data, m_log_formatter_data ) {
139 if( current_logger_data.m_entry_in_progress )
146 log_checkpoint_data m_checkpoint_data;
148 void set_checkpoint( const_string file, std::size_t line_num, const_string msg )
150 assign_op( m_checkpoint_data.m_message, msg, 0 );
151 m_checkpoint_data.m_file_name = file;
152 m_checkpoint_data.m_line_num = line_num;
156 unit_test_log_impl& s_log_impl() { static unit_test_log_impl the_inst; return the_inst; }
160 //____________________________________________________________________________//
163 unit_test_log_t::test_start( counter_t test_cases_amount )
165 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
166 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() == log_nothing )
169 current_logger_data.m_log_formatter->log_start( current_logger_data.stream(), test_cases_amount );
171 if( runtime_config::get<bool>( runtime_config::btrt_build_info ) )
172 current_logger_data.m_log_formatter->log_build_info( current_logger_data.stream() );
174 //current_logger_data.stream().flush();
176 current_logger_data.m_entry_in_progress = false;
180 //____________________________________________________________________________//
183 unit_test_log_t::test_finish()
185 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
186 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() == log_nothing )
189 current_logger_data.m_log_formatter->log_finish( current_logger_data.stream() );
191 current_logger_data.stream().flush();
195 //____________________________________________________________________________//
198 unit_test_log_t::test_aborted()
200 BOOST_TEST_LOG_ENTRY( log_messages ) << "Test is aborted";
203 //____________________________________________________________________________//
206 unit_test_log_t::test_unit_start( test_unit const& tu )
208 if( s_log_impl().has_entry_in_progress() )
210 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
211 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() > log_test_units )
213 current_logger_data.m_log_formatter->test_unit_start( current_logger_data.stream(), tu );
217 //____________________________________________________________________________//
220 unit_test_log_t::test_unit_finish( test_unit const& tu, unsigned long elapsed )
222 s_log_impl().m_checkpoint_data.clear();
224 if( s_log_impl().has_entry_in_progress() )
227 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
229 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() > log_test_units )
232 current_logger_data.m_log_formatter->test_unit_finish( current_logger_data.stream(), tu, elapsed );
236 //____________________________________________________________________________//
239 unit_test_log_t::test_unit_skipped( test_unit const& tu, const_string reason )
241 if( s_log_impl().has_entry_in_progress() )
244 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
245 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() > log_test_units )
248 current_logger_data.m_log_formatter->test_unit_skipped( current_logger_data.stream(), tu, reason );
253 unit_test_log_t::test_unit_aborted( test_unit const& tu )
255 if( s_log_impl().has_entry_in_progress() )
258 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
259 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() > log_test_units )
262 current_logger_data.m_log_formatter->test_unit_aborted(current_logger_data.stream(), tu );
266 //____________________________________________________________________________//
269 unit_test_log_t::exception_caught( execution_exception const& ex )
272 ex.code() <= execution_exception::cpp_exception_error ? log_cpp_exception_errors :
273 (ex.code() <= execution_exception::timeout_error ? log_system_errors
274 : log_fatal_errors );
276 if( s_log_impl().has_entry_in_progress() )
279 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
281 if( current_logger_data.m_enabled && l >= current_logger_data.get_log_level() ) {
283 current_logger_data.m_log_formatter->log_exception_start( current_logger_data.stream(), s_log_impl().m_checkpoint_data, ex );
285 log_entry_context( l );
287 current_logger_data.m_log_formatter->log_exception_finish( current_logger_data.stream() );
290 clear_entry_context();
293 //____________________________________________________________________________//
296 unit_test_log_t::set_checkpoint( const_string file, std::size_t line_num, const_string msg )
298 s_log_impl().set_checkpoint( file, line_num, msg );
301 //____________________________________________________________________________//
304 set_unix_slash( char in )
306 return in == '\\' ? '/' : in;
310 unit_test_log_t::operator<<( log::begin const& b )
312 if( s_log_impl().has_entry_in_progress() )
315 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
316 if( current_logger_data.m_enabled ) {
317 current_logger_data.m_stream_state_saver->restore();
321 s_log_impl().m_entry_data.clear();
323 assign_op( s_log_impl().m_entry_data.m_file_name, b.m_file_name, 0 );
325 // normalize file name
326 std::transform( s_log_impl().m_entry_data.m_file_name.begin(), s_log_impl().m_entry_data.m_file_name.end(),
327 s_log_impl().m_entry_data.m_file_name.begin(),
330 s_log_impl().m_entry_data.m_line_num = b.m_line_num;
335 //____________________________________________________________________________//
338 unit_test_log_t::operator<<( log::end const& )
340 if( s_log_impl().has_entry_in_progress() ) {
341 log_entry_context( s_log_impl().m_entry_data.m_level );
343 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
344 if( current_logger_data.m_enabled && current_logger_data.m_entry_in_progress ) {
345 current_logger_data.m_log_formatter->log_entry_finish( current_logger_data.stream() );
347 current_logger_data.m_entry_in_progress = false;
351 clear_entry_context();
356 //____________________________________________________________________________//
359 unit_test_log_t::operator<<( log_level l )
361 s_log_impl().m_entry_data.m_level = l;
366 //____________________________________________________________________________//
368 ut_detail::entry_value_collector
369 unit_test_log_t::operator()( log_level l )
373 return ut_detail::entry_value_collector();
376 //____________________________________________________________________________//
379 unit_test_log_t::log_entry_start(output_format log_format)
381 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
383 if( current_logger_data.m_format != log_format )
386 if( current_logger_data.m_entry_in_progress )
389 if( !current_logger_data.m_enabled )
392 switch( s_log_impl().m_entry_data.m_level ) {
393 case log_successful_tests:
394 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
395 unit_test_log_formatter::BOOST_UTL_ET_INFO );
398 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
399 unit_test_log_formatter::BOOST_UTL_ET_MESSAGE );
402 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
403 unit_test_log_formatter::BOOST_UTL_ET_WARNING );
406 case log_cpp_exception_errors:
407 case log_system_errors:
408 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
409 unit_test_log_formatter::BOOST_UTL_ET_ERROR );
411 case log_fatal_errors:
412 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
413 unit_test_log_formatter::BOOST_UTL_ET_FATAL_ERROR );
417 case invalid_log_level:
421 current_logger_data.m_entry_in_progress = true;
428 //____________________________________________________________________________//
431 unit_test_log_t::operator<<( const_string value )
433 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
434 if( current_logger_data.m_enabled && s_log_impl().m_entry_data.m_level >= current_logger_data.get_log_level() && !value.empty() && log_entry_start(current_logger_data.m_format) )
435 current_logger_data.m_log_formatter->log_entry_value( current_logger_data.stream(), value );
441 //____________________________________________________________________________//
444 unit_test_log_t::operator<<( lazy_ostream const& value )
446 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
447 if( current_logger_data.m_enabled && s_log_impl().m_entry_data.m_level >= current_logger_data.get_log_level() && !value.empty() ) {
448 if( log_entry_start(current_logger_data.m_format) ) {
449 current_logger_data.m_log_formatter->log_entry_value( current_logger_data.stream(), value );
456 //____________________________________________________________________________//
459 unit_test_log_t::log_entry_context( log_level l )
461 framework::context_generator const& context = framework::get_context();
462 if( context.is_empty() )
467 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
468 if( current_logger_data.m_enabled ) {
469 current_logger_data.m_log_formatter->entry_context_start( current_logger_data.stream(), l );
473 while( !(frame=context.next()).is_empty() )
475 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
476 if( current_logger_data.m_enabled ) {
477 current_logger_data.m_log_formatter->log_entry_context( current_logger_data.stream(), l, frame );
482 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
483 if( current_logger_data.m_enabled ) {
484 current_logger_data.m_log_formatter->entry_context_finish( current_logger_data.stream(), l );
489 //____________________________________________________________________________//
492 unit_test_log_t::clear_entry_context()
494 framework::clear_context();
497 //____________________________________________________________________________//
500 unit_test_log_t::set_stream( std::ostream& str )
502 if( s_log_impl().has_entry_in_progress() )
505 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
506 current_logger_data.m_stream = &str;
507 current_logger_data.m_stream_state_saver.reset( new io_saver_type( str ) );
511 //____________________________________________________________________________//
514 unit_test_log_t::set_stream( output_format log_format, std::ostream& str )
516 if( s_log_impl().has_entry_in_progress() )
519 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
520 if( current_logger_data.m_format == log_format) {
521 current_logger_data.m_stream = &str;
522 current_logger_data.m_stream_state_saver.reset( new io_saver_type( str ) );
529 unit_test_log_t::get_stream( output_format log_format ) const
531 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
532 if( current_logger_data.m_format == log_format) {
533 return current_logger_data.m_stream;
539 //____________________________________________________________________________//
542 unit_test_log_t::set_threshold_level( log_level lev )
544 if( s_log_impl().has_entry_in_progress() || lev == invalid_log_level )
547 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
548 current_logger_data.m_log_formatter->set_log_level( lev );
552 //____________________________________________________________________________//
555 unit_test_log_t::set_threshold_level( output_format log_format, log_level lev )
557 if( s_log_impl().has_entry_in_progress() || lev == invalid_log_level )
560 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
561 if( current_logger_data.m_format == log_format) {
562 current_logger_data.m_log_formatter->set_log_level( lev );
568 //____________________________________________________________________________//
571 unit_test_log_t::set_format( output_format log_format )
573 if( s_log_impl().has_entry_in_progress() )
576 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
577 current_logger_data.m_enabled = current_logger_data.m_format == log_format;
581 //____________________________________________________________________________//
584 unit_test_log_t::add_format( output_format log_format )
586 if( s_log_impl().has_entry_in_progress() )
589 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
590 if( current_logger_data.m_format == log_format) {
591 current_logger_data.m_enabled = true;
597 //____________________________________________________________________________//
599 unit_test_log_formatter*
600 unit_test_log_t::get_formatter( output_format log_format ) {
601 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
602 if( current_logger_data.m_format == log_format) {
603 return current_logger_data.m_log_formatter.get();
611 unit_test_log_t::add_formatter( unit_test_log_formatter* the_formatter )
613 // remove only user defined logger
614 for(unit_test_log_impl::v_formatter_data_t::iterator it(s_log_impl().m_log_formatter_data.begin()),
615 ite(s_log_impl().m_log_formatter_data.end());
619 if( it->m_format == OF_CUSTOM_LOGGER) {
620 s_log_impl().m_log_formatter_data.erase(it);
625 if( the_formatter ) {
626 s_log_impl().m_log_formatter_data.push_back( unit_test_log_data_helper_impl(the_formatter, OF_CUSTOM_LOGGER, true) );
631 unit_test_log_t::set_formatter( unit_test_log_formatter* the_formatter )
633 // remove only user defined logger
634 log_level current_level = invalid_log_level;
635 std::ostream *current_stream = 0;
636 output_format previous_format = OF_INVALID;
637 for(unit_test_log_impl::v_formatter_data_t::iterator it(s_log_impl().m_log_formatter_data.begin()),
638 ite(s_log_impl().m_log_formatter_data.end());
642 if( it->m_enabled ) {
643 if( current_level == invalid_log_level || it->m_format < previous_format || it->m_format == OF_CUSTOM_LOGGER) {
644 current_level = it->get_log_level();
645 current_stream = &(it->stream());
646 previous_format = it->m_format;
651 if( the_formatter ) {
652 add_formatter(the_formatter);
653 set_format(OF_CUSTOM_LOGGER);
654 set_threshold_level(OF_CUSTOM_LOGGER, current_level);
655 set_stream(OF_CUSTOM_LOGGER, *current_stream);
659 //____________________________________________________________________________//
661 // ************************************************************************** //
662 // ************** unit_test_log_formatter ************** //
663 // ************************************************************************** //
666 unit_test_log_formatter::log_entry_value( std::ostream& ostr, lazy_ostream const& value )
668 log_entry_value( ostr, (wrap_stringstream().ref() << value).str() );
672 unit_test_log_formatter::set_log_level(log_level new_log_level)
674 m_log_level = new_log_level;
678 unit_test_log_formatter::get_log_level() const
683 //____________________________________________________________________________//
685 } // namespace unit_test
688 #include <boost/test/detail/enable_warnings.hpp>
690 #endif // BOOST_TEST_UNIT_TEST_LOG_IPP_012205GER