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