Merge pull request #706 from eightyeight/add-gtest

Add Google test library

Engine/source/testing/memoryTester.h

@@ -0,0 +1,64 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2013 Stephan Brenner https://github.com/ymx/gtest_mem
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+#include <iostream>
+#include <gtest/gtest.h>
+
+#if defined(TORQUE_OS_WIN)
+#define _CRTDBG_MAP_ALLOC
+#include <crtdbg.h>
+#endif
+
+namespace testing
+{
+   class MemoryLeakDetector : public EmptyTestEventListener
+   {
+   public:
+      virtual void OnTestStart(const TestInfo&)
+      {
+#if defined(TORQUE_OS_WIN)
+         _CrtMemCheckpoint(&memState_);
+#endif
+      }
+
+      virtual void OnTestEnd(const TestInfo& test_info)
+      {
+         if(test_info.result()->Passed())
+         {
+#if defined(TORQUE_OS_WIN)
+            _CrtMemState stateNow, stateDiff;
+            _CrtMemCheckpoint(&stateNow);
+            int diffResult = _CrtMemDifference(&stateDiff, &memState_, &stateNow);
+            if (diffResult)
+            {
+               FAIL() << "Memory leak of " << stateDiff.lSizes[1] << " byte(s) detected.";
+            }
+#endif
+         }
+      }
+
+   private:
+#if defined(TORQUE_OS_WIN)
+      _CrtMemState memState_;
+#endif
+   };
+}

Engine/source/testing/unitTesting.cpp

@@ -0,0 +1,108 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2014 GarageGames, LLC
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+#ifdef TORQUE_TESTS_ENABLED
+
+#include "console/engineAPI.h"
+#include "console/consoleInternal.h"
+#include "unitTesting.h"
+#include "memoryTester.h"
+
+#include <gtest/gtest-all.cc>
+
+//-----------------------------------------------------------------------------
+
+class TorqueUnitTestListener : public ::testing::EmptyTestEventListener
+{
+   // Called before a test starts.
+   virtual void OnTestStart( const ::testing::TestInfo& testInfo )
+   {
+      Con::printf("> Starting Test '%s.%s'",
+         testInfo.test_case_name(), testInfo.name());
+   }
+
+   // Called after a failed assertion or a SUCCEED() invocation.
+   virtual void OnTestPartResult( const ::testing::TestPartResult& testPartResult )
+   {
+      if ( testPartResult.failed() )
+      {
+         Con::warnf(">> Failed with '%s' in '%s' at (line:%d)",
+            testPartResult.summary(),
+            testPartResult.file_name(),
+            testPartResult.line_number()
+            );
+      }
+      else
+      {
+         Con::printf(">> Passed with '%s' in '%s' at (line:%d)",
+            testPartResult.summary(),
+            testPartResult.file_name(),
+            testPartResult.line_number()
+            );
+      }
+   }
+
+   // Called after a test ends.
+   virtual void OnTestEnd( const ::testing::TestInfo& testInfo )
+   {
+      Con::printf("> Ending Test '%s.%s'\n",
+         testInfo.test_case_name(), testInfo.name());
+   }
+};
+
+DefineConsoleFunction( runAllUnitTests, int, (),,
+                      "" )
+{
+   // Set-up some empty arguments.
+   S32 testArgc = 0;
+   char** testArgv = NULL;
+
+   // Initialize Google Test.
+   testing::InitGoogleTest( &testArgc, testArgv );
+
+   // Fetch the unit test instance.
+   testing::UnitTest& unitTest = *testing::UnitTest::GetInstance();
+
+   // Fetch the unit test event listeners.
+   testing::TestEventListeners& listeners = unitTest.listeners();
+
+   // Release the default listener.
+   delete listeners.Release( listeners.default_result_printer() );
+
+   if ( Con::getBoolVariable( "$testing::checkMemoryLeaks", false ) ) {
+      // Add the memory leak tester.
+      listeners.Append( new testing::MemoryLeakDetector );
+   }
+
+   // Add the Torque unit test listener.
+   listeners.Append( new TorqueUnitTestListener );
+
+   Con::printf( "\nUnit Tests Starting...\n" );
+
+   const S32 result = RUN_ALL_TESTS();
+
+   Con::printf( "\n... Unit Tests Ended.\n" );
+
+   return result;
+}
+
+#endif // TORQUE_TESTS_ENABLED

Engine/source/testing/unitTesting.h

@@ -0,0 +1,43 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2014 GarageGames, LLC
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+#ifndef _UNIT_TESTING_H_
+#define _UNIT_TESTING_H_
+
+#ifdef TORQUE_TESTS_ENABLED
+
+#include <gtest/gtest.h>
+
+/// Allow test fixtures named with a Fixture suffix, so that we can name tests
+/// after a class name rather than having to call them XXTest.
+#define TEST_FIX(test_fixture, test_name)\
+   GTEST_TEST_(test_fixture, test_name, test_fixture##Fixture, \
+   ::testing::internal::GetTypeId<test_fixture##Fixture>())
+
+/// Convenience to define a test fixture with a Fixture suffix for use with
+/// TEST_FIX.
+#define FIXTURE(test_fixture)\
+   class test_fixture##Fixture : public ::testing::Test
+
+#endif // TORQUE_TESTS_ENABLED
+
+#endif // _UNIT_TESTING_H_