mirror of
https://github.com/catchorg/Catch2.git
synced 2024-12-26 04:43:28 +01:00
3255ee6312
Until recently we were probably getting it from some transitive include, but it broke. Because all files should include what they use anyway, adding `#include <cassert>` to all files that use `assert()` without including it is the best solution. Fixes #1249
420 lines
16 KiB
C++
420 lines
16 KiB
C++
/*
|
|
* Created by Phil on 22/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_IMPL_HPP_INCLUDED
|
|
#define TWOBLUECUBES_CATCH_RUNNER_IMPL_HPP_INCLUDED
|
|
|
|
#include "catch_interfaces_runner.h"
|
|
#include "catch_interfaces_reporter.h"
|
|
#include "catch_interfaces_exception.h"
|
|
#include "catch_config.hpp"
|
|
#include "catch_test_registry.hpp"
|
|
#include "catch_test_case_info.h"
|
|
#include "catch_capture.hpp"
|
|
#include "catch_totals.hpp"
|
|
#include "catch_test_spec.hpp"
|
|
#include "catch_test_case_tracker.hpp"
|
|
#include "catch_timer.h"
|
|
#include "catch_result_builder.h"
|
|
#include "catch_fatal_condition.hpp"
|
|
|
|
#include <cassert>
|
|
#include <set>
|
|
#include <string>
|
|
|
|
namespace Catch {
|
|
|
|
class StreamRedirect {
|
|
|
|
public:
|
|
StreamRedirect( std::ostream& stream, std::string& targetString )
|
|
: m_stream( stream ),
|
|
m_prevBuf( stream.rdbuf() ),
|
|
m_targetString( targetString )
|
|
{
|
|
stream.rdbuf( m_oss.rdbuf() );
|
|
}
|
|
|
|
~StreamRedirect() {
|
|
m_targetString += m_oss.str();
|
|
m_stream.rdbuf( m_prevBuf );
|
|
}
|
|
|
|
private:
|
|
std::ostream& m_stream;
|
|
std::streambuf* m_prevBuf;
|
|
std::ostringstream m_oss;
|
|
std::string& m_targetString;
|
|
};
|
|
|
|
// StdErr has two constituent streams in C++, std::cerr and std::clog
|
|
// This means that we need to redirect 2 streams into 1 to keep proper
|
|
// order of writes and cannot use StreamRedirect on its own
|
|
class StdErrRedirect {
|
|
public:
|
|
StdErrRedirect(std::string& targetString)
|
|
:m_cerrBuf( cerr().rdbuf() ), m_clogBuf(clog().rdbuf()),
|
|
m_targetString(targetString){
|
|
cerr().rdbuf(m_oss.rdbuf());
|
|
clog().rdbuf(m_oss.rdbuf());
|
|
}
|
|
~StdErrRedirect() {
|
|
m_targetString += m_oss.str();
|
|
cerr().rdbuf(m_cerrBuf);
|
|
clog().rdbuf(m_clogBuf);
|
|
}
|
|
private:
|
|
std::streambuf* m_cerrBuf;
|
|
std::streambuf* m_clogBuf;
|
|
std::ostringstream m_oss;
|
|
std::string& m_targetString;
|
|
};
|
|
|
|
///////////////////////////////////////////////////////////////////////////
|
|
|
|
class RunContext : public IResultCapture, public IRunner {
|
|
|
|
RunContext( RunContext const& );
|
|
void operator =( RunContext const& );
|
|
|
|
public:
|
|
|
|
explicit RunContext( Ptr<IConfig const> const& _config, Ptr<IStreamingReporter> const& reporter )
|
|
: m_runInfo( _config->name() ),
|
|
m_context( getCurrentMutableContext() ),
|
|
m_activeTestCase( CATCH_NULL ),
|
|
m_config( _config ),
|
|
m_reporter( reporter ),
|
|
m_shouldReportUnexpected ( true )
|
|
{
|
|
m_context.setRunner( this );
|
|
m_context.setConfig( m_config );
|
|
m_context.setResultCapture( this );
|
|
m_reporter->testRunStarting( m_runInfo );
|
|
}
|
|
|
|
virtual ~RunContext() {
|
|
m_reporter->testRunEnded( TestRunStats( m_runInfo, m_totals, aborting() ) );
|
|
}
|
|
|
|
void testGroupStarting( std::string const& testSpec, std::size_t groupIndex, std::size_t groupsCount ) {
|
|
m_reporter->testGroupStarting( GroupInfo( testSpec, groupIndex, groupsCount ) );
|
|
}
|
|
void testGroupEnded( std::string const& testSpec, Totals const& totals, std::size_t groupIndex, std::size_t groupsCount ) {
|
|
m_reporter->testGroupEnded( TestGroupStats( GroupInfo( testSpec, groupIndex, groupsCount ), totals, aborting() ) );
|
|
}
|
|
|
|
Totals runTest( TestCase const& testCase ) {
|
|
Totals prevTotals = m_totals;
|
|
|
|
std::string redirectedCout;
|
|
std::string redirectedCerr;
|
|
|
|
TestCaseInfo testInfo = testCase.getTestCaseInfo();
|
|
|
|
m_reporter->testCaseStarting( testInfo );
|
|
|
|
m_activeTestCase = &testCase;
|
|
|
|
|
|
do {
|
|
ITracker& rootTracker = m_trackerContext.startRun();
|
|
assert( rootTracker.isSectionTracker() );
|
|
static_cast<SectionTracker&>( rootTracker ).addInitialFilters( m_config->getSectionsToRun() );
|
|
do {
|
|
m_trackerContext.startCycle();
|
|
m_testCaseTracker = &SectionTracker::acquire( m_trackerContext, TestCaseTracking::NameAndLocation( testInfo.name, testInfo.lineInfo ) );
|
|
runCurrentTest( redirectedCout, redirectedCerr );
|
|
}
|
|
while( !m_testCaseTracker->isSuccessfullyCompleted() && !aborting() );
|
|
}
|
|
// !TBD: deprecated - this will be replaced by indexed trackers
|
|
while( getCurrentContext().advanceGeneratorsForCurrentTest() && !aborting() );
|
|
|
|
Totals deltaTotals = m_totals.delta( prevTotals );
|
|
if( testInfo.expectedToFail() && deltaTotals.testCases.passed > 0 ) {
|
|
deltaTotals.assertions.failed++;
|
|
deltaTotals.testCases.passed--;
|
|
deltaTotals.testCases.failed++;
|
|
}
|
|
m_totals.testCases += deltaTotals.testCases;
|
|
m_reporter->testCaseEnded( TestCaseStats( testInfo,
|
|
deltaTotals,
|
|
redirectedCout,
|
|
redirectedCerr,
|
|
aborting() ) );
|
|
|
|
m_activeTestCase = CATCH_NULL;
|
|
m_testCaseTracker = CATCH_NULL;
|
|
|
|
return deltaTotals;
|
|
}
|
|
|
|
Ptr<IConfig const> config() const {
|
|
return m_config;
|
|
}
|
|
|
|
private: // IResultCapture
|
|
|
|
|
|
virtual void assertionEnded( AssertionResult const& result ) {
|
|
if( result.getResultType() == ResultWas::Ok ) {
|
|
m_totals.assertions.passed++;
|
|
}
|
|
else if( !result.isOk() ) {
|
|
if( m_activeTestCase->getTestCaseInfo().okToFail() )
|
|
m_totals.assertions.failedButOk++;
|
|
else
|
|
m_totals.assertions.failed++;
|
|
}
|
|
|
|
// We have no use for the return value (whether messages should be cleared), because messages were made scoped
|
|
// and should be let to clear themselves out.
|
|
static_cast<void>(m_reporter->assertionEnded(AssertionStats(result, m_messages, m_totals)));
|
|
|
|
// Reset working state
|
|
m_lastAssertionInfo = AssertionInfo( "", m_lastAssertionInfo.lineInfo, "{Unknown expression after the reported line}" , m_lastAssertionInfo.resultDisposition );
|
|
m_lastResult = result;
|
|
}
|
|
|
|
virtual bool lastAssertionPassed()
|
|
{
|
|
return m_totals.assertions.passed == (m_prevPassed + 1);
|
|
}
|
|
|
|
virtual void assertionPassed()
|
|
{
|
|
m_totals.assertions.passed++;
|
|
m_lastAssertionInfo.capturedExpression = "{Unknown expression after the reported line}";
|
|
m_lastAssertionInfo.macroName = "";
|
|
}
|
|
|
|
virtual void assertionRun()
|
|
{
|
|
m_prevPassed = m_totals.assertions.passed;
|
|
}
|
|
|
|
virtual bool sectionStarted (
|
|
SectionInfo const& sectionInfo,
|
|
Counts& assertions
|
|
)
|
|
{
|
|
ITracker& sectionTracker = SectionTracker::acquire( m_trackerContext, TestCaseTracking::NameAndLocation( sectionInfo.name, sectionInfo.lineInfo ) );
|
|
if( !sectionTracker.isOpen() )
|
|
return false;
|
|
m_activeSections.push_back( §ionTracker );
|
|
|
|
m_lastAssertionInfo.lineInfo = sectionInfo.lineInfo;
|
|
|
|
m_reporter->sectionStarting( sectionInfo );
|
|
|
|
assertions = m_totals.assertions;
|
|
|
|
return true;
|
|
}
|
|
bool testForMissingAssertions( Counts& assertions ) {
|
|
if( assertions.total() != 0 )
|
|
return false;
|
|
if( !m_config->warnAboutMissingAssertions() )
|
|
return false;
|
|
if( m_trackerContext.currentTracker().hasChildren() )
|
|
return false;
|
|
m_totals.assertions.failed++;
|
|
assertions.failed++;
|
|
return true;
|
|
}
|
|
|
|
virtual void sectionEnded( SectionEndInfo const& endInfo ) {
|
|
Counts assertions = m_totals.assertions - endInfo.prevAssertions;
|
|
bool missingAssertions = testForMissingAssertions( assertions );
|
|
|
|
if( !m_activeSections.empty() ) {
|
|
m_activeSections.back()->close();
|
|
m_activeSections.pop_back();
|
|
}
|
|
|
|
m_reporter->sectionEnded( SectionStats( endInfo.sectionInfo, assertions, endInfo.durationInSeconds, missingAssertions ) );
|
|
m_messages.clear();
|
|
}
|
|
|
|
virtual void sectionEndedEarly( SectionEndInfo const& endInfo ) {
|
|
if( m_unfinishedSections.empty() )
|
|
m_activeSections.back()->fail();
|
|
else
|
|
m_activeSections.back()->close();
|
|
m_activeSections.pop_back();
|
|
|
|
m_unfinishedSections.push_back( endInfo );
|
|
}
|
|
|
|
virtual void pushScopedMessage( MessageInfo const& message ) {
|
|
m_messages.push_back( message );
|
|
}
|
|
|
|
virtual void popScopedMessage( MessageInfo const& message ) {
|
|
m_messages.erase( std::remove( m_messages.begin(), m_messages.end(), message ), m_messages.end() );
|
|
}
|
|
|
|
virtual std::string getCurrentTestName() const {
|
|
return m_activeTestCase
|
|
? m_activeTestCase->getTestCaseInfo().name
|
|
: std::string();
|
|
}
|
|
|
|
virtual const AssertionResult* getLastResult() const {
|
|
return &m_lastResult;
|
|
}
|
|
|
|
virtual void exceptionEarlyReported() {
|
|
m_shouldReportUnexpected = false;
|
|
}
|
|
|
|
virtual void handleFatalErrorCondition( std::string const& message ) {
|
|
// Don't rebuild the result -- the stringification itself can cause more fatal errors
|
|
// Instead, fake a result data.
|
|
AssertionResultData tempResult;
|
|
tempResult.resultType = ResultWas::FatalErrorCondition;
|
|
tempResult.message = message;
|
|
AssertionResult result(m_lastAssertionInfo, tempResult);
|
|
|
|
getResultCapture().assertionEnded(result);
|
|
|
|
handleUnfinishedSections();
|
|
|
|
// Recreate section for test case (as we will lose the one that was in scope)
|
|
TestCaseInfo const& testCaseInfo = m_activeTestCase->getTestCaseInfo();
|
|
SectionInfo testCaseSection( testCaseInfo.lineInfo, testCaseInfo.name, testCaseInfo.description );
|
|
|
|
Counts assertions;
|
|
assertions.failed = 1;
|
|
SectionStats testCaseSectionStats( testCaseSection, assertions, 0, false );
|
|
m_reporter->sectionEnded( testCaseSectionStats );
|
|
|
|
TestCaseInfo testInfo = m_activeTestCase->getTestCaseInfo();
|
|
|
|
Totals deltaTotals;
|
|
deltaTotals.testCases.failed = 1;
|
|
deltaTotals.assertions.failed = 1;
|
|
m_reporter->testCaseEnded( TestCaseStats( testInfo,
|
|
deltaTotals,
|
|
std::string(),
|
|
std::string(),
|
|
false ) );
|
|
m_totals.testCases.failed++;
|
|
testGroupEnded( std::string(), m_totals, 1, 1 );
|
|
m_reporter->testRunEnded( TestRunStats( m_runInfo, m_totals, false ) );
|
|
}
|
|
|
|
public:
|
|
// !TBD We need to do this another way!
|
|
bool aborting() const {
|
|
return m_totals.assertions.failed == static_cast<std::size_t>( m_config->abortAfter() );
|
|
}
|
|
|
|
private:
|
|
|
|
void runCurrentTest( std::string& redirectedCout, std::string& redirectedCerr ) {
|
|
TestCaseInfo const& testCaseInfo = m_activeTestCase->getTestCaseInfo();
|
|
SectionInfo testCaseSection( testCaseInfo.lineInfo, testCaseInfo.name, testCaseInfo.description );
|
|
m_reporter->sectionStarting( testCaseSection );
|
|
Counts prevAssertions = m_totals.assertions;
|
|
double duration = 0;
|
|
m_shouldReportUnexpected = true;
|
|
try {
|
|
m_lastAssertionInfo = AssertionInfo( "TEST_CASE", testCaseInfo.lineInfo, "", ResultDisposition::Normal );
|
|
|
|
seedRng( *m_config );
|
|
|
|
Timer timer;
|
|
timer.start();
|
|
if( m_reporter->getPreferences().shouldRedirectStdOut ) {
|
|
StreamRedirect coutRedir( Catch::cout(), redirectedCout );
|
|
StdErrRedirect errRedir( redirectedCerr );
|
|
invokeActiveTestCase();
|
|
}
|
|
else {
|
|
invokeActiveTestCase();
|
|
}
|
|
duration = timer.getElapsedSeconds();
|
|
}
|
|
catch( TestFailureException& ) {
|
|
// This just means the test was aborted due to failure
|
|
}
|
|
catch(...) {
|
|
// Under CATCH_CONFIG_FAST_COMPILE, unexpected exceptions under REQUIRE assertions
|
|
// are reported without translation at the point of origin.
|
|
if (m_shouldReportUnexpected) {
|
|
makeUnexpectedResultBuilder().useActiveException();
|
|
}
|
|
}
|
|
m_testCaseTracker->close();
|
|
handleUnfinishedSections();
|
|
m_messages.clear();
|
|
|
|
Counts assertions = m_totals.assertions - prevAssertions;
|
|
bool missingAssertions = testForMissingAssertions( assertions );
|
|
|
|
SectionStats testCaseSectionStats( testCaseSection, assertions, duration, missingAssertions );
|
|
m_reporter->sectionEnded( testCaseSectionStats );
|
|
}
|
|
|
|
void invokeActiveTestCase() {
|
|
FatalConditionHandler fatalConditionHandler; // Handle signals
|
|
m_activeTestCase->invoke();
|
|
fatalConditionHandler.reset();
|
|
}
|
|
|
|
private:
|
|
|
|
ResultBuilder makeUnexpectedResultBuilder() const {
|
|
return ResultBuilder( m_lastAssertionInfo.macroName,
|
|
m_lastAssertionInfo.lineInfo,
|
|
m_lastAssertionInfo.capturedExpression,
|
|
m_lastAssertionInfo.resultDisposition );
|
|
}
|
|
|
|
void handleUnfinishedSections() {
|
|
// If sections ended prematurely due to an exception we stored their
|
|
// infos here so we can tear them down outside the unwind process.
|
|
for( std::vector<SectionEndInfo>::const_reverse_iterator it = m_unfinishedSections.rbegin(),
|
|
itEnd = m_unfinishedSections.rend();
|
|
it != itEnd;
|
|
++it )
|
|
sectionEnded( *it );
|
|
m_unfinishedSections.clear();
|
|
}
|
|
|
|
TestRunInfo m_runInfo;
|
|
IMutableContext& m_context;
|
|
TestCase const* m_activeTestCase;
|
|
ITracker* m_testCaseTracker;
|
|
ITracker* m_currentSectionTracker;
|
|
AssertionResult m_lastResult;
|
|
|
|
Ptr<IConfig const> m_config;
|
|
Totals m_totals;
|
|
Ptr<IStreamingReporter> m_reporter;
|
|
std::vector<MessageInfo> m_messages;
|
|
AssertionInfo m_lastAssertionInfo;
|
|
std::vector<SectionEndInfo> m_unfinishedSections;
|
|
std::vector<ITracker*> m_activeSections;
|
|
TrackerContext m_trackerContext;
|
|
size_t m_prevPassed;
|
|
bool m_shouldReportUnexpected;
|
|
};
|
|
|
|
IResultCapture& getResultCapture() {
|
|
if( IResultCapture* capture = getCurrentContext().getResultCapture() )
|
|
return *capture;
|
|
else
|
|
throw std::logic_error( "No result capture instance" );
|
|
}
|
|
|
|
} // end namespace Catch
|
|
|
|
#endif // TWOBLUECUBES_CATCH_RUNNER_IMPL_HPP_INCLUDED
|