Chris@16
|
1 // (C) Copyright Gennadiy Rozental 2001-2008.
|
Chris@16
|
2 // Distributed under the Boost Software License, Version 1.0.
|
Chris@16
|
3 // (See accompanying file LICENSE_1_0.txt or copy at
|
Chris@16
|
4 // http://www.boost.org/LICENSE_1_0.txt)
|
Chris@16
|
5
|
Chris@16
|
6 // See http://www.boost.org/libs/test for the library home page.
|
Chris@16
|
7 //
|
Chris@16
|
8 // File : $RCSfile$
|
Chris@16
|
9 //
|
Chris@101
|
10 // Version : $Revision$
|
Chris@16
|
11 //
|
Chris@16
|
12 // Description : defines singleton class unit_test_log and all manipulators.
|
Chris@16
|
13 // unit_test_log has output stream like interface. It's implementation is
|
Chris@16
|
14 // completely hidden with pimple idiom
|
Chris@16
|
15 // ***************************************************************************
|
Chris@16
|
16
|
Chris@16
|
17 #ifndef BOOST_TEST_UNIT_TEST_LOG_HPP_071894GER
|
Chris@16
|
18 #define BOOST_TEST_UNIT_TEST_LOG_HPP_071894GER
|
Chris@16
|
19
|
Chris@16
|
20 // Boost.Test
|
Chris@16
|
21 #include <boost/test/test_observer.hpp>
|
Chris@16
|
22
|
Chris@16
|
23 #include <boost/test/detail/global_typedef.hpp>
|
Chris@16
|
24 #include <boost/test/detail/log_level.hpp>
|
Chris@16
|
25 #include <boost/test/detail/fwd_decl.hpp>
|
Chris@16
|
26
|
Chris@16
|
27 #include <boost/test/utils/wrap_stringstream.hpp>
|
Chris@16
|
28 #include <boost/test/utils/trivial_singleton.hpp>
|
Chris@16
|
29 #include <boost/test/utils/lazy_ostream.hpp>
|
Chris@16
|
30
|
Chris@16
|
31 // Boost
|
Chris@16
|
32 #include <boost/utility.hpp>
|
Chris@16
|
33
|
Chris@16
|
34 // STL
|
Chris@16
|
35 #include <iosfwd> // for std::ostream&
|
Chris@16
|
36
|
Chris@16
|
37 #include <boost/test/detail/suppress_warnings.hpp>
|
Chris@16
|
38
|
Chris@16
|
39 //____________________________________________________________________________//
|
Chris@16
|
40
|
Chris@16
|
41 namespace boost {
|
Chris@16
|
42
|
Chris@16
|
43 namespace unit_test {
|
Chris@16
|
44
|
Chris@16
|
45 // ************************************************************************** //
|
Chris@16
|
46 // ************** log manipulators ************** //
|
Chris@16
|
47 // ************************************************************************** //
|
Chris@16
|
48
|
Chris@16
|
49 namespace log {
|
Chris@16
|
50
|
Chris@16
|
51 struct BOOST_TEST_DECL begin {
|
Chris@16
|
52 begin( const_string fn, std::size_t ln )
|
Chris@16
|
53 : m_file_name( fn )
|
Chris@16
|
54 , m_line_num( ln )
|
Chris@16
|
55 {}
|
Chris@16
|
56
|
Chris@16
|
57 const_string m_file_name;
|
Chris@16
|
58 std::size_t m_line_num;
|
Chris@16
|
59 };
|
Chris@16
|
60
|
Chris@16
|
61 struct end {};
|
Chris@16
|
62
|
Chris@16
|
63 } // namespace log
|
Chris@16
|
64
|
Chris@16
|
65 // ************************************************************************** //
|
Chris@16
|
66 // ************** entry_value_collector ************** //
|
Chris@16
|
67 // ************************************************************************** //
|
Chris@16
|
68
|
Chris@16
|
69 namespace ut_detail {
|
Chris@16
|
70
|
Chris@16
|
71 class BOOST_TEST_DECL entry_value_collector {
|
Chris@16
|
72 public:
|
Chris@16
|
73 // Constructors
|
Chris@16
|
74 entry_value_collector() : m_last( true ) {}
|
Chris@16
|
75 entry_value_collector( entry_value_collector const& rhs ) : m_last( true ) { rhs.m_last = false; }
|
Chris@16
|
76 ~entry_value_collector();
|
Chris@16
|
77
|
Chris@16
|
78 // collection interface
|
Chris@16
|
79 entry_value_collector const& operator<<( lazy_ostream const& ) const;
|
Chris@16
|
80 entry_value_collector const& operator<<( const_string ) const;
|
Chris@16
|
81
|
Chris@16
|
82 private:
|
Chris@16
|
83 // Data members
|
Chris@16
|
84 mutable bool m_last;
|
Chris@16
|
85 };
|
Chris@16
|
86
|
Chris@16
|
87 } // namespace ut_detail
|
Chris@16
|
88
|
Chris@16
|
89 // ************************************************************************** //
|
Chris@16
|
90 // ************** unit_test_log ************** //
|
Chris@16
|
91 // ************************************************************************** //
|
Chris@16
|
92
|
Chris@16
|
93 class BOOST_TEST_DECL unit_test_log_t : public test_observer, public singleton<unit_test_log_t> {
|
Chris@16
|
94 public:
|
Chris@16
|
95 // test_observer interface implementation
|
Chris@16
|
96 void test_start( counter_t test_cases_amount );
|
Chris@16
|
97 void test_finish();
|
Chris@16
|
98 void test_aborted();
|
Chris@16
|
99
|
Chris@16
|
100 void test_unit_start( test_unit const& );
|
Chris@16
|
101 void test_unit_finish( test_unit const&, unsigned long elapsed );
|
Chris@16
|
102 void test_unit_skipped( test_unit const& );
|
Chris@16
|
103 void test_unit_aborted( test_unit const& );
|
Chris@16
|
104
|
Chris@16
|
105 void assertion_result( bool passed );
|
Chris@16
|
106 void exception_caught( execution_exception const& );
|
Chris@16
|
107
|
Chris@16
|
108 virtual int priority() { return 1; }
|
Chris@16
|
109
|
Chris@16
|
110 // log configuration methods
|
Chris@16
|
111 void set_stream( std::ostream& );
|
Chris@16
|
112 void set_threshold_level( log_level );
|
Chris@16
|
113 void set_format( output_format );
|
Chris@16
|
114 void set_formatter( unit_test_log_formatter* );
|
Chris@16
|
115
|
Chris@16
|
116 // test progress logging
|
Chris@16
|
117 void set_checkpoint( const_string file, std::size_t line_num, const_string msg = const_string() );
|
Chris@16
|
118
|
Chris@16
|
119 // entry logging
|
Chris@16
|
120 unit_test_log_t& operator<<( log::begin const& ); // begin entry
|
Chris@16
|
121 unit_test_log_t& operator<<( log::end const& ); // end entry
|
Chris@16
|
122 unit_test_log_t& operator<<( log_level ); // set entry level
|
Chris@16
|
123 unit_test_log_t& operator<<( const_string ); // log entry value
|
Chris@16
|
124 unit_test_log_t& operator<<( lazy_ostream const& ); // log entry value
|
Chris@16
|
125
|
Chris@16
|
126 ut_detail::entry_value_collector operator()( log_level ); // initiate entry collection
|
Chris@16
|
127
|
Chris@16
|
128 private:
|
Chris@16
|
129 bool log_entry_start();
|
Chris@16
|
130
|
Chris@16
|
131 BOOST_TEST_SINGLETON_CONS( unit_test_log_t );
|
Chris@16
|
132 }; // unit_test_log_t
|
Chris@16
|
133
|
Chris@16
|
134 BOOST_TEST_SINGLETON_INST( unit_test_log )
|
Chris@16
|
135
|
Chris@16
|
136 // helper macros
|
Chris@16
|
137 #define BOOST_TEST_LOG_ENTRY( ll ) \
|
Chris@16
|
138 (::boost::unit_test::unit_test_log \
|
Chris@16
|
139 << ::boost::unit_test::log::begin( BOOST_TEST_L(__FILE__), __LINE__ ))(ll) \
|
Chris@16
|
140 /**/
|
Chris@16
|
141
|
Chris@16
|
142 } // namespace unit_test
|
Chris@16
|
143
|
Chris@16
|
144 } // namespace boost
|
Chris@16
|
145
|
Chris@16
|
146 // ************************************************************************** //
|
Chris@16
|
147 // ************** Unit test log interface helpers ************** //
|
Chris@16
|
148 // ************************************************************************** //
|
Chris@16
|
149
|
Chris@16
|
150 #define BOOST_TEST_MESSAGE( M ) \
|
Chris@16
|
151 BOOST_TEST_LOG_ENTRY( ::boost::unit_test::log_messages ) \
|
Chris@16
|
152 << (::boost::unit_test::lazy_ostream::instance() << M) \
|
Chris@16
|
153 /**/
|
Chris@16
|
154
|
Chris@16
|
155 //____________________________________________________________________________//
|
Chris@16
|
156
|
Chris@16
|
157 #define BOOST_TEST_PASSPOINT() \
|
Chris@16
|
158 ::boost::unit_test::unit_test_log.set_checkpoint( \
|
Chris@16
|
159 BOOST_TEST_L(__FILE__), \
|
Chris@16
|
160 static_cast<std::size_t>(__LINE__) ) \
|
Chris@16
|
161 /**/
|
Chris@16
|
162
|
Chris@16
|
163 //____________________________________________________________________________//
|
Chris@16
|
164
|
Chris@16
|
165 #define BOOST_TEST_CHECKPOINT( M ) \
|
Chris@16
|
166 ::boost::unit_test::unit_test_log.set_checkpoint( \
|
Chris@16
|
167 BOOST_TEST_L(__FILE__), \
|
Chris@16
|
168 static_cast<std::size_t>(__LINE__), \
|
Chris@16
|
169 (::boost::wrap_stringstream().ref() << M).str() ) \
|
Chris@16
|
170 /**/
|
Chris@16
|
171
|
Chris@16
|
172 //____________________________________________________________________________//
|
Chris@16
|
173
|
Chris@16
|
174 #include <boost/test/detail/enable_warnings.hpp>
|
Chris@16
|
175
|
Chris@16
|
176 #endif // BOOST_TEST_UNIT_TEST_LOG_HPP_071894GER
|
Chris@16
|
177
|