2010-11-10 00:24:00 +01:00
|
|
|
/*
|
|
|
|
* Created by Phil on 31/10/2010.
|
|
|
|
* Copyright 2010 Two Blue Cubes Ltd. All rights reserved.
|
|
|
|
*
|
|
|
|
* 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 TWOBLUECUBES_CATCH_RUNNER_HPP_INCLUDED
|
|
|
|
#define TWOBLUECUBES_CATCH_RUNNER_HPP_INCLUDED
|
|
|
|
|
2012-08-13 08:46:10 +02:00
|
|
|
#include "internal/catch_commandline.hpp"
|
|
|
|
#include "internal/catch_list.hpp"
|
|
|
|
#include "internal/catch_runner_impl.hpp"
|
2014-05-16 19:28:58 +02:00
|
|
|
#include "internal/catch_test_spec.hpp"
|
2012-11-15 23:15:41 +01:00
|
|
|
#include "internal/catch_version.h"
|
2013-04-19 20:08:32 +02:00
|
|
|
#include "internal/catch_text.h"
|
2012-08-13 08:46:10 +02:00
|
|
|
|
2010-12-31 23:07:47 +01:00
|
|
|
#include <fstream>
|
2011-02-04 10:30:36 +01:00
|
|
|
#include <stdlib.h>
|
2011-03-15 23:41:27 +01:00
|
|
|
#include <limits>
|
2010-12-31 23:07:47 +01:00
|
|
|
|
2012-05-16 16:02:51 +02:00
|
|
|
namespace Catch {
|
|
|
|
|
2013-06-05 09:18:52 +02:00
|
|
|
class Runner {
|
2012-08-23 21:08:50 +02:00
|
|
|
|
|
|
|
public:
|
2013-06-05 09:18:52 +02:00
|
|
|
Runner( Ptr<Config> const& config )
|
2013-05-29 08:59:01 +02:00
|
|
|
: m_config( config )
|
2012-08-23 21:08:50 +02:00
|
|
|
{
|
2012-09-26 19:36:58 +02:00
|
|
|
openStream();
|
2012-08-23 21:08:50 +02:00
|
|
|
makeReporter();
|
2012-07-17 09:04:19 +02:00
|
|
|
}
|
2012-08-23 21:08:50 +02:00
|
|
|
|
|
|
|
Totals runTests() {
|
|
|
|
|
2013-06-05 09:18:52 +02:00
|
|
|
RunContext context( m_config.get(), m_reporter );
|
|
|
|
|
2012-08-23 21:08:50 +02:00
|
|
|
Totals totals;
|
|
|
|
|
2014-09-08 09:14:22 +02:00
|
|
|
context.testGroupStarting( "all tests", 1, 1 ); // deprecated?
|
2014-05-16 19:24:07 +02:00
|
|
|
|
|
|
|
TestSpec testSpec = m_config->testSpec();
|
|
|
|
if( !testSpec.hasFilters() )
|
2014-06-30 08:33:17 +02:00
|
|
|
testSpec = TestSpecParser( ITagAliasRegistry::get() ).parse( "~[.]" ).testSpec(); // All not hidden tests
|
2014-04-15 19:44:37 +02:00
|
|
|
|
|
|
|
std::vector<TestCase> testCases;
|
2014-05-16 19:24:07 +02:00
|
|
|
getRegistryHub().getTestCaseRegistry().getFilteredTests( testSpec, *m_config, testCases );
|
2014-04-15 19:44:37 +02:00
|
|
|
|
2012-08-23 21:08:50 +02:00
|
|
|
int testsRunForGroup = 0;
|
2014-04-15 19:44:37 +02:00
|
|
|
for( std::vector<TestCase>::const_iterator it = testCases.begin(), itEnd = testCases.end();
|
|
|
|
it != itEnd;
|
|
|
|
++it ) {
|
|
|
|
testsRunForGroup++;
|
|
|
|
if( m_testsAlreadyRun.find( *it ) == m_testsAlreadyRun.end() ) {
|
2012-08-13 20:27:03 +02:00
|
|
|
|
2014-04-15 19:44:37 +02:00
|
|
|
if( context.aborting() )
|
|
|
|
break;
|
2010-11-10 00:24:00 +01:00
|
|
|
|
2014-04-15 19:44:37 +02:00
|
|
|
totals += context.runTest( *it );
|
|
|
|
m_testsAlreadyRun.insert( *it );
|
2012-08-23 21:08:50 +02:00
|
|
|
}
|
|
|
|
}
|
2014-09-08 09:14:22 +02:00
|
|
|
context.testGroupEnded( "all tests", totals, 1, 1 );
|
2012-08-23 21:08:50 +02:00
|
|
|
return totals;
|
|
|
|
}
|
2012-08-13 20:27:03 +02:00
|
|
|
|
2012-08-23 21:08:50 +02:00
|
|
|
private:
|
2012-09-26 19:36:58 +02:00
|
|
|
void openStream() {
|
2012-08-23 21:08:50 +02:00
|
|
|
// Open output file, if specified
|
2013-05-28 19:39:32 +02:00
|
|
|
if( !m_config->getFilename().empty() ) {
|
|
|
|
m_ofs.open( m_config->getFilename().c_str() );
|
2012-08-23 21:08:50 +02:00
|
|
|
if( m_ofs.fail() ) {
|
|
|
|
std::ostringstream oss;
|
2013-05-28 19:39:32 +02:00
|
|
|
oss << "Unable to open file: '" << m_config->getFilename() << "'";
|
2012-08-23 21:08:50 +02:00
|
|
|
throw std::domain_error( oss.str() );
|
|
|
|
}
|
2013-05-28 19:39:32 +02:00
|
|
|
m_config->setStreamBuf( m_ofs.rdbuf() );
|
2012-08-23 21:08:50 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
void makeReporter() {
|
2013-05-28 20:07:29 +02:00
|
|
|
std::string reporterName = m_config->getReporterName().empty()
|
2013-05-28 19:39:32 +02:00
|
|
|
? "console"
|
2013-05-28 20:07:29 +02:00
|
|
|
: m_config->getReporterName();
|
2012-08-13 20:27:03 +02:00
|
|
|
|
2013-05-28 19:39:32 +02:00
|
|
|
m_reporter = getRegistryHub().getReporterRegistry().create( reporterName, m_config.get() );
|
2012-08-23 21:08:50 +02:00
|
|
|
if( !m_reporter ) {
|
|
|
|
std::ostringstream oss;
|
|
|
|
oss << "No reporter registered with name: '" << reporterName << "'";
|
|
|
|
throw std::domain_error( oss.str() );
|
|
|
|
}
|
|
|
|
}
|
2013-07-03 20:14:59 +02:00
|
|
|
|
2012-08-23 21:08:50 +02:00
|
|
|
private:
|
2013-05-28 19:39:32 +02:00
|
|
|
Ptr<Config> m_config;
|
2012-08-23 21:08:50 +02:00
|
|
|
std::ofstream m_ofs;
|
2012-11-30 20:15:23 +01:00
|
|
|
Ptr<IStreamingReporter> m_reporter;
|
2012-11-22 20:17:20 +01:00
|
|
|
std::set<TestCase> m_testsAlreadyRun;
|
2012-08-23 21:08:50 +02:00
|
|
|
};
|
|
|
|
|
2013-06-05 19:48:18 +02:00
|
|
|
class Session {
|
|
|
|
static bool alreadyInstantiated;
|
2013-07-03 20:14:59 +02:00
|
|
|
|
2013-06-05 19:48:18 +02:00
|
|
|
public:
|
2013-07-03 20:14:59 +02:00
|
|
|
|
2013-06-06 19:51:24 +02:00
|
|
|
struct OnUnusedOptions { enum DoWhat { Ignore, Fail }; };
|
|
|
|
|
|
|
|
Session()
|
2013-06-07 19:41:22 +02:00
|
|
|
: m_cli( makeCommandLineParser() ) {
|
2013-06-05 19:48:18 +02:00
|
|
|
if( alreadyInstantiated ) {
|
|
|
|
std::string msg = "Only one instance of Catch::Session can ever be used";
|
2014-10-02 20:08:19 +02:00
|
|
|
Catch::cerr() << msg << std::endl;
|
2013-06-05 19:48:18 +02:00
|
|
|
throw std::logic_error( msg );
|
|
|
|
}
|
|
|
|
alreadyInstantiated = true;
|
|
|
|
}
|
|
|
|
~Session() {
|
|
|
|
Catch::cleanUp();
|
|
|
|
}
|
2013-07-03 20:14:59 +02:00
|
|
|
|
2013-06-06 19:56:43 +02:00
|
|
|
void showHelp( std::string const& processName ) {
|
2014-10-02 20:08:19 +02:00
|
|
|
Catch::cout() << "\nCatch v" << libraryVersion.majorVersion << "."
|
2013-06-06 19:56:43 +02:00
|
|
|
<< libraryVersion.minorVersion << " build "
|
|
|
|
<< libraryVersion.buildNumber;
|
2014-04-18 09:28:52 +02:00
|
|
|
if( libraryVersion.branchName != std::string( "master" ) )
|
2014-10-02 20:08:19 +02:00
|
|
|
Catch::cout() << " (" << libraryVersion.branchName << " branch)";
|
|
|
|
Catch::cout() << "\n";
|
2013-06-06 19:56:43 +02:00
|
|
|
|
2014-10-02 20:08:19 +02:00
|
|
|
m_cli.usage( Catch::cout(), processName );
|
|
|
|
Catch::cout() << "For more detail usage please see the project docs\n" << std::endl;
|
2013-06-06 19:56:43 +02:00
|
|
|
}
|
2013-07-03 20:14:59 +02:00
|
|
|
|
2013-06-06 19:51:24 +02:00
|
|
|
int applyCommandLine( int argc, char* const argv[], OnUnusedOptions::DoWhat unusedOptionBehaviour = OnUnusedOptions::Fail ) {
|
|
|
|
try {
|
2013-12-20 20:06:02 +01:00
|
|
|
m_cli.setThrowOnUnrecognisedTokens( unusedOptionBehaviour == OnUnusedOptions::Fail );
|
2013-06-07 19:41:22 +02:00
|
|
|
m_unusedTokens = m_cli.parseInto( argc, argv, m_configData );
|
|
|
|
if( m_configData.showHelp )
|
|
|
|
showHelp( m_configData.processName );
|
|
|
|
m_config.reset();
|
2013-06-05 19:48:18 +02:00
|
|
|
}
|
|
|
|
catch( std::exception& ex ) {
|
2013-08-16 19:57:57 +02:00
|
|
|
{
|
|
|
|
Colour colourGuard( Colour::Red );
|
2014-10-02 20:08:19 +02:00
|
|
|
Catch::cerr() << "\nError(s) in input:\n"
|
2013-08-16 19:57:57 +02:00
|
|
|
<< Text( ex.what(), TextAttributes().setIndent(2) )
|
|
|
|
<< "\n\n";
|
|
|
|
}
|
2014-10-02 20:08:19 +02:00
|
|
|
m_cli.usage( Catch::cout(), m_configData.processName );
|
2013-06-05 19:48:18 +02:00
|
|
|
return (std::numeric_limits<int>::max)();
|
2012-06-08 09:22:56 +02:00
|
|
|
}
|
2013-06-06 19:51:24 +02:00
|
|
|
return 0;
|
2012-06-08 09:22:56 +02:00
|
|
|
}
|
2013-06-06 19:51:24 +02:00
|
|
|
|
|
|
|
void useConfigData( ConfigData const& _configData ) {
|
2013-06-07 19:41:22 +02:00
|
|
|
m_configData = _configData;
|
|
|
|
m_config.reset();
|
2013-06-06 19:51:24 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
int run( int argc, char* const argv[] ) {
|
2013-06-05 19:48:18 +02:00
|
|
|
|
2013-06-06 19:51:24 +02:00
|
|
|
int returnCode = applyCommandLine( argc, argv );
|
|
|
|
if( returnCode == 0 )
|
|
|
|
returnCode = run();
|
|
|
|
return returnCode;
|
|
|
|
}
|
2013-06-05 19:48:18 +02:00
|
|
|
|
2013-06-06 19:51:24 +02:00
|
|
|
int run() {
|
2013-06-07 19:41:22 +02:00
|
|
|
if( m_configData.showHelp )
|
2013-06-06 19:51:24 +02:00
|
|
|
return 0;
|
|
|
|
|
|
|
|
try
|
|
|
|
{
|
2013-06-07 19:41:22 +02:00
|
|
|
config(); // Force config to be constructed
|
2014-09-15 19:39:31 +02:00
|
|
|
|
|
|
|
std::srand( m_configData.rngSeed );
|
|
|
|
|
2013-06-07 19:41:22 +02:00
|
|
|
Runner runner( m_config );
|
2013-06-06 19:51:24 +02:00
|
|
|
|
|
|
|
// Handle list request
|
2013-06-07 19:41:22 +02:00
|
|
|
if( Option<std::size_t> listed = list( config() ) )
|
2013-06-06 23:54:42 +02:00
|
|
|
return static_cast<int>( *listed );
|
2013-06-06 19:51:24 +02:00
|
|
|
|
|
|
|
return static_cast<int>( runner.runTests().assertions.failed );
|
2013-06-05 19:48:18 +02:00
|
|
|
}
|
|
|
|
catch( std::exception& ex ) {
|
2014-10-02 20:08:19 +02:00
|
|
|
Catch::cerr() << ex.what() << std::endl;
|
2013-06-05 19:48:18 +02:00
|
|
|
return (std::numeric_limits<int>::max)();
|
|
|
|
}
|
|
|
|
}
|
2013-07-03 20:14:59 +02:00
|
|
|
|
2013-06-07 19:41:22 +02:00
|
|
|
Clara::CommandLine<ConfigData> const& cli() const {
|
|
|
|
return m_cli;
|
|
|
|
}
|
|
|
|
std::vector<Clara::Parser::Token> const& unusedTokens() const {
|
|
|
|
return m_unusedTokens;
|
|
|
|
}
|
|
|
|
ConfigData& configData() {
|
|
|
|
return m_configData;
|
|
|
|
}
|
|
|
|
Config& config() {
|
|
|
|
if( !m_config )
|
|
|
|
m_config = new Config( m_configData );
|
|
|
|
return *m_config;
|
|
|
|
}
|
2013-07-03 20:14:59 +02:00
|
|
|
|
|
|
|
private:
|
2013-06-07 19:41:22 +02:00
|
|
|
Clara::CommandLine<ConfigData> m_cli;
|
|
|
|
std::vector<Clara::Parser::Token> m_unusedTokens;
|
|
|
|
ConfigData m_configData;
|
|
|
|
Ptr<Config> m_config;
|
2013-06-05 19:48:18 +02:00
|
|
|
};
|
2013-06-06 19:51:24 +02:00
|
|
|
|
2013-06-05 19:48:18 +02:00
|
|
|
bool Session::alreadyInstantiated = false;
|
2013-07-03 20:14:59 +02:00
|
|
|
|
2010-11-10 00:24:00 +01:00
|
|
|
} // end namespace Catch
|
|
|
|
|
2011-02-16 20:02:09 +01:00
|
|
|
#endif // TWOBLUECUBES_CATCH_RUNNER_HPP_INCLUDED
|