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.m_entry_in_progress = false;
178 //____________________________________________________________________________//
181 unit_test_log_t::test_finish()
183 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
184 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() == log_nothing )
187 current_logger_data.m_log_formatter->log_finish( current_logger_data.stream() );
189 current_logger_data.stream().flush();
193 //____________________________________________________________________________//
196 unit_test_log_t::test_aborted()
198 BOOST_TEST_LOG_ENTRY( log_messages ) << "Test is aborted";
201 //____________________________________________________________________________//
204 unit_test_log_t::test_unit_start( test_unit const& tu )
206 if( s_log_impl().has_entry_in_progress() )
208 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
209 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() > log_test_units )
211 current_logger_data.m_log_formatter->test_unit_start( current_logger_data.stream(), tu );
215 //____________________________________________________________________________//
218 unit_test_log_t::test_unit_finish( test_unit const& tu, unsigned long elapsed )
220 s_log_impl().m_checkpoint_data.clear();
222 if( s_log_impl().has_entry_in_progress() )
225 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
227 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() > log_test_units )
230 current_logger_data.m_log_formatter->test_unit_finish( current_logger_data.stream(), tu, elapsed );
234 //____________________________________________________________________________//
237 unit_test_log_t::test_unit_skipped( test_unit const& tu, const_string reason )
239 if( s_log_impl().has_entry_in_progress() )
242 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
243 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() > log_test_units )
246 current_logger_data.m_log_formatter->test_unit_skipped( current_logger_data.stream(), tu, reason );
251 unit_test_log_t::test_unit_aborted( test_unit const& tu )
253 if( s_log_impl().has_entry_in_progress() )
256 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
257 if( !current_logger_data.m_enabled || current_logger_data.get_log_level() > log_test_units )
260 current_logger_data.m_log_formatter->test_unit_aborted(current_logger_data.stream(), tu );
264 //____________________________________________________________________________//
267 unit_test_log_t::exception_caught( execution_exception const& ex )
270 ex.code() <= execution_exception::cpp_exception_error ? log_cpp_exception_errors :
271 (ex.code() <= execution_exception::timeout_error ? log_system_errors
272 : log_fatal_errors );
274 if( s_log_impl().has_entry_in_progress() )
277 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
279 if( current_logger_data.m_enabled && l >= current_logger_data.get_log_level() ) {
281 current_logger_data.m_log_formatter->log_exception_start( current_logger_data.stream(), s_log_impl().m_checkpoint_data, ex );
283 log_entry_context( l );
285 current_logger_data.m_log_formatter->log_exception_finish( current_logger_data.stream() );
288 clear_entry_context();
291 //____________________________________________________________________________//
294 unit_test_log_t::set_checkpoint( const_string file, std::size_t line_num, const_string msg )
296 s_log_impl().set_checkpoint( file, line_num, msg );
299 //____________________________________________________________________________//
302 set_unix_slash( char in )
304 return in == '\\' ? '/' : in;
308 unit_test_log_t::operator<<( log::begin const& b )
310 if( s_log_impl().has_entry_in_progress() )
313 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
314 if( current_logger_data.m_enabled ) {
315 current_logger_data.m_stream_state_saver->restore();
319 s_log_impl().m_entry_data.clear();
321 assign_op( s_log_impl().m_entry_data.m_file_name, b.m_file_name, 0 );
323 // normalize file name
324 std::transform( s_log_impl().m_entry_data.m_file_name.begin(), s_log_impl().m_entry_data.m_file_name.end(),
325 s_log_impl().m_entry_data.m_file_name.begin(),
328 s_log_impl().m_entry_data.m_line_num = b.m_line_num;
333 //____________________________________________________________________________//
336 unit_test_log_t::operator<<( log::end const& )
338 if( s_log_impl().has_entry_in_progress() ) {
339 log_entry_context( s_log_impl().m_entry_data.m_level );
341 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
342 if( current_logger_data.m_enabled && current_logger_data.m_entry_in_progress ) {
343 current_logger_data.m_log_formatter->log_entry_finish( current_logger_data.stream() );
345 current_logger_data.m_entry_in_progress = false;
349 clear_entry_context();
354 //____________________________________________________________________________//
357 unit_test_log_t::operator<<( log_level l )
359 s_log_impl().m_entry_data.m_level = l;
364 //____________________________________________________________________________//
366 ut_detail::entry_value_collector
367 unit_test_log_t::operator()( log_level l )
371 return ut_detail::entry_value_collector();
374 //____________________________________________________________________________//
377 unit_test_log_t::log_entry_start(output_format log_format)
379 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
381 if( current_logger_data.m_format != log_format )
384 if( current_logger_data.m_entry_in_progress )
387 if( !current_logger_data.m_enabled )
390 switch( s_log_impl().m_entry_data.m_level ) {
391 case log_successful_tests:
392 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
393 unit_test_log_formatter::BOOST_UTL_ET_INFO );
396 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
397 unit_test_log_formatter::BOOST_UTL_ET_MESSAGE );
400 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
401 unit_test_log_formatter::BOOST_UTL_ET_WARNING );
404 case log_cpp_exception_errors:
405 case log_system_errors:
406 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
407 unit_test_log_formatter::BOOST_UTL_ET_ERROR );
409 case log_fatal_errors:
410 current_logger_data.m_log_formatter->log_entry_start( current_logger_data.stream(), s_log_impl().m_entry_data,
411 unit_test_log_formatter::BOOST_UTL_ET_FATAL_ERROR );
415 case invalid_log_level:
419 current_logger_data.m_entry_in_progress = true;
426 //____________________________________________________________________________//
429 unit_test_log_t::operator<<( const_string value )
431 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
432 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) )
433 current_logger_data.m_log_formatter->log_entry_value( current_logger_data.stream(), value );
439 //____________________________________________________________________________//
442 unit_test_log_t::operator<<( lazy_ostream const& value )
444 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
445 if( current_logger_data.m_enabled && s_log_impl().m_entry_data.m_level >= current_logger_data.get_log_level() && !value.empty() ) {
446 if( log_entry_start(current_logger_data.m_format) ) {
447 current_logger_data.m_log_formatter->log_entry_value( current_logger_data.stream(), value );
454 //____________________________________________________________________________//
457 unit_test_log_t::log_entry_context( log_level l )
459 framework::context_generator const& context = framework::get_context();
460 if( context.is_empty() )
465 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
466 if( current_logger_data.m_enabled ) {
467 current_logger_data.m_log_formatter->entry_context_start( current_logger_data.stream(), l );
471 while( !(frame=context.next()).is_empty() )
473 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
474 if( current_logger_data.m_enabled ) {
475 current_logger_data.m_log_formatter->log_entry_context( current_logger_data.stream(), frame );
480 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
481 if( current_logger_data.m_enabled ) {
482 current_logger_data.m_log_formatter->entry_context_finish( current_logger_data.stream() );
487 //____________________________________________________________________________//
490 unit_test_log_t::clear_entry_context()
492 framework::clear_context();
495 //____________________________________________________________________________//
498 unit_test_log_t::set_stream( std::ostream& str )
500 if( s_log_impl().has_entry_in_progress() )
503 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
504 current_logger_data.m_stream = &str;
505 current_logger_data.m_stream_state_saver.reset( new io_saver_type( str ) );
509 //____________________________________________________________________________//
512 unit_test_log_t::set_stream( output_format log_format, std::ostream& str )
514 if( s_log_impl().has_entry_in_progress() )
517 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
518 if( current_logger_data.m_format == log_format) {
519 current_logger_data.m_stream = &str;
520 current_logger_data.m_stream_state_saver.reset( new io_saver_type( str ) );
526 //____________________________________________________________________________//
529 unit_test_log_t::set_threshold_level( log_level lev )
531 if( s_log_impl().has_entry_in_progress() || lev == invalid_log_level )
534 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
535 current_logger_data.m_log_formatter->set_log_level( lev );
539 //____________________________________________________________________________//
542 unit_test_log_t::set_threshold_level( output_format log_format, 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 if( current_logger_data.m_format == log_format) {
549 current_logger_data.m_log_formatter->set_log_level( lev );
555 //____________________________________________________________________________//
558 unit_test_log_t::set_format( output_format log_format )
560 if( s_log_impl().has_entry_in_progress() )
563 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
564 current_logger_data.m_enabled = current_logger_data.m_format == log_format;
568 //____________________________________________________________________________//
571 unit_test_log_t::add_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 if( current_logger_data.m_format == log_format) {
578 current_logger_data.m_enabled = true;
584 //____________________________________________________________________________//
586 unit_test_log_formatter*
587 unit_test_log_t::get_formatter( output_format log_format ) {
588 BOOST_TEST_FOREACH( unit_test_log_data_helper_impl&, current_logger_data, s_log_impl().m_log_formatter_data ) {
589 if( current_logger_data.m_format == log_format) {
590 return current_logger_data.m_log_formatter.get();
598 unit_test_log_t::add_formatter( unit_test_log_formatter* the_formatter )
600 // remove only user defined logger
601 for(unit_test_log_impl::v_formatter_data_t::iterator it(s_log_impl().m_log_formatter_data.begin()),
602 ite(s_log_impl().m_log_formatter_data.end());
606 if( it->m_format == OF_CUSTOM_LOGGER) {
607 s_log_impl().m_log_formatter_data.erase(it);
612 if( the_formatter ) {
613 s_log_impl().m_log_formatter_data.push_back( unit_test_log_data_helper_impl(the_formatter, OF_CUSTOM_LOGGER, true) );
618 unit_test_log_t::set_formatter( unit_test_log_formatter* the_formatter )
620 // remove only user defined logger
621 log_level current_level = invalid_log_level;
622 std::ostream *current_stream = 0;
623 output_format previous_format = OF_INVALID;
624 for(unit_test_log_impl::v_formatter_data_t::iterator it(s_log_impl().m_log_formatter_data.begin()),
625 ite(s_log_impl().m_log_formatter_data.end());
629 if( it->m_enabled ) {
630 if( current_level == invalid_log_level || it->m_format < previous_format || it->m_format == OF_CUSTOM_LOGGER) {
631 current_level = it->get_log_level();
632 current_stream = &(it->stream());
633 previous_format = it->m_format;
638 if( the_formatter ) {
639 add_formatter(the_formatter);
640 set_format(OF_CUSTOM_LOGGER);
641 set_threshold_level(OF_CUSTOM_LOGGER, current_level);
642 set_stream(OF_CUSTOM_LOGGER, *current_stream);
646 //____________________________________________________________________________//
648 // ************************************************************************** //
649 // ************** unit_test_log_formatter ************** //
650 // ************************************************************************** //
653 unit_test_log_formatter::log_entry_value( std::ostream& ostr, lazy_ostream const& value )
655 log_entry_value( ostr, (wrap_stringstream().ref() << value).str() );
659 unit_test_log_formatter::set_log_level(log_level new_log_level)
661 m_log_level = new_log_level;
665 unit_test_log_formatter::get_log_level() const
670 //____________________________________________________________________________//
672 } // namespace unit_test
675 #include <boost/test/detail/enable_warnings.hpp>
677 #endif // BOOST_TEST_UNIT_TEST_LOG_IPP_012205GER