openshot-audio  0.1.6
Public Member Functions | Static Public Member Functions | List of all members
UnitTest Class Referenceabstract

#include <juce_UnitTest.h>

Public Member Functions

 UnitTest (const String &name)
 
virtual ~UnitTest ()
 
const StringgetName () const noexcept
 
void performTest (UnitTestRunner *runner)
 
virtual void initialise ()
 
virtual void shutdown ()
 
virtual void runTest ()=0
 
void beginTest (const String &testName)
 
void expect (bool testResult, const String &failureMessage=String::empty)
 
template<class ValueType >
void expectEquals (ValueType actual, ValueType expected, String failureMessage=String::empty)
 
void logMessage (const String &message)
 
Random getRandom () const
 

Static Public Member Functions

static Array< UnitTest * > & getAllTests ()
 

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()
{
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 ( const String name)
explicit

Creates a test with the given name.

UnitTest::~UnitTest ( )
virtual

Destructor.

Member Function Documentation

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.

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

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.

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

Compares two values, and if they don't match, prints out a message containing the expected and actual result values.

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

Returns the set of all UnitTest objects that currently exist.

const String& UnitTest::getName ( ) const
inlinenoexcept

Returns the name of the test.

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.

void UnitTest::initialise ( )
virtual

You can optionally implement this method to set up your test. This method will be called before runTest().

void UnitTest::logMessage ( const String message)

Writes a message to the test log. This can only be called from within your runTest() method.

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.

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.

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.


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