Unit Testing framework based on http://cpputest.github.io/

CppUTest

Where to find more information

Getting test reports on the console

You may need to tailor the file src/Platforms/mbed/UtestPlatform.cpp to your needs. In particular, if you want console output, you might want to look at the function PlatformSpecificPutchar().

Quick introduction (some code!)

To write your first test, all you need is a new cpp file with a TEST_GROUP and a TEST, like:

#include "CppUTest/TestHarness.h"

TEST_GROUP(FirstTestGroup)
{
};

TEST(FirstTestGroup, FirstTest)
{
   FAIL("Fail me!");
}

This test will fail.

You can add new tests to the test group by just writing more tests in the file, like this:

TEST(FirstTestGroup, SecondTest)
{
   STRCMP_EQUAL("hello", "world");
   LONGS_EQUAL(1, 2);
   CHECK(false);
}

You do need to trigger the tests from somewhere in your program. It could look something like:

#include "CppUTest/TestRegistry.h"
#include "CppUTest/CommandLineTestRunner.h"

int main(int ac, char** av)
{
    ....
    unsigned failureCount = 0;
    {
        ConsoleTestOutput output;
        CommandLineTestRunner runner(ac, av, &output, TestRegistry::getCurrentRegistry());
        failureCount = runner.runAllTestsMain();
    }

    if (failureCount == 0) {
        console.printf("PASSED\r\n");
    }
    ...
}

For more information, We’d recommend to read the manual or, even better, check some existing tests such as SimpleStringTest or (a bit more complicated) MemoryLeakDetectorTest or the mocking tests or just check out the Cheat Sheet.

Committer:
Rohit Grover
Date:
Thu Jun 19 08:24:31 2014 +0100
Revision:
2:82161d9e7b36
Parent:
1:4769360130ed
uncomment the code in CommandLineTestRunner::RunAllTests() having to do with MemoryLeakWarningPlugin

Bas Vodde, from the CppUTest development team has suggested an alternate way to run tests.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 0:0b799af9d58e 1
rgrover1 0:0b799af9d58e 2 /*
rgrover1 0:0b799af9d58e 3 * This file can be used to get extra debugging information about memory leaks in your production code.
rgrover1 0:0b799af9d58e 4 * It defines a preprocessor macro for operator new. This will pass additional information to the
rgrover1 0:0b799af9d58e 5 * operator new and this will give the line/file information of the memory leaks in your code.
rgrover1 0:0b799af9d58e 6 *
rgrover1 0:0b799af9d58e 7 * You can use this by including this file to all your production code. When using gcc, you can use
rgrover1 0:0b799af9d58e 8 * the -include file to do this for you.
rgrover1 0:0b799af9d58e 9 *
rgrover1 0:0b799af9d58e 10 * Warning: Using the new macro can cause a conflict with newly declared operator news. This can be
rgrover1 0:0b799af9d58e 11 * resolved by:
rgrover1 0:0b799af9d58e 12 * 1. #undef operator new before including this file
rgrover1 0:0b799af9d58e 13 * 2. Including the files that override operator new before this file.
rgrover1 0:0b799af9d58e 14 * This can be done by creating your own NewMacros.h file that includes your operator new overrides
rgrover1 0:0b799af9d58e 15 * and THEN this file.
rgrover1 0:0b799af9d58e 16 *
rgrover1 0:0b799af9d58e 17 * STL (or StdC++ lib) also does overrides for operator new. Therefore, you'd need to include the STL
rgrover1 0:0b799af9d58e 18 * files *before* this file too.
rgrover1 0:0b799af9d58e 19 *
rgrover1 0:0b799af9d58e 20 */
rgrover1 0:0b799af9d58e 21
rgrover1 0:0b799af9d58e 22 #include "CppUTestConfig.h"
rgrover1 0:0b799af9d58e 23
Rohit Grover 1:4769360130ed 24 /* Make sure that mem leak detection is on and that this is being included from a C++ file */
Rohit Grover 1:4769360130ed 25 #if CPPUTEST_USE_MEM_LEAK_DETECTION && defined(__cplusplus)
rgrover1 0:0b799af9d58e 26
rgrover1 0:0b799af9d58e 27 /* This #ifndef prevents <new> from being included twice and enables the file to be included anywhere */
rgrover1 0:0b799af9d58e 28 #ifndef CPPUTEST_USE_NEW_MACROS
rgrover1 0:0b799af9d58e 29
rgrover1 0:0b799af9d58e 30 #if CPPUTEST_USE_STD_CPP_LIB
rgrover1 0:0b799af9d58e 31 #include <new>
rgrover1 0:0b799af9d58e 32 #include <memory>
rgrover1 0:0b799af9d58e 33 #include <string>
rgrover1 0:0b799af9d58e 34 #endif
rgrover1 0:0b799af9d58e 35
rgrover1 0:0b799af9d58e 36 void* operator new(size_t size, const char* file, int line) UT_THROW (std::bad_alloc);
rgrover1 0:0b799af9d58e 37 void* operator new[](size_t size, const char* file, int line) UT_THROW (std::bad_alloc);
rgrover1 0:0b799af9d58e 38 void* operator new(size_t size) UT_THROW(std::bad_alloc);
rgrover1 0:0b799af9d58e 39 void* operator new[](size_t size) UT_THROW(std::bad_alloc);
rgrover1 0:0b799af9d58e 40
rgrover1 0:0b799af9d58e 41 void operator delete(void* mem) UT_NOTHROW;
rgrover1 0:0b799af9d58e 42 void operator delete[](void* mem) UT_NOTHROW;
rgrover1 0:0b799af9d58e 43 void operator delete(void* mem, const char* file, int line) UT_NOTHROW;
rgrover1 0:0b799af9d58e 44 void operator delete[](void* mem, const char* file, int line) UT_NOTHROW;
rgrover1 0:0b799af9d58e 45
rgrover1 0:0b799af9d58e 46 #endif
rgrover1 0:0b799af9d58e 47
rgrover1 0:0b799af9d58e 48 #define new new(__FILE__, __LINE__)
rgrover1 0:0b799af9d58e 49
rgrover1 0:0b799af9d58e 50 #define CPPUTEST_USE_NEW_MACROS 1
rgrover1 0:0b799af9d58e 51
rgrover1 0:0b799af9d58e 52 #endif