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:
rgrover1
Date:
Tue Jan 28 09:27:41 2014 +0000
Revision:
0:0b799af9d58e
Child:
1:4769360130ed
CppUTest unit test framework.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 0:0b799af9d58e 1 /*
rgrover1 0:0b799af9d58e 2 * Copyright (c) 2007, Michael Feathers, James Grenning and Bas Vodde
rgrover1 0:0b799af9d58e 3 * All rights reserved.
rgrover1 0:0b799af9d58e 4 *
rgrover1 0:0b799af9d58e 5 * Redistribution and use in source and binary forms, with or without
rgrover1 0:0b799af9d58e 6 * modification, are permitted provided that the following conditions are met:
rgrover1 0:0b799af9d58e 7 * * Redistributions of source code must retain the above copyright
rgrover1 0:0b799af9d58e 8 * notice, this list of conditions and the following disclaimer.
rgrover1 0:0b799af9d58e 9 * * Redistributions in binary form must reproduce the above copyright
rgrover1 0:0b799af9d58e 10 * notice, this list of conditions and the following disclaimer in the
rgrover1 0:0b799af9d58e 11 * documentation and/or other materials provided with the distribution.
rgrover1 0:0b799af9d58e 12 * * Neither the name of the <organization> nor the
rgrover1 0:0b799af9d58e 13 * names of its contributors may be used to endorse or promote products
rgrover1 0:0b799af9d58e 14 * derived from this software without specific prior written permission.
rgrover1 0:0b799af9d58e 15 *
rgrover1 0:0b799af9d58e 16 * THIS SOFTWARE IS PROVIDED BY THE EARLIER MENTIONED AUTHORS ``AS IS'' AND ANY
rgrover1 0:0b799af9d58e 17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
rgrover1 0:0b799af9d58e 18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
rgrover1 0:0b799af9d58e 19 * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
rgrover1 0:0b799af9d58e 20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
rgrover1 0:0b799af9d58e 21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
rgrover1 0:0b799af9d58e 22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
rgrover1 0:0b799af9d58e 23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
rgrover1 0:0b799af9d58e 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
rgrover1 0:0b799af9d58e 25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
rgrover1 0:0b799af9d58e 26 */
rgrover1 0:0b799af9d58e 27
rgrover1 0:0b799af9d58e 28 #ifndef D_MemoryLeakWarningPlugin_h
rgrover1 0:0b799af9d58e 29 #define D_MemoryLeakWarningPlugin_h
rgrover1 0:0b799af9d58e 30
rgrover1 0:0b799af9d58e 31 #include "TestPlugin.h"
rgrover1 0:0b799af9d58e 32 #include "MemoryLeakDetectorNewMacros.h"
rgrover1 0:0b799af9d58e 33
rgrover1 0:0b799af9d58e 34 #define IGNORE_ALL_LEAKS_IN_TEST() MemoryLeakWarningPlugin::getFirstPlugin()->ignoreAllLeaksInTest();
rgrover1 0:0b799af9d58e 35 #define EXPECT_N_LEAKS(n) MemoryLeakWarningPlugin::getFirstPlugin()->expectLeaksInTest(n);
rgrover1 0:0b799af9d58e 36
rgrover1 0:0b799af9d58e 37 extern void crash_on_allocation_number(unsigned alloc_number);
rgrover1 0:0b799af9d58e 38
rgrover1 0:0b799af9d58e 39 class MemoryLeakDetector;
rgrover1 0:0b799af9d58e 40 class MemoryLeakFailure;
rgrover1 0:0b799af9d58e 41
rgrover1 0:0b799af9d58e 42 class MemoryLeakWarningPlugin: public TestPlugin
rgrover1 0:0b799af9d58e 43 {
rgrover1 0:0b799af9d58e 44 public:
rgrover1 0:0b799af9d58e 45 MemoryLeakWarningPlugin(const SimpleString& name, MemoryLeakDetector* localDetector = 0);
rgrover1 0:0b799af9d58e 46 virtual ~MemoryLeakWarningPlugin();
rgrover1 0:0b799af9d58e 47
rgrover1 0:0b799af9d58e 48 virtual void preTestAction(UtestShell& test, TestResult& result) _override;
rgrover1 0:0b799af9d58e 49 virtual void postTestAction(UtestShell& test, TestResult& result) _override;
rgrover1 0:0b799af9d58e 50
rgrover1 0:0b799af9d58e 51 virtual const char* FinalReport(int toBeDeletedLeaks = 0);
rgrover1 0:0b799af9d58e 52
rgrover1 0:0b799af9d58e 53 void ignoreAllLeaksInTest();
rgrover1 0:0b799af9d58e 54 void expectLeaksInTest(int n);
rgrover1 0:0b799af9d58e 55
rgrover1 0:0b799af9d58e 56 void destroyGlobalDetectorAndTurnOffMemoryLeakDetectionInDestructor(bool des);
rgrover1 0:0b799af9d58e 57
rgrover1 0:0b799af9d58e 58 MemoryLeakDetector* getMemoryLeakDetector();
rgrover1 0:0b799af9d58e 59
rgrover1 0:0b799af9d58e 60 static MemoryLeakWarningPlugin* getFirstPlugin();
rgrover1 0:0b799af9d58e 61
rgrover1 0:0b799af9d58e 62 static MemoryLeakDetector* getGlobalDetector();
rgrover1 0:0b799af9d58e 63 static MemoryLeakFailure* getGlobalFailureReporter();
rgrover1 0:0b799af9d58e 64 static void setGlobalDetector(MemoryLeakDetector* detector, MemoryLeakFailure* reporter);
rgrover1 0:0b799af9d58e 65 static void destroyGlobalDetector();
rgrover1 0:0b799af9d58e 66
rgrover1 0:0b799af9d58e 67 static void turnOffNewDeleteOverloads();
rgrover1 0:0b799af9d58e 68 static void turnOnNewDeleteOverloads();
rgrover1 0:0b799af9d58e 69 private:
rgrover1 0:0b799af9d58e 70 MemoryLeakDetector* memLeakDetector_;
rgrover1 0:0b799af9d58e 71 bool ignoreAllWarnings_;
rgrover1 0:0b799af9d58e 72 bool destroyGlobalDetectorAndTurnOfMemoryLeakDetectionInDestructor_;
rgrover1 0:0b799af9d58e 73 int expectedLeaks_;
rgrover1 0:0b799af9d58e 74 int failureCount_;
rgrover1 0:0b799af9d58e 75
rgrover1 0:0b799af9d58e 76 static MemoryLeakWarningPlugin* firstPlugin_;
rgrover1 0:0b799af9d58e 77 };
rgrover1 0:0b799af9d58e 78
rgrover1 0:0b799af9d58e 79 extern void* cpputest_malloc_location_with_leak_detection(size_t size, const char* file, int line);
rgrover1 0:0b799af9d58e 80 extern void* cpputest_realloc_location_with_leak_detection(void* memory, size_t size, const char* file, int line);
rgrover1 0:0b799af9d58e 81 extern void cpputest_free_location_with_leak_detection(void* buffer, const char* file, int line);
rgrover1 0:0b799af9d58e 82
rgrover1 0:0b799af9d58e 83 #endif