2
0
mirror of https://github.com/boostorg/test.git synced 2026-01-26 07:02:12 +00:00
Files
test/src/test_tools.cpp
2005-01-19 06:40:05 +00:00

474 lines
15 KiB
C++

// (C) Copyright Gennadiy Rozental 2001-2004.
// (C) Copyright Ullrich Koethe 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 : $RCSfile$
//
// Version : $Revision$
//
// Description : supplies offline implementation for the Test Tools
// ***************************************************************************
// Boost.Test
#include <boost/test/test_tools.hpp>
#include <boost/test/unit_test_result.hpp>
// BOOST
#include <boost/config.hpp>
// STL
#include <fstream>
#include <iostream>
#include <algorithm>
#include <cstring>
#include <string>
#include <cctype>
#include <cwchar>
#ifdef BOOST_STANDARD_IOSTREAMS
#include <ios>
#endif
# ifdef BOOST_NO_STDC_NAMESPACE
namespace std { using ::strcmp; using ::strlen; using ::isprint; }
#if !defined( BOOST_NO_CWCHAR )
namespace std { using ::wcscmp; }
#endif
# endif
#include <boost/test/detail/suppress_warnings.hpp>
namespace boost {
namespace test_tools {
#define LOG BOOST_UT_LOG_ENTRY_FL( file_name, line_num )
namespace tt_detail {
// ************************************************************************** //
// ************** TOOL BOX Implementation ************** //
// ************************************************************************** //
void
checkpoint_impl( wrap_stringstream& message, const_string file_name, std::size_t line_num )
{
LOG( unit_test::log_test_suites ) << unit_test::checkpoint( message.str() );
}
//____________________________________________________________________________//
void
message_impl( wrap_stringstream& message, const_string file_name, std::size_t line_num )
{
LOG( unit_test::log_messages ) << message.str();
}
//____________________________________________________________________________//
void
warn_and_continue_impl( bool predicate, wrap_stringstream& message,
const_string file_name, std::size_t line_num, bool add_fail_pass )
{
if( !predicate ) {
LOG( unit_test::log_warnings ) << (add_fail_pass ? "condition " : "") << message.str()
<< (add_fail_pass ? " is not satisfied" : "" );
}
else {
LOG( unit_test::log_successful_tests ) << "condition " << message.str() << " is satisfied";
}
}
//____________________________________________________________________________//
void
warn_and_continue_impl( extended_predicate_value const& v, wrap_stringstream& message,
const_string file_name, std::size_t line_num, bool add_fail_pass )
{
warn_and_continue_impl( !!v,
wrap_stringstream().ref() << (add_fail_pass ? "condition " : "") << message
<< (add_fail_pass && !v ? " is not satisfied. " : "" ) << *(v.p_message),
file_name, line_num, false );
}
//____________________________________________________________________________//
bool
test_and_continue_impl( bool predicate, wrap_stringstream& message,
const_string file_name, std::size_t line_num, bool add_fail_pass,
unit_test::log_level loglevel )
{
if( !predicate ) {
unit_test::unit_test_result::instance().inc_failed_assertions();
LOG( loglevel ) << (add_fail_pass ? "test " : "") << message.str() << (add_fail_pass ? " failed" : "");
return true;
}
else {
unit_test::unit_test_result::instance().inc_passed_assertions();
LOG( unit_test::log_successful_tests ) << (add_fail_pass ? "test " : "") << message.str()
<< (add_fail_pass ? " passed" : "");
return false;
}
}
//____________________________________________________________________________//
bool
test_and_continue_impl( extended_predicate_value const& v, wrap_stringstream& message,
const_string file_name, std::size_t line_num, bool add_fail_pass,
unit_test::log_level loglevel )
{
return test_and_continue_impl( !!v,
wrap_stringstream().ref() << (add_fail_pass ? "test " : "") << message
<< (add_fail_pass ? (!v ? " failed. " : " passed. ") : "") << *(v.p_message),
file_name, line_num, false, loglevel );
}
//____________________________________________________________________________//
void
test_and_throw_impl( bool predicate, wrap_stringstream& message,
const_string file_name, std::size_t line_num,
bool add_fail_pass, unit_test::log_level loglevel )
{
if( test_and_continue_impl( predicate, message, file_name, line_num, add_fail_pass, loglevel ) )
throw test_tool_failed(); // error already reported by test_and_continue_impl
}
//____________________________________________________________________________//
void
test_and_throw_impl( extended_predicate_value const& v, wrap_stringstream& message,
const_string file_name, std::size_t line_num,
bool add_fail_pass, unit_test::log_level loglevel )
{
if( test_and_continue_impl( v, message, file_name, line_num, add_fail_pass, loglevel ) )
throw test_tool_failed(); // error already reported by test_and_continue_impl
}
//____________________________________________________________________________//
bool
equal_and_continue_impl( char const* left, char const* right, wrap_stringstream& message,
const_string file_name, std::size_t line_num,
unit_test::log_level loglevel )
{
bool predicate = (left && right) ? std::strcmp( left, right ) == 0 : (left == right);
left = left ? left : "null string";
right = right ? right : "null string";
if( !predicate ) {
return test_and_continue_impl( false,
wrap_stringstream().ref() << "test " << message.str() << " failed [" << left << " != " << right << "]",
file_name, line_num, false, loglevel );
}
return test_and_continue_impl( true, message, file_name, line_num, true, loglevel );
}
//____________________________________________________________________________//
#if !defined( BOOST_NO_CWCHAR )
bool
equal_and_continue_impl( wchar_t const* left, wchar_t const* right, wrap_stringstream& message,
const_string file_name, std::size_t line_num,
unit_test::log_level loglevel )
{
bool predicate = (left && right) ? std::wcscmp( left, right ) == 0 : (left == right);
left = left ? left : L"null string";
right = right ? right : L"null string";
if( !predicate ) {
return test_and_continue_impl( false,
wrap_stringstream().ref() << "test " << message.str() << " failed",
file_name, line_num, false, loglevel );
}
return test_and_continue_impl( true, message, file_name, line_num, true, loglevel );
}
#endif // !defined( BOOST_NO_CWCHAR )
//____________________________________________________________________________//
bool
is_defined_impl( const_string symbol_name, const_string symbol_value )
{
symbol_value.trim_left( 2 );
return symbol_name != symbol_value;
}
//____________________________________________________________________________//
// ************************************************************************** //
// ************** log print helper ************** //
// ************************************************************************** //
void
print_log_value<char>::operator()( std::ostream& ostr, char t )
{
if( (std::isprint)( t ) )
ostr << '\'' << t << '\'';
else
ostr << std::hex
// showbase is only available for new style streams:
#ifndef BOOST_NO_STD_LOCALE
<< std::showbase
#else
<< "0x"
#endif
<< (int)t;
}
//____________________________________________________________________________//
void
print_log_value<unsigned char>::operator()( std::ostream& ostr, unsigned char t )
{
ostr << std::hex
// showbase is only available for new style streams:
#ifndef BOOST_NO_STD_LOCALE
<< std::showbase
#else
<< "0x"
#endif
<< (int)t;
}
//____________________________________________________________________________//
} // namespace tt_detail
// ************************************************************************** //
// ************** output_test_stream ************** //
// ************************************************************************** //
struct output_test_stream::Impl
{
std::fstream m_pattern_to_match_or_save;
bool m_match_or_save;
std::string m_synced_string;
char get_char()
{
char res;
do {
m_pattern_to_match_or_save.get( res );
} while( res == '\r' &&
!m_pattern_to_match_or_save.fail() &&
!m_pattern_to_match_or_save.eof() );
return res;
}
void check_and_fill( extended_predicate_value& res )
{
if( !res.p_predicate_value )
*(res.p_message) << "Output content: \"" << m_synced_string << '\"';
}
};
//____________________________________________________________________________//
output_test_stream::output_test_stream( const_string pattern_file_name, bool match_or_save )
: m_pimpl( new Impl )
{
if( !pattern_file_name.is_empty() )
m_pimpl->m_pattern_to_match_or_save.open( pattern_file_name.begin(), match_or_save ? std::ios::in : std::ios::out );
m_pimpl->m_match_or_save = match_or_save;
}
//____________________________________________________________________________//
output_test_stream::~output_test_stream()
{
}
//____________________________________________________________________________//
extended_predicate_value
output_test_stream::is_empty( bool flush_stream )
{
sync();
result_type res( m_pimpl->m_synced_string.empty() );
m_pimpl->check_and_fill( res );
if( flush_stream )
flush();
return res;
}
//____________________________________________________________________________//
extended_predicate_value
output_test_stream::check_length( std::size_t length_, bool flush_stream )
{
sync();
result_type res( m_pimpl->m_synced_string.length() == length_ );
m_pimpl->check_and_fill( res );
if( flush_stream )
flush();
return res;
}
//____________________________________________________________________________//
extended_predicate_value
output_test_stream::is_equal( const_string arg, bool flush_stream )
{
sync();
result_type res( const_string( m_pimpl->m_synced_string ) == arg );
m_pimpl->check_and_fill( res );
if( flush_stream )
flush();
return res;
}
//____________________________________________________________________________//
extended_predicate_value
output_test_stream::match_pattern( bool flush_stream )
{
sync();
result_type result( true );
if( !m_pimpl->m_pattern_to_match_or_save.is_open() ) {
result = false;
*(result.p_message) << "Couldn't open pattern file for "
<< ( m_pimpl->m_match_or_save ? "reading" : "writing");
}
else {
if( m_pimpl->m_match_or_save ) {
for ( std::string::size_type i = 0; i < m_pimpl->m_synced_string.length(); ++i ) {
char c = m_pimpl->get_char();
result = !m_pimpl->m_pattern_to_match_or_save.fail() &&
!m_pimpl->m_pattern_to_match_or_save.eof() &&
(m_pimpl->m_synced_string[i] == c);
if( !result ) {
std::string::size_type suffix_size = (std::min)( m_pimpl->m_synced_string.length() - i,
static_cast<std::string::size_type>(5) );
// try to log area around the mismatch
*(result.p_message) << "Mismatch at position " << i << '\n'
<< "..." << m_pimpl->m_synced_string.substr( i, suffix_size ) << "..." << '\n'
<< "..." << c;
std::string::size_type counter = suffix_size;
while( --counter ) {
char c = m_pimpl->get_char();
if( m_pimpl->m_pattern_to_match_or_save.fail() ||
m_pimpl->m_pattern_to_match_or_save.eof() )
break;
*(result.p_message) << c;
}
*(result.p_message) << "...";
// skip rest of the bytes. May help for further matching
m_pimpl->m_pattern_to_match_or_save.ignore( m_pimpl->m_synced_string.length() - i - suffix_size);
break;
}
}
}
else {
m_pimpl->m_pattern_to_match_or_save.write( m_pimpl->m_synced_string.c_str(),
static_cast<std::streamsize>( m_pimpl->m_synced_string.length() ) );
m_pimpl->m_pattern_to_match_or_save.flush();
}
}
if( flush_stream )
flush();
return result;
}
//____________________________________________________________________________//
void
output_test_stream::flush()
{
m_pimpl->m_synced_string.erase();
#ifndef BOOST_NO_STRINGSTREAM
str( std::string() );
#else
seekp( 0, std::ios::beg );
#endif
}
//____________________________________________________________________________//
std::size_t
output_test_stream::length()
{
sync();
return m_pimpl->m_synced_string.length();
}
//____________________________________________________________________________//
void
output_test_stream::sync()
{
#ifdef BOOST_NO_STRINGSTREAM
m_pimpl->m_synced_string.assign( str(), pcount() );
freeze( false );
#else
m_pimpl->m_synced_string = str();
#endif
}
//____________________________________________________________________________//
} // namespace test_tools
#undef LOG
} // namespace boost
// ***************************************************************************
// Revision History :
//
// $Log$
// Revision 1.43 2005/01/19 06:40:05 vawjr
// deleted redundant \r in many \r\r\n sequences of the source. VC8.0 doesn't like them
//
// Revision 1.42 2005/01/18 08:30:08 rogeeff
// unit_test_log rework:
// eliminated need for ::instance()
// eliminated need for << end and ...END macro
// straitend interface between log and formatters
// change compiler like formatter name
// minimized unit_test_log interface and reworked to use explicit calls
//
// ***************************************************************************
// EOF