catch2/include/catch_session.hpp

265 lines
9.2 KiB
C++
Raw Permalink Normal View History

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
#include "internal/catch_commandline.hpp"
2017-07-10 14:25:38 +02:00
#include "internal/catch_console_colour.hpp"
#include "internal/catch_enforce.h"
2017-07-10 14:25:38 +02:00
#include "internal/catch_list.h"
#include "internal/catch_run_context.hpp"
#include "internal/catch_stream.h"
#include "internal/catch_test_spec.hpp"
2012-11-15 23:15:41 +01:00
#include "internal/catch_version.h"
2017-04-26 18:04:00 +02:00
#include "internal/catch_interfaces_reporter.h"
#include "internal/catch_startup_exception_registry.h"
#include "internal/catch_text.h"
#include <fstream>
2017-06-29 15:27:42 +02:00
#include <cstdlib>
2011-03-15 23:41:27 +01:00
#include <limits>
#include <iomanip>
2012-05-16 16:02:51 +02:00
namespace Catch {
IStreamingReporterPtr createReporter( std::string const& reporterName, IConfigPtr const& config ) {
auto reporter = getRegistryHub().getReporterRegistry().create( reporterName, config );
CATCH_ENFORCE( reporter, "No reporter registered with name: '" << reporterName << "'" );
return reporter;
}
#ifndef CATCH_CONFIG_DEFAULT_REPORTER
#define CATCH_CONFIG_DEFAULT_REPORTER "console"
#endif
IStreamingReporterPtr makeReporter( std::shared_ptr<Config> const& config ) {
auto const& reporterNames = config->getReporterNames();
if( reporterNames.empty() )
return createReporter(CATCH_CONFIG_DEFAULT_REPORTER, config );
IStreamingReporterPtr reporter;
for( auto const& name : reporterNames )
addReporter( reporter, createReporter( name, config ) );
return reporter;
}
void addListeners( IStreamingReporterPtr& reporters, IConfigPtr const& config ) {
2017-04-25 21:35:38 +02:00
auto const& listeners = getRegistryHub().getReporterRegistry().getListeners();
for( auto const& listener : listeners )
addReporter(reporters, listener->create( ReporterConfig( config ) ) );
}
Totals runTests( std::shared_ptr<Config> const& config ) {
2012-08-23 21:08:50 +02:00
IStreamingReporterPtr reporter = makeReporter( config );
2017-07-18 19:03:57 +02:00
addListeners( reporter, config );
2017-07-18 19:03:57 +02:00
RunContext context( config, std::move( reporter ) );
Totals totals;
2012-08-23 21:08:50 +02:00
context.testGroupStarting( config->name(), 1, 1 );
2014-05-16 19:24:07 +02:00
TestSpec testSpec = config->testSpec();
if( !testSpec.hasFilters() )
testSpec = TestSpecParser( ITagAliasRegistry::get() ).parse( "~[.]" ).testSpec(); // All not hidden tests
2017-07-18 19:03:57 +02:00
std::vector<TestCase> const& allTestCases = getAllTestCasesSorted( *config );
for( auto const& testCase : allTestCases ) {
2017-07-18 19:03:57 +02:00
if( !context.aborting() && matchTest( testCase, testSpec, *config ) )
totals += context.runTest( testCase );
2015-08-05 00:11:56 +02:00
else
context.reporter().skipTest( testCase );
2012-08-23 21:08:50 +02:00
}
2012-08-13 20:27:03 +02:00
2017-07-18 19:03:57 +02:00
context.testGroupEnded( config->name(), totals, 1, 1 );
return totals;
}
2015-08-05 00:11:56 +02:00
void applyFilenamesAsTags( IConfig const& config ) {
auto& tests = const_cast<std::vector<TestCase>&>( getAllTestCasesSorted( config ) );
for( auto& testCase : tests ) {
auto tags = testCase.tags;
std::string filename = testCase.lineInfo.file;
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 );
2017-06-29 15:27:42 +02:00
std::string::size_type lastDot = filename.find_last_of( '.' );
2015-07-02 09:20:18 +02:00
if( lastDot != std::string::npos )
filename = filename.substr( 0, lastDot );
tags.push_back( '#' + filename );
setTags( testCase, tags );
2015-07-02 09:20:18 +02:00
}
}
2012-08-23 21:08:50 +02:00
2017-07-18 19:03:57 +02:00
class Session : NonCopyable {
static const int MaxExitCode;
public:
2017-06-13 00:04:24 +02:00
Session() {
static bool alreadyInstantiated = false;
if( alreadyInstantiated )
CATCH_INTERNAL_ERROR( "Only one instance of Catch::Session can ever be used" );
alreadyInstantiated = true;
2017-06-13 00:04:24 +02:00
m_cli = makeCommandLineParser( m_configData );
}
2017-06-29 15:27:42 +02:00
~Session() override {
Catch::cleanUp();
}
void showHelp() const {
2017-07-18 19:03:57 +02:00
Catch::cout()
<< "\nCatch v" << libraryVersion() << "\n"
<< m_cli << std::endl
<< "For more detailed usage please see the project docs\n" << std::endl;
2013-06-06 19:56:43 +02:00
}
void libIdentify() {
Catch::cout()
<< std::left << std::setw(16) << "description: " << "A Catch test executable\n"
<< std::left << std::setw(16) << "category: " << "testframework\n"
<< std::left << std::setw(16) << "framework: " << "Catch Test\n"
<< std::left << std::setw(16) << "version: " << libraryVersion() << std::endl;
}
2017-06-13 00:04:24 +02:00
int applyCommandLine( int argc, char* argv[] ) {
auto result = m_cli.parse( clara::Args( argc, argv ) );
if( !result ) {
Catch::cerr()
<< Colour( Colour::Red )
<< "\nError(s) in input:\n"
<< Column( result.errorMessage() ).indent( 2 )
<< "\n\n";
Catch::cerr() << "Run with -? for usage\n" << std::endl;
return MaxExitCode;
2012-06-08 09:22:56 +02:00
}
2017-06-13 00:04:24 +02:00
if( m_configData.showHelp )
2017-06-29 15:27:42 +02:00
showHelp();
if( m_configData.libIdentify )
libIdentify();
2017-06-13 00:04:24 +02:00
m_config.reset();
return 0;
2012-06-08 09:22:56 +02:00
}
2017-07-18 19:03:57 +02:00
void useConfigData( ConfigData const& configData ) {
m_configData = configData;
m_config.reset();
}
2017-06-13 00:04:24 +02:00
int run( int argc, char* argv[] ) {
const auto& exceptions = getRegistryHub().getStartupExceptionRegistry().getExceptions();
if ( !exceptions.empty() ) {
Catch::cerr() << "Errors occured during startup!" << '\n';
// iterate over all exceptions and notify user
for ( const auto& ex_ptr : exceptions ) {
try {
std::rethrow_exception(ex_ptr);
} catch ( std::exception const& ex ) {
Catch::cerr() << ex.what() << '\n';
}
}
return 1;
}
int returnCode = applyCommandLine( argc, argv );
if( returnCode == 0 )
returnCode = run();
return returnCode;
}
#if defined(WIN32) && defined(UNICODE)
2017-06-13 00:04:24 +02:00
int run( int argc, wchar_t* const argv[] ) {
char **utf8Argv = new char *[ argc ];
for ( int i = 0; i < argc; ++i ) {
int bufSize = WideCharToMultiByte( CP_UTF8, 0, argv[i], -1, NULL, 0, NULL, NULL );
utf8Argv[ i ] = new char[ bufSize ];
WideCharToMultiByte( CP_UTF8, 0, argv[i], -1, utf8Argv[i], bufSize, NULL, NULL );
}
int returnCode = run( argc, utf8Argv );
for ( int i = 0; i < argc; ++i )
delete [] utf8Argv[ i ];
delete [] utf8Argv;
return returnCode;
}
#endif
int run() {
if( ( m_configData.waitForKeypress & WaitForKeypress::BeforeStart ) != 0 ) {
Catch::cout() << "...waiting for enter/ return before starting" << std::endl;
static_cast<void>(std::getchar());
}
int exitCode = runInternal();
if( ( m_configData.waitForKeypress & WaitForKeypress::BeforeExit ) != 0 ) {
Catch::cout() << "...waiting for enter/ return before exiting, with code: " << exitCode << std::endl;
static_cast<void>(std::getchar());
}
return exitCode;
}
clara::Parser const& cli() const {
return m_cli;
}
void cli( clara::Parser const& newParser ) {
m_cli = newParser;
}
ConfigData& configData() {
return m_configData;
}
Config& config() {
if( !m_config )
m_config = std::make_shared<Config>( m_configData );
return *m_config;
}
private:
int runInternal() {
if( m_configData.showHelp || m_configData.libIdentify )
return 0;
try
{
config(); // Force config to be constructed
seedRng( *m_config );
2015-08-05 00:11:56 +02:00
if( m_configData.filenamesAsTags )
applyFilenamesAsTags( *m_config );
// Handle list request
if( Option<std::size_t> listed = list( config() ) )
2013-06-06 23:54:42 +02:00
return static_cast<int>( *listed );
return (std::min)( MaxExitCode, static_cast<int>( runTests( m_config ).assertions.failed ) );
}
catch( std::exception& ex ) {
Catch::cerr() << ex.what() << std::endl;
return MaxExitCode;
}
}
2017-06-13 00:04:24 +02:00
clara::Parser m_cli;
ConfigData m_configData;
std::shared_ptr<Config> m_config;
};
const int Session::MaxExitCode = 255;
2010-11-10 00:24:00 +01:00
} // end namespace Catch
#endif // TWOBLUECUBES_CATCH_RUNNER_HPP_INCLUDED