C++ unit testing: Add a tracked-allocation implementation of operator-new

Two tests that catch memory leaks are also added.
For the purposes of verifying the patch works, the fix is in a separate changeset.

5 files changed, 239 insertions, 4 deletions

diff --git a/tests/cpp-unit-tests/IcedTeaScriptablePluginObjectTest.cc b/tests/cpp-unit-tests/IcedTeaScriptablePluginObjectTest.cc
new file mode 100644
index 0000000..65e4d16
--- /dev/null
+++ b/tests/cpp-unit-tests/IcedTeaScriptablePluginObjectTest.cc
@@ -0,0 +1,66 @@
+/* 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. */
+
+#include <UnitTest++.h>
+
+#include <npapi.h>
+
+#include "browser_mock.h"
+#include "checked_allocations.h"
+
+#include "IcedTeaScriptablePluginObject.h"
+
+SUITE(IcedTeaScriptableJavaObject) {
+    TEST(deallocate) {
+        int pre_allocations = cpp_unfreed_allocations();
+        IcedTeaScriptableJavaObject* obj = new IcedTeaScriptableJavaObject(NULL);
+        IcedTeaScriptableJavaObject::deAllocate(obj);
+        int post_allocations = cpp_unfreed_allocations();
+
+        CHECK(pre_allocations == post_allocations);
+    }
+}
+
+SUITE(IcedTeaScriptableJavaPackageObject) {
+    TEST(deallocate) {
+        int pre_allocations = cpp_unfreed_allocations();
+        IcedTeaScriptableJavaPackageObject* obj = new IcedTeaScriptableJavaPackageObject(NULL);
+        IcedTeaScriptableJavaPackageObject::deAllocate(obj);
+        int post_allocations = cpp_unfreed_allocations();
+
+        CHECK(pre_allocations == post_allocations);
+    }
+}
diff --git a/tests/cpp-unit-tests/browser_mock.cc b/tests/cpp-unit-tests/browser_mock.cc
index 040910b..6b01224 100644
--- a/tests/cpp-unit-tests/browser_mock.cc
+++ b/tests/cpp-unit-tests/browser_mock.cc
@@ -37,7 +37,7 @@
 // Browser mock functions. Add more as needed.
 
 #include <cstring>
-#include <set>
+#include "checked_allocations.h"
 
 #include "UnitTest++.h"
 
@@ -45,7 +45,7 @@
 
 #include "IcedTeaNPPlugin.h"
 
-static std::set<void*> __allocations;
+static AllocationSet __allocations;
 
 // It is expected that these will only run during a unit test
 static void* mock_memalloc(uint32_t size) {
@@ -63,11 +63,29 @@ static void mock_memfree(void* ptr) {
     }
 }
 
+static NPObject* mock_retainobject(NPObject* obj) {
+    obj->referenceCount++;
+    return obj;
+}
+
+static void mock_releaseobject(NPObject* obj) {
+    if (--(obj->referenceCount) == 0) {
+        if (obj->_class->deallocate) {
+            obj->_class->deallocate(obj);
+        } else {
+            free(obj);
+        }
+    }
+}
+
 void browsermock_setup_functions() {
     memset(&browser_functions, 0, sizeof(NPNetscapeFuncs));
 
     browser_functions.memalloc = &mock_memalloc;
     browser_functions.memfree = &mock_memfree;
+
+    browser_functions.retainobject = &mock_retainobject;
+    browser_functions.releaseobject= &mock_releaseobject;
 }
 
 void browsermock_clear_state() {
diff --git a/tests/cpp-unit-tests/checked_allocations.cc b/tests/cpp-unit-tests/checked_allocations.cc
new file mode 100644
index 0000000..573d489
--- /dev/null
+++ b/tests/cpp-unit-tests/checked_allocations.cc
@@ -0,0 +1,77 @@
+/* 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. */
+
+//  Overrides global 'new' operator with one that does error checking.
+
+#include <new>
+
+#include <UnitTest++.h>
+#include "checked_allocations.h"
+
+// We keep a set of allocations, that, for obvious reasons, does not itself use the 'new' operator.
+static AllocationSet* __allocations = NULL;
+
+// Override global definition of new and delete!
+void* operator new(size_t size) throw (std::bad_alloc) {
+    if (!__allocations) {
+        // This uses placement-new, which calls the constructor on a specific memory location
+        // This is needed because we cannot call 'new' in this context, nor can we rely on static-initialization
+        // for the set to occur before any call to 'new'!
+        void* memory = malloc(sizeof(AllocationSet));
+        __allocations = new (memory) AllocationSet();
+    }
+
+    void* mem = malloc(size);
+    if (mem == 0) {
+        throw std::bad_alloc(); // ANSI/ISO compliant behavior
+    }
+    __allocations->insert(mem);
+    return mem;
+}
+
+void operator delete(void* ptr) throw () {
+    if (__allocations->erase(ptr)) {
+        free(ptr);
+    } else {
+        printf(
+                "Attempt to free memory with operator 'delete' that was not allocated by 'new'!\n");
+        CHECK(false);
+    }
+}
+
+int cpp_unfreed_allocations() {
+    return __allocations->size();
+}
diff --git a/tests/cpp-unit-tests/checked_allocations.h b/tests/cpp-unit-tests/checked_allocations.h
new file mode 100644
index 0000000..0c9ce04
--- /dev/null
+++ b/tests/cpp-unit-tests/checked_allocations.h
@@ -0,0 +1,54 @@
+/* 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. */
+
+//  Overrides global 'new' operator with one that does error checking.
+
+#ifndef CHECKED_ALLOCATIONS_H_
+#define CHECKED_ALLOCATIONS_H_
+
+#include <set>
+#include <cstdio>
+#include <exception>
+#include <memory>
+#include <cstdlib>
+#include <ext/malloc_allocator.h> //GNU extension
+
+// Plays nice with custom-defined operator new
+typedef std::set<void*, std::less<void*>, __gnu_cxx::malloc_allocator<void*> > AllocationSet;
+
+int cpp_unfreed_allocations();
+
+#endif /* CHECKED_ALLOCATIONS_H_ */
diff --git a/tests/cpp-unit-tests/main.cc b/tests/cpp-unit-tests/main.cc
index 135644c..2afacf2 100644
--- a/tests/cpp-unit-tests/main.cc
+++ b/tests/cpp-unit-tests/main.cc
@@ -43,9 +43,19 @@
 #include <TestReporter.h>
 
 #include "browser_mock.h"
+#include "checked_allocations.h"
 
 using namespace UnitTest;
 
+static std::string full_testname(const TestDetails& details) {
+    std::string suite = details.suiteName;
+    if (suite == "DefaultSuite") {
+        return details.testName;
+    } else {
+        return suite + "." + details.testName;
+    }
+}
+
 class IcedteaWebUnitTestReporter: public TestReporter {
 public:
 
@@ -57,13 +67,15 @@ public:
 
     virtual void ReportTestStart(const TestDetails& test) {
         browsermock_clear_state();
+        pretest_allocs = cpp_unfreed_allocations();
         did_finish_correctly = true;
     }
 
     virtual void ReportFailure(const TestDetails& details,
             char const* failure) {
+        std::string testname = full_testname(details);
 
-        printf("FAILED: %s line %d (%s)\n", details.testName,
+        printf("FAILED: %s line %d (%s)\n", testname.c_str(),
                 details.lineNumber, failure);
 
         did_finish_correctly = false;
@@ -72,13 +84,20 @@ public:
     virtual void ReportTestFinish(const TestDetails& details,
             float secondsElapsed) {
 
+        int posttest_allocs = cpp_unfreed_allocations();
+
         if (browsermock_unfreed_allocations() > 0) {
             printf("*** WARNING: Memory leak! %d more NPAPI allocations than frees!\n",
                     browsermock_unfreed_allocations());
         }
+        if (posttest_allocs > pretest_allocs) {
+            printf("*** WARNING: Memory leak! %d more operator 'new' allocations than 'delete's!\n",
+                    posttest_allocs - pretest_allocs);
+        }
 
         if (did_finish_correctly) {
-            printf("Passed: %s\n", details.testName);
+            std::string testname = full_testname(details);
+            printf("Passed: %s\n", testname.c_str());
         }
     }
 
@@ -95,6 +114,7 @@ public:
     }
 
 private:
+    int pretest_allocs;
     bool did_finish_correctly;
 };