le_test.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
#ifndef LEGATO_TEST_INCLUDE_GUARD
#define LEGATO_TEST_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void _le_test_Init(int testCount);
void _le_test_Exit(void) __attribute__((noreturn));
bool _le_test_CheckNeedsPlan(void);
void _le_test_Fail(void);
int _le_test_NumberTest(void);
int _le_test_GetNumTests(void);
int _le_test_GetNumFailures(void);
bool _le_test_SetTodo(bool todo);
void _le_test_Skip(int count);
bool _le_test_IsSkipping(void);
const char* _le_test_GetTag(void);

//
// Allow overriding LE_TEST_OUTPUT by a frameworkAdaptor
//
#ifndef LE_TEST_OUTPUT
#   define LE_TEST_OUTPUT(format, ...) LE_INFO("TAP | " format, ##__VA_ARGS__)
#endif
// @}

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_NO_PLAN   -1

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_PLAN(testCount) do {                                    \
        if (testCount >= 0) { LE_TEST_OUTPUT("1..%d", testCount); }     \
        _le_test_Init(testCount);                                       \
    } while(0)


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_INIT                LE_TEST_PLAN(LE_TEST_NO_PLAN)


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_OK(test, testName, ...) do {                            \
        if (test)                                                       \
        {                                                               \
            LE_TEST_OUTPUT("ok %d - " testName "%s",                    \
                           _le_test_NumberTest(),                       \
                           ##__VA_ARGS__,                               \
                           _le_test_GetTag());                          \
        }                                                               \
        else                                                            \
        {                                                               \
            LE_TEST_OUTPUT("not ok %d - " testName "%s",                \
                           _le_test_NumberTest(),                       \
                           ##__VA_ARGS__,                               \
                           _le_test_GetTag());                          \
            _le_test_Fail();                                            \
        }                                                               \
    } while(0)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST(testResult) LE_TEST_OK((testResult), #testResult)


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_FATAL(...) do {                         \
        LE_TEST_OUTPUT("Bail out! " __VA_ARGS__);       \
        _le_test_Exit();                                \
    } while(0)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_ASSERT(test, testName, ...) do {                            \
        if (test)                                                       \
        {                                                               \
            LE_TEST_OUTPUT("ok %d - " testName "%s",                    \
                           _le_test_NumberTest(),                       \
                           ##__VA_ARGS__,                               \
                           _le_test_GetTag());                          \
        }                                                               \
        else                                                            \
        {                                                               \
            LE_TEST_OUTPUT("not ok %d - " testName "%s",                \
                           _le_test_NumberTest(),                       \
                           ##__VA_ARGS__,                               \
                           _le_test_GetTag());                          \
            _le_test_Fail();                                            \
            LE_TEST_FATAL();                                            \
        }                                                               \
    } while(0)


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_INFO(...) LE_TEST_OUTPUT("# " __VA_ARGS__)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_BEGIN_TODO(cond) do {                                   \
        bool _le_test_OldTodo = _le_test_SetTodo(cond);                 \

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_END_TODO()                          \
        _le_test_SetTodo(_le_test_OldTodo);         \
    } while(0)


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_BEGIN_SKIP(cond, count) do {                            \
          if (cond)                                                     \
          {                                                             \
              _le_test_Skip(count);                                     \
              break;                                                    \
          }

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_END_SKIP()                              \
    } while(0)


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_TEST_EXIT do {                                       \
        if (_le_test_CheckNeedsPlan())                          \
        {                                                       \
            LE_TEST_OUTPUT("1..%d", _le_test_GetNumTests());    \
        }                                                       \
        _le_test_Exit();                                        \
    } while(0)

#define LE_TEST_SUMMARY LE_TEST_EXIT


#endif // LEGATO_TEST_INCLUDE_GUARD