juce_UnitTest.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the juce_core module of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission to use, copy, modify, and/or distribute this software for any purpose with
   or without fee is hereby granted, provided that the above copyright notice and this
   permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
   NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
   DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
   IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
   CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
   ------------------------------------------------------------------------------
 
   NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
   All other JUCE modules are covered by a dual GPL/commercial license, so if you are
   using any other modules, be sure to check that you also comply with their license.
 
   For more details, visit www.juce.com
 
  ==============================================================================
*/
 
#ifndef JUCE_UNITTEST_H_INCLUDED
#define JUCE_UNITTEST_H_INCLUDED
 
class UnitTestRunner;
 
 
//==============================================================================
class JUCE_API  UnitTest
{
public:
    //==============================================================================
    explicit UnitTest (const String& name);
 
    virtual ~UnitTest();
 
    const String& getName() const noexcept       { return name; }
 
    void performTest (UnitTestRunner* runner);
 
    static Array<UnitTest*>& getAllTests();
 
    //==============================================================================
    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)
    {
        const bool result = (actual == expected);
 
        if (! result)
        {
            if (failureMessage.isNotEmpty())
                failureMessage << " -- ";
 
            failureMessage << "Expected value: " << expected << ", Actual value: " << actual;
        }
 
        expect (result, failureMessage);
    }
 
    //==============================================================================
    void logMessage (const String& message);
 
    Random getRandom() const;
 
private:
    //==============================================================================
    const String name;
    UnitTestRunner* runner;
 
    JUCE_DECLARE_NON_COPYABLE (UnitTest)
};
 
 
//==============================================================================
class JUCE_API  UnitTestRunner
{
public:
    //==============================================================================
    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;
 
    //==============================================================================
    struct TestResult
    {
        String unitTestName;
        String subcategoryName;
 
        int passes;
        int failures;
 
        StringArray messages;
    };
 
    int getNumResults() const noexcept;
 
    const TestResult* getResult (int index) const noexcept;
 
protected:
    virtual void resultsUpdated();
 
    virtual void logMessage (const String& message);
 
    virtual bool shouldAbortTests();
 
private:
    //==============================================================================
    friend class UnitTest;
 
    UnitTest* currentTest;
    String currentSubCategory;
    OwnedArray <TestResult, CriticalSection> results;
    bool assertOnFailure, logPasses;
    Random randomForTest;
 
    void beginNewTest (UnitTest* test, const String& subCategory);
    void endTest();
 
    void addPass();
    void addFail (const String& failureMessage);
 
    JUCE_DECLARE_NON_COPYABLE (UnitTestRunner)
};
 
 
#endif   // JUCE_UNITTEST_H_INCLUDED