1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef BASE_TEST_MULTIPROCESS_TEST_H_ 6 #define BASE_TEST_MULTIPROCESS_TEST_H_ 7 8 #include <string> 9 10 #include "base/macros.h" 11 #include "base/process/launch.h" 12 #include "base/process/process.h" 13 #include "build/build_config.h" 14 #include "testing/platform_test.h" 15 16 namespace base { 17 18 class CommandLine; 19 20 // Helpers to spawn a child for a multiprocess test and execute a designated 21 // function. Use these when you already have another base class for your test 22 // fixture, but you want (some) of your tests to be multiprocess (otherwise you 23 // may just want to derive your fixture from |MultiProcessTest|, below). 24 // 25 // Use these helpers as follows: 26 // 27 // TEST_F(MyTest, ATest) { 28 // CommandLine command_line( 29 // base::GetMultiProcessTestChildBaseCommandLine()); 30 // // Maybe add our own switches to |command_line|.... 31 // 32 // LaunchOptions options; 33 // // Maybe set some options (e.g., |start_hidden| on Windows).... 34 // 35 // // Start a child process and run |a_test_func|. 36 // base::Process test_child_process = 37 // base::SpawnMultiProcessTestChild("a_test_func", command_line, 38 // options); 39 // 40 // // Do stuff involving |test_child_process| and the child process.... 41 // 42 // int rv = -1; 43 // ASSERT_TRUE(base::WaitForMultiprocessTestChildExit(test_child_process, 44 // TestTimeouts::action_timeout(), &rv)); 45 // EXPECT_EQ(0, rv); 46 // } 47 // 48 // // Note: |MULTIPROCESS_TEST_MAIN()| is defined in 49 // // testing/multi_process_function_list.h. 50 // MULTIPROCESS_TEST_MAIN(a_test_func) { 51 // // Code here runs in a child process.... 52 // return 0; 53 // } 54 // 55 // If you need to terminate the child process, use the 56 // TerminateMultiProcessTestChild method to ensure that test will work on 57 // Android. 58 59 // Spawns a child process and executes the function |procname| declared using 60 // |MULTIPROCESS_TEST_MAIN()| or |MULTIPROCESS_TEST_MAIN_WITH_SETUP()|. 61 // |command_line| should be as provided by 62 // |GetMultiProcessTestChildBaseCommandLine()| (below), possibly with arguments 63 // added. Note: On Windows, you probably want to set |options.start_hidden|. 64 Process SpawnMultiProcessTestChild(const std::string& procname, 65 const CommandLine& command_line, 66 const LaunchOptions& options); 67 68 // Gets the base command line for |SpawnMultiProcessTestChild()|. To this, you 69 // may add any flags needed for your child process. 70 CommandLine GetMultiProcessTestChildBaseCommandLine(); 71 72 // Waits for the child process to exit. Returns true if the process exited 73 // within |timeout| and sets |exit_code| if non null. 74 bool WaitForMultiprocessTestChildExit(const Process& process, 75 TimeDelta timeout, 76 int* exit_code); 77 78 // Terminates |process| with |exit_code|. If |wait| is true, this call blocks 79 // until the process actually terminates. 80 bool TerminateMultiProcessTestChild(const Process& process, 81 int exit_code, 82 bool wait); 83 84 // MultiProcessTest ------------------------------------------------------------ 85 86 // A MultiProcessTest is a test class which makes it easier to 87 // write a test which requires code running out of process. 88 // 89 // To create a multiprocess test simply follow these steps: 90 // 91 // 1) Derive your test from MultiProcessTest. Example: 92 // 93 // class MyTest : public MultiProcessTest { 94 // }; 95 // 96 // TEST_F(MyTest, TestCaseName) { 97 // ... 98 // } 99 // 100 // 2) Create a mainline function for the child processes and include 101 // testing/multiprocess_func_list.h. 102 // See the declaration of the MULTIPROCESS_TEST_MAIN macro 103 // in that file for an example. 104 // 3) Call SpawnChild("foo"), where "foo" is the name of 105 // the function you wish to run in the child processes. 106 // That's it! 107 class MultiProcessTest : public PlatformTest { 108 public: 109 MultiProcessTest(); 110 111 protected: 112 // Run a child process. 113 // 'procname' is the name of a function which the child will 114 // execute. It must be exported from this library in order to 115 // run. 116 // 117 // Example signature: 118 // extern "C" int __declspec(dllexport) FooBar() { 119 // // do client work here 120 // } 121 // 122 // Returns the child process. 123 Process SpawnChild(const std::string& procname); 124 125 // Run a child process using the given launch options. 126 // 127 // Note: On Windows, you probably want to set |options.start_hidden|. 128 Process SpawnChildWithOptions(const std::string& procname, 129 const LaunchOptions& options); 130 131 // Set up the command line used to spawn the child process. 132 // Override this to add things to the command line (calling this first in the 133 // override). 134 // Note that currently some tests rely on this providing a full command line, 135 // which they then use directly with |LaunchProcess()|. 136 // TODO(viettrungluu): Remove this and add a virtual 137 // |ModifyChildCommandLine()|; make the two divergent uses more sane. 138 virtual CommandLine MakeCmdLine(const std::string& procname); 139 140 private: 141 DISALLOW_COPY_AND_ASSIGN(MultiProcessTest); 142 }; 143 144 } // namespace base 145 146 #endif // BASE_TEST_MULTIPROCESS_TEST_H_ 147
