CppUnit project page FAQ CppUnit home page

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AdditionalMessageAn additional Message for assertions.

Provides a implicit constructor that takes a single string. This allow this class to be used as the message arguments in macros

AsserterA set of functions to help writing assertion macros.

Here is an example of assertion, a simplified version of the actual assertion implemented in examples/cppunittest/XmlUniformiser.h:

assertion_traits< T >Traits used by CPPUNIT_ASSERT_EQUAL()
assertion_traits< double >Traits used by CPPUNIT_ASSERT_DOUBLES_EQUAL()
AutoRegisterRegistry(Implementation) Automatically adds a registry into another registry
AutoRegisterSuite< TestCaseType >(Implementation) Automatically register the test suite of the specified type
BriefTestProgressListenerTestListener that prints the name of each test before running it
CompilerOutputterOutputs a TestResultCollector in a compiler compatible format.

Printing the test results in a compiler compatible format (assertion location has the same format as compiler error), allow you to use your IDE to jump to the assertion failure. Location format can be customized (see setLocationFormat() )

ConcretTestFixtureFactory< TestFixtureType >Concret TestFixture factory (Implementation)
CppUnitTestPlugInTest plug-in interface.

This class define the interface implemented by test plug-in. A pointer to that interface is returned by the function exported by the test plug-in

DefaultProtectorDefault protector that catch all exceptions (Implementation)
DynamicLibraryManagerManages dynamic libraries
DynamicLibraryManagerExceptionException thrown by DynamicLibraryManager when a failure occurs
ExceptionExceptions thrown by failed assertions.

Exception is an exception that serves descriptive strings through its what() method

ExceptionTestCaseDecorator< ExpectedException >Expected exception test case decorator
Functor
ITestRunnerDSPluginVtbl
MessageMessage associated to an Exception.

A message is composed of two items:

  • a short description (~20/30 characters)
  • a list of detail strings
MfcTestRunnerMFC test runner.

Use this to launch the MFC TestRunner. Usually called from you CWinApp subclass:

Orthodox< ClassUnderTest >
OutputterAbstract outputter to print test result summary
PlugInManagerManges TestPlugIn
PlugInManager::PlugInInfo(INTERNAL) Information about a specific plug-in
PlugInParametersTest plug-ins parameters
ProtectorProtects one or more test case run
ProtectorChainProtector chain (Implementation). Implementation detail
ProtectorChain::ProtectFunctor
ProtectorContextProtector context (Implementation). Implementation detail
ProtectorGuardScoped protector push to TestResult
QtTestRunnerQT test runner.

Here is an example of usage:

RepeatedTestDecorator that runs a test repeatedly
SourceLineRepresents a source line location.

Used to capture the failure location in assertion

StringToolsTool functions to manipulate string
SynchronizedObjectBase class for synchronized object
SynchronizedObject::ExclusiveZoneLocks a synchronization object in the current scope
SynchronizedObject::SynchronizationObjectAbstract synchronization object (mutex)
TestBase class for all test objects.

All test objects should be a subclass of Test. Some test objects, TestCase for example, represent one individual test. Other test objects, such as TestSuite, are comprised of several tests

TestCaller< Fixture >Generate a test case from a fixture method.

A test caller provides access to a test case method on a test fixture class. Test callers are useful when you want to run an individual test or add it to a suite. Test Callers invoke only one Test (i.e. test method) on one Fixture of a TestFixture

TestCaseA single test object
TestCaseDecoratorDecorator for Test cases
TestCaseMethodFunctorFunctor to call test case method (Implementation)
TestCompositeA Composite of Tests
TestDecoratorDecorator for Tests
TestFactoryAbstract Test factory
TestFactoryRegistryRegistry for TestFactory.

Notes that the registry DON'T assumes lifetime control for any registered tests anymore

TestFactoryRegistryList(INTERNAL) List of all TestFactoryRegistry
TestFailureRecord of a failed Test execution.

A TestFailure collects a failed test together with the caught exception

TestFixtureWraps a test case with setUp and tearDown methods.

A TestFixture is used to provide a common environment for a set of test cases

TestFixtureFactoryAbstract TestFixture factory (Implementation)
TestLeafA single test object
TestListenerListener for test progress and result.

Implementing the Observer pattern a TestListener may be registered to a TestResult to obtain information on the testing progress. Use specialized sub classes of TestListener for text output (TextTestProgressListener). Do not use the Listener for the test result output, use a subclass of Outputter instead

TestNamerNames a test or a fixture suite
TestPathA List of Test representing a path to access a Test.

The path can be converted to a string and resolved from a string with toString() and TestPath( Test *root, const std::string &pathAsString )

TestPlugInDefaultImplDefault implementation of test plug-in interface.

Override getSuiteName() to specify the suite name. Default is "All Tests"

TestPlugInInterfaceAbstract TestPlugIn for DLL
TestResultManages TestListener.

A single instance of this class is used when running the test. It is usually created by the test runner (TestRunner)

TestResultCollectorCollects test result.

A TestResultCollector is a TestListener which collects the results of executing a test case. It is an instance of the Collecting Parameter pattern

TestRunnerGeneric test runner.

The TestRunner assumes ownership of all added tests: you can not add test or suite that are local variable since they can't be deleted

TestRunner::WrappingSuite(INTERNAL) Mutating test suite
TestSetUpDecorates a test by providing a specific setUp() and tearDown()
TestSuccessListenerTestListener that checks if any test case failed
TestSuiteA Composite of Tests.

It runs a collection of test cases. Here is an example

TestSuiteBuilderContext< Fixture >Type-sage context used when creating test suite in HelperMacros
TestSuiteBuilderContextBaseContext used when creating test suite in HelperMacros
TestSuiteFactory< TestCaseType >TestFactory for TestFixture that implements a static suite() method
TextOutputterPrints a TestResultCollector to a text stream
TextTestProgressListenerTestListener that show the status of each TestCase test result
TextTestResultHolds printable test result (DEPRECATED).

deprecated Use class TextTestProgressListener and TextOutputter instead

TextTestRunnerA text mode test runner.

The test runner manage the life cycle of the added tests

XmlDocumentA XML Document
XmlElementA XML Element
XmlOutputterOutputs a TestResultCollector in XML format.

Save the test result as a XML stream

XmlOutputterHookHook to customize Xml output

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