CppUTest is a C /C++ based unit xUnit test framework for unit testing and for test-driving your code.

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.

Revision:
1:4769360130ed
Parent:
0:0b799af9d58e
--- a/include/CppUTest/CommandLineArguments.h	Tue Jan 28 09:27:41 2014 +0000
+++ b/include/CppUTest/CommandLineArguments.h	Tue Jun 17 15:52:54 2014 +0100
@@ -48,6 +48,7 @@
 	bool isJUnitOutput() const;
 	bool isEclipseOutput() const;
 	bool runTestsInSeperateProcess() const;
+	const SimpleString& getPackageName() const;
 	const char* usage() const;
 
 private:
@@ -65,6 +66,7 @@
 	TestFilter groupFilter_;
 	TestFilter nameFilter_;
 	OutputType outputType_;
+	SimpleString packageName_;
 
 	SimpleString getParameterField(int ac, const char** av, int& i, const SimpleString& parameterName);
 	void SetRepeatCount(int ac, const char** av, int& index);
@@ -74,6 +76,7 @@
 	void SetStrictNameFilter(int ac, const char** av, int& index);
 	void SetTestToRunBasedOnVerboseOutput(int ac, const char** av, int& index, const char* parameterName);
 	bool SetOutputType(int ac, const char** av, int& index);
+	void SetPackageName(int ac, const char** av, int& index);
 
 	CommandLineArguments(const CommandLineArguments&);
 	CommandLineArguments& operator=(const CommandLineArguments&);