Made a Plugin for checking expectations so that its not easily forgotten

examples/AllTests/AllTests.cpp

@@ -27,9 +27,13 @@
 
 #include "CppUTest/CommandLineTestRunner.h"
 #include "CppUTest/TestPlugin.h"
+#include "CppUTest/TestRegistry.h"
+#include "CppUTestExt/MockSupportPlugin.h"
 
 int main(int ac, char** av)
 {
+	MockSupportPlugin mockPlugin;
+	TestRegistry::getCurrentRegistry()->installPlugin(&mockPlugin);
 	return CommandLineTestRunner::RunAllTests(ac, av);
 }
 

examples/ApplicationLib/EventDispatcherTest.cpp

@@ -53,7 +53,6 @@ TEST_GROUP(EventDispatcher)
 TEST(EventDispatcher, EventWithoutRegistrationsResultsIntoNoCalls)
 {
 	dispatcher->dispatchEvent(event, 10);
-	mock().checkExpectations();
 }
 
 TEST(EventDispatcher, EventWithRegistrationForEventResultsIntoCallback)
@@ -63,7 +62,6 @@ TEST(EventDispatcher, EventWithRegistrationForEventResultsIntoCallback)
 
 	dispatcher->registerObserver(IMPORTANT_EVENT, &observer);
 	dispatcher->dispatchEvent(event, 10);
-	mock().checkExpectations();
 }
 
 TEST(EventDispatcher, DifferentEventWithRegistrationDoesNotResultIntoCallback)
@@ -84,5 +82,4 @@ TEST(EventDispatcher, RegisterTwoObserversResultIntoTwoCallsAndARegistrationNoti
 	dispatcher->registerObserver(IMPORTANT_EVENT, &observer);
 	dispatcher->registerObserver(IMPORTANT_EVENT, &observer);
 	dispatcher->dispatchEvent(event, 10);
-	mock().checkExpectations();
 }

include/CppUTestExt/MockSupportPlugin.h

@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+
+#ifndef D_MockSupportPlugin_h
+#define D_MockSupportPlugin_h
+
+#include "CppUTest/TestPlugin.h"
+
+class MockSupportPlugin : public TestPlugin
+{
+public:
+	MockSupportPlugin(const SimpleString& name = "MockSupportPLugin");
+
+	virtual void postTestAction(Utest&, TestResult&);
+
+};
+
+#endif

src/CppUTestExt/MockSupportPlugin.cpp

@@ -0,0 +1,65 @@
+/*
+ * 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.
+ */
+
+#include "CppUTest/TestHarness.h"
+#include "CppUTestExt/MockSupport.h"
+#include "CppUTestExt/MockSupportPlugin.h"
+
+class MockSupportPluginReporter : public MockFailureReporter
+{
+	Utest& test_;
+	TestResult& result_;
+public:
+	MockSupportPluginReporter(Utest& test, TestResult& result)
+		: test_(test), result_(result)
+	{
+	}
+
+	virtual void failTest(const MockFailure& failure)
+	{
+		result_.addFailure(failure);
+	}
+
+	virtual Utest* getTestToFail()
+	{
+		return &test_;
+	}
+};
+
+MockSupportPlugin::MockSupportPlugin(const SimpleString& name)
+	: TestPlugin(name)
+{
+}
+
+void MockSupportPlugin::postTestAction(Utest& test, TestResult& result)
+{
+	MockSupportPluginReporter reporter(test, result);
+	mock().setMockFailureReporter(&reporter);
+	mock().checkExpectations();
+	mock().clear();
+	mock().setMockFailureReporter(NULL);
+}

tests/CppUTestExt/AllTests.cpp

@@ -28,11 +28,14 @@
 #include "CppUTest/CommandLineTestRunner.h"
 #include "CppUTest/TestRegistry.h"
 #include "CppUTestExt/MemoryReporterPlugin.h"
+#include "CppUTestExt/MockSupportPlugin.h"
 
 int main(int ac, const char** av)
 {
 	MemoryReporterPlugin plugin;
+	MockSupportPlugin mockPlugin;
 	TestRegistry::getCurrentRegistry()->installPlugin(&plugin);
+	TestRegistry::getCurrentRegistry()->installPlugin(&mockPlugin);
 	return CommandLineTestRunner::RunAllTests(ac, av);
 }
 

tests/CppUTestExt/TestMockPlugin.cpp

@@ -0,0 +1,56 @@
+/*
+ * 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.
+ */
+#include "CppUTest/TestHarness.h"
+#include "CppUTest/TestOutput.h"
+#include "CppUTestExt/MockSupport.h"
+#include "CppUTestExt/MockSupportPlugin.h"
+
+TEST_GROUP(MockPlugin)
+{
+};
+
+TEST(MockPlugin, checkExpectationsAndClearAtEnd)
+{
+	Utest test("group", "name", "file", 1);
+	StringBufferTestOutput output;
+	TestResult result(output);
+
+	MockExpectedFunctionsList expectationsList;
+	MockExpectedFunctionCall call;
+	call.withName("foobar");
+	expectationsList.addExpectedCall(&call);
+	MockExpectedCallsDidntHappenFailure expectedFailure(&test, expectationsList);
+
+	MockSupportPlugin plugin;
+	mock().expectOneCall("foobar");
+
+	plugin.postTestAction(test, result);
+
+	STRCMP_CONTAINS(expectedFailure.getMessage().asCharString(), output.getOutput().asCharString())
+	LONGS_EQUAL(0, mock().expectedCallsLeft());
+//	clear makes sure there are no memory leaks.
+}