Chris@16: //  (C) Copyright Gennadiy Rozental 2005-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 : implemets Unit Test Log
Chris@16: // ***************************************************************************
Chris@16: 
Chris@16: #ifndef BOOST_TEST_UNIT_TEST_LOG_IPP_012205GER
Chris@16: #define BOOST_TEST_UNIT_TEST_LOG_IPP_012205GER
Chris@16: 
Chris@16: // Boost.Test
Chris@16: #include <boost/test/unit_test_log.hpp>
Chris@16: #include <boost/test/unit_test_log_formatter.hpp>
Chris@16: #include <boost/test/unit_test_suite_impl.hpp>
Chris@16: #include <boost/test/execution_monitor.hpp>
Chris@16: 
Chris@16: #include <boost/test/detail/unit_test_parameters.hpp>
Chris@16: 
Chris@16: #include <boost/test/utils/basic_cstring/compare.hpp>
Chris@16: 
Chris@16: #include <boost/test/output/compiler_log_formatter.hpp>
Chris@16: #include <boost/test/output/xml_log_formatter.hpp>
Chris@16: 
Chris@16: // Boost
Chris@16: #include <boost/scoped_ptr.hpp>
Chris@16: #include <boost/io/ios_state.hpp>
Chris@16: typedef ::boost::io::ios_base_all_saver io_saver_type;
Chris@16: 
Chris@16: #include <boost/test/detail/suppress_warnings.hpp>
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: namespace boost {
Chris@16: 
Chris@16: namespace unit_test {
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************             entry_value_collector            ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: namespace ut_detail {
Chris@16: 
Chris@16: entry_value_collector const&
Chris@16: entry_value_collector::operator<<( lazy_ostream const& v ) const
Chris@16: {
Chris@16:     unit_test_log << v;
Chris@16: 
Chris@16:     return *this;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: entry_value_collector const& 
Chris@16: entry_value_collector::operator<<( const_string v ) const
Chris@16: {
Chris@16:     unit_test_log << v;
Chris@16: 
Chris@16:     return *this;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: entry_value_collector::~entry_value_collector()
Chris@16: {
Chris@16:     if( m_last )
Chris@16:         unit_test_log << log::end();
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: } // namespace ut_detail
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************                 unit_test_log                ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: namespace {
Chris@16: 
Chris@16: struct unit_test_log_impl {
Chris@16:     // Constructor
Chris@16:     unit_test_log_impl()
Chris@16:     : m_stream( runtime_config::log_sink() )
Chris@16:     , m_stream_state_saver( new io_saver_type( *m_stream ) )
Chris@16:     , m_threshold_level( log_all_errors )
Chris@16:     , m_log_formatter( new output::compiler_log_formatter )
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     // log data
Chris@16:     typedef scoped_ptr<unit_test_log_formatter> formatter_ptr;
Chris@16:     typedef scoped_ptr<io_saver_type>           saver_ptr;
Chris@16: 
Chris@16:     std::ostream*       m_stream;
Chris@16:     saver_ptr           m_stream_state_saver;
Chris@16:     log_level           m_threshold_level;
Chris@16:     formatter_ptr       m_log_formatter;
Chris@16: 
Chris@16:     // entry data
Chris@16:     bool                m_entry_in_progress;
Chris@16:     bool                m_entry_started;
Chris@16:     log_entry_data      m_entry_data;
Chris@16: 
Chris@16:     // check point data
Chris@16:     log_checkpoint_data m_checkpoint_data;
Chris@16: 
Chris@16:     // helper functions
Chris@16:     std::ostream&       stream()            { return *m_stream; }
Chris@16:     void                set_checkpoint( const_string file, std::size_t line_num, const_string msg )
Chris@16:     {
Chris@16:         assign_op( m_checkpoint_data.m_message, msg, 0 );
Chris@16:         m_checkpoint_data.m_file_name    = file;
Chris@16:         m_checkpoint_data.m_line_num    = line_num;
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: unit_test_log_impl& s_log_impl() { static unit_test_log_impl the_inst; return the_inst; }
Chris@16: 
Chris@16: } // local namespace
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::test_start( counter_t test_cases_amount )
Chris@16: {
Chris@16:     if( s_log_impl().m_threshold_level == log_nothing )
Chris@16:         return;
Chris@16: 
Chris@16:     s_log_impl().m_log_formatter->log_start( s_log_impl().stream(), test_cases_amount );
Chris@16: 
Chris@16:     if( runtime_config::show_build_info() )
Chris@16:         s_log_impl().m_log_formatter->log_build_info( s_log_impl().stream() );
Chris@16: 
Chris@16:     s_log_impl().m_entry_in_progress = false;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::test_finish()
Chris@16: {
Chris@16:     if( s_log_impl().m_threshold_level == log_nothing )
Chris@16:         return;
Chris@16: 
Chris@16:     s_log_impl().m_log_formatter->log_finish( s_log_impl().stream() );
Chris@16: 
Chris@16:     s_log_impl().stream().flush();
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::test_aborted()
Chris@16: {
Chris@16:     BOOST_TEST_LOG_ENTRY( log_messages ) << "Test is aborted";
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::test_unit_start( test_unit const& tu )
Chris@16: {
Chris@16:     if( s_log_impl().m_threshold_level > log_test_units )
Chris@16:         return;
Chris@16: 
Chris@16:     if( s_log_impl().m_entry_in_progress )
Chris@16:         *this << log::end();
Chris@16: 
Chris@16:     s_log_impl().m_log_formatter->test_unit_start( s_log_impl().stream(), tu );
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::test_unit_finish( test_unit const& tu, unsigned long elapsed )
Chris@16: {
Chris@16:     if( s_log_impl().m_threshold_level > log_test_units )
Chris@16:         return;
Chris@16: 
Chris@16:     s_log_impl().m_checkpoint_data.clear();
Chris@16: 
Chris@16:     if( s_log_impl().m_entry_in_progress )
Chris@16:         *this << log::end();
Chris@16: 
Chris@16:     s_log_impl().m_log_formatter->test_unit_finish( s_log_impl().stream(), tu, elapsed );
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::test_unit_skipped( test_unit const& tu )
Chris@16: {
Chris@16:     if( s_log_impl().m_threshold_level > log_test_units )
Chris@16:         return;
Chris@16: 
Chris@16:     if( s_log_impl().m_entry_in_progress )
Chris@16:         *this << log::end();
Chris@16: 
Chris@16:     s_log_impl().m_log_formatter->test_unit_skipped( s_log_impl().stream(), tu );
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::test_unit_aborted( test_unit const& )
Chris@16: {
Chris@16:     // do nothing
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::assertion_result( bool )
Chris@16: {
Chris@16:     // do nothing
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::exception_caught( execution_exception const& ex )
Chris@16: {
Chris@16:     log_level l =
Chris@16:         ex.code() <= execution_exception::cpp_exception_error   ? log_cpp_exception_errors :
Chris@16:         (ex.code() <= execution_exception::timeout_error        ? log_system_errors
Chris@16:                                                                 : log_fatal_errors );
Chris@16: 
Chris@16:     if( l >= s_log_impl().m_threshold_level ) {
Chris@16:         if( s_log_impl().m_entry_in_progress )
Chris@16:             *this << log::end();
Chris@16: 
Chris@16:         s_log_impl().m_log_formatter->log_exception( s_log_impl().stream(), s_log_impl().m_checkpoint_data, ex );
Chris@16:     }
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::set_checkpoint( const_string file, std::size_t line_num, const_string msg )
Chris@16: {
Chris@16:     s_log_impl().set_checkpoint( file, line_num, msg );
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: char
Chris@16: set_unix_slash( char in )
Chris@16: {
Chris@16:     return in == '\\' ? '/' : in;
Chris@16: }
Chris@16:     
Chris@16: unit_test_log_t&
Chris@16: unit_test_log_t::operator<<( log::begin const& b )
Chris@16: {
Chris@16:     if( s_log_impl().m_entry_in_progress )
Chris@16:         *this << log::end();
Chris@16: 
Chris@16:     s_log_impl().m_stream_state_saver->restore();
Chris@16: 
Chris@16:     s_log_impl().m_entry_data.clear();
Chris@16: 
Chris@16:     assign_op( s_log_impl().m_entry_data.m_file_name, b.m_file_name, 0 );
Chris@16: 
Chris@16:     // normalize file name
Chris@16:     std::transform( s_log_impl().m_entry_data.m_file_name.begin(), s_log_impl().m_entry_data.m_file_name.end(),
Chris@16:                     s_log_impl().m_entry_data.m_file_name.begin(),
Chris@16:                     &set_unix_slash );
Chris@16: 
Chris@16:     s_log_impl().m_entry_data.m_line_num = b.m_line_num;
Chris@16: 
Chris@16:     return *this;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: unit_test_log_t&
Chris@16: unit_test_log_t::operator<<( log::end const& )
Chris@16: {
Chris@16:     if( s_log_impl().m_entry_in_progress )
Chris@16:         s_log_impl().m_log_formatter->log_entry_finish( s_log_impl().stream() );
Chris@16: 
Chris@16:     s_log_impl().m_entry_in_progress = false;
Chris@16: 
Chris@16:     return *this;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: unit_test_log_t&
Chris@16: unit_test_log_t::operator<<( log_level l )
Chris@16: {
Chris@16:     s_log_impl().m_entry_data.m_level = l;
Chris@16: 
Chris@16:     return *this;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: ut_detail::entry_value_collector
Chris@16: unit_test_log_t::operator()( log_level l )
Chris@16: {
Chris@16:     *this << l;
Chris@16: 
Chris@16:     return ut_detail::entry_value_collector();
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: bool
Chris@16: unit_test_log_t::log_entry_start()
Chris@16: {
Chris@16:     if( s_log_impl().m_entry_in_progress ) 
Chris@16:         return true;
Chris@16: 
Chris@16:     switch( s_log_impl().m_entry_data.m_level ) {
Chris@16:     case log_successful_tests:
Chris@16:         s_log_impl().m_log_formatter->log_entry_start( s_log_impl().stream(), s_log_impl().m_entry_data,
Chris@16:                                                        unit_test_log_formatter::BOOST_UTL_ET_INFO );
Chris@16:         break;
Chris@16:     case log_messages:
Chris@16:         s_log_impl().m_log_formatter->log_entry_start( s_log_impl().stream(), s_log_impl().m_entry_data,
Chris@16:                                                        unit_test_log_formatter::BOOST_UTL_ET_MESSAGE );
Chris@16:         break;
Chris@16:     case log_warnings:
Chris@16:         s_log_impl().m_log_formatter->log_entry_start( s_log_impl().stream(), s_log_impl().m_entry_data,
Chris@16:                                                        unit_test_log_formatter::BOOST_UTL_ET_WARNING );
Chris@16:         break;
Chris@16:     case log_all_errors:
Chris@16:     case log_cpp_exception_errors:
Chris@16:     case log_system_errors:
Chris@16:         s_log_impl().m_log_formatter->log_entry_start( s_log_impl().stream(), s_log_impl().m_entry_data,
Chris@16:                                                        unit_test_log_formatter::BOOST_UTL_ET_ERROR );
Chris@16:         break;
Chris@16:     case log_fatal_errors:
Chris@16:         s_log_impl().m_log_formatter->log_entry_start( s_log_impl().stream(), s_log_impl().m_entry_data,
Chris@16:                                                        unit_test_log_formatter::BOOST_UTL_ET_FATAL_ERROR );
Chris@16:         break;
Chris@16:     case log_nothing:
Chris@16:     case log_test_units:
Chris@16:     case invalid_log_level:
Chris@16:         return false;
Chris@16:     }
Chris@16: 
Chris@16:     s_log_impl().m_entry_in_progress = true;
Chris@16: 
Chris@16:     return true;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: unit_test_log_t&
Chris@16: unit_test_log_t::operator<<( const_string value )
Chris@16: {
Chris@16:     if( s_log_impl().m_entry_data.m_level >= s_log_impl().m_threshold_level && !value.empty() && log_entry_start() )
Chris@16:         s_log_impl().m_log_formatter->log_entry_value( s_log_impl().stream(), value );
Chris@16: 
Chris@16:     return *this;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: unit_test_log_t&
Chris@16: unit_test_log_t::operator<<( lazy_ostream const& value )
Chris@16: {
Chris@16:     if( s_log_impl().m_entry_data.m_level >= s_log_impl().m_threshold_level && !value.empty() && log_entry_start() )
Chris@16:         s_log_impl().m_log_formatter->log_entry_value( s_log_impl().stream(), value );
Chris@16: 
Chris@16:     return *this;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::set_stream( std::ostream& str )
Chris@16: {
Chris@16:     if( s_log_impl().m_entry_in_progress )
Chris@16:         return;
Chris@16: 
Chris@16:     s_log_impl().m_stream = &str;
Chris@16:     s_log_impl().m_stream_state_saver.reset( new io_saver_type( str ) );
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::set_threshold_level( log_level lev )
Chris@16: {
Chris@16:     if( s_log_impl().m_entry_in_progress || lev == invalid_log_level )
Chris@16:         return;
Chris@16: 
Chris@16:     s_log_impl().m_threshold_level = lev;
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::set_format( output_format log_format )
Chris@16: {
Chris@16:     if( s_log_impl().m_entry_in_progress )
Chris@16:         return;
Chris@16: 
Chris@16:     if( log_format == CLF )
Chris@16:         set_formatter( new output::compiler_log_formatter );
Chris@16:     else
Chris@16:         set_formatter( new output::xml_log_formatter );
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_t::set_formatter( unit_test_log_formatter* the_formatter )
Chris@16: {
Chris@16:     s_log_impl().m_log_formatter.reset( the_formatter );
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************            unit_test_log_formatter           ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: void
Chris@16: unit_test_log_formatter::log_entry_value( std::ostream& ostr, lazy_ostream const& value )
Chris@16: {
Chris@16:     log_entry_value( ostr, (wrap_stringstream().ref() << value).str() );
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: } // namespace unit_test
Chris@16: 
Chris@16: } // namespace boost
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: #include <boost/test/detail/enable_warnings.hpp>
Chris@16: 
Chris@16: #endif // BOOST_TEST_UNIT_TEST_LOG_IPP_012205GER