JUCE
|
This is a base class for classes that perform a unit test. More...
Public Member Functions | |
UnitTest (const String &name) | |
Creates a test with the given name. More... | |
virtual | ~UnitTest () |
Destructor. More... | |
const String & | getName () const noexcept |
Returns the name 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 two values, and if they don't match, prints out a message containing the expected and actual result values. 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... | |
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:
To run a test, use the UnitTestRunner class.
|
explicit |
Creates a test with the given name.
|
virtual |
Destructor.
|
noexcept |
Returns the name of the test.
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.
Returns the set of all UnitTest objects that currently exist.
|
virtual |
You can optionally implement this method to set up your test.
This method will be called before runTest().
|
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.
|
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.
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.
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.
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.
void UnitTest::expectEquals | ( | ValueType | actual, |
ValueType | expected, | ||
String | failureMessage = String() |
||
) |
Compares two values, and if they don't match, prints out a message containing the expected and actual result values.
void UnitTest::logMessage | ( | const String & | message | ) |
Writes a message to the test log.
This can only be called from within your runTest() method.
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.