OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 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 // TestBrowserThreadBundle is a convenience class for creating a set of | 5 // TestBrowserThreadBundle is a convenience class for creating a set of |
6 // TestBrowserThreads, a blocking pool, and a task scheduler in unit tests. For | 6 // TestBrowserThreads, a blocking pool, and a task scheduler in unit tests. For |
7 // most tests, it is sufficient to just instantiate the TestBrowserThreadBundle | 7 // most tests, it is sufficient to just instantiate the TestBrowserThreadBundle |
8 // as a member variable. It is a good idea to put the TestBrowserThreadBundle as | 8 // as a member variable. It is a good idea to put the TestBrowserThreadBundle as |
9 // the first member variable in test classes, so it is destroyed last, and the | 9 // the first member variable in test classes, so it is destroyed last, and the |
10 // test threads always exist from the perspective of other classes. | 10 // test threads always exist from the perspective of other classes. |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
46 // IO_MAINLOOP option. Most of the time, IO_MAINLOOP avoids needing to use a | 46 // IO_MAINLOOP option. Most of the time, IO_MAINLOOP avoids needing to use a |
47 // REAL_IO_THREAD. | 47 // REAL_IO_THREAD. |
48 // | 48 // |
49 // For some tests it is important to emulate real browser startup. During real | 49 // For some tests it is important to emulate real browser startup. During real |
50 // browser startup, the main MessageLoop is created before other threads. | 50 // browser startup, the main MessageLoop is created before other threads. |
51 // Passing DONT_CREATE_THREADS to constructor will delay creating other threads | 51 // Passing DONT_CREATE_THREADS to constructor will delay creating other threads |
52 // until the test explicitly calls CreateThreads(). | 52 // until the test explicitly calls CreateThreads(). |
53 // | 53 // |
54 // DONT_CREATE_THREADS should only be used when the options specify at least | 54 // DONT_CREATE_THREADS should only be used when the options specify at least |
55 // one real thread other than the main thread. | 55 // one real thread other than the main thread. |
| 56 // |
| 57 // Basic usage: |
| 58 // |
| 59 // class MyTestFixture : public testing::Test { |
| 60 // public: |
| 61 // (...) |
| 62 // |
| 63 // protected: |
| 64 // // Must be the first member (or at least before any member that cares |
| 65 // // about tasks) to be initialized first and destroyed last. protected |
| 66 // // instead of private visibility will allow controlling the task |
| 67 // // environment (e.g. clock) once such features are added (see |
| 68 // // base::test::ScopedTaskEnvironment for details), until then it at least |
| 69 // // doesn't hurt :). |
| 70 // content::TestBrowserThreadBundle test_browser_thread_bundle_; |
| 71 // |
| 72 // // Other members go here (or further below in private section.) |
| 73 // }; |
56 | 74 |
57 #ifndef CONTENT_PUBLIC_TEST_TEST_BROWSER_THREAD_BUNDLE_H_ | 75 #ifndef CONTENT_PUBLIC_TEST_TEST_BROWSER_THREAD_BUNDLE_H_ |
58 #define CONTENT_PUBLIC_TEST_TEST_BROWSER_THREAD_BUNDLE_H_ | 76 #define CONTENT_PUBLIC_TEST_TEST_BROWSER_THREAD_BUNDLE_H_ |
59 | 77 |
60 #include <memory> | 78 #include <memory> |
61 | 79 |
62 #include "base/macros.h" | 80 #include "base/macros.h" |
63 | 81 |
64 namespace base { | 82 namespace base { |
65 class MessageLoop; | 83 class MessageLoop; |
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
111 | 129 |
112 int options_; | 130 int options_; |
113 bool threads_created_; | 131 bool threads_created_; |
114 | 132 |
115 DISALLOW_COPY_AND_ASSIGN(TestBrowserThreadBundle); | 133 DISALLOW_COPY_AND_ASSIGN(TestBrowserThreadBundle); |
116 }; | 134 }; |
117 | 135 |
118 } // namespace content | 136 } // namespace content |
119 | 137 |
120 #endif // CONTENT_PUBLIC_TEST_TEST_BROWSER_THREAD_BUNDLE_H_ | 138 #endif // CONTENT_PUBLIC_TEST_TEST_BROWSER_THREAD_BUNDLE_H_ |
OLD | NEW |