// Copyright 2013-2017 by Martin Moene // // lest is based on ideas by Kevlin Henney, see video at // http://skillsmatter.com/podcast/agile-testing/kevlin-henney-rethinking-unit-testing-in-c-plus-plus // // 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) #ifndef LEST_LEST_HPP_INCLUDED #define LEST_LEST_HPP_INCLUDED #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifdef __clang__ # pragma clang diagnostic ignored "-Wgnu-zero-variadic-macro-arguments" # pragma clang diagnostic ignored "-Woverloaded-shift-op-parentheses" # pragma clang diagnostic ignored "-Wunused-comparison" # pragma clang diagnostic ignored "-Wunused-value" #elif defined __GNUC__ # pragma GCC diagnostic ignored "-Wunused-value" #endif #define lest_VERSION "1.31.0" #ifndef lest_FEATURE_AUTO_REGISTER # define lest_FEATURE_AUTO_REGISTER 0 #endif #ifndef lest_FEATURE_COLOURISE # define lest_FEATURE_COLOURISE 0 #endif #ifndef lest_FEATURE_LITERAL_SUFFIX # define lest_FEATURE_LITERAL_SUFFIX 0 #endif #ifndef lest_FEATURE_REGEX_SEARCH # define lest_FEATURE_REGEX_SEARCH 0 #endif #ifndef lest_FEATURE_TIME_PRECISION #define lest_FEATURE_TIME_PRECISION 0 #endif #ifndef lest_FEATURE_WSTRING #define lest_FEATURE_WSTRING 1 #endif #ifdef lest_FEATURE_RTTI # define lest__cpp_rtti lest_FEATURE_RTTI #elif defined(__cpp_rtti) # define lest__cpp_rtti __cpp_rtti #elif defined(__GXX_RTTI) || defined (_CPPRTTI) # define lest__cpp_rtti 1 #else # define lest__cpp_rtti 0 #endif #if lest_FEATURE_REGEX_SEARCH # include #endif #if ! defined( lest_NO_SHORT_MACRO_NAMES ) && ! defined( lest_NO_SHORT_ASSERTION_NAMES ) # define MODULE lest_MODULE # if ! lest_FEATURE_AUTO_REGISTER # define CASE lest_CASE # endif # define SETUP lest_SETUP # define SECTION lest_SECTION # define EXPECT lest_EXPECT # define EXPECT_NOT lest_EXPECT_NOT # define EXPECT_NO_THROW lest_EXPECT_NO_THROW # define EXPECT_THROWS lest_EXPECT_THROWS # define EXPECT_THROWS_AS lest_EXPECT_THROWS_AS # define SCENARIO lest_SCENARIO # define GIVEN lest_GIVEN # define WHEN lest_WHEN # define THEN lest_THEN # define AND_WHEN lest_AND_WHEN # define AND_THEN lest_AND_THEN #endif #define lest_SCENARIO( sketch ) lest_CASE( lest::text("Scenario: ") + sketch ) #define lest_GIVEN( context ) lest_SETUP( lest::text( "Given: ") + context ) #define lest_WHEN( story ) lest_SECTION( lest::text( " When: ") + story ) #define lest_THEN( story ) lest_SECTION( lest::text( " Then: ") + story ) #define lest_AND_WHEN( story ) lest_SECTION( lest::text( " And: ") + story ) #define lest_AND_THEN( story ) lest_SECTION( lest::text( " And: ") + story ) #if lest_FEATURE_AUTO_REGISTER # define lest_CASE( specification, proposition ) \ static void lest_FUNCTION( lest::env & ); \ namespace { lest::add_test lest_REGISTRAR( specification, lest::test( proposition, lest_FUNCTION ) ); } \ static void lest_FUNCTION( lest::env & lest_env ) #else // lest_FEATURE_AUTO_REGISTER # define lest_CASE( proposition, ... ) \ proposition, [__VA_ARGS__]( lest::env & lest_env ) # define lest_MODULE( specification, module ) \ namespace { lest::add_module _( specification, module ); } #endif //lest_FEATURE_AUTO_REGISTER #define lest_SETUP( context ) \ for ( int lest__section = 0, lest__count = 1; lest__section < lest__count; lest__count -= 0==lest__section++ ) #define lest_SECTION( proposition ) \ static int lest_UNIQUE( id ) = 0; \ if ( lest::guard( lest_UNIQUE( id ), lest__section, lest__count ) ) \ for ( int lest__section = 0, lest__count = 1; lest__section < lest__count; lest__count -= 0==lest__section++ ) #define lest_EXPECT( expr ) \ do { \ try \ { \ if ( lest::result score = lest_DECOMPOSE( expr ) ) \ throw lest::failure{ lest_LOCATION, #expr, score.decomposition }; \ else if ( lest_env.pass ) \ lest::report( lest_env.os, lest::passing{ lest_LOCATION, #expr, score.decomposition }, lest_env.testing ); \ } \ catch(...) \ { \ lest::inform( lest_LOCATION, #expr ); \ } \ } while ( lest::is_false() ) #define lest_EXPECT_NOT( expr ) \ do { \ try \ { \ if ( lest::result score = lest_DECOMPOSE( expr ) ) \ { \ if ( lest_env.pass ) \ lest::report( lest_env.os, lest::passing{ lest_LOCATION, lest::not_expr( #expr ), lest::not_expr( score.decomposition ) }, lest_env.testing ); \ } \ else \ throw lest::failure{ lest_LOCATION, lest::not_expr( #expr ), lest::not_expr( score.decomposition ) }; \ } \ catch(...) \ { \ lest::inform( lest_LOCATION, lest::not_expr( #expr ) ); \ } \ } while ( lest::is_false() ) #define lest_EXPECT_NO_THROW( expr ) \ do \ { \ try \ { \ expr; \ } \ catch (...) \ { \ lest::inform( lest_LOCATION, #expr ); \ } \ if ( lest_env.pass ) \ lest::report( lest_env.os, lest::got_none( lest_LOCATION, #expr ), lest_env.testing ); \ } while ( lest::is_false() ) #define lest_EXPECT_THROWS( expr ) \ do \ { \ try \ { \ expr; \ } \ catch (...) \ { \ if ( lest_env.pass ) \ lest::report( lest_env.os, lest::got{ lest_LOCATION, #expr }, lest_env.testing ); \ break; \ } \ throw lest::expected{ lest_LOCATION, #expr }; \ } \ while ( lest::is_false() ) #define lest_EXPECT_THROWS_AS( expr, excpt ) \ do \ { \ try \ { \ expr; \ } \ catch ( excpt & ) \ { \ if ( lest_env.pass ) \ lest::report( lest_env.os, lest::got{ lest_LOCATION, #expr, lest::of_type( #excpt ) }, lest_env.testing ); \ break; \ } \ catch (...) {} \ throw lest::expected{ lest_LOCATION, #expr, lest::of_type( #excpt ) }; \ } \ while ( lest::is_false() ) #define lest_UNIQUE( name ) lest_UNIQUE2( name, __LINE__ ) #define lest_UNIQUE2( name, line ) lest_UNIQUE3( name, line ) #define lest_UNIQUE3( name, line ) name ## line #define lest_DECOMPOSE( expr ) ( lest::expression_decomposer() << expr ) #define lest_FUNCTION lest_UNIQUE(__lest_function__ ) #define lest_REGISTRAR lest_UNIQUE(__lest_registrar__ ) #define lest_LOCATION lest::location{__FILE__, __LINE__} namespace lest { using text = std::string; using texts = std::vector; struct env; struct test { text name; std::function behaviour; #if lest_FEATURE_AUTO_REGISTER test( text name, std::function behaviour ) : name( name ), behaviour( behaviour ) {} #endif }; using tests = std::vector; #if lest_FEATURE_AUTO_REGISTER struct add_test { add_test( tests & specification, test const & test_case ) { specification.push_back( test_case ); } }; #else struct add_module { template add_module( tests & specification, test const (&module)[N] ) { specification.insert( specification.end(), std::begin( module ), std::end( module ) ); } }; #endif struct result { const bool passed; const text decomposition; explicit operator bool() { return ! passed; } }; struct location { const text file; const int line; location( text file, int line ) : file( file ), line( line ) {} }; struct comment { const text info; comment( text info ) : info( info ) {} explicit operator bool() { return ! info.empty(); } }; struct message : std::runtime_error { const text kind; const location where; const comment note; ~message() throw() {} // GCC 4.6 message( text kind, location where, text expr, text note = "" ) : std::runtime_error( expr ), kind( kind ), where( where ), note( note ) {} }; struct failure : message { failure( location where, text expr, text decomposition ) : message{ "failed", where, expr + " for " + decomposition } {} }; struct success : message { // using message::message; // VC is lagging here success( text kind, location where, text expr, text note = "" ) : message( kind, where, expr, note ) {} }; struct passing : success { passing( location where, text expr, text decomposition ) : success( "passed", where, expr + " for " + decomposition ) {} }; struct got_none : success { got_none( location where, text expr ) : success( "passed: got no exception", where, expr ) {} }; struct got : success { got( location where, text expr ) : success( "passed: got exception", where, expr ) {} got( location where, text expr, text excpt ) : success( "passed: got exception " + excpt, where, expr ) {} }; struct expected : message { expected( location where, text expr, text excpt = "" ) : message{ "failed: didn't get exception", where, expr, excpt } {} }; struct unexpected : message { unexpected( location where, text expr, text note = "" ) : message{ "failed: got unexpected exception", where, expr, note } {} }; struct guard { int & id; int const & section; guard( int & id, int const & section, int & count ) : id( id ), section( section ) { if ( section == 0 ) id = count++ - 1; } operator bool() { return id == section; } }; class approx { public: explicit approx ( double magnitude ) : epsilon_ { std::numeric_limits::epsilon() * 100 } , scale_ { 1.0 } , magnitude_{ magnitude } {} approx( approx const & other ) = default; static approx custom() { return approx( 0 ); } approx operator()( double magnitude ) { approx approx ( magnitude ); approx.epsilon( epsilon_ ); approx.scale ( scale_ ); return approx; } double magnitude() const { return magnitude_; } approx & epsilon( double epsilon ) { epsilon_ = epsilon; return *this; } approx & scale ( double scale ) { scale_ = scale; return *this; } friend bool operator == ( double lhs, approx const & rhs ) { // Thanks to Richard Harris for his help refining this formula. return std::abs( lhs - rhs.magnitude_ ) < rhs.epsilon_ * ( rhs.scale_ + (std::min)( std::abs( lhs ), std::abs( rhs.magnitude_ ) ) ); } friend bool operator == ( approx const & lhs, double rhs ) { return operator==( rhs, lhs ); } friend bool operator != ( double lhs, approx const & rhs ) { return !operator==( lhs, rhs ); } friend bool operator != ( approx const & lhs, double rhs ) { return !operator==( rhs, lhs ); } friend bool operator <= ( double lhs, approx const & rhs ) { return lhs < rhs.magnitude_ || lhs == rhs; } friend bool operator <= ( approx const & lhs, double rhs ) { return lhs.magnitude_ < rhs || lhs == rhs; } friend bool operator >= ( double lhs, approx const & rhs ) { return lhs > rhs.magnitude_ || lhs == rhs; } friend bool operator >= ( approx const & lhs, double rhs ) { return lhs.magnitude_ > rhs || lhs == rhs; } private: double epsilon_; double scale_; double magnitude_; }; inline bool is_false( ) { return false; } inline bool is_true ( bool flag ) { return flag; } inline text not_expr( text message ) { return "! ( " + message + " )"; } inline text with_message( text message ) { return "with message \"" + message + "\""; } inline text of_type( text type ) { return "of type " + type; } inline void inform( location where, text expr ) { try { throw; } catch( message const & ) { throw; } catch( std::exception const & e ) { throw unexpected{ where, expr, with_message( e.what() ) }; \ } catch(...) { throw unexpected{ where, expr, "of unknown type" }; \ } } // Expression decomposition: template auto make_value_string( T const & value ) -> std::string; template auto make_memory_string( T const & item ) -> std::string; #if lest_FEATURE_LITERAL_SUFFIX inline char const * sfx( char const * text ) { return text; } #else inline char const * sfx( char const * ) { return ""; } #endif inline std::string to_string( std::nullptr_t ) { return "nullptr"; } inline std::string to_string( std::string const & text ) { return "\"" + text + "\"" ; } #if lest_FEATURE_WSTRING inline std::string to_string( std::wstring const & text ) ; #endif inline std::string to_string( char const * const text ) { return text ? to_string( std::string ( text ) ) : "{null string}"; } inline std::string to_string( char * const text ) { return text ? to_string( std::string ( text ) ) : "{null string}"; } #if lest_FEATURE_WSTRING inline std::string to_string( wchar_t const * const text ) { return text ? to_string( std::wstring( text ) ) : "{null string}"; } inline std::string to_string( wchar_t * const text ) { return text ? to_string( std::wstring( text ) ) : "{null string}"; } #endif inline std::string to_string( char text ) { return "\'" + std::string( 1, text ) + "\'" ; } inline std::string to_string( signed char text ) { return "\'" + std::string( 1, text ) + "\'" ; } inline std::string to_string( unsigned char text ) { return "\'" + std::string( 1, text ) + "\'" ; } inline std::string to_string( bool flag ) { return flag ? "true" : "false"; } inline std::string to_string( signed short value ) { return make_value_string( value ) ; } inline std::string to_string( unsigned short value ) { return make_value_string( value ) + sfx("u" ); } inline std::string to_string( signed int value ) { return make_value_string( value ) ; } inline std::string to_string( unsigned int value ) { return make_value_string( value ) + sfx("u" ); } inline std::string to_string( signed long value ) { return make_value_string( value ) + sfx("l" ); } inline std::string to_string( unsigned long value ) { return make_value_string( value ) + sfx("ul" ); } inline std::string to_string( signed long long value ) { return make_value_string( value ) + sfx("ll" ); } inline std::string to_string( unsigned long long value ) { return make_value_string( value ) + sfx("ull"); } inline std::string to_string( double value ) { return make_value_string( value ) ; } inline std::string to_string( float value ) { return make_value_string( value ) + sfx("f" ); } template struct is_streamable { template static auto test( int ) -> decltype( std::declval() << std::declval(), std::true_type() ); template static auto test( ... ) -> std::false_type; #ifdef _MSC_VER enum { value = std::is_same< decltype( test(0) ), std::true_type >::value }; #else static constexpr bool value = std::is_same< decltype( test(0) ), std::true_type >::value; #endif }; template struct is_container { template static auto test( int ) -> decltype( std::declval().begin() == std::declval().end(), std::true_type() ); template static auto test( ... ) -> std::false_type; #ifdef _MSC_VER enum { value = std::is_same< decltype( test(0) ), std::true_type >::value }; #else static constexpr bool value = std::is_same< decltype( test(0) ), std::true_type >::value; #endif }; template using ForEnum = typename std::enable_if< std::is_enum::value, R>::type; template using ForNonEnum = typename std::enable_if< ! std::is_enum::value, R>::type; template using ForStreamable = typename std::enable_if< is_streamable::value, R>::type; template using ForNonStreamable = typename std::enable_if< ! is_streamable::value, R>::type; template using ForContainer = typename std::enable_if< is_container::value, R>::type; template using ForNonContainer = typename std::enable_if< ! is_container::value, R>::type; template auto make_enum_string( T const & ) -> ForNonEnum { #if lest__cpp_rtti return text("[type: ") + typeid(T).name() + "]"; #else return text("[type: (no RTTI)]"); #endif } template auto make_enum_string( T const & item ) -> ForEnum { return to_string( static_cast::type>( item ) ); } template auto make_string( T const & item ) -> ForNonStreamable { return make_enum_string( item ); } template auto make_string( T const & item ) -> ForStreamable { std::ostringstream os; os << item; return os.str(); } template auto make_string( T * p )-> std::string { if ( p ) return make_memory_string( p ); else return "NULL"; } template auto make_string( R C::* p ) -> std::string { if ( p ) return make_memory_string( p ); else return "NULL"; } template auto make_string( std::pair const & pair ) -> std::string { std::ostringstream oss; oss << "{ " << to_string( pair.first ) << ", " << to_string( pair.second ) << " }"; return oss.str(); } template struct make_tuple_string { static std::string make( TU const & tuple ) { std::ostringstream os; os << to_string( std::get( tuple ) ) << ( N < std::tuple_size::value ? ", ": " "); return make_tuple_string::make( tuple ) + os.str(); } }; template struct make_tuple_string { static std::string make( TU const & ) { return ""; } }; template auto make_string( std::tuple const & tuple ) -> std::string { return "{ " + make_tuple_string, sizeof...(TS)>::make( tuple ) + "}"; } template auto to_string( T const & item ) -> ForNonContainer { return make_string( item ); } template auto to_string( C const & cont ) -> ForContainer { std::ostringstream os; os << "{ "; for ( auto & x : cont ) { os << to_string( x ) << ", "; } os << "}"; return os.str(); } #if lest_FEATURE_WSTRING inline auto to_string( std::wstring const & text ) -> std::string { std::string result; result.reserve( text.size() ); for( auto & chr : text ) { result += chr <= 0xff ? static_cast( chr ) : '?'; } return to_string( result ); } #endif template auto make_value_string( T const & value ) -> std::string { std::ostringstream os; os << value; return os.str(); } inline auto make_memory_string( void const * item, std::size_t size ) -> std::string { // reverse order for little endian architectures: auto is_little_endian = [] { union U { int i = 1; char c[ sizeof(int) ]; }; return 1 != U{}.c[ sizeof(int) - 1 ]; }; int i = 0, end = static_cast( size ), inc = 1; if ( is_little_endian() ) { i = end - 1; end = inc = -1; } unsigned char const * bytes = static_cast( item ); std::ostringstream os; os << "0x" << std::setfill( '0' ) << std::hex; for ( ; i != end; i += inc ) { os << std::setw(2) << static_cast( bytes[i] ) << " "; } return os.str(); } template auto make_memory_string( T const & item ) -> std::string { return make_memory_string( &item, sizeof item ); } inline auto to_string( approx const & appr ) -> std::string { return to_string( appr.magnitude() ); } template auto to_string( L const & lhs, std::string op, R const & rhs ) -> std::string { std::ostringstream os; os << to_string( lhs ) << " " << op << " " << to_string( rhs ); return os.str(); } template struct expression_lhs { const L lhs; expression_lhs( L lhs ) : lhs( lhs ) {} operator result() { return result{ !!lhs, to_string( lhs ) }; } template result operator==( R const & rhs ) { return result{ lhs == rhs, to_string( lhs, "==", rhs ) }; } template result operator!=( R const & rhs ) { return result{ lhs != rhs, to_string( lhs, "!=", rhs ) }; } template result operator< ( R const & rhs ) { return result{ lhs < rhs, to_string( lhs, "<" , rhs ) }; } template result operator<=( R const & rhs ) { return result{ lhs <= rhs, to_string( lhs, "<=", rhs ) }; } template result operator> ( R const & rhs ) { return result{ lhs > rhs, to_string( lhs, ">" , rhs ) }; } template result operator>=( R const & rhs ) { return result{ lhs >= rhs, to_string( lhs, ">=", rhs ) }; } }; struct expression_decomposer { template expression_lhs operator<< ( L const & operand ) { return expression_lhs( operand ); } }; // Reporter: #if lest_FEATURE_COLOURISE inline text red ( text words ) { return "\033[1;31m" + words + "\033[0m"; } inline text green( text words ) { return "\033[1;32m" + words + "\033[0m"; } inline text gray ( text words ) { return "\033[1;30m" + words + "\033[0m"; } inline bool starts_with( text words, text with ) { return 0 == words.find( with ); } inline text replace( text words, text from, text to ) { size_t pos = words.find( from ); return pos == std::string::npos ? words : words.replace( pos, from.length(), to ); } inline text colour( text words ) { if ( starts_with( words, "failed" ) ) return replace( words, "failed", red ( "failed" ) ); else if ( starts_with( words, "passed" ) ) return replace( words, "passed", green( "passed" ) ); return replace( words, "for", gray( "for" ) ); } inline bool is_cout( std::ostream & os ) { return &os == &std::cout; } struct colourise { const text words; colourise( text words ) : words( words ) {} // only colourise for std::cout, not for a stringstream as used in tests: std::ostream & operator()( std::ostream & os ) const { return is_cout( os ) ? os << colour( words ) : os << words; } }; inline std::ostream & operator<<( std::ostream & os, colourise words ) { return words( os ); } #else inline text colourise( text words ) { return words; } #endif inline text pluralise( text word, int n ) { return n == 1 ? word : word + "s"; } inline std::ostream & operator<<( std::ostream & os, comment note ) { return os << (note ? " " + note.info : "" ); } inline std::ostream & operator<<( std::ostream & os, location where ) { #ifdef __GNUG__ return os << where.file << ":" << where.line; #else return os << where.file << "(" << where.line << ")"; #endif } inline void report( std::ostream & os, message const & e, text test ) { os << e.where << ": " << colourise( e.kind ) << e.note << ": " << test << ": " << colourise( e.what() ) << std::endl; } // Test runner: #if lest_FEATURE_REGEX_SEARCH inline bool search( text re, text line ) { return std::regex_search( line, std::regex( re ) ); } #else inline bool search( text part, text line ) { auto case_insensitive_equal = []( char a, char b ) { return tolower( a ) == tolower( b ); }; return std::search( line.begin(), line.end(), part.begin(), part.end(), case_insensitive_equal ) != line.end(); } #endif inline bool match( texts whats, text line ) { for ( auto & what : whats ) { if ( search( what, line ) ) return true; } return false; } inline bool select( text name, texts include ) { auto none = []( texts args ) { return args.size() == 0; }; #if lest_FEATURE_REGEX_SEARCH auto hidden = []( text name ){ return match( { "\\[\\..*", "\\[hide\\]" }, name ); }; #else auto hidden = []( text name ){ return match( { "[.", "[hide]" }, name ); }; #endif if ( none( include ) ) { return ! hidden( name ); } bool any = false; for ( auto pos = include.rbegin(); pos != include.rend(); ++pos ) { auto & part = *pos; if ( part == "@" || part == "*" ) return true; if ( search( part, name ) ) return true; if ( '!' == part[0] ) { any = true; if ( search( part.substr(1), name ) ) return false; } else { any = false; } } return any && ! hidden( name ); } inline int indefinite( int repeat ) { return repeat == -1; } using seed_t = unsigned long; struct options { bool help = false; bool abort = false; bool count = false; bool list = false; bool tags = false; bool time = false; bool pass = false; bool lexical = false; bool random = false; bool version = false; int repeat = 1; seed_t seed = 0; }; struct env { std::ostream & os; bool pass; text testing; env( std::ostream & os, bool pass ) : os( os ), pass( pass ), testing() {} env & operator()( text test ) { testing = test; return *this; } }; struct action { std::ostream & os; action( std::ostream & os ) : os( os ) {} action( action const & ) = delete; void operator=( action const & ) = delete; operator int() { return 0; } bool abort() { return false; } action & operator()( test ) { return *this; } }; struct print : action { print( std::ostream & os ) : action( os ) {} print & operator()( test testing ) { os << testing.name << "\n"; return *this; } }; inline texts tags( text name, texts result = {} ) { auto none = std::string::npos; auto lb = name.find_first_of( "[" ); auto rb = name.find_first_of( "]" ); if ( lb == none || rb == none ) return result; result.emplace_back( name.substr( lb, rb - lb + 1 ) ); return tags( name.substr( rb + 1 ), result ); } struct ptags : action { std::set result; ptags( std::ostream & os ) : action( os ), result() {} ptags & operator()( test testing ) { for ( auto & tag : tags( testing.name ) ) result.insert( tag ); return *this; } ~ptags() { std::copy( result.begin(), result.end(), std::ostream_iterator( os, "\n" ) ); } }; struct count : action { int n = 0; count( std::ostream & os ) : action( os ) {} count & operator()( test ) { ++n; return *this; } ~count() { os << n << " selected " << pluralise("test", n) << "\n"; } }; struct timer { using time = std::chrono::high_resolution_clock; time::time_point start = time::now(); double elapsed_seconds() const { return 1e-6 * std::chrono::duration_cast< std::chrono::microseconds >( time::now() - start ).count(); } }; struct times : action { env output; options option; int selected = 0; int failures = 0; timer total; times( std::ostream & os, options option ) : action( os ), output( os, option.pass ), option( option ), total() { os << std::setfill(' ') << std::fixed << std::setprecision( lest_FEATURE_TIME_PRECISION ); } operator int() { return failures; } bool abort() { return option.abort && failures > 0; } times & operator()( test testing ) { timer t; try { testing.behaviour( output( testing.name ) ); } catch( message const & ) { ++failures; } os << std::setw(3) << ( 1000 * t.elapsed_seconds() ) << " ms: " << testing.name << "\n"; return *this; } ~times() { os << "Elapsed time: " << std::setprecision(1) << total.elapsed_seconds() << " s\n"; } }; struct confirm : action { env output; options option; int selected = 0; int failures = 0; confirm( std::ostream & os, options option ) : action( os ), output( os, option.pass ), option( option ) {} operator int() { return failures; } bool abort() { return option.abort && failures > 0; } confirm & operator()( test testing ) { try { ++selected; testing.behaviour( output( testing.name ) ); } catch( message const & e ) { ++failures; report( os, e, testing.name ); } return *this; } ~confirm() { if ( failures > 0 ) { os << failures << " out of " << selected << " selected " << pluralise("test", selected) << " " << colourise( "failed.\n" ); } else if ( option.pass ) { os << "All " << selected << " selected " << pluralise("test", selected) << " " << colourise( "passed.\n" ); } } }; template bool abort( Action & perform ) { return perform.abort(); } template< typename Action > Action && for_test( tests specification, texts in, Action && perform, int n = 1 ) { for ( int i = 0; indefinite( n ) || i < n; ++i ) { for ( auto & testing : specification ) { if ( select( testing.name, in ) ) if ( abort( perform( testing ) ) ) return std::move( perform ); } } return std::move( perform ); } inline void sort( tests & specification ) { auto test_less = []( test const & a, test const & b ) { return a.name < b.name; }; std::sort( specification.begin(), specification.end(), test_less ); } inline void shuffle( tests & specification, options option ) { std::shuffle( specification.begin(), specification.end(), std::mt19937( option.seed ) ); } // workaround MinGW bug, http://stackoverflow.com/a/16132279: inline int stoi( text num ) { return static_cast( std::strtol( num.c_str(), nullptr, 10 ) ); } inline bool is_number( text arg ) { return std::all_of( arg.begin(), arg.end(), ::isdigit ); } inline seed_t seed( text opt, text arg ) { if ( is_number( arg ) ) return static_cast( lest::stoi( arg ) ); if ( arg == "time" ) return static_cast( std::chrono::high_resolution_clock::now().time_since_epoch().count() ); throw std::runtime_error( "expecting 'time' or positive number with option '" + opt + "', got '" + arg + "' (try option --help)" ); } inline int repeat( text opt, text arg ) { const int num = lest::stoi( arg ); if ( indefinite( num ) || num >= 0 ) return num; throw std::runtime_error( "expecting '-1' or positive number with option '" + opt + "', got '" + arg + "' (try option --help)" ); } inline auto split_option( text arg ) -> std::tuple { auto pos = arg.rfind( '=' ); return pos == text::npos ? std::make_tuple( arg, "" ) : std::make_tuple( arg.substr( 0, pos ), arg.substr( pos + 1 ) ); } inline auto split_arguments( texts args ) -> std::tuple { options option; texts in; bool in_options = true; for ( auto & arg : args ) { if ( in_options ) { text opt, val; std::tie( opt, val ) = split_option( arg ); if ( opt[0] != '-' ) { in_options = false; } else if ( opt == "--" ) { in_options = false; continue; } else if ( opt == "-h" || "--help" == opt ) { option.help = true; continue; } else if ( opt == "-a" || "--abort" == opt ) { option.abort = true; continue; } else if ( opt == "-c" || "--count" == opt ) { option.count = true; continue; } else if ( opt == "-g" || "--list-tags" == opt ) { option.tags = true; continue; } else if ( opt == "-l" || "--list-tests" == opt ) { option.list = true; continue; } else if ( opt == "-t" || "--time" == opt ) { option.time = true; continue; } else if ( opt == "-p" || "--pass" == opt ) { option.pass = true; continue; } else if ( "--version" == opt ) { option.version = true; continue; } else if ( opt == "--order" && "declared" == val ) { /* by definition */ ; continue; } else if ( opt == "--order" && "lexical" == val ) { option.lexical = true; continue; } else if ( opt == "--order" && "random" == val ) { option.random = true; continue; } else if ( opt == "--random-seed" ) { option.seed = seed ( "--random-seed", val ); continue; } else if ( opt == "--repeat" ) { option.repeat = repeat( "--repeat" , val ); continue; } else throw std::runtime_error( "unrecognised option '" + arg + "' (try option --help)" ); } in.push_back( arg ); } return std::make_tuple( option, in ); } inline int usage( std::ostream & os ) { os << "\nUsage: test [options] [test-spec ...]\n" "\n" "Options:\n" " -h, --help this help message\n" " -a, --abort abort at first failure\n" " -c, --count count selected tests\n" " -g, --list-tags list tags of selected tests\n" " -l, --list-tests list selected tests\n" " -p, --pass also report passing tests\n" " -t, --time list duration of selected tests\n" " --order=declared use source code test order (default)\n" " --order=lexical use lexical sort test order\n" " --order=random use random test order\n" " --random-seed=n use n for random generator seed\n" " --random-seed=time use time for random generator seed\n" " --repeat=n repeat selected tests n times (-1: indefinite)\n" " --version report lest version and compiler used\n" " -- end options\n" "\n" "Test specification:\n" " \"@\", \"*\" all tests, unless excluded\n" " empty all tests, unless tagged [hide] or [.optional-name]\n" #if lest_FEATURE_REGEX_SEARCH " \"re\" select tests that match regular expression\n" " \"!re\" omit tests that match regular expression\n" #else " \"text\" select tests that contain text (case insensitive)\n" " \"!text\" omit tests that contain text (case insensitive)\n" #endif ; return 0; } inline text compiler() { std::ostringstream os; #if defined (__clang__ ) os << "clang " << __clang_version__; #elif defined (__GNUC__ ) os << "gcc " << __GNUC__ << "." << __GNUC_MINOR__ << "." << __GNUC_PATCHLEVEL__; #elif defined ( _MSC_VER ) os << "MSVC " << (_MSC_VER / 100 - 5 - (_MSC_VER < 1900)) << " (" << _MSC_VER << ")"; #else os << "[compiler]"; #endif return os.str(); } inline int version( std::ostream & os ) { os << "lest version " << lest_VERSION << "\n" << "Compiled with " << compiler() << " on " << __DATE__ << " at " << __TIME__ << ".\n" << "For more information, see https://github.com/martinmoene/lest.\n"; return 0; } inline int run( tests specification, texts arguments, std::ostream & os = std::cout ) { try { options option; texts in; std::tie( option, in ) = split_arguments( arguments ); if ( option.lexical ) { sort( specification ); } if ( option.random ) { shuffle( specification, option ); } if ( option.help ) { return usage ( os ); } if ( option.version ) { return version ( os ); } if ( option.count ) { return for_test( specification, in, count( os ) ); } if ( option.list ) { return for_test( specification, in, print( os ) ); } if ( option.tags ) { return for_test( specification, in, ptags( os ) ); } if ( option.time ) { return for_test( specification, in, times( os, option ) ); } return for_test( specification, in, confirm( os, option ), option.repeat ); } catch ( std::exception const & e ) { os << "Error: " << e.what() << "\n"; return 1; } } inline int run( tests specification, int argc, char * argv[], std::ostream & os = std::cout ) { return run( specification, texts( argv + 1, argv + argc ), os ); } template int run( test const (&specification)[N], texts arguments, std::ostream & os = std::cout ) { return run( tests( specification, specification + N ), arguments, os ); } template int run( test const (&specification)[N], std::ostream & os = std::cout ) { return run( tests( specification, specification + N ), {}, os ); } template int run( test const (&specification)[N], int argc, char * argv[], std::ostream & os = std::cout ) { return run( tests( specification, specification + N ), texts( argv + 1, argv + argc ), os ); } } // namespace lest #endif // LEST_LEST_HPP_INCLUDED