[ceph.git] / ceph / src / boost / boost / test / unit_test_log.hpp

//  (C) Copyright Gennadiy Rozental 2001.
//  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
/// @brief defines singleton class unit_test_log and all manipulators.
/// unit_test_log has output stream like interface. It's implementation is
/// completely hidden with pimple idiom
// ***************************************************************************

#ifndef BOOST_TEST_UNIT_TEST_LOG_HPP_071894GER
#define BOOST_TEST_UNIT_TEST_LOG_HPP_071894GER

// Boost.Test
#include <boost/test/tree/observer.hpp>

#include <boost/test/detail/global_typedef.hpp>
#include <boost/test/detail/log_level.hpp>
#include <boost/test/detail/fwd_decl.hpp>

#include <boost/test/utils/wrap_stringstream.hpp>
#include <boost/test/utils/trivial_singleton.hpp>
#include <boost/test/utils/lazy_ostream.hpp>

// Boost

// STL
#include <iosfwd>   // for std::ostream&

#include <boost/test/detail/suppress_warnings.hpp>

//____________________________________________________________________________//

namespace boost {
namespace unit_test {

// ************************************************************************** //
// **************                log manipulators              ************** //
// ************************************************************************** //

namespace log {

struct BOOST_TEST_DECL begin {
    begin( const_string fn, std::size_t ln )
    : m_file_name( fn )
    , m_line_num( ln )
    {}

    const_string m_file_name;
    std::size_t m_line_num;
};

struct end {};

} // namespace log

// ************************************************************************** //
// **************             entry_value_collector            ************** //
// ************************************************************************** //

namespace ut_detail {

class BOOST_TEST_DECL entry_value_collector {
public:
    // Constructors
    entry_value_collector() : m_last( true ) {}
    entry_value_collector( entry_value_collector const& rhs ) : m_last( true ) { rhs.m_last = false; }
    ~entry_value_collector();

    // collection interface
    entry_value_collector const& operator<<( lazy_ostream const& ) const;
    entry_value_collector const& operator<<( const_string ) const;

private:
    // Data members
    mutable bool    m_last;
};

} // namespace ut_detail

// ************************************************************************** //
// **************                 unit_test_log                ************** //
// ************************************************************************** //

/// @brief Manages the sets of loggers, their streams and log levels
///
/// The Boost.Test framework allows for having several formatters/loggers at the same time, each of which
/// having their own log level and output stream.
///
/// This class serves the purpose of
/// - exposing an interface to the test framework (as a boost::unit_test::test_observer)
/// - exposing an interface to the testing tools
/// - managing several loggers
///
/// @note Accesses to the functions exposed by this class are made through the singleton
///   @c boost::unit_test::unit_test_log.
///
/// Users/developers willing to implement their own formatter need to:
/// - implement a boost::unit_test::unit_test_log_formatter that will output the desired format
/// - register the formatter during a eg. global fixture using the method @c set_formatter (though the framework singleton).
///
/// @warning this observer has a higher priority than the @ref boost::unit_test::results_collector_t. This means
/// that the various @ref boost::unit_test::test_results associated to each test unit may not be available at the time
/// the @c test_unit_start, @c test_unit_finish ... are called.
///
/// @see
/// - boost::unit_test::test_observer
/// - boost::unit_test::unit_test_log_formatter
class BOOST_TEST_DECL unit_test_log_t : public test_observer, public singleton<unit_test_log_t> {
public:
    // test_observer interface implementation
    virtual void        test_start( counter_t test_cases_amount );
    virtual void        test_finish();
    virtual void        test_aborted();

    virtual void        test_unit_start( test_unit const& );
    virtual void        test_unit_finish( test_unit const&, unsigned long elapsed );
    virtual void        test_unit_skipped( test_unit const&, const_string );
    virtual void        test_unit_aborted( test_unit const& );

    virtual void        exception_caught( execution_exception const& ex );

    virtual int         priority() { return 2; }

    // log configuration methods
    //! Sets the stream for all loggers
    //!
    //! This will override the log sink/stream of all loggers, whether enabled or not.
    void                set_stream( std::ostream& );

    //! Sets the stream for specific logger
    //!
    //! @note Has no effect if the specified format is not found
    //! @par Since Boost 1.62
    void                set_stream( output_format, std::ostream& );

    //! Returns a pointer to the stream associated to specific logger
    //!
    //! @note Returns a null pointer if the format is not found
    //! @par Since Boost 1.67
    std::ostream*       get_stream( output_format ) const;


    //! Sets the threshold level for all loggers/formatters.
    //!
    //! This will override the log level of all loggers, whether enabled or not.
    void                set_threshold_level( log_level );

    //! Sets the threshold/log level of a specific format
    //!
    //! @note Has no effect if the specified format is not found
    //! @par Since Boost 1.62
    void                set_threshold_level( output_format, log_level );

    //! Add a format to the set of loggers
    //!
    //! Adding a logger means that the specified logger is enabled. The log level is managed by the formatter itself
    //! and specifies what events are forwarded to the underlying formatter.
    //! @par Since Boost 1.62
    void                add_format( output_format );

    //! Sets the format of the logger
    //!
    //! This will become the only active format of the logs.
    void                set_format( output_format );

    //! Returns the logger instance for a specific format.
    //!
    //! @returns the logger/formatter instance, or @c (unit_test_log_formatter*)0 if the format is not found.
    //! @par Since Boost 1.62
    unit_test_log_formatter* get_formatter( output_format );

    //! Sets the logger instance
    //!
    //! The specified logger becomes the unique active one. The custom log formatter has the
    //! format @c OF_CUSTOM_LOGGER. If such a format exists already, its formatter gets replaced by the one
    //! given in argument.
    //!
    //! The log level and output stream of the new formatter are taken from the currently active logger. In case
    //! several loggers are active, the order of priority is CUSTOM, HRF, XML, and JUNIT.
    //! If (unit_test_log_formatter*)0 is given as argument, the custom logger (if any) is removed.
    //!
    //! @note The ownership of the pointer is transfered to the Boost.Test framework. This call is equivalent to
    //! - a call to @c add_formatter
    //! - a call to @c set_format(OF_CUSTOM_LOGGER)
    //! - a configuration of the newly added logger with a previously configured stream and log level.
    void                set_formatter( unit_test_log_formatter* );

    //! Adds a custom log formatter to the set of formatters
    //!
    //! The specified logger is added with the format @c OF_CUSTOM_LOGGER, such that it can
    //! be futher selected or its stream/log level can be specified.
    //! If there is already a custom logger (with @c OF_CUSTOM_LOGGER), then
    //! the existing one gets replaced by the one given in argument.
    //! The provided logger is added with an enabled state.
    //! If (unit_test_log_formatter*)0 is given as argument, the custom logger (if any) is removed and
    //! no other action is performed.
    //!
    //! @note The ownership of the pointer is transfered to the Boost.Test framework.
    //! @par Since Boost 1.62
    void                add_formatter( unit_test_log_formatter* the_formatter );

    // test progress logging
    void                set_checkpoint( const_string file, std::size_t line_num, const_string msg = const_string() );

    // entry logging
    unit_test_log_t&    operator<<( log::begin const& );        // begin entry
    unit_test_log_t&    operator<<( log::end const& );          // end entry
    unit_test_log_t&    operator<<( log_level );                // set entry level
    unit_test_log_t&    operator<<( const_string );             // log entry value
    unit_test_log_t&    operator<<( lazy_ostream const& );      // log entry value

    ut_detail::entry_value_collector operator()( log_level );   // initiate entry collection

private:
    // Implementation helpers
    bool                log_entry_start(output_format log_format);
    void                log_entry_context( log_level l );
    void                clear_entry_context();

    BOOST_TEST_SINGLETON_CONS( unit_test_log_t )
}; // unit_test_log_t

BOOST_TEST_SINGLETON_INST( unit_test_log )

// helper macros
#define BOOST_TEST_LOG_ENTRY( ll )                                                  \
    (::boost::unit_test::unit_test_log                                              \
        << ::boost::unit_test::log::begin( BOOST_TEST_L(__FILE__), __LINE__ ))(ll)  \
/**/

} // namespace unit_test
} // namespace boost

// ************************************************************************** //
// **************       Unit test log interface helpers        ************** //
// ************************************************************************** //

// messages sent by the framework
#define BOOST_TEST_FRAMEWORK_MESSAGE( M )                       \
   (::boost::unit_test::unit_test_log                           \
        << ::boost::unit_test::log::begin(                      \
                "boost.test framework",                         \
                __LINE__ ))                                     \
             ( ::boost::unit_test::log_messages )               \
    << BOOST_TEST_LAZY_MSG( M )                                 \
/**/


#define BOOST_TEST_MESSAGE( M )                                 \
    BOOST_TEST_LOG_ENTRY( ::boost::unit_test::log_messages )    \
    << BOOST_TEST_LAZY_MSG( M )                                 \
/**/

//____________________________________________________________________________//

#define BOOST_TEST_PASSPOINT()                                  \
    ::boost::unit_test::unit_test_log.set_checkpoint(           \
        BOOST_TEST_L(__FILE__),                                 \
        static_cast<std::size_t>(__LINE__) )                    \
/**/

//____________________________________________________________________________//

#define BOOST_TEST_CHECKPOINT( M )                              \
    ::boost::unit_test::unit_test_log.set_checkpoint(           \
        BOOST_TEST_L(__FILE__),                                 \
        static_cast<std::size_t>(__LINE__),                     \
        (::boost::wrap_stringstream().ref() << M).str() )       \
/**/

//____________________________________________________________________________//

#include <boost/test/detail/enable_warnings.hpp>

#endif // BOOST_TEST_UNIT_TEST_LOG_HPP_071894GER
Commit	Line	Data
7c673cae FG	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)
	5
	6	// See http://www.boost.org/libs/test for the library home page.
	7	//
	8	/// @file
	9	/// @brief defines singleton class unit_test_log and all manipulators.
	10	/// unit_test_log has output stream like interface. It's implementation is
	11	/// completely hidden with pimple idiom
	12	// ***************************************************************************
	13
	14	#ifndef BOOST_TEST_UNIT_TEST_LOG_HPP_071894GER
	15	#define BOOST_TEST_UNIT_TEST_LOG_HPP_071894GER
	16
	17	// Boost.Test
	18	#include <boost/test/tree/observer.hpp>
	19
	20	#include <boost/test/detail/global_typedef.hpp>
	21	#include <boost/test/detail/log_level.hpp>
	22	#include <boost/test/detail/fwd_decl.hpp>
	23
	24	#include <boost/test/utils/wrap_stringstream.hpp>
	25	#include <boost/test/utils/trivial_singleton.hpp>
	26	#include <boost/test/utils/lazy_ostream.hpp>
	27
	28	// Boost
	29
	30	// STL
	31	#include <iosfwd> // for std::ostream&
	32
	33	#include <boost/test/detail/suppress_warnings.hpp>
	34
	35	//____________________________________________________________________________//
	36
	37	namespace boost {
	38	namespace unit_test {
	39
	40	// ************************************************************************** //
	41	// ************ log manipulators ************ //
	42	// ************************************************************************** //
	43
	44	namespace log {
	45
	46	struct BOOST_TEST_DECL begin {
	47	begin( const_string fn, std::size_t ln )
	48	: m_file_name( fn )
	49	, m_line_num( ln )
	50	{}
	51
	52	const_string m_file_name;
	53	std::size_t m_line_num;
	54	};
	55
	56	struct end {};
	57
	58	} // namespace log
	59
	60	// ************************************************************************** //
	61	// ************ entry_value_collector ************ //
	62	// ************************************************************************** //
	63
	64	namespace ut_detail {
65
66	class BOOST_TEST_DECL entry_value_collector {
67	public:
68	// Constructors
69	entry_value_collector() : m_last( true ) {}
70	entry_value_collector( entry_value_collector const& rhs ) : m_last( true ) { rhs.m_last = false; }
71	~entry_value_collector();
72
73	// collection interface
74	entry_value_collector const& operator<<( lazy_ostream const& ) const;
75	entry_value_collector const& operator<<( const_string ) const;
76
77	private:
78	// Data members
79	mutable bool m_last;
80	};
81
82	} // namespace ut_detail
83
84	// ************************************************************************** //
85	// ************ unit_test_log ************ //
86	// ************************************************************************** //
87
88	/// @brief Manages the sets of loggers, their streams and log levels
89	///
90	/// The Boost.Test framework allows for having several formatters/loggers at the same time, each of which
91	/// having their own log level and output stream.
92	///
93	/// This class serves the purpose of
94	/// - exposing an interface to the test framework (as a boost::unit_test::test_observer)
95	/// - exposing an interface to the testing tools
96	/// - managing several loggers
97	///
98	/// @note Accesses to the functions exposed by this class are made through the singleton
99	/// @c boost::unit_test::unit_test_log.
100	///
101	/// Users/developers willing to implement their own formatter need to:
102	/// - implement a boost::unit_test::unit_test_log_formatter that will output the desired format
103	/// - register the formatter during a eg. global fixture using the method @c set_formatter (though the framework singleton).
104	///
105	/// @warning this observer has a higher priority than the @ref boost::unit_test::results_collector_t. This means
106	/// that the various @ref boost::unit_test::test_results associated to each test unit may not be available at the time
107	/// the @c test_unit_start, @c test_unit_finish ... are called.
108	///
109	/// @see
110	/// - boost::unit_test::test_observer
111	/// - boost::unit_test::unit_test_log_formatter
112	class BOOST_TEST_DECL unit_test_log_t : public test_observer, public singleton<unit_test_log_t> {
113	public:
114	// test_observer interface implementation
115	virtual void test_start( counter_t test_cases_amount );
116	virtual void test_finish();
117	virtual void test_aborted();
118
119	virtual void test_unit_start( test_unit const& );
120	virtual void test_unit_finish( test_unit const&, unsigned long elapsed );
121	virtual void test_unit_skipped( test_unit const&, const_string );
122	virtual void test_unit_aborted( test_unit const& );
123
124	virtual void exception_caught( execution_exception const& ex );
125
b32b8144	126	virtual int priority() { return 2; }
7c673cae FG	127
	128	// log configuration methods
	129	//! Sets the stream for all loggers
	130	//!
	131	//! This will override the log sink/stream of all loggers, whether enabled or not.
	132	void set_stream( std::ostream& );
	133
	134	//! Sets the stream for specific logger
	135	//!
	136	//! @note Has no effect if the specified format is not found
	137	//! @par Since Boost 1.62
	138	void set_stream( output_format, std::ostream& );
	139
11fdf7f2 TL	140	//! Returns a pointer to the stream associated to specific logger
	141	//!
	142	//! @note Returns a null pointer if the format is not found
	143	//! @par Since Boost 1.67
	144	std::ostream* get_stream( output_format ) const;
	145
	146
7c673cae FG	147	//! Sets the threshold level for all loggers/formatters.
	148	//!
	149	//! This will override the log level of all loggers, whether enabled or not.
	150	void set_threshold_level( log_level );
	151
	152	//! Sets the threshold/log level of a specific format
	153	//!
	154	//! @note Has no effect if the specified format is not found
	155	//! @par Since Boost 1.62
	156	void set_threshold_level( output_format, log_level );
	157
	158	//! Add a format to the set of loggers
	159	//!
	160	//! Adding a logger means that the specified logger is enabled. The log level is managed by the formatter itself
	161	//! and specifies what events are forwarded to the underlying formatter.
	162	//! @par Since Boost 1.62
	163	void add_format( output_format );
	164
	165	//! Sets the format of the logger
	166	//!
	167	//! This will become the only active format of the logs.
	168	void set_format( output_format );
	169
	170	//! Returns the logger instance for a specific format.
	171	//!
	172	//! @returns the logger/formatter instance, or @c (unit_test_log_formatter*)0 if the format is not found.
	173	//! @par Since Boost 1.62
	174	unit_test_log_formatter* get_formatter( output_format );
	175
	176	//! Sets the logger instance
	177	//!
	178	//! The specified logger becomes the unique active one. The custom log formatter has the
	179	//! format @c OF_CUSTOM_LOGGER. If such a format exists already, its formatter gets replaced by the one
	180	//! given in argument.
	181	//!
	182	//! The log level and output stream of the new formatter are taken from the currently active logger. In case
	183	//! several loggers are active, the order of priority is CUSTOM, HRF, XML, and JUNIT.
	184	//! If (unit_test_log_formatter*)0 is given as argument, the custom logger (if any) is removed.
	185	//!
	186	//! @note The ownership of the pointer is transfered to the Boost.Test framework. This call is equivalent to
	187	//! - a call to @c add_formatter
	188	//! - a call to @c set_format(OF_CUSTOM_LOGGER)
	189	//! - a configuration of the newly added logger with a previously configured stream and log level.
	190	void set_formatter( unit_test_log_formatter* );
	191
	192	//! Adds a custom log formatter to the set of formatters
	193	//!
	194	//! The specified logger is added with the format @c OF_CUSTOM_LOGGER, such that it can
	195	//! be futher selected or its stream/log level can be specified.
	196	//! If there is already a custom logger (with @c OF_CUSTOM_LOGGER), then
	197	//! the existing one gets replaced by the one given in argument.
	198	//! The provided logger is added with an enabled state.
	199	//! If (unit_test_log_formatter*)0 is given as argument, the custom logger (if any) is removed and
	200	//! no other action is performed.
	201	//!
	202	//! @note The ownership of the pointer is transfered to the Boost.Test framework.
	203	//! @par Since Boost 1.62
	204	void add_formatter( unit_test_log_formatter* the_formatter );
	205
	206	// test progress logging
	207	void set_checkpoint( const_string file, std::size_t line_num, const_string msg = const_string() );
	208
	209	// entry logging
	210	unit_test_log_t& operator<<( log::begin const& ); // begin entry
211	unit_test_log_t& operator<<( log::end const& ); // end entry
212	unit_test_log_t& operator<<( log_level ); // set entry level
213	unit_test_log_t& operator<<( const_string ); // log entry value
214	unit_test_log_t& operator<<( lazy_ostream const& ); // log entry value
215
216	ut_detail::entry_value_collector operator()( log_level ); // initiate entry collection
217
218	private:
219	// Implementation helpers
220	bool log_entry_start(output_format log_format);
221	void log_entry_context( log_level l );
222	void clear_entry_context();
223
224	BOOST_TEST_SINGLETON_CONS( unit_test_log_t )
225	}; // unit_test_log_t
226
227	BOOST_TEST_SINGLETON_INST( unit_test_log )
228
229	// helper macros
230	#define BOOST_TEST_LOG_ENTRY( ll ) \
231	(::boost::unit_test::unit_test_log \
232	<< ::boost::unit_test::log::begin( BOOST_TEST_L(__FILE__), __LINE__ ))(ll) \
233	/**/
234
235	} // namespace unit_test
236	} // namespace boost
237
238	// ************************************************************************** //
239	// ************ Unit test log interface helpers ************ //
240	// ************************************************************************** //
241
242	// messages sent by the framework
243	#define BOOST_TEST_FRAMEWORK_MESSAGE( M ) \
244	(::boost::unit_test::unit_test_log \
245	<< ::boost::unit_test::log::begin( \
246	"boost.test framework", \
247	__LINE__ )) \
248	( ::boost::unit_test::log_messages ) \
249	<< BOOST_TEST_LAZY_MSG( M ) \
250	/**/
251
252
253	#define BOOST_TEST_MESSAGE( M ) \
254	BOOST_TEST_LOG_ENTRY( ::boost::unit_test::log_messages ) \
255	<< BOOST_TEST_LAZY_MSG( M ) \
256	/**/
257
258	//____________________________________________________________________________//
259
260	#define BOOST_TEST_PASSPOINT() \
261	::boost::unit_test::unit_test_log.set_checkpoint( \
262	BOOST_TEST_L(__FILE__), \
263	static_cast<std::size_t>(__LINE__) ) \
264	/**/
265
266	//____________________________________________________________________________//
267
268	#define BOOST_TEST_CHECKPOINT( M ) \
269	::boost::unit_test::unit_test_log.set_checkpoint( \
270	BOOST_TEST_L(__FILE__), \
271	static_cast<std::size_t>(__LINE__), \
272	(::boost::wrap_stringstream().ref() << M).str() ) \
273	/**/
274
275	//____________________________________________________________________________//
276
277	#include <boost/test/detail/enable_warnings.hpp>
278
279	#endif // BOOST_TEST_UNIT_TEST_LOG_HPP_071894GER
280