C++ unit testing: Simple mocking of browser-table functions

4 files changed, 152 insertions, 2 deletions

diff --git a/ChangeLog b/ChangeLog
index 9228a0a..a28a84f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2012-11-30  Adam Domurad  <[email protected]>
+
+	Added a simple mechanism for mocking functions in the browser function
+	table. Can be expanded as needed.
+	* tests/cpp-unit-tests/main.cc: Call setup function, warn on browser 
+	function based memory leak.
+	* tests/cpp-unit-tests/browser_mock.cc: New, implements simple 
+	error-checking mocks of browser callbacks.
+	* tests/cpp-unit-tests/browser_mock.h: New, interface to mocking 
+	functions.
+
 2012-11-27  Jiri Vanek <[email protected]>
 
 	Better error reporting from applets
diff --git a/tests/cpp-unit-tests/browser_mock.cc b/tests/cpp-unit-tests/browser_mock.cc
new file mode 100644
index 0000000..040910b
--- /dev/null
+++ b/tests/cpp-unit-tests/browser_mock.cc
@@ -0,0 +1,79 @@
+/* Copyright (C) 2012 Red Hat
+
+ This file is part of IcedTea.
+
+ IcedTea is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2, or (at your option)
+ any later version.
+
+ IcedTea is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with IcedTea; see the file COPYING.  If not, write to the
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301 USA.
+
+ Linking this library statically or dynamically with other modules is
+ making a combined work based on this library.  Thus, the terms and
+ conditions of the GNU General Public License cover the whole
+ combination.
+
+ As a special exception, the copyright holders of this library give you
+ permission to link this library with independent modules to produce an
+ executable, regardless of the license terms of these independent
+ modules, and to copy and distribute the resulting executable under
+ terms of your choice, provided that you also meet, for each linked
+ independent module, the terms and conditions of the license of that
+ module.  An independent module is a module which is not derived from
+ or based on this library.  If you modify this library, you may extend
+ this exception to your version of the library, but you are not
+ obligated to do so.  If you do not wish to do so, delete this
+ exception statement from your version. */
+
+// Browser mock functions. Add more as needed.
+
+#include <cstring>
+#include <set>
+
+#include "UnitTest++.h"
+
+#include "browser_mock.h"
+
+#include "IcedTeaNPPlugin.h"
+
+static std::set<void*> __allocations;
+
+// It is expected that these will only run during a unit test
+static void* mock_memalloc(uint32_t size) {
+    void* mem = malloc(size);
+    __allocations.insert(mem);
+    return mem;
+}
+
+static void mock_memfree(void* ptr) {
+    if (__allocations.erase(ptr)) {
+        free(ptr);
+    } else {
+        printf("Attempt to free memory with browserfunctions.memfree that was not allocated by the browser!\n");
+        CHECK(false);
+    }
+}
+
+void browsermock_setup_functions() {
+    memset(&browser_functions, 0, sizeof(NPNetscapeFuncs));
+
+    browser_functions.memalloc = &mock_memalloc;
+    browser_functions.memfree = &mock_memfree;
+}
+
+void browsermock_clear_state() {
+    __allocations.clear();
+}
+
+int browsermock_unfreed_allocations() {
+    return __allocations.size();
+}
diff --git a/tests/cpp-unit-tests/browser_mock.h b/tests/cpp-unit-tests/browser_mock.h
new file mode 100644
index 0000000..d936215
--- /dev/null
+++ b/tests/cpp-unit-tests/browser_mock.h
@@ -0,0 +1,50 @@
+/* Copyright (C) 2012 Red Hat
+
+ This file is part of IcedTea.
+
+ IcedTea is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2, or (at your option)
+ any later version.
+
+ IcedTea is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with IcedTea; see the file COPYING.  If not, write to the
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301 USA.
+
+ Linking this library statically or dynamically with other modules is
+ making a combined work based on this library.  Thus, the terms and
+ conditions of the GNU General Public License cover the whole
+ combination.
+
+ As a special exception, the copyright holders of this library give you
+ permission to link this library with independent modules to produce an
+ executable, regardless of the license terms of these independent
+ modules, and to copy and distribute the resulting executable under
+ terms of your choice, provided that you also meet, for each linked
+ independent module, the terms and conditions of the license of that
+ module.  An independent module is a module which is not derived from
+ or based on this library.  If you modify this library, you may extend
+ this exception to your version of the library, but you are not
+ obligated to do so.  If you do not wish to do so, delete this
+ exception statement from your version. */
+
+// Browser mock functions.
+// This sets up a mock for unit testing purposes that puts simple
+// functions in the 'browserfunctions' table. This enables unit testing
+// of some functions that would otherwise not be possible.
+// Add additional mock functions in browser_mock.cc as needed
+
+#ifndef __BROWSER_MOCK_H__
+#define __BROWSER_MOCK_H__
+
+void browsermock_setup_functions();
+void browsermock_clear_state();
+int browsermock_unfreed_allocations();
+
+#endif // __BROWSER_MOCK_H__
diff --git a/tests/cpp-unit-tests/main.cc b/tests/cpp-unit-tests/main.cc
index d1b6c65..135644c 100644
--- a/tests/cpp-unit-tests/main.cc
+++ b/tests/cpp-unit-tests/main.cc
@@ -42,6 +42,8 @@
 #include <UnitTest++.h>
 #include <TestReporter.h>
 
+#include "browser_mock.h"
+
 using namespace UnitTest;
 
 class IcedteaWebUnitTestReporter: public TestReporter {
@@ -54,6 +56,7 @@ public:
     }
 
     virtual void ReportTestStart(const TestDetails& test) {
+        browsermock_clear_state();
         did_finish_correctly = true;
     }
 
@@ -69,6 +72,11 @@ public:
     virtual void ReportTestFinish(const TestDetails& details,
             float secondsElapsed) {
 
+        if (browsermock_unfreed_allocations() > 0) {
+            printf("*** WARNING: Memory leak! %d more NPAPI allocations than frees!\n",
+                    browsermock_unfreed_allocations());
+        }
+
         if (did_finish_correctly) {
             printf("Passed: %s\n", details.testName);
         }
@@ -99,7 +107,9 @@ static int run_icedtea_web_unit_tests() {
 }
 
 int main() {
-    return run_icedtea_web_unit_tests();
-}
+    browsermock_setup_functions();
 
+    int exitcode = run_icedtea_web_unit_tests();
 
+    return exitcode;
+}