AnCH Framework 0.1
Another C++ Hack Framework
Loading...
Searching...
No Matches
anch::ut::UnitTests Class Reference

Unit tests collection. More...

#include <unit.hpp>

Collaboration diagram for anch::ut::UnitTests:

Public Member Functions

 UnitTests ()
virtual ~UnitTests ()
UnitTestsname (const std::string &name)
UnitTestsdescription (const std::string &description)
UnitTestsinitialize (std::function< void(void)> initFunc)
UnitTestsuninitialize (std::function< void(void)> uninitFunc)
UnitTestsbeforeTest (std::function< void(void)> beforeFunc)
UnitTestsafterTest (std::function< void(void)> afterFunc)
UnitTestsadd (const std::string &name, std::function< void(void)> testFunc)
void initialize () const
void uninitialize () const
void before () const
void after () const
const std::string & getName () const
const std::string & getDescription () const
const std::map< std::string, std::function< void(void)> > & getTests () const
void setTests (const std::map< std::string, std::function< void(void)> > &tests)

Detailed Description

Unit tests collection.

This class aims to provide (un)intialization functions (either global and per test) and unit tests registration

Author
Vincent Lachenal
Since
0.1

Constructor & Destructor Documentation

◆ UnitTests()

anch::ut::UnitTests::UnitTests ( )

UnitTests default construtor

◆ ~UnitTests()

virtual anch::ut::UnitTests::~UnitTests ( )
virtual

UnitTests destructor

Member Function Documentation

◆ add()

UnitTests & anch::ut::UnitTests::add ( const std::string & name,
std::function< void(void)> testFunc )

Unit test function setter

Parameters
namethe unit test's name
testFuncthe function to add
Returns
this
Here is the call graph for this function:

◆ after()

void anch::ut::UnitTests::after ( ) const

Call uninitialiation unit test

◆ afterTest()

UnitTests & anch::ut::UnitTests::afterTest ( std::function< void(void)> afterFunc)

Unit test uninitialization function setter

Parameters
afterFuncthe function to set
Returns
this
Here is the call graph for this function:

◆ before()

void anch::ut::UnitTests::before ( ) const

Call initialiation unit test

◆ beforeTest()

UnitTests & anch::ut::UnitTests::beforeTest ( std::function< void(void)> beforeFunc)

Unit test initialization function setter

Parameters
beforeFuncthe function to set
Returns
this
Here is the call graph for this function:

◆ description()

UnitTests & anch::ut::UnitTests::description ( const std::string & description)

Unit tests colletion description setter
This field is used for reporting usage.

Parameters
descriptionthe description to set
Returns
this
Here is the call graph for this function:

◆ getDescription()

const std::string & anch::ut::UnitTests::getDescription ( ) const

Unit tests collection's description getter

Returns
the description

◆ getName()

const std::string & anch::ut::UnitTests::getName ( ) const

Unit tests collection's name getter

Returns
the name

◆ getTests()

const std::map< std::string, std::function< void(void)> > & anch::ut::UnitTests::getTests ( ) const

Unit tests gettter

Returns
the tests

◆ initialize() [1/2]

void anch::ut::UnitTests::initialize ( ) const

Call initialiation unit tests collection

◆ initialize() [2/2]

UnitTests & anch::ut::UnitTests::initialize ( std::function< void(void)> initFunc)

Unit tests colletion initialization function setter

Parameters
initFuncthe function to set
Returns
this
Here is the call graph for this function:

◆ name()

UnitTests & anch::ut::UnitTests::name ( const std::string & name)

Unit tests colletion name setter.
This field is used for reporting usage.

Parameters
namethe name to set
Returns
this
Here is the call graph for this function:

◆ setTests()

void anch::ut::UnitTests::setTests ( const std::map< std::string, std::function< void(void)> > & tests)

Unit tests setters

Parameters
teststhe tests to set

◆ uninitialize() [1/2]

void anch::ut::UnitTests::uninitialize ( ) const

Call uninitialiation unit tests collection

◆ uninitialize() [2/2]

UnitTests & anch::ut::UnitTests::uninitialize ( std::function< void(void)> uninitFunc)

Unit tests colletion uninitialization function setter

Parameters
uninitFuncthe function to set
Returns
this
Here is the call graph for this function:

The documentation for this class was generated from the following file: