CppUnit project page CppUnit home page

CppUT Namespace Reference


Classes

struct  DefaultComparator
struct  DeRefComparator
struct  RefComparator
class  DllProxyError
class  DllProxy
 Manages dynamic libraries. More...
struct  EqualityTraits
struct  NoSpecificEqualityTest
class  ExceptionGuardElement
class  ExceptionTranslatorGuard
 Helpers to provide simple exception translation. More...
class  ExceptionGuard
class  TestExtendedDataHelper
 Helper to set test extended data (description, time-out, dependencies...)

Example of usage:. More...

class  TestExtendedData
class  TestExtendedDataList
class  DescriptionData
class  TimeOutData
class  DependenciesData
class  GroupData
class  TestExtendedDataFactory
class  TableDataSource
class  JsonTableDataSource
class  InputTest
struct  Bind234
class  ColumnInputTest
class  LightTestRunner
class  Message
 Carry informative message about a failed assertion. More...
class  LazyMessage
class  OpenTestAdaptor
class  Registry
class  SuiteRegisterer
class  SuiteRelationshipRegisterer
class  TestFactoryRegisterer
 Helper object used to statically register a TestFactory. More...
struct  DefaultStringizer
 A generic functor that can be used to convert a value into a string.

It is used as default argument by function template that allow the user to pass a specific functor to convert data to string. More...

struct  RefStringizer
struct  DerefStringizer
struct  NotConvertibleToStdString
struct  NoToStringOverload
class  Test
class  AbstractTestCase
 An abstract test case that can be run. More...
class  TestCase
 A test case that can be run. More...
class  TestFixture
class  TestFunctionFactory
class  AbortingAssertionException
 Exception thrown when an aborting assertion fails. More...
class  SkipTestException
 Exception thrown to skip the current test. More...
class  UndeclaredResourceException
 Exception thrown when attempting to obtain an undeclared resource. More...
class  SourceLocation
 Represents the location of an assertion in the source code. More...
class  Assertion
 Represents a failed assertion. More...
class  TestStatus
 Represents the status of the current test. More...
class  CheckerResult
 All checker functions used in assert and check macro should returns an object of this type. More...
class  TestResultUpdater
 Provides notification of failed assertions and log events. More...
class  TestInfo
 Heart of the test system: hold current test status and the state of the current assertion. More...
class  AbstractTestSuite
 An abstract test suite that represents a collection of Test. More...
class  TestSuite
 A test suite that represents a collection of Test. More...
class  TestVisitor

Namespaces

namespace  Impl

Typedefs

typedef CppTL::Any Resource
typedef unsigned int ResourceId
typedef CppTL::ConstString ResourceName
typedef CppTL::IntrusivePtr
< AbstractTestCase
AbstractTestCasePtr
typedef CppTL::IntrusivePtr
< AbstractTestSuite
AbstractTestSuitePtr
typedef CppTL::IntrusivePtr
< ExceptionGuardElement
ExceptionGuardElementPtr
typedef CppTL::IntrusivePtr< TestTestPtr
typedef CppTL::IntrusivePtr
< TestInfo
TestInfoPtr
typedef CppTL::IntrusivePtr
< TestSuite
TestSuitePtr
typedef CppTL::IntrusivePtr
< TestResultUpdater
TestResultUpdaterPtr
typedef CppTL::IntrusivePtr
< ResourceHandler > 
ResourceHandlerPtr
typedef CppTL::IntrusivePtr
< ResourceInstance > 
ResourceInstancePtr
typedef CppTL::IntrusivePtr
< AcquiredResourceHandle > 
AcquiredResourceHandlePtr
typedef CppTL::Functor0R< TestPtrTestFactory
typedef int TestFactoryId

Enumerations

enum  AssertionType { abortingAssertion = 1, checkingAssertion }
 Indiciates if on failure the assertion it will abort the current test. More...
enum  AbortingAssertionMode { fastAbortingAssertion = 1, richAbortingAssertion }
 Indicates if AbortingAssertionException contains detail about the failed assertion. Used by CppUnit 2 to test itself without relying on TestResultUpdater. More...

Functions

CheckerResult pass ()
CheckerResult fail ()
CheckerResult fail (const LazyMessage &message)
CheckerResult checkTrue (bool shouldBeTrue, const LazyMessage &message=LazyMessage::none)
CheckerResult checkFalse (bool shouldBeFalse, const LazyMessage &message=LazyMessage::none)
CheckerResult checkAssertionFail (bool assertionFailed, const LazyMessage &message=LazyMessage::none)
CheckerResult checkAssertionPass (bool assertionFailed, const LazyMessage &message=LazyMessage::none)
void buildEqualityFailedMessage (CheckerResult &result, const std::string &expected, const std::string &actual, const LazyMessage &message=LazyMessage::none)
template<typename FirstType, typename SecondType>
void makeEqualityFailedMessage (CheckerResult &result, const FirstType &expected, const SecondType &actual, const LazyMessage &message=LazyMessage::none)
template<typename FirstType, typename SecondType, typename EqualityFunctorType>
CheckerResult checkEquals (const FirstType &expected, const SecondType &actual, EqualityFunctorType equality, const Message &message)
template<typename FirstType, typename SecondType>
CheckerResult checkEquals (const FirstType &expected, const SecondType &actual, const LazyMessage &message=LazyMessage::none)
void buildUnequalityFailedMessage (CheckerResult &result, const std::string &expected, const std::string &actual, const LazyMessage &message=LazyMessage::none)
template<typename FirstType, typename SecondType>
void makeUnequalityFailedMessage (CheckerResult &result, const FirstType &expected, const SecondType &actual, const LazyMessage &message=LazyMessage::none)
template<typename FirstType, typename SecondType, typename EqualityFunctorType>
CheckerResult checkNotEquals (const FirstType &expected, const SecondType &actual, EqualityFunctorType equality, const Message &message)
template<typename FirstType, typename SecondType>
CheckerResult checkNotEquals (const FirstType &expected, const SecondType &actual, const LazyMessage &message=LazyMessage::none)
CheckerResult checkDoubleEquals (double expected, double actual, double tolerance, const LazyMessage &message=LazyMessage::none)
void skipCurrentTest ()
template<typename ItemType>
std::string stringizeEnumItem (const ItemType &item)
template<class ExpectedEnumerator, class ActualEnumerator, class ExpectedStringizer, class ActualStringizer, class EqualityPredicate>
CheckerResult checkCustomHeterogeneousSequenceEqual (const ExpectedEnumerator &expected, const ActualEnumerator &actual, ExpectedStringizer expectedStringizer, ActualStringizer actualStringizer, EqualityPredicate comparator, const Message &message)
template<class EnumeratorType, class StringizerType, class EqualityPredicate>
CheckerResult checkCustomSequenceEqual (const EnumeratorType &expected, const EnumeratorType &actual, StringizerType stringizer, EqualityPredicate comparator, const Message &message)
template<class EnumeratorType, class StringizerType, class EqualityPredicate>
CheckerResult checkCustomStringSequenceEqual (const EnumeratorType &expected, const EnumeratorType &actual, StringizerType stringizer, const Message &message=Message())
template<class ExpectedEnumerator, class ActualEnumerator, class EqualityPredicate>
CheckerResult checkCustomEqualitySequenceEqual (const ExpectedEnumerator &expected, const ActualEnumerator &actual, EqualityPredicate comparator, const Message &message=Message())
template<class ExpectedEnumeratorType, class ActualEnumeratorType>
CheckerResult checkSequenceEqual (const ExpectedEnumeratorType &expected, const ActualEnumeratorType &actual, const Message &message=Message())
template<class ExpectedEnumeratorType, class ActualEnumeratorType, class EqualityPredicate>
CheckerResult checkCustomEqualityStlSequenceEqual (const ExpectedEnumeratorType &expected, const ActualEnumeratorType &actual, EqualityPredicate comparator, const Message &message=Message())
template<class ExpectedEnumeratorType, class ActualEnumeratorType>
CheckerResult checkStlSequenceEqual (const ExpectedEnumeratorType &expected, const ActualEnumeratorType &actual, const Message &message=Message())
template<class ExpectedEnumerator, class ActualEnumerator, class ExpectedStringizer, class ActualStringizer, class EqualityPredicate>
CheckerResult checkCustomHeterogeneousSetEqual (const ExpectedEnumerator &expected, const ActualEnumerator &actual, ExpectedStringizer expectedStringizer, ActualStringizer actualStringizer, EqualityPredicate predicate, const Message &message)
template<class ExpectedEnumerator, class ActualEnumerator, class ItemStringizer, class EqualityPredicate>
CheckerResult checkCustomSetEqual (const ExpectedEnumerator &expected, const ActualEnumerator &actual, ItemStringizer itemStringizer, EqualityPredicate comparator, const Message &message=Message())
template<class ExpectedEnumerator, class ActualEnumerator, class ItemStringizer>
CheckerResult checkCustomStringSetEqual (const ExpectedEnumerator &expected, const ActualEnumerator &actual, ItemStringizer itemStringizer, const Message &message=Message())
template<class ExpectedEnumerator, class ActualEnumerator, class EqualityPredicate>
CheckerResult checkCustomEqualitySetEqual (const ExpectedEnumerator &expected, const ActualEnumerator &actual, EqualityPredicate comparator, const Message &message=Message())
template<class ExpectedEnumerator, class ActualEnumerator>
CheckerResult checkSetEqual (const ExpectedEnumerator &expected, const ActualEnumerator &actual, const Message &message=Message())
template<class ExpectedStlSet, class ActualStlSet>
CheckerResult checkStlSetEqual (const ExpectedStlSet &expected, const ActualStlSet &actual, const Message &message=Message())
template<class ExpectedSetType, class ActualSetType, class EqualityPredicate>
CheckerResult checkCustomEqualityStlSetEqual (const ExpectedSetType &expected, const ActualSetType &actual, EqualityPredicate predicate, const Message &message=Message())
template<class EnumeratorType, class ItemStringizerType>
std::string enumToStringCustom (EnumeratorType enumerator, ItemStringizerType itemStringizer, const std::string &separator="; ", const std::string &begin="{ ", const std::string &end=" }")
template<class EnumType>
std::string enumToString (const EnumType &enumerator, const std::string &separator="; ", const std::string &begin="{ ", const std::string &end=" }")
CheckerResult checkStdStringStartsWith (const std::string &string, const std::string &pattern, const Message &message)
CheckerResult checkStdStringEndsWith (const std::string &string, const std::string &pattern, const Message &message)
CheckerResult checkStdStringContains (const std::string &string, const std::string &pattern, const Message &message)
CheckerResult checkStdStringEquals (const std::string &expected, const std::string &actual, const Message &message)
template<typename String1, typename String2>
CheckerResult checkStringStartsWith (const String1 &string, const String2 &pattern, const Message &message=Message())
template<typename String1, typename String2>
CheckerResult checkStringEndsWith (const String1 &string, const String2 &pattern, const Message &message=Message())
template<typename String1, typename String2>
CheckerResult checkStringContains (const String1 &string, const String2 &pattern, const Message &message=Message())
template<typename String1, typename String2>
CheckerResult checkStringEquals (const String1 &expected, const String2 &actual, const Message &message=Message())
NoSpecificEqualityTest isEqual (...)
template<typename AType, typename BType>
implementation_detail bool equalityTest (const AType &a, const BType &b)
template<class Translator, class ExceptionType>
void registerExceptionTranslation (ExceptionGuard &guard, Translator translator, CppTL::Type< ExceptionType >)
 Register an exception translator.
template<typename Functor, typename A2, typename A3, typename A4>
CppTL::Functor1< typename
Functor::arg1_type > 
bind234 (const Functor &functor, A2 a2, A3 a3, A4 a4)
std::string getStdString (const char *cstr)
std::string getStdString (const std::string &s)
std::string getStdString (const CppTL::ConstString &s)
template<class T>
NotConvertibleToStdString getStdString (const T &)
template<class StringType>
std::string convertToString (const StringType &s)
template<class T>
NoToStringOverload toString (const T &)
template<typename ValueType>
implementation_detail std::string stringize (const ValueType &value)
template<typename ValueType>
std::string defaultStringize (const ValueType &value)
TestPtr makeTestCase (void(*run)(), const std::string &name)
 Creates a TestCase with the specified name and run functor.
TestPtr makeTestCase (const CppTL::Functor0 &run, const std::string &name)
 Creates a TestCase with the specified name and run functor.
TestPtr makeTestCase (const CppTL::Functor0 &setUp, const CppTL::Functor0 &run, const CppTL::Functor0 &tearDown, const std::string &name)
 Creates a TestCase with the specified name and setUp, run, and tearDown functor.
TestPtr makeFailingTestCase (const std::string &name, const Message &message)
 Creates a TestCase with the specified name that will always fail.

The test case run body simply call CPPUT_FAIL() with the specified message.

template<typename FixtureType>
TestPtr makeFixtureTestCase (const CppTL::IntrusivePtr< FixtureType > &fixture, const CppTL::Functor0 &run, const std::string &name)
 Creates a TestCase using a fixture-like object.

The test case will delegate implementation of AbstractTestCase setUp() and tearDown() to method of the same name on the given fixture object.

ResourcegetResource (const ResourceName &name)
 Obtains the instance of the resource required by the test case.
void log (const Json::Value &log)
 Log an event.
void log (const std::string &log)
 Log an event.
void log (const char *log)
 Log an event.
void log (const CppTL::ConstString &log)
 Log an event.
TestSuitePtr makeTestSuite (const std::string &name)
 Creates a TestSuite with the specified name.
std::string translate (const char *message)
 Translate the specified message.


Typedef Documentation

typedef CppTL::IntrusivePtr<AcquiredResourceHandle> CppUT::AcquiredResourceHandlePtr

typedef unsigned int CppUT::ResourceId


Enumeration Type Documentation

Indicates if AbortingAssertionException contains detail about the failed assertion. Used by CppUnit 2 to test itself without relying on TestResultUpdater.

Enumerator:
fastAbortingAssertion 
richAbortingAssertion 


Function Documentation

template<typename Functor, typename A2, typename A3, typename A4>
CppTL::Functor1< typename Functor::arg1_type> CppUT::bind234 ( const Functor &  functor,
A2  a2,
A3  a3,
A4  a4 
) [inline]

Todo:
Extends functor API to allow not binding all parameters.

References CppTL::fn1().

Referenced by CppUT::ColumnInputTest::operator()().

void CppUT::buildEqualityFailedMessage ( CheckerResult &  result,
const std::string &  expected,
const std::string &  actual,
const LazyMessage &  message = LazyMessage::none 
)

void CppUT::buildUnequalityFailedMessage ( CheckerResult &  result,
const std::string &  expected,
const std::string &  actual,
const LazyMessage &  message = LazyMessage::none 
)

CheckerResult CppUT::checkAssertionFail ( bool  assertionFailed,
const LazyMessage &  message = LazyMessage::none 
)

CheckerResult CppUT::checkAssertionPass ( bool  assertionFailed,
const LazyMessage &  message = LazyMessage::none 
)

template<class ExpectedEnumerator, class ActualEnumerator, class EqualityPredicate>
CheckerResult CppUT::checkCustomEqualitySequenceEqual ( const ExpectedEnumerator &  expected,
const ActualEnumerator &  actual,
EqualityPredicate  comparator,
const Message &  message = Message() 
) [inline]

template<class ExpectedEnumerator, class ActualEnumerator, class EqualityPredicate>
CheckerResult CppUT::checkCustomEqualitySetEqual ( const ExpectedEnumerator &  expected,
const ActualEnumerator &  actual,
EqualityPredicate  comparator,
const Message &  message = Message() 
) [inline]

template<class ExpectedEnumeratorType, class ActualEnumeratorType, class EqualityPredicate>
CheckerResult CppUT::checkCustomEqualityStlSequenceEqual ( const ExpectedEnumeratorType &  expected,
const ActualEnumeratorType &  actual,
EqualityPredicate  comparator,
const Message &  message = Message() 
) [inline]

template<class ExpectedSetType, class ActualSetType, class EqualityPredicate>
CheckerResult CppUT::checkCustomEqualityStlSetEqual ( const ExpectedSetType &  expected,
const ActualSetType &  actual,
EqualityPredicate  predicate,
const Message &  message = Message() 
) [inline]

template<class ExpectedEnumerator, class ActualEnumerator, class ExpectedStringizer, class ActualStringizer, class EqualityPredicate>
CheckerResult CppUT::checkCustomHeterogeneousSequenceEqual ( const ExpectedEnumerator &  expected,
const ActualEnumerator &  actual,
ExpectedStringizer  expectedStringizer,
ActualStringizer  actualStringizer,
EqualityPredicate  comparator,
const Message &  message 
) [inline]

template<class ExpectedEnumerator, class ActualEnumerator, class ExpectedStringizer, class ActualStringizer, class EqualityPredicate>
CheckerResult CppUT::checkCustomHeterogeneousSetEqual ( const ExpectedEnumerator &  expected,
const ActualEnumerator &  actual,
ExpectedStringizer  expectedStringizer,
ActualStringizer  actualStringizer,
EqualityPredicate  predicate,
const Message &  message 
) [inline]

template<class EnumeratorType, class StringizerType, class EqualityPredicate>
CheckerResult CppUT::checkCustomSequenceEqual ( const EnumeratorType &  expected,
const EnumeratorType &  actual,
StringizerType  stringizer,
EqualityPredicate  comparator,
const Message &  message 
) [inline]

template<class ExpectedEnumerator, class ActualEnumerator, class ItemStringizer, class EqualityPredicate>
CheckerResult CppUT::checkCustomSetEqual ( const ExpectedEnumerator &  expected,
const ActualEnumerator &  actual,
ItemStringizer  itemStringizer,
EqualityPredicate  comparator,
const Message &  message = Message() 
) [inline]

template<class EnumeratorType, class StringizerType, class EqualityPredicate>
CheckerResult CppUT::checkCustomStringSequenceEqual ( const EnumeratorType &  expected,
const EnumeratorType &  actual,
StringizerType  stringizer,
const Message &  message = Message() 
) [inline]

template<class ExpectedEnumerator, class ActualEnumerator, class ItemStringizer>
CheckerResult CppUT::checkCustomStringSetEqual ( const ExpectedEnumerator &  expected,
const ActualEnumerator &  actual,
ItemStringizer  itemStringizer,
const Message &  message = Message() 
) [inline]

CheckerResult CppUT::checkDoubleEquals ( double  expected,
double  actual,
double  tolerance,
const LazyMessage &  message = LazyMessage::none 
)

template<typename FirstType, typename SecondType>
CheckerResult CppUT::checkEquals ( const FirstType &  expected,
const SecondType &  actual,
const LazyMessage &  message = LazyMessage::none 
) [inline]

template<typename FirstType, typename SecondType, typename EqualityFunctorType>
CheckerResult CppUT::checkEquals ( const FirstType &  expected,
const SecondType &  actual,
EqualityFunctorType  equality,
const Message &  message 
) [inline]

CheckerResult CppUT::checkFalse ( bool  shouldBeFalse,
const LazyMessage &  message = LazyMessage::none 
)

template<typename FirstType, typename SecondType>
CheckerResult CppUT::checkNotEquals ( const FirstType &  expected,
const SecondType &  actual,
const LazyMessage &  message = LazyMessage::none 
) [inline]

template<typename FirstType, typename SecondType, typename EqualityFunctorType>
CheckerResult CppUT::checkNotEquals ( const FirstType &  expected,
const SecondType &  actual,
EqualityFunctorType  equality,
const Message &  message 
) [inline]

template<class ExpectedEnumeratorType, class ActualEnumeratorType>
CheckerResult CppUT::checkSequenceEqual ( const ExpectedEnumeratorType &  expected,
const ActualEnumeratorType &  actual,
const Message &  message = Message() 
) [inline]

template<class ExpectedEnumerator, class ActualEnumerator>
CheckerResult CppUT::checkSetEqual ( const ExpectedEnumerator &  expected,
const ActualEnumerator &  actual,
const Message &  message = Message() 
) [inline]

CheckerResult CppUT::checkStdStringContains ( const std::string &  string,
const std::string &  pattern,
const Message &  message 
)

CheckerResult CppUT::checkStdStringEndsWith ( const std::string &  string,
const std::string &  pattern,
const Message &  message 
)

CheckerResult CppUT::checkStdStringEquals ( const std::string &  expected,
const std::string &  actual,
const Message &  message 
)

CheckerResult CppUT::checkStdStringStartsWith ( const std::string &  string,
const std::string &  pattern,
const Message &  message 
)

template<class ExpectedEnumeratorType, class ActualEnumeratorType>
CheckerResult CppUT::checkStlSequenceEqual ( const ExpectedEnumeratorType &  expected,
const ActualEnumeratorType &  actual,
const Message &  message = Message() 
) [inline]

template<class ExpectedStlSet, class ActualStlSet>
CheckerResult CppUT::checkStlSetEqual ( const ExpectedStlSet &  expected,
const ActualStlSet &  actual,
const Message &  message = Message() 
) [inline]

template<typename String1, typename String2>
CheckerResult CppUT::checkStringContains ( const String1 &  string,
const String2 &  pattern,
const Message &  message = Message() 
) [inline]

template<typename String1, typename String2>
CheckerResult CppUT::checkStringEndsWith ( const String1 &  string,
const String2 &  pattern,
const Message &  message = Message() 
) [inline]

template<typename String1, typename String2>
CheckerResult CppUT::checkStringEquals ( const String1 &  expected,
const String2 &  actual,
const Message &  message = Message() 
) [inline]

template<typename String1, typename String2>
CheckerResult CppUT::checkStringStartsWith ( const String1 &  string,
const String2 &  pattern,
const Message &  message = Message() 
) [inline]

CheckerResult CppUT::checkTrue ( bool  shouldBeTrue,
const LazyMessage &  message = LazyMessage::none 
)

template<class EnumType>
std::string CppUT::enumToString ( const EnumType &  enumerator,
const std::string &  separator = "; ",
const std::string &  begin = "{ ",
const std::string &  end = " }" 
) [inline]

References enumToStringCustom().

template<class EnumeratorType, class ItemStringizerType>
std::string CppUT::enumToStringCustom ( EnumeratorType  enumerator,
ItemStringizerType  itemStringizer,
const std::string &  separator = "; ",
const std::string &  begin = "{ ",
const std::string &  end = " }" 
) [inline]

CheckerResult CppUT::fail ( const LazyMessage &  message  ) 

CheckerResult CppUT::fail (  ) 

References translate().

Resource & CppUT::getResource ( const ResourceName &  name  ) 

Obtains the instance of the resource required by the test case.

Parameters:
name Name of the resource to obtains. This resource must have been declared in the list of resource required by the test case.
Warning:
This function may only be called inside a test case (setUp, run or tearDown).
See also:
AbstractTestCase::requireResource, ResourceHandlerRegistry.

References CppUT::TestInfo::getResource(), and CppUT::TestInfo::threadInstance().

void CppUT::log ( const CppTL::ConstString log  ) 

void CppUT::log ( const char *  log  ) 

Log an event.

See also:
TestInfo

References CppUT::TestInfo::log(), and CppUT::TestInfo::threadInstance().

void CppUT::log ( const std::string &  log  ) 

Log an event.

See also:
TestInfo

References CppUT::TestInfo::log(), and CppUT::TestInfo::threadInstance().

void CppUT::log ( const Json::Value log  ) 

Log an event.

See also:
TestInfo

References CppUT::TestInfo::log(), and CppUT::TestInfo::threadInstance().

template<typename FirstType, typename SecondType>
void CppUT::makeEqualityFailedMessage ( CheckerResult &  result,
const FirstType &  expected,
const SecondType &  actual,
const LazyMessage &  message = LazyMessage::none 
) [inline]

References buildEqualityFailedMessage(), and stringize().

Referenced by checkEquals().

template<typename FirstType, typename SecondType>
void CppUT::makeUnequalityFailedMessage ( CheckerResult &  result,
const FirstType &  expected,
const SecondType &  actual,
const LazyMessage &  message = LazyMessage::none 
) [inline]

CheckerResult CppUT::pass (  ) 

void CppUT::skipCurrentTest (  ) 

template<typename ItemType>
std::string CppUT::stringizeEnumItem ( const ItemType &  item  )  [inline]

References stringize().

template<class T>
NoToStringOverload CppUT::toString ( const T &   )  [inline]

std::string CppUT::translate ( const char *  message  )  [inline]


SourceForge Logo hosts this site. Send comments to:
CppUnit Developers