chrome/browser/extensions/extension_test_notification_observer.h

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