blob: 0f158c33a35a7274155a293b92a09a68ea660953 [file] [log] [blame]
Jeff Thompsonef2d5a42013-08-22 19:09:24 -07001// (C) Copyright Gennadiy Rozental 2005-2008.
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$
9//
10// Version : $Revision: 49312 $
11//
12// Description : Facilities to perform interaction-based testing
13// ***************************************************************************
14
Jeff Thompson3d613fd2013-10-15 15:39:04 -070015#ifndef NDNBOOST_TEST_INTERACTION_BASED_HPP_112105GER
16#define NDNBOOST_TEST_INTERACTION_BASED_HPP_112105GER
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070017
18// Boost.Test
19#include <ndnboost/test/detail/config.hpp>
20#include <ndnboost/test/detail/global_typedef.hpp>
21
22#include <ndnboost/test/utils/wrap_stringstream.hpp>
23
24#include <ndnboost/test/detail/suppress_warnings.hpp>
25
26// Boost
27#include <ndnboost/lexical_cast.hpp>
28
29//____________________________________________________________________________//
30
31// ************************************************************************** //
Jeff Thompson3d613fd2013-10-15 15:39:04 -070032// ************** NDNBOOST_ITEST_EPOINT ************** //
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070033// ************************************************************************** //
34
Jeff Thompson3d613fd2013-10-15 15:39:04 -070035#define NDNBOOST_ITEST_EPOINT( description ) \
36 ::ndnboost::itest::manager::instance().exception_point( NDNBOOST_TEST_L(__FILE__), __LINE__, description )
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070037/**/
38
39// ************************************************************************** //
Jeff Thompson3d613fd2013-10-15 15:39:04 -070040// ************** NDNBOOST_ITEST_DPOINT ************** //
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070041// ************************************************************************** //
42
Jeff Thompson3d613fd2013-10-15 15:39:04 -070043#define NDNBOOST_ITEST_DPOINT() \
44 ::ndnboost::itest::manager::instance().decision_point( NDNBOOST_TEST_L(__FILE__), __LINE__ )
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070045/**/
46
47// ************************************************************************** //
Jeff Thompson3d613fd2013-10-15 15:39:04 -070048// ************** NDNBOOST_ITEST_SCOPE ************** //
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070049// ************************************************************************** //
50
Jeff Thompson3d613fd2013-10-15 15:39:04 -070051#define NDNBOOST_ITEST_SCOPE( scope_name ) \
52 ::ndnboost::itest::scope_guard itest_scope_guard ## __LINE__( NDNBOOST_TEST_L(__FILE__), __LINE__, NDNBOOST_STRINGIZE(scope_name) )
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070053/**/
54
55// ************************************************************************** //
Jeff Thompson3d613fd2013-10-15 15:39:04 -070056// ************** NDNBOOST_ITEST_NEW ************** //
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070057// ************************************************************************** //
58
Jeff Thompson3d613fd2013-10-15 15:39:04 -070059#define NDNBOOST_ITEST_NEW( type_name ) \
60 new ( ::ndnboost::itest::location( NDNBOOST_TEST_L(__FILE__), __LINE__ ) ) type_name
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070061/**/
62
63// ************************************************************************** //
Jeff Thompson3d613fd2013-10-15 15:39:04 -070064// ************** NDNBOOST_ITEST_DATA_FLOW ************** //
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070065// ************************************************************************** //
66
Jeff Thompson3d613fd2013-10-15 15:39:04 -070067#define NDNBOOST_ITEST_DATA_FLOW( v ) \
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070068 ::ndnboost::itest::manager::instance().generic_data_flow( v )
69/**/
70
71// ************************************************************************** //
Jeff Thompson3d613fd2013-10-15 15:39:04 -070072// ************** NDNBOOST_ITEST_RETURN ************** //
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070073// ************************************************************************** //
74
Jeff Thompson3d613fd2013-10-15 15:39:04 -070075#define NDNBOOST_ITEST_RETURN( type, default_value ) \
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070076 ::ndnboost::itest::manager::instance().generic_return<type>( default_value )
77/**/
78
79// ************************************************************************** //
Jeff Thompson3d613fd2013-10-15 15:39:04 -070080// ************** NDNBOOST_ITEST_MOCK_FUNC ************** //
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070081// ************************************************************************** //
82
Jeff Thompson3d613fd2013-10-15 15:39:04 -070083#define NDNBOOST_ITEST_MOCK_FUNC( function_name ) \
84 NDNBOOST_ITEST_SCOPE( function_name ); \
85 NDNBOOST_ITEST_EPOINT( 0 ); \
Jeff Thompsonef2d5a42013-08-22 19:09:24 -070086 return ::ndnboost::itest::mock_object<>::prototype(); \
87/**/
88
89namespace ndnboost {
90
91namespace itest { // interaction-based testing
92
93using unit_test::const_string;
94
95// ************************************************************************** //
96// ************** manager ************** //
97// ************************************************************************** //
98
Jeff Thompson3d613fd2013-10-15 15:39:04 -070099class NDNBOOST_TEST_DECL manager {
Jeff Thompsonef2d5a42013-08-22 19:09:24 -0700100public:
101 // instance access
102 static manager& instance() { return *instance_ptr(); }
103
104 // Mock objects interface hooks
105 virtual void exception_point( const_string /*file*/,
106 std::size_t /*line_num*/,
107 const_string /*descr*/ ){}
108 virtual bool decision_point( const_string /*file*/,
109 std::size_t /*line_num*/ ) { return true; }
110 virtual unsigned enter_scope( const_string /*file*/,
111 std::size_t /*line_num*/,
112 const_string /*scope_name*/){ return 0; }
113 virtual void leave_scope( unsigned ) {}
114 virtual void allocated( const_string /*file*/,
115 std::size_t /*line_num*/,
116 void* /*p*/, std::size_t /*s*/ ) {}
117 virtual void freed( void* /*p*/ ) {}
118 virtual void data_flow( const_string /*d*/ ) {}
119 virtual std::string return_value( const_string /*default_value */ ) { return ""; }
120
121 template<typename T>
122 void generic_data_flow( T const& t )
123 {
124 wrap_stringstream ws;
125
126 data_flow( (ws << t).str() );
127 }
128 template<typename T, typename DefaultValueType>
129 T generic_return( DefaultValueType const& dv )
130 {
131 wrap_stringstream ws;
132
133 std::string const& res = return_value( (ws << dv).str() );
134
135 if( res.empty() )
136 return dv;
137
138 return lexical_cast<T>( res );
139 }
140
141protected:
142 manager();
Jeff Thompson3d613fd2013-10-15 15:39:04 -0700143#if NDNBOOST_WORKAROUND(__BORLANDC__, NDNBOOST_TESTED_AT(0x564))
Jeff Thompsonef2d5a42013-08-22 19:09:24 -0700144public:
145#endif
Jeff Thompson3d613fd2013-10-15 15:39:04 -0700146 NDNBOOST_TEST_PROTECTED_VIRTUAL ~manager();
Jeff Thompsonef2d5a42013-08-22 19:09:24 -0700147
148private:
149 struct dummy_constr{};
150 explicit manager( dummy_constr* ) {}
151
152 static manager* instance_ptr( bool reset = false, manager* ptr = 0 );
153}; // manager
154
155// ************************************************************************** //
156// ************** scope_guard ************** //
157// ************************************************************************** //
158
159class scope_guard {
160public:
161 // Constructor
162 scope_guard( const_string file, std::size_t line_num, const_string scope_name )
163 {
164 m_scope_index = manager::instance().enter_scope( file, line_num, scope_name );
165 }
166 ~scope_guard()
167 {
168 manager::instance().leave_scope( m_scope_index );
169 }
170
171 unsigned m_scope_index;
172};
173
174// ************************************************************************** //
175// ************** location ************** //
176// ************************************************************************** //
177
178struct location {
179 location( const_string file, std::size_t line )
180 : m_file_name( file )
181 , m_line_num( line )
182 {}
183
184 const_string m_file_name;
185 std::size_t m_line_num;
186};
187
188} // namespace itest
189
190} // namespace ndnboost
191
192// ************************************************************************** //
193// ************** operator new overload ************** //
194// ************************************************************************** //
195
Jeff Thompson3d613fd2013-10-15 15:39:04 -0700196#if !defined(NDNBOOST_ITEST_NO_NEW_OVERLOADS)
Jeff Thompsonef2d5a42013-08-22 19:09:24 -0700197
198// STL
199#include <cstdlib>
200
Jeff Thompson3d613fd2013-10-15 15:39:04 -0700201# ifdef NDNBOOST_NO_STDC_NAMESPACE
Jeff Thompsonef2d5a42013-08-22 19:09:24 -0700202namespace std { using ::malloc; using ::free; }
203# endif
204# ifdef _CRTDBG_MAP_ALLOC
205namespace std { using ::_malloc_dbg; using ::_free_dbg; }
206# endif
207
208inline void*
209operator new( std::size_t s, ::ndnboost::itest::location const& l )
210{
211 void* res = std::malloc(s ? s : 1);
212
213 if( res )
214 ::ndnboost::itest::manager::instance().allocated( l.m_file_name, l.m_line_num, res, s );
215 else
216 throw std::bad_alloc();
217
218 return res;
219}
220
221//____________________________________________________________________________//
222
223inline void*
224operator new[]( std::size_t s, ::ndnboost::itest::location const& l )
225{
226 void* res = std::malloc(s ? s : 1);
227
228 if( res )
229 ::ndnboost::itest::manager::instance().allocated( l.m_file_name, l.m_line_num, res, s );
230 else
231 throw std::bad_alloc();
232
233 return res;
234}
235
236//____________________________________________________________________________//
237
238inline void
239operator delete( void* p, ::ndnboost::itest::location const& )
240{
241 ::ndnboost::itest::manager::instance().freed( p );
242
243 std::free( p );
244}
245
246//____________________________________________________________________________//
247
248inline void
249operator delete[]( void* p, ::ndnboost::itest::location const& )
250{
251 ::ndnboost::itest::manager::instance().freed( p );
252
253 std::free( p );
254}
255
256//____________________________________________________________________________//
257
258#endif
259
260#include <ndnboost/test/detail/enable_warnings.hpp>
261
Jeff Thompson3d613fd2013-10-15 15:39:04 -0700262#endif // NDNBOOST_TEST_INTERACTION_BASED_HPP_112105GER