OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 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 CHROME_BROWSER_EXTENSIONS_EXTENSION_TEST_NOTIFICATION_OBSERVER_H_ | 5 #ifndef EXTENSIONS_TEST_EXTENSION_TEST_NOTIFICATION_OBSERVER_H_ |
6 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_TEST_NOTIFICATION_OBSERVER_H_ | 6 #define EXTENSIONS_TEST_EXTENSION_TEST_NOTIFICATION_OBSERVER_H_ |
7 | 7 |
| 8 #include <memory> |
8 #include <string> | 9 #include <string> |
9 | 10 |
10 #include "base/callback.h" | 11 #include "base/callback.h" |
11 #include "base/compiler_specific.h" | 12 #include "base/callback_list.h" |
12 #include "chrome/browser/chrome_notification_types.h" | 13 #include "base/macros.h" |
13 #include "chrome/browser/extensions/api/extension_action/extension_action_api.h" | 14 #include "base/scoped_observer.h" |
14 #include "chrome/browser/ui/browser.h" | |
15 #include "chrome/browser/ui/location_bar/location_bar.h" | |
16 #include "content/public/browser/notification_details.h" | |
17 #include "content/public/browser/notification_observer.h" | 15 #include "content/public/browser/notification_observer.h" |
18 #include "content/public/browser/notification_types.h" | 16 #include "content/public/browser/notification_registrar.h" |
| 17 #include "extensions/browser/process_manager_observer.h" |
19 | 18 |
20 namespace content { | 19 namespace content { |
| 20 class BrowserContext; |
| 21 class NotificationDetails; |
21 class WindowedNotificationObserver; | 22 class WindowedNotificationObserver; |
22 } | 23 } |
23 | 24 |
| 25 namespace extensions { |
| 26 class ProcessManager; |
| 27 } |
| 28 |
24 // Test helper class for observing extension-related events. | 29 // Test helper class for observing extension-related events. |
25 class ExtensionTestNotificationObserver | 30 class ExtensionTestNotificationObserver : public content::NotificationObserver { |
26 : public content::NotificationObserver, | |
27 public extensions::ExtensionActionAPI::Observer { | |
28 public: | 31 public: |
29 explicit ExtensionTestNotificationObserver(Browser* browser); | 32 explicit ExtensionTestNotificationObserver(content::BrowserContext* context); |
30 ~ExtensionTestNotificationObserver() override; | 33 ~ExtensionTestNotificationObserver() override; |
31 | 34 |
32 // Wait for the number of visible page actions to change to |count|. | |
33 bool WaitForPageActionVisibilityChangeTo(int count); | |
34 | |
35 // Wait for an extension install error to be raised. Returns true if an | 35 // Wait for an extension install error to be raised. Returns true if an |
36 // error was raised. | 36 // error was raised. |
37 bool WaitForExtensionInstallError(); | 37 bool WaitForExtensionInstallError(); |
38 | 38 |
39 // Waits until an extension is loaded and all view have loaded. | |
40 void WaitForExtensionAndViewLoad(); | |
41 | |
42 // Waits until an extension is loaded. | 39 // Waits until an extension is loaded. |
43 void WaitForExtensionLoad(); | 40 void WaitForExtensionLoad(); |
44 | 41 |
45 // Waits for an extension load error. Returns true if the error really | 42 // Waits for an extension load error. Returns true if the error really |
46 // happened. | 43 // happened. |
47 bool WaitForExtensionLoadError(); | 44 bool WaitForExtensionLoadError(); |
48 | 45 |
49 // Wait for the specified extension to crash. Returns true if it really | 46 // Wait for the specified extension to crash. Returns true if it really |
50 // crashed. | 47 // crashed. |
51 bool WaitForExtensionCrash(const std::string& extension_id); | 48 bool WaitForExtensionCrash(const std::string& extension_id); |
52 | 49 |
53 // Wait for the crx installer to be done. Returns true if it really is done. | 50 // Wait for the crx installer to be done. Returns true if it really is done. |
54 bool WaitForCrxInstallerDone(); | 51 bool WaitForCrxInstallerDone(); |
55 | 52 |
56 // Wait for all extension views to load. | |
57 bool WaitForExtensionViewsToLoad(); | |
58 | |
59 // Wait for extension to be idle. | |
60 bool WaitForExtensionIdle(const std::string& extension_id); | |
61 | |
62 // Wait for extension to be not idle. | |
63 bool WaitForExtensionNotIdle(const std::string& extension_id); | |
64 | |
65 // Watch for the given event type from the given source. | 53 // Watch for the given event type from the given source. |
66 // After calling this method, call Wait() to ensure that RunMessageLoop() is | 54 // After calling this method, call Wait() to ensure that RunMessageLoop() is |
67 // called appropriately and cleanup is performed. | 55 // called appropriately and cleanup is performed. |
68 void Watch(int type, const content::NotificationSource& source); | 56 void Watch(int type, const content::NotificationSource& source); |
69 | 57 |
70 // After registering one or more event types with Watch(), call | 58 // After registering one or more event types with Watch(), call |
71 // this method to run the message loop and perform cleanup. | 59 // this method to run the message loop and perform cleanup. |
72 void Wait(); | 60 void Wait(); |
73 | 61 |
74 const std::string& last_loaded_extension_id() { | 62 const std::string& last_loaded_extension_id() { |
75 return last_loaded_extension_id_; | 63 return last_loaded_extension_id_; |
76 } | 64 } |
77 void set_last_loaded_extension_id( | 65 void set_last_loaded_extension_id( |
78 const std::string& last_loaded_extension_id) { | 66 const std::string& last_loaded_extension_id) { |
79 last_loaded_extension_id_ = last_loaded_extension_id; | 67 last_loaded_extension_id_ = last_loaded_extension_id; |
80 } | 68 } |
81 | 69 |
82 // content::NotificationObserver | 70 // content::NotificationObserver |
83 void Observe(int type, | 71 void Observe(int type, |
84 const content::NotificationSource& source, | 72 const content::NotificationSource& source, |
85 const content::NotificationDetails& details) override; | 73 const content::NotificationDetails& details) override; |
86 | 74 |
87 private: | 75 protected: |
88 class NotificationSet; | 76 class NotificationSet : public content::NotificationObserver, |
| 77 public extensions::ProcessManagerObserver { |
| 78 public: |
| 79 NotificationSet(); |
| 80 ~NotificationSet() override; |
89 | 81 |
90 Profile* GetProfile(); | 82 void Add(int type, const content::NotificationSource& source); |
| 83 void Add(int type); |
| 84 void AddExtensionFrameUnregistration(extensions::ProcessManager* manager); |
91 | 85 |
92 void WaitForNotification(int notification_type); | 86 // Notified any time an Add()ed notification is received. |
| 87 // The details of the notification are dropped. |
| 88 base::CallbackList<void()>& callback_list() { return callback_list_; } |
| 89 |
| 90 private: |
| 91 // content::NotificationObserver: |
| 92 void Observe(int type, |
| 93 const content::NotificationSource& source, |
| 94 const content::NotificationDetails& details) override; |
| 95 |
| 96 // extensions::ProcessManagerObserver: |
| 97 void OnExtensionFrameUnregistered( |
| 98 const std::string& extension_id, |
| 99 content::RenderFrameHost* render_frame_host) override; |
| 100 |
| 101 content::NotificationRegistrar notification_registrar_; |
| 102 base::CallbackList<void()> callback_list_; |
| 103 ScopedObserver<extensions::ProcessManager, |
| 104 extensions::ProcessManagerObserver> |
| 105 process_manager_observer_; |
| 106 DISALLOW_COPY_AND_ASSIGN(NotificationSet); |
| 107 }; |
93 | 108 |
94 // Wait for |condition_| to be met. |notification_set| is the set of | 109 // Wait for |condition_| to be met. |notification_set| is the set of |
95 // notifications to wait for and to check |condition| when observing. This | 110 // notifications to wait for and to check |condition| when observing. This |
96 // can be NULL if we are instead waiting for a different observer method, like | 111 // can be NULL if we are instead waiting for a different observer method, like |
97 // OnPageActionsUpdated(). | 112 // OnPageActionsUpdated(). |
98 void WaitForCondition(const base::Callback<bool(void)>& condition, | 113 void WaitForCondition(const base::Callback<bool(void)>& condition, |
99 NotificationSet* notification_set); | 114 NotificationSet* notification_set); |
100 | 115 |
| 116 void WaitForNotification(int notification_type); |
| 117 |
101 // Quits the message loop if |condition_| is met. | 118 // Quits the message loop if |condition_| is met. |
102 void MaybeQuit(); | 119 void MaybeQuit(); |
103 | 120 |
104 // extensions::ExtensionActionAPI::Observer: | 121 content::BrowserContext* context_; |
105 void OnPageActionsUpdated(content::WebContents* contents) override; | |
106 | 122 |
107 Browser* browser_; | 123 private: |
108 Profile* profile_; | |
109 | |
110 content::NotificationRegistrar registrar_; | 124 content::NotificationRegistrar registrar_; |
111 std::unique_ptr<content::WindowedNotificationObserver> observer_; | 125 std::unique_ptr<content::WindowedNotificationObserver> observer_; |
112 | 126 |
113 std::string last_loaded_extension_id_; | 127 std::string last_loaded_extension_id_; |
114 int extension_installs_observed_; | 128 int extension_installs_observed_; |
115 int extension_load_errors_observed_; | 129 int extension_load_errors_observed_; |
116 int crx_installers_done_observed_; | 130 int crx_installers_done_observed_; |
117 | 131 |
118 // The condition for which we are waiting. This should be checked in any | 132 // The condition for which we are waiting. This should be checked in any |
119 // observing methods that could trigger it. | 133 // observing methods that could trigger it. |
120 base::Callback<bool(void)> condition_; | 134 base::Callback<bool(void)> condition_; |
121 | 135 |
122 // The closure to quit the currently-running message loop. | 136 // The closure to quit the currently-running message loop. |
123 base::Closure quit_closure_; | 137 base::Closure quit_closure_; |
| 138 |
| 139 DISALLOW_COPY_AND_ASSIGN(ExtensionTestNotificationObserver); |
124 }; | 140 }; |
125 | 141 |
126 #endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_TEST_NOTIFICATION_OBSERVER_H_ | 142 #endif // EXTENSIONS_TEST_EXTENSION_TEST_NOTIFICATION_OBSERVER_H_ |
OLD | NEW |