15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_TEST_TEST_SUITE_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_TEST_TEST_SUITE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Defines a basic test suite framework for running gtest based tests. You can 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// instantiate this class in your main function and call its Run method to run 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// any gtest based tests that are linked into your executable. 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/at_exit.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 161320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/test/trace_to_file.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace testing { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TestInfo; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 24f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)// Instantiates TestSuite, runs it and returns exit code. 25f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)int RunUnitTestsUsingBaseTestSuite(int argc, char **argv); 26f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TestSuite { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Match function used by the GetTestCount method. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef bool (*TestMatch)(const testing::TestInfo&); 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TestSuite(int argc, char** argv); 33f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#if defined(OS_WIN) 34f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) TestSuite(int argc, wchar_t** argv); 35f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#endif // defined(OS_WIN) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~TestSuite(); 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the test is marked as "MAYBE_". 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // When using different prefixes depending on platform, we use MAYBE_ and 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // preprocessor directives to replace MAYBE_ with the target prefix. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool IsMarkedMaybe(const testing::TestInfo& test); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CatchMaybeTests(); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ResetCommandLine(); 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 47424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) void AddTestLauncherResultPrinter(); 48424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int Run(); 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This constructor is only accessible to specialized test suite 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // implementations which need to control the creation of an AtExitManager 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // instance for the duration of the test. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TestSuite(int argc, char** argv, bool create_at_exit_manager); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // By default fatal log messages (e.g. from DCHECKs) result in error dialogs 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // which gum up buildbots. Use a minimalistic assert handler which just 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // terminates the process. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnitTestAssertHandler(const std::string& str); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Disable crash dialogs so that it doesn't gum up the buildbot 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SuppressErrorDialogs(); 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Override these for custom initialization and shutdown handling. Use these 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // instead of putting complex code in your constructor/destructor. 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Initialize(); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Shutdown(); 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Make sure that we setup an AtExitManager so Singleton objects will be 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // destroyed. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<base::AtExitManager> at_exit_manager_; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 76f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) void InitializeFromCommandLine(int argc, char** argv); 77f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#if defined(OS_WIN) 78f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) void InitializeFromCommandLine(int argc, wchar_t** argv); 79f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#endif // defined(OS_WIN) 80f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Basic initialization for the test suite happens here. 82f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) void PreInitialize(bool create_at_exit_manager); 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 841320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci test::TraceToFile trace_to_file_; 851320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool initialized_command_line_; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(TestSuite); 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace base 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TODO(brettw) remove this. This is a temporary hack to allow WebKit to compile 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// until we can update it to use "base::" (preventing a two-sided patch). 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)using base::TestSuite; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // BASE_TEST_TEST_SUITE_H_ 98