source/test_setup.cpp

   1 /* Copyright (C) 2014 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 // Got to be consistent with what the rest of the source files do before
  19 // including precompiled.h, so that the PCH works correctly
  20 #ifndef CXXTEST_RUNNING
  21 #define CXXTEST_RUNNING
  22 #endif
  23 #define _CXXTEST_HAVE_STD
  24
  25 #include "precompiled.h"
  26
  27 #include <fstream>
  28
  29 #include "lib/self_test.h"
  30 #include <cxxtest/GlobalFixture.h>
  31
  32 #if OS_WIN
  33 #include "lib/sysdep/os/win/wdbg_heap.h"
  34 #endif
  35
  36 #include "lib/timer.h"
  37 #include "lib/sysdep/sysdep.h"
  38 #include "ps/Profiler2.h"
  39 #include "scriptinterface/ScriptInterface.h"
  40
  41 class LeakReporter : public CxxTest::GlobalFixture
  42 {
  43         virtual bool tearDownWorld()
  44         {
  45                 // Shut down JS to prevent leak reports from it
  46                 ScriptInterface::ShutDown();
  47
  48                 // Enable leak reporting on exit.
  49                 // (This is done in tearDownWorld so that it doesn't report 'leaks'
  50                 // if the program is aborted before finishing cleanly.)
  51 #if OS_WIN
  52                 wdbg_heap_Enable(true);
  53 #endif
  54                 return true;
  55         }
  56
  57         virtual bool setUpWorld()
  58         {
  59 #if MSC_VERSION
  60                 // (Warning: the allocation numbers seem to differ by 3 when you
  61                 // run in the build process vs the debugger)
  62                 // _CrtSetBreakAlloc(1952);
  63 #endif
  64                 return true;
  65         }
  66
  67 };
  68
  69 class MiscSetup : public CxxTest::GlobalFixture
  70 {
  71         virtual bool setUpWorld()
  72         {
  73                 // Timer must be initialised, else things will break when tests do IO
  74                 timer_LatchStartTime();
  75
  76 #if OS_MACOSX || OS_BSD
  77                 // See comment in GameSetup.cpp FixLocales
  78                 setlocale(LC_CTYPE, "UTF-8");
  79 #endif
  80
  81                 ThreadUtil::SetMainThread();
  82
  83                 g_Profiler2.Initialise();
  84                 g_ScriptRuntime = ScriptInterface::CreateRuntime();
  85
  86                 return true;
  87         }
  88
  89         virtual bool tearDownWorld()
  90         {
  91                 g_ScriptRuntime.reset();
  92                 g_Profiler2.Shutdown();
  93
  94                 return true;
  95         }
  96 };
  97
  98 static LeakReporter leakReporter;
  99 static MiscSetup miscSetup;
 100
 101 // Definition of functions from lib/self_test.h
 102
 103 bool ts_str_contains(const std::string& str1, const std::string& str2)
 104 {
 105         return str1.find(str2) != str1.npos;
 106 }
 107
 108 bool ts_str_contains(const std::wstring& str1, const std::wstring& str2)
 109 {
 110         return str1.find(str2) != str1.npos;
 111 }
 112
 113 // we need the (version-controlled) binaries/data directory because it
 114 // contains input files (it is assumed that developer's machines have
 115 // write access to those directories). note that argv0 isn't
 116 // available, so we use sys_ExecutablePathname.
 117 OsPath DataDir()
 118 {
 119         return sys_ExecutablePathname().Parent()/".."/"data";
 120 }
 121
 122 // Script-based testing setup:
 123
 124 namespace
 125 {
 126         void script_TS_FAIL(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const std::wstring& msg)
 127         {
 128                 TS_FAIL(msg);
 129         }
 130 }
 131
 132 void ScriptTestSetup(ScriptInterface& ifc)
 133 {
 134         ifc.RegisterFunction<void, std::wstring, script_TS_FAIL>("TS_FAIL");
 135
 136         // Load the TS_* function definitions
 137         // (We don't use VFS because tests might not have the normal VFS paths loaded)
 138         OsPath path = DataDir()/"tests"/"test_setup.js";
 139         std::ifstream ifs(OsString(path).c_str());
 140         ENSURE(ifs.good());
 141         std::string content((std::istreambuf_iterator<char>(ifs)), std::istreambuf_iterator<char>());
 142         bool ok = ifc.LoadScript(L"test_setup.js", content);
 143         ENSURE(ok);
 144 }