2015-10-23 19:20:33 +02:00
|
|
|
/*
|
|
|
|
* Created by Phil on 1/10/2015.
|
|
|
|
* Copyright 2015 Two Blue Cubes Ltd
|
|
|
|
*
|
|
|
|
* 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)
|
|
|
|
*/
|
|
|
|
#include "internal/catch_suppress_warnings.h"
|
|
|
|
#include "internal/catch_compiler_capabilities.h"
|
|
|
|
#include "internal/catch_ptr.hpp"
|
|
|
|
|
|
|
|
#ifdef __clang__
|
|
|
|
//# pragma clang diagnostic ignored "-Wpadded"
|
|
|
|
//# pragma clang diagnostic ignored "-Wc++98-compat"
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#include <cassert>
|
|
|
|
#include <memory>
|
|
|
|
#include <vector>
|
|
|
|
|
|
|
|
namespace Catch
|
|
|
|
{
|
|
|
|
struct ITrackedPart : SharedImpl<> {
|
|
|
|
virtual ~ITrackedPart() {}
|
2015-10-23 19:34:16 +02:00
|
|
|
|
|
|
|
// queries
|
2015-10-23 19:20:33 +02:00
|
|
|
virtual std::string name() const = 0;
|
2015-10-23 19:34:16 +02:00
|
|
|
virtual bool hasStarted() const = 0; // true even if ended
|
|
|
|
virtual bool hasEnded() const = 0;
|
|
|
|
virtual bool didCompleteSuccessfully() const = 0;
|
2015-10-23 19:20:33 +02:00
|
|
|
virtual bool isOpen() const = 0;
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
virtual ITrackedPart& parent() = 0;
|
2015-10-23 19:20:33 +02:00
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
// actions
|
2015-10-23 19:20:33 +02:00
|
|
|
virtual void close() = 0;
|
|
|
|
virtual void fail() = 0;
|
2015-10-23 19:34:16 +02:00
|
|
|
|
2015-10-23 19:20:33 +02:00
|
|
|
virtual void addChild( Ptr<ITrackedPart> const& child ) = 0;
|
|
|
|
virtual ITrackedPart* findChild( std::string const& name ) = 0;
|
|
|
|
virtual void openChild() = 0;
|
|
|
|
virtual void childFailed() = 0;
|
2015-10-23 19:34:16 +02:00
|
|
|
|
2015-10-23 19:20:33 +02:00
|
|
|
};
|
2015-10-23 19:34:16 +02:00
|
|
|
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
class TrackerContext {
|
|
|
|
|
|
|
|
enum RunState {
|
|
|
|
NotStarted,
|
|
|
|
Executing,
|
|
|
|
CompletedCycle
|
|
|
|
};
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
Ptr<ITrackedPart> m_rootPart;
|
|
|
|
ITrackedPart* m_currentPart;
|
2015-10-23 19:20:33 +02:00
|
|
|
RunState m_runState;
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
|
|
|
static TrackerContext& instance() {
|
|
|
|
static TrackerContext s_instance;
|
|
|
|
return s_instance;
|
|
|
|
}
|
|
|
|
|
|
|
|
TrackerContext()
|
|
|
|
: m_currentPart( CATCH_NULL ),
|
|
|
|
m_runState( NotStarted )
|
|
|
|
{}
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
|
|
|
|
ITrackedPart& startRun();
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
void endRun() {
|
2015-10-23 19:34:16 +02:00
|
|
|
m_rootPart.reset();
|
2015-10-23 19:20:33 +02:00
|
|
|
m_currentPart = CATCH_NULL;
|
|
|
|
m_runState = NotStarted;
|
|
|
|
}
|
|
|
|
|
|
|
|
void startCycle() {
|
2015-10-23 19:34:16 +02:00
|
|
|
m_currentPart = m_rootPart.get();
|
2015-10-23 19:20:33 +02:00
|
|
|
m_runState = Executing;
|
|
|
|
}
|
|
|
|
void completeCycle() {
|
|
|
|
m_runState = CompletedCycle;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool completedCycle() const {
|
|
|
|
return m_runState == CompletedCycle;
|
|
|
|
}
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
ITrackedPart& currentPart() {
|
2015-10-23 19:20:33 +02:00
|
|
|
return *m_currentPart;
|
|
|
|
}
|
2015-10-23 19:34:16 +02:00
|
|
|
void setCurrentPart( ITrackedPart* part ) {
|
2015-10-23 19:20:33 +02:00
|
|
|
m_currentPart = part;
|
|
|
|
}
|
|
|
|
|
|
|
|
ITrackedPart* findPart( std::string const& name ) {
|
|
|
|
return m_currentPart->findChild( name );
|
|
|
|
}
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
class SectionTracker : public ITrackedPart {
|
2015-10-23 19:20:33 +02:00
|
|
|
enum RunState {
|
|
|
|
NotStarted,
|
|
|
|
Executing,
|
|
|
|
ExecutingChildren,
|
|
|
|
CompletedSuccessfully,
|
|
|
|
Failed,
|
|
|
|
ChildFailed
|
|
|
|
};
|
|
|
|
class TrackerHasName {
|
|
|
|
std::string m_name;
|
|
|
|
public:
|
|
|
|
TrackerHasName( std::string const& name ) : m_name( name ) {}
|
|
|
|
bool operator ()( Ptr<ITrackedPart> const& tracker ) {
|
|
|
|
return tracker->name() == m_name;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
typedef std::vector<Ptr<ITrackedPart> > Children;
|
|
|
|
std::string m_name;
|
|
|
|
TrackerContext& m_ctx;
|
2015-10-23 19:34:16 +02:00
|
|
|
ITrackedPart* m_parent;
|
2015-10-23 19:20:33 +02:00
|
|
|
Children m_children;
|
|
|
|
RunState m_runState;
|
|
|
|
public:
|
2015-10-23 19:34:16 +02:00
|
|
|
SectionTracker( std::string const& name, TrackerContext& ctx, ITrackedPart* parent )
|
2015-10-23 19:20:33 +02:00
|
|
|
: m_name( name ),
|
|
|
|
m_ctx( ctx ),
|
|
|
|
m_parent( parent ),
|
|
|
|
m_runState( NotStarted ) {}
|
|
|
|
|
|
|
|
virtual std::string name() const CATCH_OVERRIDE {
|
|
|
|
return m_name;
|
|
|
|
}
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
virtual bool hasEnded() const CATCH_OVERRIDE {
|
2015-10-23 19:20:33 +02:00
|
|
|
return m_runState == CompletedSuccessfully || m_runState == Failed;
|
|
|
|
}
|
2015-10-23 19:34:16 +02:00
|
|
|
virtual bool didCompleteSuccessfully() const CATCH_OVERRIDE {
|
2015-10-23 19:20:33 +02:00
|
|
|
return m_runState == CompletedSuccessfully;
|
|
|
|
}
|
2015-10-23 19:34:16 +02:00
|
|
|
virtual bool hasStarted() const CATCH_OVERRIDE {
|
|
|
|
return m_runState != NotStarted;
|
2015-10-23 19:20:33 +02:00
|
|
|
}
|
|
|
|
virtual bool isOpen() const CATCH_OVERRIDE {
|
|
|
|
return m_runState == Executing || m_runState == ExecutingChildren;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
virtual void addChild( Ptr<ITrackedPart> const& child ) CATCH_OVERRIDE {
|
|
|
|
m_children.push_back( child );
|
|
|
|
size_t childCount = m_children.size();
|
|
|
|
}
|
|
|
|
|
|
|
|
virtual ITrackedPart* findChild( std::string const& name ) CATCH_OVERRIDE {
|
|
|
|
Children::const_iterator it = std::find_if( m_children.begin(), m_children.end(), TrackerHasName( name ) );
|
|
|
|
return( it != m_children.end() )
|
|
|
|
? it->get()
|
|
|
|
: CATCH_NULL;
|
|
|
|
}
|
2015-10-23 19:34:16 +02:00
|
|
|
virtual ITrackedPart& parent() CATCH_OVERRIDE {
|
2015-10-23 19:20:33 +02:00
|
|
|
assert( m_parent ); // Should always be non-null except for root
|
|
|
|
return *m_parent;
|
|
|
|
}
|
|
|
|
|
|
|
|
virtual void openChild() CATCH_OVERRIDE {
|
|
|
|
if( m_runState != ExecutingChildren ) {
|
|
|
|
m_runState = ExecutingChildren;
|
|
|
|
if( m_parent )
|
|
|
|
m_parent->openChild();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
virtual void childFailed() CATCH_OVERRIDE {
|
|
|
|
assert( m_runState == ExecutingChildren );
|
|
|
|
m_runState = ChildFailed;
|
|
|
|
if( m_parent )
|
|
|
|
m_parent->childFailed();
|
|
|
|
}
|
|
|
|
void open() {
|
|
|
|
m_runState = Executing;
|
|
|
|
moveToThis();
|
|
|
|
if( m_parent )
|
|
|
|
m_parent->openChild();
|
|
|
|
}
|
|
|
|
|
|
|
|
virtual void close() CATCH_OVERRIDE {
|
|
|
|
switch( m_runState ) {
|
|
|
|
case Executing:
|
|
|
|
m_runState = CompletedSuccessfully;
|
|
|
|
break;
|
|
|
|
case ExecutingChildren:
|
|
|
|
if( !hasUnstartedChildren() )
|
|
|
|
m_runState = CompletedSuccessfully;
|
|
|
|
break;
|
|
|
|
case ChildFailed:
|
|
|
|
m_runState = ExecutingChildren;
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
throw std::logic_error( "Unexpected state" );
|
|
|
|
}
|
|
|
|
moveToParent();
|
|
|
|
m_ctx.completeCycle();
|
|
|
|
}
|
|
|
|
virtual void fail() CATCH_OVERRIDE {
|
|
|
|
m_runState = Failed;
|
|
|
|
if( m_parent )
|
|
|
|
m_parent->childFailed();
|
|
|
|
moveToParent();
|
|
|
|
m_ctx.completeCycle();
|
|
|
|
}
|
|
|
|
private:
|
|
|
|
void moveToParent() {
|
|
|
|
m_ctx.setCurrentPart( m_parent );
|
|
|
|
}
|
|
|
|
void moveToThis() {
|
|
|
|
m_ctx.setCurrentPart( this );
|
|
|
|
}
|
|
|
|
|
|
|
|
bool hasUnstartedChildren() const {
|
2015-10-23 19:34:16 +02:00
|
|
|
return !m_children.empty() && !m_children.back()->hasStarted();
|
2015-10-23 19:20:33 +02:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
ITrackedPart& TrackerContext::startRun() {
|
|
|
|
m_rootPart = new SectionTracker( "{root}", *this, CATCH_NULL );
|
2015-10-23 19:20:33 +02:00
|
|
|
m_currentPart = CATCH_NULL;
|
|
|
|
m_runState = Executing;
|
2015-10-23 19:34:16 +02:00
|
|
|
return *m_rootPart;
|
2015-10-23 19:20:33 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
class LocalContext {
|
|
|
|
|
|
|
|
public:
|
|
|
|
TrackerContext& operator()() const {
|
|
|
|
return TrackerContext::instance();
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
class SectionPart : public SectionTracker {
|
2015-10-23 19:20:33 +02:00
|
|
|
public:
|
2015-10-23 19:34:16 +02:00
|
|
|
SectionPart( std::string const& name, TrackerContext& ctx, ITrackedPart* parent )
|
|
|
|
: SectionTracker( name, ctx, parent )
|
2015-10-23 19:20:33 +02:00
|
|
|
{}
|
|
|
|
|
|
|
|
static SectionPart& acquire( TrackerContext& ctx, std::string const& name ) {
|
|
|
|
SectionPart* section = CATCH_NULL;
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
ITrackedPart& currentPart = ctx.currentPart();
|
2015-10-23 19:20:33 +02:00
|
|
|
if( ITrackedPart* part = currentPart.findChild( name ) ) {
|
|
|
|
section = dynamic_cast<SectionPart*>( part );
|
|
|
|
assert( section );
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
section = new SectionPart( name, ctx, ¤tPart );
|
|
|
|
currentPart.addChild( section );
|
|
|
|
}
|
2015-10-23 19:34:16 +02:00
|
|
|
if( !ctx.completedCycle() && !section->hasEnded() ) {
|
2015-10-23 19:20:33 +02:00
|
|
|
section->open();
|
|
|
|
}
|
|
|
|
return *section;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace Catch
|
|
|
|
|
|
|
|
inline Catch::TrackerContext& C_A_T_C_H_Context() {
|
|
|
|
return Catch::TrackerContext::instance();
|
|
|
|
}
|
|
|
|
|
|
|
|
// -------------------
|
|
|
|
|
|
|
|
#include "catch.hpp"
|
|
|
|
|
|
|
|
using namespace Catch;
|
|
|
|
|
|
|
|
inline void testCase( Catch::LocalContext const& C_A_T_C_H_Context ) {
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
// REQUIRE( C_A_T_C_H_Context().i() == 42 );
|
2015-10-23 19:20:33 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
TEST_CASE( "PartTracker" ) {
|
|
|
|
|
|
|
|
TrackerContext ctx;
|
|
|
|
ctx.startRun();
|
|
|
|
ctx.startCycle();
|
|
|
|
|
|
|
|
SectionPart& testCase = SectionPart::acquire( ctx, "Testcase" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
SectionPart& s1 = SectionPart::acquire( ctx, "S1" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s1.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
SECTION( "successfully close one section" ) {
|
|
|
|
s1.close();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s1.didCompleteSuccessfully() == true );
|
|
|
|
REQUIRE( testCase.hasEnded() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
testCase.close();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase.didCompleteSuccessfully() == true );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
REQUIRE( ctx.completedCycle() == true );
|
|
|
|
}
|
|
|
|
|
|
|
|
SECTION( "fail one section" ) {
|
|
|
|
s1.fail();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s1.didCompleteSuccessfully() == false );
|
|
|
|
REQUIRE( s1.hasEnded() == true );
|
|
|
|
REQUIRE( testCase.didCompleteSuccessfully() == false );
|
|
|
|
REQUIRE( testCase.hasEnded() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
testCase.close();
|
|
|
|
REQUIRE( ctx.completedCycle() == true );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
SECTION( "re-enter after failed section" ) {
|
|
|
|
ctx.startCycle();
|
|
|
|
SectionPart& testCase2 = SectionPart::acquire( ctx, "Testcase" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase2.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
SectionPart& s1b = SectionPart::acquire( ctx, "S1" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s1b.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
testCase2.close();
|
|
|
|
REQUIRE( ctx.completedCycle() == true );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase.didCompleteSuccessfully() == true );
|
|
|
|
REQUIRE( testCase.hasEnded() == true );
|
2015-10-23 19:20:33 +02:00
|
|
|
}
|
|
|
|
SECTION( "re-enter after failed section and find next section" ) {
|
|
|
|
ctx.startCycle();
|
|
|
|
SectionPart& testCase2 = SectionPart::acquire( ctx, "Testcase" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase2.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
SectionPart& s1b = SectionPart::acquire( ctx, "S1" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s1b.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
SectionPart& s2 = SectionPart::acquire( ctx, "S2" );
|
|
|
|
REQUIRE( s2.isOpen() );
|
|
|
|
s2.close();
|
|
|
|
REQUIRE( ctx.completedCycle() == true );
|
|
|
|
|
|
|
|
testCase2.close();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase.didCompleteSuccessfully() == true );
|
|
|
|
REQUIRE( testCase.hasEnded() == true );
|
2015-10-23 19:20:33 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
SECTION( "successfully close one section, then find another" ) {
|
|
|
|
s1.close();
|
|
|
|
REQUIRE( ctx.completedCycle() == true );
|
|
|
|
|
|
|
|
SectionPart& s2 = SectionPart::acquire( ctx, "S2" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s2.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
REQUIRE( s2.isOpen() == false );
|
|
|
|
|
|
|
|
testCase.close();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
SECTION( "Re-enter - skip S1 and enter S2" ) {
|
|
|
|
ctx.startCycle();
|
|
|
|
SectionPart& testCase2 = SectionPart::acquire( ctx, "Testcase" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase2.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
SectionPart& s1b = SectionPart::acquire( ctx, "S1" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s1b.didCompleteSuccessfully() == true );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
SectionPart& s2b = SectionPart::acquire( ctx, "S2" );
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s2b.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
REQUIRE( s2b.isOpen() );
|
|
|
|
|
|
|
|
REQUIRE( ctx.completedCycle() == false );
|
|
|
|
|
|
|
|
SECTION ("Successfully close S2") {
|
|
|
|
s2b.close();
|
|
|
|
REQUIRE( ctx.completedCycle() == true );
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s2b.didCompleteSuccessfully() == true );
|
|
|
|
REQUIRE( testCase2.hasEnded() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
testCase2.close();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase2.didCompleteSuccessfully() == true );
|
2015-10-23 19:20:33 +02:00
|
|
|
}
|
|
|
|
SECTION ("fail S2") {
|
|
|
|
s2b.fail();
|
|
|
|
REQUIRE( ctx.completedCycle() == true );
|
|
|
|
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s2b.didCompleteSuccessfully() == false );
|
|
|
|
REQUIRE( s2b.hasEnded() == true );
|
|
|
|
REQUIRE( testCase2.hasEnded() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
testCase2.close();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase2.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
SECTION( "open a nested section" ) {
|
|
|
|
SectionPart& s2 = SectionPart::acquire( ctx, "S2" );
|
|
|
|
REQUIRE( s2.isOpen() == true );
|
|
|
|
|
|
|
|
s2.close();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s2.didCompleteSuccessfully() == true );
|
|
|
|
REQUIRE( s1.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
s1.close();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( s1.didCompleteSuccessfully() == true );
|
|
|
|
REQUIRE( testCase.didCompleteSuccessfully() == false );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
testCase.close();
|
2015-10-23 19:34:16 +02:00
|
|
|
REQUIRE( testCase.didCompleteSuccessfully() == true );
|
2015-10-23 19:20:33 +02:00
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|