source: NonGTP/Boost/boost/test/unit_test_suite.hpp @ 857

Revision 857, 10.1 KB checked in by igarcia, 18 years ago (diff)
Line 
1//  (C) Copyright Gennadiy Rozental 2005.
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        : $RCSfile: unit_test_suite.hpp,v $
9//
10//  Version     : $Revision: 1.32 $
11//
12//  Description : defines test_unit, test_case, test_case_results, test_suite and test_tree_visitor
13// ***************************************************************************
14
15#ifndef BOOST_TEST_UNIT_TEST_SUITE_HPP_071894GER
16#define BOOST_TEST_UNIT_TEST_SUITE_HPP_071894GER
17
18// Boost.Test
19#include <boost/test/detail/config.hpp>
20#include <boost/test/detail/global_typedef.hpp>
21#include <boost/test/utils/class_properties.hpp>
22#include <boost/test/utils/callback.hpp>
23#include <boost/test/detail/fwd_decl.hpp>
24#include <boost/test/detail/workaround.hpp>
25
26// Boost
27#include <boost/shared_ptr.hpp>
28
29// STL
30#include <string>   // for std::string
31#include <list>     // for std::list
32#include <vector>   // for std::list
33
34#include <boost/test/detail/suppress_warnings.hpp>
35
36//____________________________________________________________________________//
37
38#define BOOST_TEST_CASE( function ) \
39boost::unit_test::make_test_case( boost::unit_test::callback0<>(function), BOOST_TEST_STRINGIZE( function ) )
40#define BOOST_CLASS_TEST_CASE( function, tc_instance ) \
41boost::unit_test::make_test_case((function), BOOST_TEST_STRINGIZE( function ), tc_instance )
42#define BOOST_TEST_SUITE( testsuite_name ) \
43( new boost::unit_test::test_suite( testsuite_name ) )
44
45namespace boost {
46
47namespace unit_test {
48
49// ************************************************************************** //
50// **************                   test_unit                  ************** //
51// ************************************************************************** //
52
53class test_unit {
54public:
55    enum { type = tut_any };
56
57    // Constructor
58    test_unit( const_string tu_name, test_unit_type t );
59
60    // dependencies management
61    void    depends_on( test_unit* tu );
62    bool    check_dependencies() const;
63
64    // Public r/o properties
65    typedef BOOST_READONLY_PROPERTY(test_unit_id,(framework_impl)) id_t;
66    readonly_property<test_unit_type>   p_type;                 // type for this test unit
67    readonly_property<const_string>     p_type_name;            // "case"/"suite"
68    id_t                                p_id;                   // unique id for this test unit
69
70    // Public r/w properties
71    readwrite_property<std::string>     p_name;                 // name for this test unit
72    readwrite_property<unsigned>        p_timeout;              // timeout for the test unit execution
73    readwrite_property<counter_t>       p_expected_failures;    // number of expected failured in this test unit
74
75private:
76    // Data members
77    std::list<test_unit_id>             m_dependencies;
78};
79
80// ************************************************************************** //
81// **************              test_case_generator             ************** //
82// ************************************************************************** //
83
84class test_unit_generator {
85public:
86    virtual test_unit*  next() const = 0;
87
88protected:
89    BOOST_TEST_PROTECTED_VIRTUAL ~test_unit_generator() {}
90};
91
92// ************************************************************************** //
93// **************                   test_case                  ************** //
94// ************************************************************************** //
95
96class test_case : public test_unit {
97public:
98    enum { type = tut_case };
99
100    // Constructor
101    test_case( const_string tc_name, callback0<> const& test_func );
102
103    // Access methods
104    callback0<> const&  test_func() const { return m_test_func; }
105
106private:
107    friend class framework_impl;
108    ~test_case() {}
109
110    // BOOST_MSVC <= 1200 have problems with callback as property
111    // Data members
112    callback0<> m_test_func;
113};
114
115// ************************************************************************** //
116// **************                  test_suite                  ************** //
117// ************************************************************************** //
118
119class test_suite : public test_unit {
120public:
121    enum { type = tut_suite };
122
123    // Constructor
124    explicit    test_suite( const_string ts_name = "Master" );
125
126    // test case list management
127    void        add( test_unit* tu, counter_t expected_failures = 0, unsigned timeout = 0 );
128    void        add( test_unit_generator const& gen, unsigned timeout = 0 );
129
130protected:
131    friend void traverse_test_tree( test_suite const&, test_tree_visitor& );
132    friend class framework_impl;
133    virtual     ~test_suite() {}
134
135private:
136    // Data members
137    std::vector<test_unit_id> m_members;
138};
139
140// ************************************************************************** //
141// **************               test_tree_visitor              ************** //
142// ************************************************************************** //
143
144class test_tree_visitor {
145public:
146    // test tree visitor interface
147    virtual void    visit( test_case const& )               {}
148    virtual bool    test_suite_start( test_suite const& )   { return true; }
149    virtual void    test_suite_finish( test_suite const& )  {}
150
151protected:
152    BOOST_TEST_PROTECTED_VIRTUAL ~test_tree_visitor() {}
153};
154
155// ************************************************************************** //
156// **************               traverse_test_tree             ************** //
157// ************************************************************************** //
158
159void    traverse_test_tree( test_case const&, test_tree_visitor& );
160void    traverse_test_tree( test_suite const&, test_tree_visitor& );
161void    traverse_test_tree( test_unit_id id, test_tree_visitor& );
162
163//____________________________________________________________________________//
164
165inline void
166traverse_test_tree( test_unit const& tu, test_tree_visitor& V )
167{
168    if( tu.p_type == tut_case )
169        traverse_test_tree( static_cast<test_case const&>( tu ), V );
170    else
171        traverse_test_tree( static_cast<test_suite const&>( tu ), V );
172}
173
174//____________________________________________________________________________//
175
176// ************************************************************************** //
177// **************                test_case_counter             ************** //
178// ************************************************************************** //
179
180struct test_case_counter : test_tree_visitor {
181    test_case_counter() : m_count( 0 ) {}
182
183    void        visit( test_case const& ) { m_count++; }
184
185    counter_t   m_count;
186};
187
188// ************************************************************************** //
189// **************                  test_aborted                ************** //
190// ************************************************************************** //
191
192struct test_aborted {};
193
194// ************************************************************************** //
195// **************               object generators              ************** //
196// ************************************************************************** //
197
198namespace ut_detail {
199
200std::string normalize_test_case_name( const_string tu_name );
201
202template<typename UserTestCase>
203struct user_tc_method_invoker {
204    typedef void (UserTestCase::*test_method )();
205
206    user_tc_method_invoker( shared_ptr<UserTestCase> inst, test_method tm )
207    : m_inst( inst ), m_test_method( tm ) {}
208
209    void operator()() { ((*m_inst).*m_test_method)(); }
210
211    shared_ptr<UserTestCase> m_inst;
212    test_method              m_test_method;
213};
214
215} // namespace ut_detail
216
217//____________________________________________________________________________//
218
219inline test_case*
220make_test_case( callback0<> const& test_func, const_string tc_name )
221{
222    return new test_case( ut_detail::normalize_test_case_name( tc_name ), test_func );
223}
224
225//____________________________________________________________________________//
226
227template<typename UserTestCase>
228inline test_case*
229make_test_case( void (UserTestCase::*test_method )(),
230                  const_string tc_name,
231                  boost::shared_ptr<UserTestCase> const& user_test_case )
232{
233    return new test_case( ut_detail::normalize_test_case_name( tc_name ),
234                          ut_detail::user_tc_method_invoker<UserTestCase>( user_test_case, test_method ) );
235}
236
237//____________________________________________________________________________//
238
239} // unit_test
240
241} // namespace boost
242
243//____________________________________________________________________________//
244
245#include <boost/test/detail/enable_warnings.hpp>
246
247// ***************************************************************************
248//  Revision History :
249// 
250//  $Log: unit_test_suite.hpp,v $
251//  Revision 1.32  2005/05/02 06:00:10  rogeeff
252//  restore a parameterized user case method based testing
253//
254//  Revision 1.31  2005/04/18 04:55:30  rogeeff
255//  test unit name made read/write
256//
257//  Revision 1.30  2005/03/22 06:57:29  rogeeff
258//  allow to inherit test_suite
259//
260//  Revision 1.29  2005/02/21 10:25:54  rogeeff
261//  use std::vector so we could employ random_shuffle
262//
263//  Revision 1.28  2005/02/20 08:27:06  rogeeff
264//  This a major update for Boost.Test framework. See release docs for complete list of fixes/updates
265//
266//  Revision 1.27  2005/02/01 06:40:06  rogeeff
267//  copyright update
268//  old log entries removed
269//  minor stylistic changes
270//  deprecated tools removed
271//
272//  Revision 1.26  2005/01/30 03:22:07  rogeeff
273//  interface changed to use const_string
274//  use BOOST_TEST_STRINGIZE
275//
276//  Revision 1.25  2005/01/22 19:22:12  rogeeff
277//  implementation moved into headers section to eliminate dependency of included/minimal component on src directory
278//
279// ***************************************************************************
280
281#endif // BOOST_TEST_UNIT_TEST_SUITE_HPP_071894GER
282
Note: See TracBrowser for help on using the repository browser.