Convert ProtocolHandlerRegistry to be a ProfileKeyedService.

chrome/browser/custom_handlers/protocol_handler_registry_unittest.cc

 // Copyright (c) 2012 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/custom_handlers/protocol_handler_registry.h"
 
 #include <set>
 
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
+#include "base/synchronization/waitable_event.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/custom_handlers/protocol_handler.h"
 #include "chrome/test/base/testing_browser_process.h"
 #include "chrome/test/base/testing_pref_service.h"
 #include "chrome/test/base/testing_profile.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/notification_source.h"
 #include "content/public/test/test_browser_thread.h"
 #include "content/public/test/test_renderer_host.h"
 #include "net/url_request/url_request.h"
 #include "net/url_request/url_request_context.h"
+#include "testing/gtest/include/gtest/gtest.h"
 
 using content::BrowserThread;
 
 namespace {
 
+void AssertInterceptedIO(
+    const GURL& url,
+    net::URLRequestJobFactory::Interceptor* interceptor) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  net::URLRequestContext context;
+  net::URLRequest request(url, NULL, &context);
+  scoped_refptr<net::URLRequestJob> job = interceptor->MaybeIntercept(&request);
+  ASSERT_TRUE(job.get() != NULL);
+}
+
+void AssertIntercepted(
+    const GURL& url,
+    net::URLRequestJobFactory::Interceptor* interceptor) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+  BrowserThread::PostTask(BrowserThread::IO,
+                          FROM_HERE,
+                          base::Bind(AssertInterceptedIO,
+                                     url,
+                                     base::Unretained(interceptor)));
+  MessageLoop::current()->RunAllPending();
+}
+
+void AssertWillHandleIO(
+    const std::string& scheme,
+    bool expected,
+    net::URLRequestJobFactory::Interceptor* interceptor) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  ASSERT_EQ(expected, interceptor->WillHandleProtocol(scheme));
+}
+
+void AssertWillHandle(
+    const std::string& scheme,
+    bool expected,
+    net::URLRequestJobFactory::Interceptor* interceptor) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+  BrowserThread::PostTask(BrowserThread::IO,
+                          FROM_HERE,
+                          base::Bind(AssertWillHandleIO,
+                                     scheme,
+                                     expected,
+                                     base::Unretained(interceptor)));
+  MessageLoop::current()->RunAllPending();
+}
+
 class FakeDelegate : public ProtocolHandlerRegistry::Delegate {
  public:
   FakeDelegate() : force_os_failure_(false) {}
   virtual ~FakeDelegate() { }
   virtual void RegisterExternalHandler(const std::string& protocol) {
     ASSERT_TRUE(
         registered_protocols_.find(protocol) == registered_protocols_.end());
     registered_protocols_.insert(protocol);
   }
 
@@ skipping 128 matching lines @@
 
   int events_;
   content::NotificationRegistrar notification_registrar_;
 };
 
 class QueryProtocolHandlerOnChange
     : public content::NotificationObserver {
  public:
   QueryProtocolHandlerOnChange(Profile* profile,
                                ProtocolHandlerRegistry* registry)
-    : registry_(registry),
+    : local_registry_(registry),
       called_(false),
       notification_registrar_() {
     notification_registrar_.Add(this,
         chrome::NOTIFICATION_PROTOCOL_HANDLER_REGISTRY_CHANGED,
         content::Source<Profile>(profile));
   }
 
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) {
     std::vector<std::string> output;
-    registry_->GetRegisteredProtocols(&output);
+    local_registry_->GetRegisteredProtocols(&output);
     called_ = true;
   }
 
-  ProtocolHandlerRegistry* registry_;
+  ProtocolHandlerRegistry* local_registry_;
   bool called_;
   content::NotificationRegistrar notification_registrar_;
 };
 
+// URLRequest DCHECKS that the current MessageLoop is IO. It does this because
+// it can't check the thread id (since net can't depend on content.) We want
+// to harness our tests so all threads use the same loop allowing us to
+// guarantee all messages are processed.) By overriding the IsType method
+// we basically ignore the supplied message loop type, and instead infer
+// our type based on the current thread. GO DEPENDENCY INJECTION!
+class TestMessageLoop : public MessageLoop {
+ public:
+  TestMessageLoop() : MessageLoop(MessageLoop::TYPE_DEFAULT) {}
+  ~TestMessageLoop() {}
+  virtual bool IsType(MessageLoop::Type type) const OVERRIDE {
+    switch (type) {
+       case MessageLoop::TYPE_UI:
+         return BrowserThread::CurrentlyOn(BrowserThread::UI);
+       case MessageLoop::TYPE_IO:
+         return BrowserThread::CurrentlyOn(BrowserThread::IO);
+       case MessageLoop::TYPE_DEFAULT:
+         return !BrowserThread::CurrentlyOn(BrowserThread::UI) &&
+             !BrowserThread::CurrentlyOn(BrowserThread::IO);
+    }
+    return false;
+  }
+};
+
 }  // namespace
 
 class ProtocolHandlerRegistryTest : public testing::Test {
  protected:
   ProtocolHandlerRegistryTest()
-      : test_protocol_handler_(CreateProtocolHandler("test", "test")) {}
+  : ui_thread_(BrowserThread::UI, &loop_),
+    file_thread_(BrowserThread::FILE, &loop_),
+    io_thread_(BrowserThread::IO, &loop_),
+    test_protocol_handler_(CreateProtocolHandler("test", "test")) {}
 
   FakeDelegate* delegate() const { return delegate_; }
+  ProtocolHandlerRegistry* registry() { return registry_.get(); }
   TestingProfile* profile() const { return profile_.get(); }
   PrefService* pref_service() const { return profile_->GetPrefs(); }
-  ProtocolHandlerRegistry* registry() const { return registry_.get(); }
   const ProtocolHandler& test_protocol_handler() const {
     return test_protocol_handler_;
   }
 
   ProtocolHandler CreateProtocolHandler(const std::string& protocol,
                                         const GURL& url,
                                         const std::string& title) {
     return ProtocolHandler::CreateProtocolHandler(protocol, url,
         UTF8ToUTF16(title));
   }
 
   ProtocolHandler CreateProtocolHandler(const std::string& protocol,
       const std::string& name) {
     return CreateProtocolHandler(protocol, GURL("http://" + name + "/%s"),
         name);
   }
 
-  void ReloadProtocolHandlerRegistry() {
-    delegate_ = new FakeDelegate();
-    registry_->Finalize();
-    registry_ = NULL;
-    registry_ = new ProtocolHandlerRegistry(profile(), delegate());
-    registry_->Load();
+  void RecreateRegistry(bool initialize) {
+    TeadDownRegistry();
+    SetUpRegistry(initialize);
   }
 
-  void ReloadProtocolHandlerRegistryAndInstallDefaultHandler() {
+  // Returns a new registry, initializing it if |initialize| is true.
+  // Caller assumes ownership for the object
+  void SetUpRegistry(bool initialize) {
     delegate_ = new FakeDelegate();
-    registry_->Finalize();
-    registry_ = NULL;
-    registry_ = new ProtocolHandlerRegistry(profile(), delegate());
-    registry_->AddPredefinedHandler(CreateProtocolHandler(
-        "test", GURL("http://test.com/%s"), "Test"));
-    registry_->Load();
+    registry_.reset(new ProtocolHandlerRegistry(profile(), delegate()));
+    if (initialize) registry_->InitProtocolSettings();
+  }
+
+  void TeadDownRegistry() {
+    registry_->Shutdown();
+    registry_.reset();
+    // Registry owns the delegate_ it handles deletion of that object.
   }
 
   virtual void SetUp() {
-    ui_message_loop_.reset(new MessageLoopForUI());
-    ui_thread_.reset(new content::TestBrowserThread(BrowserThread::UI,
-                                                    MessageLoop::current()));
-    io_thread_.reset(new content::TestBrowserThread(BrowserThread::IO));
-    io_thread_->StartIOThread();
-
-    file_thread_.reset(new content::TestBrowserThread(BrowserThread::FILE));
-    file_thread_->Start();
-
     profile_.reset(new TestingProfile());
     profile_->SetPrefService(new TestingPrefService());
-    delegate_ = new FakeDelegate();
-    registry_ = new ProtocolHandlerRegistry(profile(), delegate());
-    registry_->Load();
+    SetUpRegistry(true);
     test_protocol_handler_ =
         CreateProtocolHandler("test", GURL("http://test.com/%s"), "Test");
-
     ProtocolHandlerRegistry::RegisterPrefs(pref_service());
   }
 
   virtual void TearDown() {
-    registry_->Finalize();
-    registry_ = NULL;
-    io_thread_->Stop();
-    io_thread_.reset(NULL);
-    file_thread_->Stop();
-    file_thread_.reset(NULL);
-    ui_thread_.reset(NULL);
-    ui_message_loop_.reset(NULL);
+    TeadDownRegistry();
   }
 
-  bool enabled_io() {
-    return registry()->enabled_io_;
-  }
+  TestMessageLoop loop_;
 
-  scoped_ptr<MessageLoopForUI> ui_message_loop_;
-  scoped_ptr<content::TestBrowserThread> ui_thread_;
-  scoped_ptr<content::TestBrowserThread> io_thread_;
-  scoped_ptr<content::TestBrowserThread> file_thread_;
+ private:
+  content::TestBrowserThread ui_thread_;
+  content::TestBrowserThread file_thread_;
+  content::TestBrowserThread io_thread_;
 
-  FakeDelegate* delegate_;
   scoped_ptr<TestingProfile> profile_;
-  scoped_refptr<ProtocolHandlerRegistry> registry_;
+  FakeDelegate* delegate_;  // Registry assumes ownership of delegate_.
+  scoped_ptr<ProtocolHandlerRegistry> registry_;
   ProtocolHandler test_protocol_handler_;
 };
 
 // ProtocolHandlerRegistryTest tests are flaky on Linux & ChromeOS.
 // http://crbug.com/133023
 #if defined(OS_LINUX) || defined(OS_CHROMEOS)
 #define MAYBE_AcceptProtocolHandlerHandlesProtocol \
     DISABLED_AcceptProtocolHandlerHandlesProtocol
 #define MAYBE_DeniedProtocolIsntHandledUntilAccepted \
     DISABLED_DeniedProtocolIsntHandledUntilAccepted
@@ skipping 78 matching lines @@
 
 TEST_F(ProtocolHandlerRegistryTest, SaveAndLoad) {
   ProtocolHandler stuff_protocol_handler(
       CreateProtocolHandler("stuff", "stuff"));
   registry()->OnAcceptRegisterProtocolHandler(test_protocol_handler());
   registry()->OnIgnoreRegisterProtocolHandler(stuff_protocol_handler);
 
   ASSERT_TRUE(registry()->IsHandledProtocol("test"));
   ASSERT_TRUE(registry()->IsIgnored(stuff_protocol_handler));
   delegate()->Reset();
-  ReloadProtocolHandlerRegistry();
+  RecreateRegistry(true);
   ASSERT_TRUE(registry()->IsHandledProtocol("test"));
   ASSERT_TRUE(registry()->IsIgnored(stuff_protocol_handler));
 }
 
 TEST_F(ProtocolHandlerRegistryTest, TestEnabledDisabled) {
   registry()->Disable();
   ASSERT_FALSE(registry()->enabled());
   registry()->Enable();
   ASSERT_TRUE(registry()->enabled());
 }
@@ skipping 65 matching lines @@
 
 TEST_F(ProtocolHandlerRegistryTest, TestDefaultSaveLoad) {
   ProtocolHandler ph1 = CreateProtocolHandler("test", "test1");
   ProtocolHandler ph2 = CreateProtocolHandler("test", "test2");
   registry()->OnDenyRegisterProtocolHandler(ph1);
   registry()->OnDenyRegisterProtocolHandler(ph2);
 
   registry()->OnAcceptRegisterProtocolHandler(ph2);
   registry()->Disable();
 
-  ReloadProtocolHandlerRegistry();
+  RecreateRegistry(true);
 
   ASSERT_FALSE(registry()->enabled());
   registry()->Enable();
   ASSERT_FALSE(registry()->IsDefault(ph1));
   ASSERT_TRUE(registry()->IsDefault(ph2));
 
-  ReloadProtocolHandlerRegistry();
+  RecreateRegistry(true);
   ASSERT_TRUE(registry()->enabled());
 }
 
 TEST_F(ProtocolHandlerRegistryTest, TestRemoveHandler) {
   ProtocolHandler ph1 = CreateProtocolHandler("test", "test1");
   registry()->OnAcceptRegisterProtocolHandler(ph1);
   registry()->OnAcceptRegisterProtocolHandler(ph1);
 
   registry()->RemoveHandler(ph1);
   ASSERT_FALSE(registry()->IsRegistered(ph1));
@@ skipping 139 matching lines @@
 }
 
 TEST_F(ProtocolHandlerRegistryTest, TestDisablePreventsHandling) {
   ProtocolHandler ph1 = CreateProtocolHandler("test", "test1");
   registry()->OnAcceptRegisterProtocolHandler(ph1);
   ASSERT_TRUE(registry()->IsHandledProtocol("test"));
   registry()->Disable();
   ASSERT_FALSE(registry()->IsHandledProtocol("test"));
 }
 
+// TODO(smckay): This is much more appropriately an integration
+// test. Make that so, then update the
+// ShellIntegretion{Delegate,Observer,Worker} test classes we use to fully
+// isolate this test from the FILE thread.
 TEST_F(ProtocolHandlerRegistryTest, TestOSRegistration) {
   ProtocolHandler ph_do1 = CreateProtocolHandler("do", "test1");
   ProtocolHandler ph_do2 = CreateProtocolHandler("do", "test2");
   ProtocolHandler ph_dont = CreateProtocolHandler("dont", "test");
 
   ASSERT_FALSE(delegate()->IsFakeRegisteredWithOS("do"));
   ASSERT_FALSE(delegate()->IsFakeRegisteredWithOS("dont"));
 
   registry()->OnAcceptRegisterProtocolHandler(ph_do1);
   registry()->OnDenyRegisterProtocolHandler(ph_dont);
-  MessageLoop::current()->Run();
+  MessageLoop::current()->Run();  // FILE thread needs to run.
   ASSERT_TRUE(delegate()->IsFakeRegisteredWithOS("do"));
   ASSERT_FALSE(delegate()->IsFakeRegisteredWithOS("dont"));
 
   // This should not register with the OS, if it does the delegate
   // will assert for us. We don't need to wait for the message loop
   // as it should not go through to the shell worker.
   registry()->OnAcceptRegisterProtocolHandler(ph_do2);
 }
 
 #if defined(OS_LINUX)
 // TODO(benwells): When Linux support is more reliable and
 // http://crbut.com/88255 is fixed this test will pass.
 #define MAYBE_TestOSRegistrationFailure FAILS_TestOSRegistrationFailure
 #else
 #define MAYBE_TestOSRegistrationFailure TestOSRegistrationFailure
 #endif
 
+// TODO(smckay): This is much more appropriately an integration
+// test. Make that so, then update the
+// ShellIntegretion{Delegate,Observer,Worker} test classes we use to fully
+// isolate this test from the FILE thread.
 TEST_F(ProtocolHandlerRegistryTest, MAYBE_TestOSRegistrationFailure) {
   ProtocolHandler ph_do = CreateProtocolHandler("do", "test1");
   ProtocolHandler ph_dont = CreateProtocolHandler("dont", "test");
 
   ASSERT_FALSE(registry()->IsHandledProtocol("do"));
   ASSERT_FALSE(registry()->IsHandledProtocol("dont"));
 
   registry()->OnAcceptRegisterProtocolHandler(ph_do);
-  MessageLoop::current()->Run();
+  MessageLoop::current()->Run();  // FILE thread needs to run.
   delegate()->set_force_os_failure(true);
   registry()->OnAcceptRegisterProtocolHandler(ph_dont);
-  MessageLoop::current()->Run();
+  MessageLoop::current()->Run();  // FILE thread needs to run.
   ASSERT_TRUE(registry()->IsHandledProtocol("do"));
   ASSERT_EQ(static_cast<size_t>(1), registry()->GetHandlersFor("do").size());
   ASSERT_FALSE(registry()->IsHandledProtocol("dont"));
   ASSERT_EQ(static_cast<size_t>(1), registry()->GetHandlersFor("dont").size());
 }
 
-static void MakeRequest(const GURL& url, ProtocolHandlerRegistry* registry) {
-  net::URLRequestContext context;
-  net::URLRequest request(url, NULL, &context);
-  BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
-                          MessageLoop::QuitClosure());
-  scoped_refptr<net::URLRequestJob> job(registry->MaybeCreateJob(&request));
-  ASSERT_TRUE(job.get() != NULL);
-}
-
 TEST_F(ProtocolHandlerRegistryTest, TestMaybeCreateTaskWorksFromIOThread) {
   ProtocolHandler ph1 = CreateProtocolHandler("mailto", "test1");
   registry()->OnAcceptRegisterProtocolHandler(ph1);
   GURL url("mailto:someone@something.com");
-  scoped_refptr<ProtocolHandlerRegistry> r(registry());
-  BrowserThread::PostTask(BrowserThread::IO, FROM_HERE,
-                          base::Bind(MakeRequest, url, r));
-  MessageLoop::current()->Run();
-}
+  net::URLRequestJobFactory::Interceptor* interceptor =
+      registry()->CreateURLInterceptor();
 
-static void CheckIsHandled(const std::string& scheme, bool expected,
-    ProtocolHandlerRegistry* registry) {
-  BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
-                          MessageLoop::QuitClosure());
-  ASSERT_EQ(expected, registry->IsHandledProtocolIO(scheme));
+  AssertIntercepted(url, interceptor);
 }
 
 TEST_F(ProtocolHandlerRegistryTest,
        MAYBE_TestIsHandledProtocolWorksOnIOThread) {
   std::string scheme("mailto");
   ProtocolHandler ph1 = CreateProtocolHandler(scheme, "test1");
   registry()->OnAcceptRegisterProtocolHandler(ph1);
-  scoped_refptr<ProtocolHandlerRegistry> r(registry());
-  BrowserThread::PostTask(
-      BrowserThread::IO,
-      FROM_HERE,
-      base::Bind(CheckIsHandled, scheme, true, r));
+  net::URLRequestJobFactory::Interceptor* interceptor =
+      registry()->CreateURLInterceptor();
+
+  AssertWillHandle(scheme, true, interceptor);
 }
 
 TEST_F(ProtocolHandlerRegistryTest, TestRemovingDefaultFallsBackToOldDefault) {
   ProtocolHandler ph1 = CreateProtocolHandler("mailto", "test1");
   ProtocolHandler ph2 = CreateProtocolHandler("mailto", "test2");
   ProtocolHandler ph3 = CreateProtocolHandler("mailto", "test3");
   registry()->OnAcceptRegisterProtocolHandler(ph1);
   registry()->OnAcceptRegisterProtocolHandler(ph2);
   registry()->OnAcceptRegisterProtocolHandler(ph3);
 
@@ skipping 23 matching lines @@
 
   ASSERT_EQ(ph2, handlers[0]);
   ASSERT_EQ(ph1, handlers[1]);
 }
 
 TEST_F(ProtocolHandlerRegistryTest, MAYBE_TestClearDefaultGetsPropagatedToIO) {
   std::string scheme("mailto");
   ProtocolHandler ph1 = CreateProtocolHandler(scheme, "test1");
   registry()->OnAcceptRegisterProtocolHandler(ph1);
   registry()->ClearDefault(scheme);
-  scoped_refptr<ProtocolHandlerRegistry> r(registry());
+  net::URLRequestJobFactory::Interceptor* interceptor =
+      registry()->CreateURLInterceptor();
 
-  BrowserThread::PostTask(
-      BrowserThread::IO,
-      FROM_HERE,
-      base::Bind(CheckIsHandled, scheme, false, r));
-}
-
-static void QuitUILoop() {
-  BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
-                          MessageLoop::QuitClosure());
+  AssertWillHandle(scheme, false, interceptor);
 }
 
 TEST_F(ProtocolHandlerRegistryTest, TestLoadEnabledGetsPropogatedToIO) {
+  std::string mailto("mailto");
+  ProtocolHandler ph1 = CreateProtocolHandler(mailto, "MailtoHandler");
+  registry()->OnAcceptRegisterProtocolHandler(ph1);
+
+  AssertWillHandle(mailto, true, registry()->CreateURLInterceptor());
   registry()->Disable();
-  ReloadProtocolHandlerRegistry();
-  BrowserThread::PostTask(BrowserThread::IO, FROM_HERE,
-                          base::Bind(QuitUILoop));
-  MessageLoop::current()->Run();
-  ASSERT_FALSE(enabled_io());
+  AssertWillHandle(mailto, false, registry()->CreateURLInterceptor());
 }
 
 TEST_F(ProtocolHandlerRegistryTest, TestReplaceHandler) {
   ProtocolHandler ph1 = CreateProtocolHandler("mailto",
       GURL("http://test.com/%s"), "test1");
   ProtocolHandler ph2 = CreateProtocolHandler("mailto",
       GURL("http://test.com/updated-url/%s"), "test2");
   registry()->OnAcceptRegisterProtocolHandler(ph1);
   ASSERT_TRUE(registry()->AttemptReplace(ph2));
   const ProtocolHandler& handler(registry()->GetHandlerFor("mailto"));
@@ skipping 43 matching lines @@
       ph1.IsSameOrigin(ph2));
   ASSERT_EQ(ph1.url().GetOrigin() == ph2.url().GetOrigin(),
       ph2.IsSameOrigin(ph1));
   ASSERT_EQ(ph2.url().GetOrigin() == ph3.url().GetOrigin(),
       ph2.IsSameOrigin(ph3));
   ASSERT_EQ(ph3.url().GetOrigin() == ph2.url().GetOrigin(),
       ph3.IsSameOrigin(ph2));
 }
 
 TEST_F(ProtocolHandlerRegistryTest, MAYBE_TestInstallDefaultHandler) {
-  ReloadProtocolHandlerRegistryAndInstallDefaultHandler();
+  RecreateRegistry(false);
+  registry()->AddPredefinedHandler(CreateProtocolHandler(
+      "test", GURL("http://test.com/%s"), "Test"));
+  registry()->InitProtocolSettings();
   std::vector<std::string> protocols;
   registry()->GetRegisteredProtocols(&protocols);
   ASSERT_EQ(static_cast<size_t>(1), protocols.size());
 }