Chris@16: //  (C) Copyright Gennadiy Rozental 2005-2008.
Chris@16: //  Use, modification, and distribution are subject to the
Chris@16: //  Boost Software License, ELOG_VER 1.0. (See accompanying file
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 : Facilities to perform interaction based testng of logged expectations
Chris@16: // ***************************************************************************
Chris@16: 
Chris@16: #ifndef BOOST_TEST_LOGGED_EXPECTATIONS_IPP_120905GER
Chris@16: #define BOOST_TEST_LOGGED_EXPECTATIONS_IPP_120905GER
Chris@16: 
Chris@16: // Boost.Test
Chris@16: #include <boost/test/detail/config.hpp>
Chris@16: 
Chris@16: #if BOOST_TEST_SUPPORT_INTERACTION_TESTING
Chris@16: 
Chris@16: #include <boost/test/detail/global_typedef.hpp>
Chris@16: 
Chris@16: #include <boost/test/utils/callback.hpp>
Chris@16: #include <boost/test/utils/iterator/token_iterator.hpp>
Chris@16: 
Chris@16: #include <boost/test/interaction_based.hpp>
Chris@16: #include <boost/test/test_tools.hpp>
Chris@16: 
Chris@16: #include <boost/test/detail/suppress_warnings.hpp>
Chris@16: 
Chris@16: // Boost
Chris@16: #include <boost/lexical_cast.hpp>
Chris@16: 
Chris@16: // STL
Chris@16: #include <fstream>
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: namespace boost {
Chris@16: 
Chris@16: using namespace ::boost::unit_test;
Chris@16: 
Chris@16: namespace itest {
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************    logged expectation test implementation    ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: struct expectations_logger : itest::manager {
Chris@16:     // Constructor
Chris@16:     expectations_logger( const_string log_file_name, bool test_or_log );
Chris@16: 
Chris@16:     virtual bool        decision_point( const_string, std::size_t );
Chris@16:     virtual unsigned    enter_scope( const_string, std::size_t, const_string scope_name );
Chris@16:     virtual void        allocated( const_string, std::size_t, void*, std::size_t s );
Chris@16:     virtual void        data_flow( const_string d );
Chris@16:     virtual std::string return_value( const_string default_value );
Chris@16:     
Chris@16: private:
Chris@16:     // Data members
Chris@16:     bool            m_test_or_log;
Chris@16:     std::fstream    m_log_file;
Chris@16: };
Chris@16: 
Chris@16: literal_string ELOG_VER     = "1.0";
Chris@16: literal_string CLMN_SEP     = "|";
Chris@16: static const char LINE_SEP  = '\n';
Chris@16: 
Chris@16: literal_string FILE_SIG     = "ELOG";
Chris@16: literal_string SCOPE_SIG    = "SCOPE";
Chris@16: literal_string ALLOC_SIG    = "ALLOC";
Chris@16: literal_string DP_SIG       = "SWITCH";
Chris@16: literal_string DATA_SIG     = "DATA";
Chris@16: literal_string RETURN_SIG   = "RETURN";
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: expectations_logger::expectations_logger( const_string log_file_name, bool test_or_log )
Chris@16: : m_test_or_log( test_or_log )
Chris@16: {
Chris@16:     BOOST_REQUIRE_MESSAGE( !log_file_name.is_empty(), "Empty expectations log file name" );
Chris@16: 
Chris@16:     m_log_file.open( log_file_name.begin(), test_or_log ? std::ios::in : std::ios::out );
Chris@16: 
Chris@16:     BOOST_REQUIRE_MESSAGE( m_log_file.is_open(),
Chris@16:                            "Can't open expectations log file " << log_file_name
Chris@16:                                 << " for " << ( m_test_or_log ? "reading" : "writing") );
Chris@16: 
Chris@16:     if( m_test_or_log ) {
Chris@16:         std::string line;
Chris@16:         
Chris@16:         std::getline( m_log_file, line, LINE_SEP );
Chris@16:         
Chris@16:         const_string cline( line );
Chris@16:         string_token_iterator tit( cline, (dropped_delimeters = CLMN_SEP, kept_delimeters = dt_none));
Chris@16: 
Chris@16:         BOOST_CHECK_EQUAL( *tit, FILE_SIG ); 
Chris@16:         ++tit;
Chris@16:         BOOST_CHECK_EQUAL( *tit, ELOG_VER );
Chris@16:     }
Chris@16:     else {
Chris@16:         m_log_file << FILE_SIG << CLMN_SEP << ELOG_VER << LINE_SEP;
Chris@16:     }
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: bool
Chris@16: expectations_logger::decision_point( const_string, std::size_t )
Chris@16: {
Chris@16:     if( m_test_or_log ) {
Chris@16:         std::string line;
Chris@16:         
Chris@16:         std::getline( m_log_file, line, LINE_SEP );
Chris@16:         
Chris@16:         const_string cline( line );
Chris@16:         string_token_iterator tit( cline, (dropped_delimeters = CLMN_SEP, kept_delimeters = dt_none));
Chris@16:         
Chris@16:         BOOST_CHECK_EQUAL( *tit, DP_SIG ); ++tit;
Chris@16:         return lexical_cast<bool>( *tit );
Chris@16:     }
Chris@16:     else {
Chris@16:         m_log_file << DP_SIG << CLMN_SEP << std::boolalpha << true << LINE_SEP;
Chris@16:         
Chris@16:         return true;
Chris@16:     }
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16:     
Chris@16: unsigned
Chris@16: expectations_logger::enter_scope( const_string, std::size_t, const_string scope_name )
Chris@16: {
Chris@16:     if( m_test_or_log ) {
Chris@16:         std::string line;
Chris@16:         
Chris@16:         std::getline( m_log_file, line, LINE_SEP );
Chris@16:         
Chris@16:         const_string cline( line );
Chris@16:         string_token_iterator tit( cline, (dropped_delimeters = CLMN_SEP, kept_delimeters = dt_none));
Chris@16:         
Chris@16:         BOOST_CHECK_EQUAL( *tit, SCOPE_SIG ); ++tit;
Chris@16:         BOOST_CHECK_EQUAL( *tit, scope_name );
Chris@16:     }
Chris@16:     else {
Chris@16:         m_log_file << SCOPE_SIG << CLMN_SEP << scope_name << LINE_SEP;
Chris@16:     }
Chris@16:     
Chris@16:     return 0;
Chris@16: }
Chris@16:     
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: expectations_logger::allocated( const_string, std::size_t, void*, std::size_t s )
Chris@16: {
Chris@16:     if( m_test_or_log ) {
Chris@16:         std::string line;
Chris@16:         
Chris@16:         std::getline( m_log_file, line, LINE_SEP );
Chris@16:         
Chris@16:         const_string cline( line );
Chris@16:         string_token_iterator tit( cline, (dropped_delimeters = CLMN_SEP, kept_delimeters = dt_none));
Chris@16:         
Chris@16:         BOOST_CHECK_EQUAL( *tit, ALLOC_SIG ); ++tit;
Chris@16:         BOOST_CHECK_EQUAL( lexical_cast<std::size_t>( *tit ), s );
Chris@16:     }
Chris@16:     else {
Chris@16:         m_log_file << ALLOC_SIG << CLMN_SEP << s << LINE_SEP;
Chris@16:     }
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: void
Chris@16: expectations_logger::data_flow( const_string d )
Chris@16: {
Chris@16:     if( m_test_or_log ) {
Chris@16:         std::string line;
Chris@16:         
Chris@16:         std::getline( m_log_file, line, LINE_SEP );
Chris@16:         
Chris@16:         const_string cline( line );
Chris@16:         string_token_iterator tit( cline, (dropped_delimeters = CLMN_SEP, kept_delimeters = dt_none));
Chris@16:         
Chris@16:         BOOST_CHECK_EQUAL( *tit, DATA_SIG ); ++tit;
Chris@16:         BOOST_CHECK_EQUAL( *tit, d );
Chris@16:     }
Chris@16:     else {
Chris@16:         m_log_file << DATA_SIG << CLMN_SEP << d << LINE_SEP;
Chris@16:     }
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: std::string
Chris@16: expectations_logger::return_value( const_string default_value )
Chris@16: {
Chris@16:     if( m_test_or_log ) {
Chris@16:         std::string line;
Chris@16:         
Chris@16:         std::getline( m_log_file, line, LINE_SEP );
Chris@16:         
Chris@16:         const_string cline( line );
Chris@16:         string_token_iterator tit( cline, (dropped_delimeters = CLMN_SEP, kept_delimeters = dt_none));
Chris@16:         
Chris@16:         BOOST_CHECK_EQUAL( *tit, RETURN_SIG ); ++tit;
Chris@16:         
Chris@16:         return std::string( tit->begin(), tit->size() );
Chris@16:     }
Chris@16:     else {
Chris@16:         m_log_file << RETURN_SIG << CLMN_SEP << default_value << LINE_SEP;
Chris@16:                                  
Chris@16:         return std::string();
Chris@16:     }
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16:     
Chris@16: // ************************************************************************** //
Chris@16: // **************           logged expectations test           ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: void BOOST_TEST_DECL
Chris@16: logged_expectations( callback0<> const& F, const_string log_file_name, bool test_or_log )
Chris@16: {
Chris@16:     expectations_logger el( log_file_name, test_or_log );
Chris@16: 
Chris@16:     F();
Chris@16: }
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: }  // namespace itest
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 // not ancient compiler
Chris@16: 
Chris@16: #endif // BOOST_TEST_LOGGED_EXPECTATIONS_IPP_120905GER