Rohit Grover / CppUTest-mbed-port

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.

Diff: include/CppUTest/TestRegistry.h

Revision:
0:0b799af9d58e
diff -r 000000000000 -r 0b799af9d58e include/CppUTest/TestRegistry.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/include/CppUTest/TestRegistry.h	Tue Jan 28 09:27:41 2014 +0000
@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2007, Michael Feathers, James Grenning and Bas Vodde
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the <organization> nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE EARLIER MENTIONED AUTHORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+///////////////////////////////////////////////////////////////////////////////
+//
+// TestRegistry is a collection of tests that can be run
+//
+
+#ifndef D_TestRegistry_h
+#define D_TestRegistry_h
+
+#include "SimpleString.h"
+#include "TestFilter.h"
+
+class UtestShell;
+class TestResult;
+class TestPlugin;
+
+class TestRegistry
+{
+public:
+	TestRegistry();
+	virtual ~TestRegistry();
+
+	virtual void addTest(UtestShell *test);
+	virtual void unDoLastAddTest();
+	virtual int countTests();
+	virtual void runAllTests(TestResult& result);
+	virtual void nameFilter(const TestFilter& filter);
+	virtual void groupFilter(const TestFilter& filter);
+
+	virtual void installPlugin(TestPlugin* plugin);
+	virtual void resetPlugins();
+	virtual TestPlugin* getFirstPlugin();
+	virtual TestPlugin* getPluginByName(const SimpleString& name);
+	virtual void removePluginByName(const SimpleString& name);
+	virtual int countPlugins();
+
+	TestFilter getGroupFilter();
+	TestFilter getNameFilter();
+
+	virtual UtestShell* getFirstTest();
+	virtual UtestShell* getLastTest();
+	virtual UtestShell* getTestWithNext(UtestShell* test);
+
+	virtual UtestShell* findTestWithName(const SimpleString& name);
+	virtual UtestShell* findTestWithGroup(const SimpleString& name);
+
+	static TestRegistry* getCurrentRegistry();
+	virtual void setCurrentRegistry(TestRegistry* registry);
+
+	virtual void setRunTestsInSeperateProcess();
+private:
+
+	bool testShouldRun(UtestShell* test, TestResult& result);
+	bool endOfGroup(UtestShell* test);
+
+	UtestShell * tests_;
+	TestFilter nameFilter_;
+	TestFilter groupFilter_;
+	TestPlugin* firstPlugin_;
+	static TestRegistry* currentRegistry_;
+	bool runInSeperateProcess_;
+
+};
+
+#endif