Torque3D/Engine/source/testing/unitTesting.cpp

//-----------------------------------------------------------------------------
// 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 )
   {
      if( mVerbose )
         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)\n",
            testPartResult.summary(),
            testPartResult.file_name(),
            testPartResult.line_number()
            );
      }
      else if( mVerbose )
      {
         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 )
   {
      if( mVerbose )
         Con::printf("> Ending Test '%s.%s'\n",
            testInfo.test_case_name(), testInfo.name());
   }

   bool mVerbose;

public:
   TorqueUnitTestListener( bool verbose ) : mVerbose( verbose ) {}
};

DefineConsoleFunction( runAllUnitTests, int, (const char* testSpecs), (""),
   "Runs engine unit tests. Some tests are marked as 'stress' tests which do not "
   "necessarily check correctness, just performance or possible nondeterministic "
   "glitches. There may also be interactive or networking tests which may be "
   "excluded by using the testSpecs argument.\n"
   "This function should only be called once per executable run, because of "
   "googletest's design.\n\n"

   "@param testSpecs A space-sepatated list of filters for test cases. "
   "See https://code.google.com/p/googletest/wiki/AdvancedGuide#Running_a_Subset_of_the_Tests "
   "and http://stackoverflow.com/a/14021997/945863 "
   "for a description of the flag format.")
{
   S32 testArgc = 0;
   char** testArgv = NULL;
   if ( dStrlen( testSpecs ) > 0 )
   {
      String specs(testSpecs);
      specs.replace(' ', ':');
      specs.insert(0, "--gtest_filter=");
      testArgc = 2;
      testArgv = new char*[2];
      testArgv[0] = NULL; // Program name is unused by googletest.
      testArgv[1] = new char[specs.length()+1];
      dStrcpy(testArgv[1], specs);
   }

   // 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(false) );

   // Perform googletest run.
   Con::printf( "\nUnit Tests Starting...\n" );
   const S32 result = RUN_ALL_TESTS();
   Con::printf( "... Unit Tests Ended.\n" );

   return result;
}

#endif // TORQUE_TESTS_ENABLED