UT/UT_TestManager.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Edward Lam
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        UT_TestManager.h (C++)
 *
 * COMMENTS:    This class provides a test harness framework.
 *
 * USAGE:
 *      1.  Create a main() method for your test application like so:
 *              int main(int argc, char *argv[])
 *              {
 *                  return UT_TestManager::get().run(argc, argv);
 *              }
 *          The return code will be the number of test failures.
 *          To obtain the command line usage, use "testapp -h".
 *
 *      2.  For each test case, use one of the TEST_REGISTER*() macros for
 *          registering a test function. The function should return true if the
 *          test passed.
 */

#ifndef __UT_TESTMANAGER_H__
#define __UT_TESTMANAGER_H__

#include "UT_API.h"

#include "UT_Functor.h"

class UT_API UT_TestManager
{
public:
    /// Access the global test manager
    static UT_TestManager & get();

    /// Determine if the test was interactively invoked
    virtual bool            isInteractive() const = 0;

    /// Called by main() to run the tests. Returns the number of test failures.
    virtual int             run(int argc, char *argv[]) = 0;

    /// Called by the TEST_REGISTER*() macros to automatically add a new test
    /// case
    virtual void            addTest(const char *name,
                                    UT_Functor<bool> &callback) = 0;
};

/// Use this macro after your test function is declared. It will register
/// your method with the test manager. Your method should return true if the
/// test succeeded, false otherwise. The name is the label that will be used
/// for invoking this specific test.
#define TEST_REGISTER_FN(name, method)                                  \
            class method##Registrar                                     \
            {                                                           \
                public:                                                 \
                    method##Registrar()                                 \
                    {                                                   \
                        UT_Functor<bool> callback(&method);             \
                        UT_TestManager::get().addTest(name, callback);  \
                    }                                                   \
            };                                                          \
            static method##Registrar    the##method##Registrar;

/// Use this macro after your test class is declared. It will create a static
/// instance of your class that then registers your 'bool classname::method()'
/// with the test manager. Your method should return true if the test
/// succeeded, false otherwise. The name is the label that will be used for
/// invoking this specific test.
#define TEST_REGISTER(name, classname, method)                          \
            class classname##method##Registrar                          \
            {                                                           \
                public:                                                 \
                    classname##method##Registrar()                      \
                    {                                                   \
                        UT_Functor<bool> callback(&myTest,              \
                                                  &classname::method);  \
                        UT_TestManager::get().addTest(name, callback);  \
                    }                                                   \
                private:                                                \
                    classname   myTest;                                 \
            };                                                          \
            static classname##method##Registrar                         \
                                    the##classname##method##Registrar;

#endif // __UT_TESTMANAGER_H__

---