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:
0:0b799af9d58e
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 * 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 ///////////////////////////////////////////////////////////////////////////////
rgrover1 0:0b799af9d58e 29 //
rgrover1 0:0b799af9d58e 30 // TestRegistry is a collection of tests that can be run
rgrover1 0:0b799af9d58e 31 //
rgrover1 0:0b799af9d58e 32
rgrover1 0:0b799af9d58e 33 #ifndef D_TestRegistry_h
rgrover1 0:0b799af9d58e 34 #define D_TestRegistry_h
rgrover1 0:0b799af9d58e 35
rgrover1 0:0b799af9d58e 36 #include "SimpleString.h"
rgrover1 0:0b799af9d58e 37 #include "TestFilter.h"
rgrover1 0:0b799af9d58e 38
rgrover1 0:0b799af9d58e 39 class UtestShell;
rgrover1 0:0b799af9d58e 40 class TestResult;
rgrover1 0:0b799af9d58e 41 class TestPlugin;
rgrover1 0:0b799af9d58e 42
rgrover1 0:0b799af9d58e 43 class TestRegistry
rgrover1 0:0b799af9d58e 44 {
rgrover1 0:0b799af9d58e 45 public:
rgrover1 0:0b799af9d58e 46 TestRegistry();
rgrover1 0:0b799af9d58e 47 virtual ~TestRegistry();
rgrover1 0:0b799af9d58e 48
rgrover1 0:0b799af9d58e 49 virtual void addTest(UtestShell *test);
rgrover1 0:0b799af9d58e 50 virtual void unDoLastAddTest();
rgrover1 0:0b799af9d58e 51 virtual int countTests();
rgrover1 0:0b799af9d58e 52 virtual void runAllTests(TestResult& result);
rgrover1 0:0b799af9d58e 53 virtual void nameFilter(const TestFilter& filter);
rgrover1 0:0b799af9d58e 54 virtual void groupFilter(const TestFilter& filter);
rgrover1 0:0b799af9d58e 55
rgrover1 0:0b799af9d58e 56 virtual void installPlugin(TestPlugin* plugin);
rgrover1 0:0b799af9d58e 57 virtual void resetPlugins();
rgrover1 0:0b799af9d58e 58 virtual TestPlugin* getFirstPlugin();
rgrover1 0:0b799af9d58e 59 virtual TestPlugin* getPluginByName(const SimpleString& name);
rgrover1 0:0b799af9d58e 60 virtual void removePluginByName(const SimpleString& name);
rgrover1 0:0b799af9d58e 61 virtual int countPlugins();
rgrover1 0:0b799af9d58e 62
rgrover1 0:0b799af9d58e 63 TestFilter getGroupFilter();
rgrover1 0:0b799af9d58e 64 TestFilter getNameFilter();
rgrover1 0:0b799af9d58e 65
rgrover1 0:0b799af9d58e 66 virtual UtestShell* getFirstTest();
rgrover1 0:0b799af9d58e 67 virtual UtestShell* getLastTest();
rgrover1 0:0b799af9d58e 68 virtual UtestShell* getTestWithNext(UtestShell* test);
rgrover1 0:0b799af9d58e 69
rgrover1 0:0b799af9d58e 70 virtual UtestShell* findTestWithName(const SimpleString& name);
rgrover1 0:0b799af9d58e 71 virtual UtestShell* findTestWithGroup(const SimpleString& name);
rgrover1 0:0b799af9d58e 72
rgrover1 0:0b799af9d58e 73 static TestRegistry* getCurrentRegistry();
rgrover1 0:0b799af9d58e 74 virtual void setCurrentRegistry(TestRegistry* registry);
rgrover1 0:0b799af9d58e 75
rgrover1 0:0b799af9d58e 76 virtual void setRunTestsInSeperateProcess();
rgrover1 0:0b799af9d58e 77 private:
rgrover1 0:0b799af9d58e 78
rgrover1 0:0b799af9d58e 79 bool testShouldRun(UtestShell* test, TestResult& result);
rgrover1 0:0b799af9d58e 80 bool endOfGroup(UtestShell* test);
rgrover1 0:0b799af9d58e 81
rgrover1 0:0b799af9d58e 82 UtestShell * tests_;
rgrover1 0:0b799af9d58e 83 TestFilter nameFilter_;
rgrover1 0:0b799af9d58e 84 TestFilter groupFilter_;
rgrover1 0:0b799af9d58e 85 TestPlugin* firstPlugin_;
rgrover1 0:0b799af9d58e 86 static TestRegistry* currentRegistry_;
rgrover1 0:0b799af9d58e 87 bool runInSeperateProcess_;
rgrover1 0:0b799af9d58e 88
rgrover1 0:0b799af9d58e 89 };
rgrover1 0:0b799af9d58e 90
rgrover1 0:0b799af9d58e 91 #endif