openshot-audio  0.1.5
Classes | Public Member Functions | Protected Member Functions | Friends | List of all members
juce::UnitTestRunner Class Reference

#include <juce_core.h>

Classes

struct  TestResult
 

Public Member Functions

 UnitTestRunner ()
 
virtual ~UnitTestRunner ()
 
void runTests (const Array< UnitTest *> &tests, int64 randomSeed=0)
 
void runAllTests (int64 randomSeed=0)
 
void setAssertOnFailure (bool shouldAssert) noexcept
 
void setPassesAreLogged (bool shouldDisplayPasses) noexcept
 
int getNumResults () const noexcept
 
const TestResultgetResult (int index) const noexcept
 

Protected Member Functions

virtual void resultsUpdated ()
 
virtual void logMessage (const String &message)
 
virtual bool shouldAbortTests ()
 

Friends

class UnitTest
 

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::UnitTestRunner ( )

◆ ~UnitTestRunner()

UnitTestRunner::~UnitTestRunner ( )
virtual

Destructor.

Member Function Documentation

◆ getNumResults()

int UnitTestRunner::getNumResults ( ) const
noexcept

Returns the number of TestResult objects that have been performed.

See also
getResult

◆ getResult()

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

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

See also
getNumResults

◆ logMessage()

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.

◆ resultsUpdated()

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.

◆ runAllTests()

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.

◆ runTests()

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.

◆ setAssertOnFailure()

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.

◆ setPassesAreLogged()

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.

◆ shouldAbortTests()

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.

Friends And Related Function Documentation

◆ UnitTest

friend class UnitTest
friend

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