OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef BASE_TEST_MULTIPROCESS_TEST_H_ | 5 #ifndef BASE_TEST_MULTIPROCESS_TEST_H_ |
6 #define BASE_TEST_MULTIPROCESS_TEST_H_ | 6 #define BASE_TEST_MULTIPROCESS_TEST_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/macros.h" | 10 #include "base/macros.h" |
11 #include "base/process/launch.h" | 11 #include "base/process/launch.h" |
12 #include "base/process/process.h" | 12 #include "base/process/process.h" |
13 #include "build/build_config.h" | 13 #include "build/build_config.h" |
14 #include "testing/platform_test.h" | 14 #include "testing/platform_test.h" |
15 | 15 |
| 16 #if defined(OS_ANDROID) |
| 17 #include "base/android/scoped_java_ref.h" |
| 18 #endif |
| 19 |
16 namespace base { | 20 namespace base { |
17 | 21 |
18 class CommandLine; | 22 class CommandLine; |
19 | 23 |
| 24 struct SpawnChildResult { |
| 25 Process process; |
| 26 #if defined(OS_ANDROID) |
| 27 base::android::ScopedJavaGlobalRef<jobject> parcelable_channel_client; |
| 28 base::android::ScopedJavaGlobalRef<jobject> parcelable_channel_server; |
| 29 #endif |
| 30 }; |
| 31 |
20 // Helpers to spawn a child for a multiprocess test and execute a designated | 32 // 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 | 33 // 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 | 34 // fixture, but you want (some) of your tests to be multiprocess (otherwise you |
23 // may just want to derive your fixture from |MultiProcessTest|, below). | 35 // may just want to derive your fixture from |MultiProcessTest|, below). |
24 // | 36 // |
25 // Use these helpers as follows: | 37 // Use these helpers as follows: |
26 // | 38 // |
27 // TEST_F(MyTest, ATest) { | 39 // TEST_F(MyTest, ATest) { |
28 // CommandLine command_line( | 40 // CommandLine command_line( |
29 // base::GetMultiProcessTestChildBaseCommandLine()); | 41 // base::GetMultiProcessTestChildBaseCommandLine()); |
30 // // Maybe add our own switches to |command_line|.... | 42 // // Maybe add our own switches to |command_line|.... |
31 // | 43 // |
32 // LaunchOptions options; | 44 // LaunchOptions options; |
33 // // Maybe set some options (e.g., |start_hidden| on Windows).... | 45 // // Maybe set some options (e.g., |start_hidden| on Windows).... |
34 // | 46 // |
35 // // Start a child process and run |a_test_func|. | 47 // // Start a child process and run |a_test_func|. |
36 // base::Process test_child_process = | 48 // SpawnChildResult result = |
37 // base::SpawnMultiProcessTestChild("a_test_func", command_line, | 49 // base::SpawnMultiProcessTestChild("a_test_func", command_line, |
38 // options); | 50 // options); |
| 51 // base::Process test_child_process = std::move(result.process); |
39 // | 52 // |
40 // // Do stuff involving |test_child_process| and the child process.... | 53 // // Do stuff involving |test_child_process| and the child process.... |
41 // | 54 // |
42 // int rv = -1; | 55 // int rv = -1; |
43 // ASSERT_TRUE(base::WaitForMultiprocessTestChildExit(test_child_process, | 56 // ASSERT_TRUE(base::WaitForMultiprocessTestChildExit(test_child_process, |
44 // TestTimeouts::action_timeout(), &rv)); | 57 // TestTimeouts::action_timeout(), &rv)); |
45 // EXPECT_EQ(0, rv); | 58 // EXPECT_EQ(0, rv); |
46 // } | 59 // } |
47 // | 60 // |
48 // // Note: |MULTIPROCESS_TEST_MAIN()| is defined in | 61 // // Note: |MULTIPROCESS_TEST_MAIN()| is defined in |
49 // // testing/multi_process_function_list.h. | 62 // // testing/multi_process_function_list.h. |
50 // MULTIPROCESS_TEST_MAIN(a_test_func) { | 63 // MULTIPROCESS_TEST_MAIN(a_test_func) { |
51 // // Code here runs in a child process.... | 64 // // Code here runs in a child process.... |
52 // return 0; | 65 // return 0; |
53 // } | 66 // } |
54 // | 67 // |
55 // If you need to terminate the child process, use the | 68 // If you need to terminate the child process, use the |
56 // TerminateMultiProcessTestChild method to ensure that test will work on | 69 // TerminateMultiProcessTestChild method to ensure that test will work on |
57 // Android. | 70 // Android. |
58 | 71 |
59 // Spawns a child process and executes the function |procname| declared using | 72 // Spawns a child process and executes the function |procname| declared using |
60 // |MULTIPROCESS_TEST_MAIN()| or |MULTIPROCESS_TEST_MAIN_WITH_SETUP()|. | 73 // |MULTIPROCESS_TEST_MAIN()| or |MULTIPROCESS_TEST_MAIN_WITH_SETUP()|. |
61 // |command_line| should be as provided by | 74 // |command_line| should be as provided by |
62 // |GetMultiProcessTestChildBaseCommandLine()| (below), possibly with arguments | 75 // |GetMultiProcessTestChildBaseCommandLine()| (below), possibly with arguments |
63 // added. Note: On Windows, you probably want to set |options.start_hidden|. | 76 // added. Note: On Windows, you probably want to set |options.start_hidden|. |
64 Process SpawnMultiProcessTestChild( | 77 SpawnChildResult SpawnMultiProcessTestChild(const std::string& procname, |
65 const std::string& procname, | 78 const CommandLine& command_line, |
66 const CommandLine& command_line, | 79 const LaunchOptions& options); |
67 const LaunchOptions& options); | |
68 | 80 |
69 // Gets the base command line for |SpawnMultiProcessTestChild()|. To this, you | 81 // Gets the base command line for |SpawnMultiProcessTestChild()|. To this, you |
70 // may add any flags needed for your child process. | 82 // may add any flags needed for your child process. |
71 CommandLine GetMultiProcessTestChildBaseCommandLine(); | 83 CommandLine GetMultiProcessTestChildBaseCommandLine(); |
72 | 84 |
73 // Waits for the child process to exit. Returns true if the process exited | 85 // Waits for the child process to exit. Returns true if the process exited |
74 // within |timeout| and sets |exit_code| if non null. | 86 // within |timeout| and sets |exit_code| if non null. |
75 bool WaitForMultiprocessTestChildExit(const Process& process, | 87 bool WaitForMultiprocessTestChildExit(const Process& process, |
76 TimeDelta timeout, | 88 TimeDelta timeout, |
77 int* exit_code); | 89 int* exit_code); |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
114 // 'procname' is the name of a function which the child will | 126 // 'procname' is the name of a function which the child will |
115 // execute. It must be exported from this library in order to | 127 // execute. It must be exported from this library in order to |
116 // run. | 128 // run. |
117 // | 129 // |
118 // Example signature: | 130 // Example signature: |
119 // extern "C" int __declspec(dllexport) FooBar() { | 131 // extern "C" int __declspec(dllexport) FooBar() { |
120 // // do client work here | 132 // // do client work here |
121 // } | 133 // } |
122 // | 134 // |
123 // Returns the child process. | 135 // Returns the child process. |
124 Process SpawnChild(const std::string& procname); | 136 SpawnChildResult SpawnChild(const std::string& procname); |
125 | 137 |
126 // Run a child process using the given launch options. | 138 // Run a child process using the given launch options. |
127 // | 139 // |
128 // Note: On Windows, you probably want to set |options.start_hidden|. | 140 // Note: On Windows, you probably want to set |options.start_hidden|. |
129 Process SpawnChildWithOptions(const std::string& procname, | 141 SpawnChildResult SpawnChildWithOptions(const std::string& procname, |
130 const LaunchOptions& options); | 142 const LaunchOptions& options); |
131 | 143 |
132 // Set up the command line used to spawn the child process. | 144 // Set up the command line used to spawn the child process. |
133 // Override this to add things to the command line (calling this first in the | 145 // Override this to add things to the command line (calling this first in the |
134 // override). | 146 // override). |
135 // Note that currently some tests rely on this providing a full command line, | 147 // Note that currently some tests rely on this providing a full command line, |
136 // which they then use directly with |LaunchProcess()|. | 148 // which they then use directly with |LaunchProcess()|. |
137 // TODO(viettrungluu): Remove this and add a virtual | 149 // TODO(viettrungluu): Remove this and add a virtual |
138 // |ModifyChildCommandLine()|; make the two divergent uses more sane. | 150 // |ModifyChildCommandLine()|; make the two divergent uses more sane. |
139 virtual CommandLine MakeCmdLine(const std::string& procname); | 151 virtual CommandLine MakeCmdLine(const std::string& procname); |
140 | 152 |
141 private: | 153 private: |
142 DISALLOW_COPY_AND_ASSIGN(MultiProcessTest); | 154 DISALLOW_COPY_AND_ASSIGN(MultiProcessTest); |
143 }; | 155 }; |
144 | 156 |
145 } // namespace base | 157 } // namespace base |
146 | 158 |
147 #endif // BASE_TEST_MULTIPROCESS_TEST_H_ | 159 #endif // BASE_TEST_MULTIPROCESS_TEST_H_ |
OLD | NEW |