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"
|
2015-08-05 20:02:17 +02:00
|
|
|
#include "internal/catch_run_context.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"
|
2017-04-26 18:04:00 +02:00
|
|
|
#include "internal/catch_interfaces_reporter.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 {
|
|
|
|
|
2017-04-25 21:42:01 +02:00
|
|
|
IStreamingReporterPtr createReporter( std::string const& reporterName, IConfigPtr const& config ) {
|
2017-04-29 20:38:34 +02:00
|
|
|
if( auto reporter = getRegistryHub().getReporterRegistry().create( reporterName, config ) )
|
|
|
|
return reporter;
|
|
|
|
|
|
|
|
std::ostringstream oss;
|
|
|
|
oss << "No reporter registered with name: '" << reporterName << "'";
|
|
|
|
throw std::domain_error( oss.str() );
|
2015-07-28 19:55:11 +02:00
|
|
|
}
|
2015-11-04 19:01:28 +01:00
|
|
|
|
2017-04-25 21:42:01 +02:00
|
|
|
IStreamingReporterPtr makeReporter( std::shared_ptr<Config> const& config ) {
|
2017-04-29 20:38:34 +02:00
|
|
|
auto const& reporterNames = config->getReporterNames();
|
|
|
|
if( reporterNames.empty() )
|
|
|
|
return createReporter( "console", config );
|
2015-08-05 20:02:17 +02:00
|
|
|
|
2017-04-25 21:42:01 +02:00
|
|
|
IStreamingReporterPtr reporter;
|
2017-04-29 20:38:34 +02:00
|
|
|
for( auto const& name : reporterNames )
|
|
|
|
addReporter( reporter, createReporter( name, config ) );
|
2015-08-05 20:02:17 +02:00
|
|
|
return reporter;
|
|
|
|
}
|
2017-04-29 20:38:34 +02:00
|
|
|
void addListeners( IStreamingReporterPtr& reporters, IConfigPtr const& config ) {
|
2017-04-25 21:35:38 +02:00
|
|
|
auto const& listeners = getRegistryHub().getReporterRegistry().getListeners();
|
2017-04-25 12:06:52 +02:00
|
|
|
for( auto const& listener : listeners )
|
2017-04-29 20:38:34 +02:00
|
|
|
addReporter(reporters, listener->create( ReporterConfig( config ) ) );
|
2015-08-07 09:20:56 +02:00
|
|
|
}
|
2015-11-04 19:01:28 +01:00
|
|
|
|
|
|
|
|
2017-04-25 21:18:02 +02:00
|
|
|
Totals runTests( std::shared_ptr<Config> const& config ) {
|
2012-08-23 21:08:50 +02:00
|
|
|
|
2017-04-25 21:18:02 +02:00
|
|
|
IConfigPtr iconfig = config;
|
2015-11-04 19:01:28 +01:00
|
|
|
|
2017-04-25 21:42:01 +02:00
|
|
|
IStreamingReporterPtr reporter = makeReporter( config );
|
2017-04-29 20:38:34 +02:00
|
|
|
addListeners( reporter, iconfig );
|
2015-11-04 19:01:28 +01:00
|
|
|
|
2017-04-29 20:38:34 +02:00
|
|
|
RunContext context( iconfig, std::move( reporter ) );
|
2013-06-05 09:18:52 +02:00
|
|
|
|
2015-07-28 19:55:11 +02:00
|
|
|
Totals totals;
|
2012-08-23 21:08:50 +02:00
|
|
|
|
2015-07-28 19:55:11 +02:00
|
|
|
context.testGroupStarting( config->name(), 1, 1 );
|
2014-05-16 19:24:07 +02:00
|
|
|
|
2015-07-28 19:55:11 +02:00
|
|
|
TestSpec testSpec = config->testSpec();
|
|
|
|
if( !testSpec.hasFilters() )
|
|
|
|
testSpec = TestSpecParser( ITagAliasRegistry::get() ).parse( "~[.]" ).testSpec(); // All not hidden tests
|
2014-04-15 19:44:37 +02:00
|
|
|
|
2015-09-28 10:09:06 +02:00
|
|
|
std::vector<TestCase> const& allTestCases = getAllTestCasesSorted( *iconfig );
|
2017-04-25 12:06:52 +02:00
|
|
|
for( auto const& testCase : allTestCases ) {
|
|
|
|
if( !context.aborting() && matchTest( testCase, testSpec, *iconfig ) )
|
|
|
|
totals += context.runTest( testCase );
|
2015-08-05 00:11:56 +02:00
|
|
|
else
|
2017-04-29 20:38:34 +02:00
|
|
|
context.reporter().skipTest( testCase );
|
2012-08-23 21:08:50 +02:00
|
|
|
}
|
2012-08-13 20:27:03 +02:00
|
|
|
|
2015-09-28 10:09:06 +02:00
|
|
|
context.testGroupEnded( iconfig->name(), totals, 1, 1 );
|
2015-07-28 19:55:11 +02:00
|
|
|
return totals;
|
|
|
|
}
|
2015-11-04 19:01:28 +01:00
|
|
|
|
2015-08-05 00:11:56 +02:00
|
|
|
void applyFilenamesAsTags( IConfig const& config ) {
|
2017-04-25 12:06:52 +02:00
|
|
|
auto& tests = const_cast<std::vector<TestCase>&>( getAllTestCasesSorted( config ) );
|
|
|
|
for( auto& testCase : tests ) {
|
|
|
|
std::set<std::string> tags = testCase.tags;
|
2015-11-04 19:01:28 +01:00
|
|
|
|
2017-04-25 12:06:52 +02:00
|
|
|
std::string filename = testCase.lineInfo.file;
|
2015-07-03 19:07:13 +02:00
|
|
|
std::string::size_type lastSlash = filename.find_last_of( "\\/" );
|
2015-07-02 09:20:18 +02:00
|
|
|
if( lastSlash != std::string::npos )
|
|
|
|
filename = filename.substr( lastSlash+1 );
|
|
|
|
|
|
|
|
std::string::size_type lastDot = filename.find_last_of( "." );
|
|
|
|
if( lastDot != std::string::npos )
|
|
|
|
filename = filename.substr( 0, lastDot );
|
2015-11-04 19:01:28 +01:00
|
|
|
|
2015-07-06 19:46:50 +02:00
|
|
|
tags.insert( "#" + filename );
|
2017-04-25 12:06:52 +02:00
|
|
|
setTags( testCase, tags );
|
2015-07-02 09:20:18 +02:00
|
|
|
}
|
|
|
|
}
|
2012-08-23 21:08:50 +02:00
|
|
|
|
2014-10-03 09:15:27 +02:00
|
|
|
class Session : NonCopyable {
|
2013-06-05 19:48:18 +02:00
|
|
|
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 ) {
|
2017-03-16 19:17:45 +01:00
|
|
|
Catch::cout() << "\nCatch v" << libraryVersion() << "\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
|
|
|
|
2016-04-23 14:21:29 +02:00
|
|
|
int applyCommandLine( int argc, char const* const* const argv, OnUnusedOptions::DoWhat unusedOptionBehaviour = OnUnusedOptions::Fail ) {
|
2013-06-06 19:51:24 +02:00
|
|
|
try {
|
2013-12-20 20:06:02 +01:00
|
|
|
m_cli.setThrowOnUnrecognisedTokens( unusedOptionBehaviour == OnUnusedOptions::Fail );
|
2016-04-23 14:21:29 +02:00
|
|
|
m_unusedTokens = m_cli.parseInto( Clara::argsToVector( argc, argv ), m_configData );
|
2013-06-07 19:41:22 +02:00
|
|
|
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 );
|
2015-06-29 19:05:23 +02:00
|
|
|
Catch::cerr()
|
|
|
|
<< "\nError(s) in input:\n"
|
|
|
|
<< Text( ex.what(), TextAttributes().setIndent(2) )
|
|
|
|
<< "\n\n";
|
2013-08-16 19:57:57 +02:00
|
|
|
}
|
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
|
|
|
}
|
|
|
|
|
2016-04-23 14:21:29 +02:00
|
|
|
int run( int argc, char const* const* 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
|
2015-11-04 19:01:28 +01:00
|
|
|
|
2015-07-03 00:02:35 +02:00
|
|
|
seedRng( *m_config );
|
2014-09-15 19:39:31 +02:00
|
|
|
|
2015-08-05 00:11:56 +02:00
|
|
|
if( m_configData.filenamesAsTags )
|
|
|
|
applyFilenamesAsTags( *m_config );
|
2015-11-04 19:01:28 +01:00
|
|
|
|
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
|
|
|
|
2015-07-28 19:55:11 +02:00
|
|
|
return static_cast<int>( runTests( m_config ).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 )
|
2017-04-25 21:18:02 +02:00
|
|
|
m_config = std::make_shared<Config>( m_configData );
|
2013-06-07 19:41:22 +02:00
|
|
|
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;
|
2017-04-25 21:18:02 +02:00
|
|
|
std::shared_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
|