Add a ExtensionBrowserTest base class

chrome/browser/extensions/extension_browsertest.cc

-// Copyright (c) 2009 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
+#include "chrome/browser/extensions/extension_browsertest.h"
 
-#include "base/ref_counted.h"
+#include "base/command_line.h"
+#include "base/file_path.h"
+#include "base/path_service.h"
 #include "chrome/browser/browser.h"
-#include "chrome/browser/browser_list.h"
-#include "chrome/browser/renderer_host/render_view_host.h"
 #include "chrome/browser/extensions/extension_host.h"
-#include "chrome/browser/extensions/extension_process_manager.h"
 #include "chrome/browser/extensions/extensions_service.h"
-#include "chrome/browser/extensions/test_extension_loader.h"
 #include "chrome/browser/profile.h"
-#include "chrome/browser/renderer_host/site_instance.h"
-#include "chrome/browser/views/extensions/extension_shelf.h"
+#include "chrome/common/chrome_switches.h"
 #include "chrome/common/chrome_paths.h"
-#include "chrome/common/chrome_switches.h"
-#include "chrome/common/extensions/extension_error_reporter.h"
-#include "chrome/common/url_constants.h"
-#include "chrome/test/in_process_browser_test.h"
+#include "chrome/common/notification_registrar.h"
+#include "chrome/common/notification_service.h"
+#include "chrome/common/notification_type.h"
 #include "chrome/test/ui_test_utils.h"
 
 namespace {
+// Amount of time to wait to load an extension. This is purposely obscenely
+// long because it will only get used in the case of failure and we want to
+// minimize false positives.
+static const int kTimeoutMs = 60 * 1000;  // 1 minute
+};
 
-// How long to wait for the extension to put up a javascript alert before giving
-// up.
-const int kAlertTimeoutMs = 20000;
+// Base class for extension browser tests. Provides utilities for loading,
+// unloading, and installing extensions.
+void ExtensionBrowserTest::SetUpCommandLine(CommandLine* command_line) {
+  // This enables DOM automation for tab contentses.
+  EnableDOMAutomation();
 
-// The extensions we're using as our test case.
-const char* kGoodExtension1Id = "behllobkkfkfnphdnhnkndlbkcpglgmj";
-const char* kGoodCrxId        = "ldnnhddmnhbkjipkidpdiheffobcpfmf";
+  // This enables it for extension hosts.
+  ExtensionHost::EnableDOMAutomation();
 
-};  // namespace
+  command_line->AppendSwitch(switches::kEnableExtensions);
 
-// This class starts up an extension process and waits until it tries to put
-// up a javascript alert.
-class MockExtensionHost : public ExtensionHost {
- public:
-  MockExtensionHost(Extension* extension, const GURL& url,
-                    SiteInstance* instance)
-      : ExtensionHost(extension, instance, url),
-        got_message_(false) {
-    CreateRenderView(NULL);
-    MessageLoop::current()->PostDelayedTask(FROM_HERE,
-        new MessageLoop::QuitTask, kAlertTimeoutMs);
-    ui_test_utils::RunMessageLoop();
+  PathService::Get(chrome::DIR_TEST_DATA, &test_data_dir_);
+  test_data_dir_ = test_data_dir_.AppendASCII("extensions");
+}
+
+bool ExtensionBrowserTest::LoadExtension(const FilePath& path) {
+  ExtensionsService* service = browser()->profile()->GetExtensionsService();
+  size_t num_before = service->extensions()->size();
+  registrar_.Add(this, NotificationType::EXTENSIONS_LOADED,
+                 NotificationService::AllSources());
+  service->LoadExtension(path);
+  MessageLoop::current()->PostDelayedTask(FROM_HERE, new MessageLoop::QuitTask,
+      kTimeoutMs);
+  ui_test_utils::RunMessageLoop();
+  registrar_.Remove(this, NotificationType::EXTENSIONS_LOADED,
+                    NotificationService::AllSources());
+  size_t num_after = service->extensions()->size();
+  if (num_after != (num_before + 1))
+    return false;
+
+  return WaitForExtensionHostsToLoad();
+}
+
+bool ExtensionBrowserTest::InstallExtension(const FilePath& path) {
+  ExtensionsService* service = browser()->profile()->GetExtensionsService();
+  service->set_show_extensions_prompts(false);
+  size_t num_before = service->extensions()->size();
+
+  registrar_.Add(this, NotificationType::EXTENSION_INSTALLED,
+                 NotificationService::AllSources());
+  service->InstallExtension(path);
+  MessageLoop::current()->PostDelayedTask(FROM_HERE, new MessageLoop::QuitTask,
+      kTimeoutMs);
+  ui_test_utils::RunMessageLoop();
+  registrar_.Remove(this, NotificationType::EXTENSION_INSTALLED,
+                    NotificationService::AllSources());
+  size_t num_after = service->extensions()->size();
+  if (num_after != (num_before + 1))
+    return false;
+
+  return WaitForExtensionHostsToLoad();
+}
+
+void ExtensionBrowserTest::UninstallExtension(const std::string& extension_id) {
+  ExtensionsService* service = browser()->profile()->GetExtensionsService();
+  service->UninstallExtension(extension_id, false);
+}
+
+bool ExtensionBrowserTest::WaitForExtensionHostsToLoad() {
+  // Wait for all the extension hosts that exist to finish loading.
+  // NOTE: This assumes that the extension host list is not changing while
+  // this method is running.
+  ExtensionProcessManager* manager =
+        browser()->profile()->GetExtensionProcessManager();
+  base::Time start_time = base::Time::Now();
+  for (ExtensionProcessManager::const_iterator iter = manager->begin();
+     iter != manager->end(); ++iter) {
+    while (!(*iter)->did_stop_loading()) {
+      if ((base::Time::Now() - start_time).InMilliseconds() > kTimeoutMs)
+        return false;
+
+      MessageLoop::current()->PostDelayedTask(FROM_HERE,
+          new MessageLoop::QuitTask, 200);
+      ui_test_utils::RunMessageLoop();
+    }
   }
 
-  virtual ExtensionFunctionDispatcher* CreateExtensionFunctionDispatcher(
-      RenderViewHost* render_view_host) {
-    NOTREACHED();
-    return NULL;
-  }
-
-  bool got_message() { return got_message_; }
- private:
-  virtual void RunJavaScriptMessage(
-      const std::wstring& message,
-      const std::wstring& default_prompt,
-      const GURL& frame_url,
-      const int flags,
-      IPC::Message* reply_msg,
-      bool* did_suppress_message) {
-    got_message_ = true;
-    MessageLoopForUI::current()->Quit();
-
-    // Call super, otherwise we'll leak reply_msg.
-    ExtensionHost::RunJavaScriptMessage(
-        message, default_prompt, frame_url, flags,
-        reply_msg, did_suppress_message);
-  }
-
-  bool got_message_;
-};
-
-class ExtensionViewTest : public InProcessBrowserTest {
- public:
-  virtual void SetUp() {
-    // Initialize the error reporter here, otherwise BrowserMain will create it
-    // with the wrong MessageLoop.
-    ExtensionErrorReporter::Init(false);
-
-    InProcessBrowserTest::SetUp();
-  }
-  virtual void SetUpCommandLine(CommandLine* command_line) {
-    command_line->AppendSwitch(switches::kEnableExtensions);
-  }
-};
-
-// Tests that ExtensionView starts an extension process and runs the script
-// contained in the extension's toolstrip.
-// TODO(mpcomplete): http://crbug.com/15081 Disabled because it fails.
-IN_PROC_BROWSER_TEST_F(ExtensionViewTest, DISABLED_Toolstrip) {
-  // Get the path to our extension.
-  FilePath path;
-  ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &path));
-  path = path.AppendASCII("extensions")
-      .AppendASCII("good")
-      .AppendASCII("Extensions")
-      .AppendASCII("behllobkkfkfnphdnhnkndlbkcpglgmj")
-      .AppendASCII("1.0.0.0");
-  ASSERT_TRUE(file_util::DirectoryExists(path));  // sanity check
-
-  // Wait for the extension to load and grab a pointer to it.
-  TestExtensionLoader loader(browser()->profile());
-  Extension* extension = loader.Load(kGoodExtension1Id, path);
-  ASSERT_TRUE(extension);
-  GURL url = Extension::GetResourceURL(extension->url(), "toolstrip1.html");
-
-  // Start the extension process and wait for it to show a javascript alert.
-  MockExtensionHost host(extension, url,
-      browser()->profile()->GetExtensionProcessManager()->
-          GetSiteInstanceForURL(url));
-  EXPECT_TRUE(host.got_message());
+  return true;
 }
 
-// Tests that the ExtensionShelf initializes properly, notices that
-// an extension loaded and has a view available, and then sets that up
-// properly.
-// TODO(mpcomplete): http://crbug.com/15081 Disabled because it fails.
-IN_PROC_BROWSER_TEST_F(ExtensionViewTest, DISABLED_Shelf) {
-  // When initialized, there are no extension views and the preferred height
-  // should be zero.
-  scoped_ptr<ExtensionShelf> shelf(new ExtensionShelf(browser()));
-  EXPECT_EQ(shelf->GetChildViewCount(), 0);
-  EXPECT_EQ(shelf->GetPreferredSize().height(), 0);
-
-  // Get the path to our extension.
-  FilePath path;
-  ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &path));
-  path = path.AppendASCII("extensions")
-      .AppendASCII("good")
-      .AppendASCII("Extensions")
-      .AppendASCII("behllobkkfkfnphdnhnkndlbkcpglgmj")
-      .AppendASCII("1.0.0.0");
-  ASSERT_TRUE(file_util::DirectoryExists(path));  // sanity check
-
-  // Wait for the extension to load and grab a pointer to it.
-  TestExtensionLoader loader(browser()->profile());
-  Extension* extension = loader.Load(kGoodExtension1Id, path);
-  ASSERT_TRUE(extension);
-
-  // There should now be two extension views and preferred height of the view
-  // should be non-zero.
-  EXPECT_EQ(shelf->GetChildViewCount(), 2);
-  EXPECT_NE(shelf->GetPreferredSize().height(), 0);
+void ExtensionBrowserTest::Observe(NotificationType type,
+                     const NotificationSource& source,
+                     const NotificationDetails& details) {
+  switch (type.value) {
+    case NotificationType::EXTENSION_INSTALLED:
+    case NotificationType::EXTENSIONS_LOADED:
+      MessageLoopForUI::current()->Quit();
+      break;
+    default:
+      NOTREACHED();
+      break;
+  }
 }
-
-// Tests that installing and uninstalling extensions don't crash with an
-// incognito window open.
-// TODO(mpcomplete): http://crbug.com/14947 disabled because it crashes.
-IN_PROC_BROWSER_TEST_F(ExtensionViewTest, DISABLED_Incognito) {
-  // Open an incognito window to the extensions management page.  We just
-  // want to make sure that we don't crash while playing with extensions when
-  // this guy is around.
-  Browser::OpenURLOffTheRecord(browser()->profile(),
-                               GURL(chrome::kChromeUIExtensionsURL));
-
-  // Get the path to our extension.
-  FilePath path;
-  ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &path));
-  path = path.AppendASCII("extensions").AppendASCII("good.crx");
-  ASSERT_TRUE(file_util::PathExists(path));  // sanity check
-
-  // Wait for the extension to load and grab a pointer to it.
-  TestExtensionLoader loader(browser()->profile());
-  Extension* extension = loader.Install(kGoodCrxId, path);
-  ASSERT_TRUE(extension);
-
-  // TODO(mpcomplete): wait for uninstall to complete?
-  browser()->profile()->GetExtensionsService()->
-             UninstallExtension(kGoodCrxId, false);
-}