JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Member Functions | Protected Member Functions | List of all members
UnitTestRunner Class Reference

Runs a set of unit tests. More...

Classes

struct  TestResult
 Contains the results of a test. More...
 

Public Member Functions

 UnitTestRunner ()
 
virtual ~UnitTestRunner ()
 Destructor.
 
void runTests (const Array< UnitTest * > &tests, int64 randomSeed=0)
 Runs a set of tests.
 
void runAllTests (int64 randomSeed=0)
 Runs all the UnitTest objects that currently exist.
 
void setAssertOnFailure (bool shouldAssert) noexcept
 Sets a flag to indicate whether an assertion should be triggered if a test fails.
 
void setPassesAreLogged (bool shouldDisplayPasses) noexcept
 Sets a flag to indicate whether successful tests should be logged.
 
int getNumResults () const noexcept
 Returns the number of TestResult objects that have been performed.
 
const TestResultgetResult (int index) const noexcept
 Returns one of the TestResult objects that describes a test that has been run.
 

Protected Member Functions

virtual void resultsUpdated ()
 Called when the list of results changes.
 
virtual void logMessage (const String &message)
 Logs a message about the current test progress.
 
virtual bool shouldAbortTests ()
 This can be overridden to let the runner know that it should abort the tests as soon as possible, e.g.
 

Detailed Description

Runs a set of unit tests.

You can instantiate one of these objects and use it to invoke tests on a set of UnitTest objects.

By using a subclass of UnitTestRunner, you can intercept logging messages and perform custom behaviour when each test completes.

See Also
UnitTest

Constructor & Destructor Documentation

UnitTestRunner::UnitTestRunner ( )
virtual UnitTestRunner::~UnitTestRunner ( )
virtual

Destructor.

Member Function Documentation

void UnitTestRunner::runTests ( const Array< UnitTest * > &  tests,
int64  randomSeed = 0 
)

Runs a set of tests.

The tests are performed in order, and the results are logged. To run all the registered UnitTest objects that exist, use runAllTests().

If you want to run the tests with a predetermined seed, you can pass that into the randomSeed argument, or pass 0 to have a randomly-generated seed chosen.

void UnitTestRunner::runAllTests ( int64  randomSeed = 0)

Runs all the UnitTest objects that currently exist.

This calls runTests() for all the objects listed in UnitTest::getAllTests().

If you want to run the tests with a predetermined seed, you can pass that into the randomSeed argument, or pass 0 to have a randomly-generated seed chosen.

void UnitTestRunner::setAssertOnFailure ( bool  shouldAssert)
noexcept

Sets a flag to indicate whether an assertion should be triggered if a test fails.

This is true by default.

void UnitTestRunner::setPassesAreLogged ( bool  shouldDisplayPasses)
noexcept

Sets a flag to indicate whether successful tests should be logged.

By default, this is set to false, so that only failures will be displayed in the log.

int UnitTestRunner::getNumResults ( ) const
noexcept

Returns the number of TestResult objects that have been performed.

See Also
getResult
const TestResult* UnitTestRunner::getResult ( int  index) const
noexcept

Returns one of the TestResult objects that describes a test that has been run.

See Also
getNumResults
virtual void UnitTestRunner::resultsUpdated ( )
protectedvirtual

Called when the list of results changes.

You can override this to perform some sort of behaviour when results are added.

virtual void UnitTestRunner::logMessage ( const String message)
protectedvirtual

Logs a message about the current test progress.

By default this just writes the message to the Logger class, but you could override this to do something else with the data.

virtual bool UnitTestRunner::shouldAbortTests ( )
protectedvirtual

This can be overridden to let the runner know that it should abort the tests as soon as possible, e.g.

because the thread needs to stop.


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