This is a base class for classes that perform a unit test. More...

Public Member Functions

 UnitTest (const String &name, const String &category=String())
 Creates a test with the given name and optionally places it in a category. More...
 
virtual ~UnitTest ()
 Destructor. More...
 
const StringgetName () const noexcept
 Returns the name of the test. More...
 
const StringgetCategory () const noexcept
 Returns the category of the test. More...
 
void performTest (UnitTestRunner *runner)
 Runs the test, using the specified UnitTestRunner. More...
 
virtual void initialise ()
 You can optionally implement this method to set up your test. More...
 
virtual void shutdown ()
 You can optionally implement this method to clear up after your test has been run. More...
 
virtual void runTest ()=0
 Implement this method in your subclass to actually run your tests. More...
 
void beginTest (const String &testName)
 Tells the system that a new subsection of tests is beginning. More...
 
void expect (bool testResult, const String &failureMessage=String())
 Checks that the result of a test is true, and logs this result. More...
 
template<class ValueType >
void expectEquals (ValueType actual, ValueType expected, String failureMessage=String())
 Compares a value to an expected value. More...
 
template<class ValueType >
void expectNotEquals (ValueType value, ValueType valueToCompareTo, String failureMessage=String())
 Checks whether a value is not equal to a comparison value. More...
 
template<class ValueType >
void expectGreaterThan (ValueType value, ValueType valueToCompareTo, String failureMessage=String())
 Checks whether a value is greater than a comparison value. More...
 
template<class ValueType >
void expectLessThan (ValueType value, ValueType valueToCompareTo, String failureMessage=String())
 Checks whether a value is less than a comparison value. More...
 
template<class ValueType >
void expectGreaterOrEqual (ValueType value, ValueType valueToCompareTo, String failureMessage=String())
 Checks whether a value is greater or equal to a comparison value. More...
 
template<class ValueType >
void expectLessOrEqual (ValueType value, ValueType valueToCompareTo, String failureMessage=String())
 Checks whether a value is less or equal to a comparison value. More...
 
template<class ValueType >
void expectWithinAbsoluteError (ValueType actual, ValueType expected, ValueType maxAbsoluteError, String failureMessage=String())
 Computes the difference between a value and a comparison value, and if it is larger than a specified maximum value, prints out a message containing the actual and comparison values and the maximum allowed error. More...
 
void logMessage (const String &message)
 Writes a message to the test log. More...
 
Random getRandom () const
 Returns a shared RNG that all unit tests should use. More...
 

Static Public Member Functions

static Array< UnitTest * > & getAllTests ()
 Returns the set of all UnitTest objects that currently exist. More...
 
static Array< UnitTest * > getTestsInCategory (const String &category)
 Returns the set of UnitTests in a specified category. More...
 
static StringArray getAllCategories ()
 Returns a StringArray containing all of the categories of UnitTests that have been registered. More...
 

Detailed Description

This is a base class for classes that perform a unit test.

To write a test using this class, your code should look something like this:

class MyTest : public UnitTest
{
public:
MyTest() : UnitTest ("Foobar testing") {}
void runTest() override
{
beginTest ("Part 1");
expect (myFoobar.doesSomething());
expect (myFoobar.doesSomethingElse());
beginTest ("Part 2");
expect (myOtherFoobar.doesSomething());
expect (myOtherFoobar.doesSomethingElse());
...etc..
}
};
// Creating a static instance will automatically add the instance to the array
// returned by UnitTest::getAllTests(), so the test will be included when you call
// UnitTestRunner::runAllTests()
static MyTest test;

To run a test, use the UnitTestRunner class.

See also
UnitTestRunner

Constructor & Destructor Documentation

◆ UnitTest()

UnitTest::UnitTest ( const String name,
const String category = String() 
)
explicit

Creates a test with the given name and optionally places it in a category.

◆ ~UnitTest()

virtual UnitTest::~UnitTest ( )
virtual

Destructor.

Member Function Documentation

◆ getName()

const String& UnitTest::getName ( ) const
noexcept

Returns the name of the test.

◆ getCategory()

const String& UnitTest::getCategory ( ) const
noexcept

Returns the category of the test.

References initialise().

◆ performTest()

void UnitTest::performTest ( UnitTestRunner runner)

Runs the test, using the specified UnitTestRunner.

You shouldn't need to call this method directly - use UnitTestRunner::runTests() instead.

◆ getAllTests()

static Array<UnitTest*>& UnitTest::getAllTests ( )
static

Returns the set of all UnitTest objects that currently exist.

◆ getTestsInCategory()

static Array<UnitTest*> UnitTest::getTestsInCategory ( const String category)
static

Returns the set of UnitTests in a specified category.

◆ getAllCategories()

static StringArray UnitTest::getAllCategories ( )
static

Returns a StringArray containing all of the categories of UnitTests that have been registered.

◆ initialise()

virtual void UnitTest::initialise ( )
virtual

You can optionally implement this method to set up your test.

This method will be called before runTest().

◆ shutdown()

virtual void UnitTest::shutdown ( )
virtual

You can optionally implement this method to clear up after your test has been run.

This method will be called after runTest() has returned.

◆ runTest()

virtual void UnitTest::runTest ( )
pure virtual

Implement this method in your subclass to actually run your tests.

The content of your implementation should call beginTest() and expect() to perform the tests.

◆ beginTest()

void UnitTest::beginTest ( const String testName)

Tells the system that a new subsection of tests is beginning.

This should be called from your runTest() method, and may be called as many times as you like, to demarcate different sets of tests.

◆ expect()

void UnitTest::expect ( bool  testResult,
const String failureMessage = String() 
)

Checks that the result of a test is true, and logs this result.

In your runTest() method, you should call this method for each condition that you want to check, e.g.

void runTest()
{
beginTest ("basic tests");
expect (x + y == 2);
expect (getThing() == someThing);
...etc...
}

If testResult is true, a pass is logged; if it's false, a failure is logged. If the failure message is specified, it will be written to the log if the test fails.

◆ expectEquals()

template<class ValueType >
void UnitTest::expectEquals ( ValueType  actual,
ValueType  expected,
String  failureMessage = String() 
)

Compares a value to an expected value.

If they are not equal, prints out a message containing the expected and actual values.

◆ expectNotEquals()

template<class ValueType >
void UnitTest::expectNotEquals ( ValueType  value,
ValueType  valueToCompareTo,
String  failureMessage = String() 
)

Checks whether a value is not equal to a comparison value.

If this check fails, prints out a message containing the actual and comparison values.

◆ expectGreaterThan()

template<class ValueType >
void UnitTest::expectGreaterThan ( ValueType  value,
ValueType  valueToCompareTo,
String  failureMessage = String() 
)

Checks whether a value is greater than a comparison value.

If this check fails, prints out a message containing the actual and comparison values.

◆ expectLessThan()

template<class ValueType >
void UnitTest::expectLessThan ( ValueType  value,
ValueType  valueToCompareTo,
String  failureMessage = String() 
)

Checks whether a value is less than a comparison value.

If this check fails, prints out a message containing the actual and comparison values.

◆ expectGreaterOrEqual()

template<class ValueType >
void UnitTest::expectGreaterOrEqual ( ValueType  value,
ValueType  valueToCompareTo,
String  failureMessage = String() 
)

Checks whether a value is greater or equal to a comparison value.

If this check fails, prints out a message containing the actual and comparison values.

◆ expectLessOrEqual()

template<class ValueType >
void UnitTest::expectLessOrEqual ( ValueType  value,
ValueType  valueToCompareTo,
String  failureMessage = String() 
)

Checks whether a value is less or equal to a comparison value.

If this check fails, prints out a message containing the actual and comparison values.

◆ expectWithinAbsoluteError()

template<class ValueType >
void UnitTest::expectWithinAbsoluteError ( ValueType  actual,
ValueType  expected,
ValueType  maxAbsoluteError,
String  failureMessage = String() 
)

Computes the difference between a value and a comparison value, and if it is larger than a specified maximum value, prints out a message containing the actual and comparison values and the maximum allowed error.

References abs().

◆ logMessage()

void UnitTest::logMessage ( const String message)

Writes a message to the test log.

This can only be called from within your runTest() method.

◆ getRandom()

Random UnitTest::getRandom ( ) const

Returns a shared RNG that all unit tests should use.

If a test needs random numbers, it's important that when an error is found, the exact circumstances can be re-created in order to re-test the problem, by repeating the test with the same random seed value. To make this possible, the UnitTestRunner class creates a master seed value for the run, writes this number to the log, and then this method returns a Random object based on that seed. All tests should only use this method to create any Random objects that they need.

Note that this method will return an identical object each time it's called for a given run, so if you need several different Random objects, the best way to do that is to call Random::combineSeed() on the result to permute it with a constant value.


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