Correctly integrate StoragePartition into TestingProfile.

chrome/browser/password_manager/password_store_x_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 "base/basictypes.h"
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/platform_file.h"
 #include "base/prefs/pref_service.h"
+#include "base/run_loop.h"
 #include "base/stl_util.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/utf_string_conversions.h"
-#include "base/synchronization/waitable_event.h"
 #include "base/time/time.h"
 #include "chrome/browser/password_manager/password_form_data.h"
 #include "chrome/browser/password_manager/password_store_change.h"
 #include "chrome/browser/password_manager/password_store_consumer.h"
 #include "chrome/browser/password_manager/password_store_x.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/test/base/testing_browser_process.h"
 #include "chrome/test/base/testing_profile.h"
+#include "content/public/browser/browser_thread.h"
 #include "content/public/browser/notification_details.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/notification_source.h"
 #include "content/public/test/mock_notification_observer.h"
-#include "content/public/test/test_browser_thread.h"
+#include "content/public/test/test_browser_thread_bundle.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
-using base::WaitableEvent;
 using content::BrowserThread;
 using testing::_;
 using testing::DoAll;
 using testing::ElementsAreArray;
 using testing::Pointee;
 using testing::Property;
 using testing::WithArg;
 using content::PasswordForm;
 
 typedef std::vector<PasswordForm*> VectorOfForms;
 
 namespace {
 
 class MockPasswordStoreConsumer : public PasswordStoreConsumer {
  public:
   MOCK_METHOD2(OnPasswordStoreRequestDone,
                void(CancelableRequestProvider::Handle,
                     const std::vector<PasswordForm*>&));
   MOCK_METHOD1(OnGetPasswordStoreResults,
                void(const std::vector<PasswordForm*>&));
 };
 
 // This class will add and remove a mock notification observer from
 // the DB thread.
-class DBThreadObserverHelper
-    : public base::RefCountedThreadSafe<DBThreadObserverHelper,
-                                        BrowserThread::DeleteOnDBThread> {
+class DBThreadObserverHelper {
  public:
-  DBThreadObserverHelper() : done_event_(true, false) {}
+  DBThreadObserverHelper() {}
+
+  ~DBThreadObserverHelper() {
+    registrar_.RemoveAll();
+  }
 
   void Init(PasswordStore* password_store) {
-    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
-    BrowserThread::PostTask(
-        BrowserThread::DB,
-        FROM_HERE,
-        base::Bind(&DBThreadObserverHelper::AddObserverTask,
-                   this, make_scoped_refptr(password_store)));
-    done_event_.Wait();
+    registrar_.Add(&observer_,
+                   chrome::NOTIFICATION_LOGINS_CHANGED,
+                   content::Source<PasswordStore>(password_store));
   }
 
   content::MockNotificationObserver& observer() {
     return observer_;
   }
 
- protected:
-  friend struct BrowserThread::DeleteOnThread<BrowserThread::DB>;
-  friend class base::DeleteHelper<DBThreadObserverHelper>;
-
-  virtual ~DBThreadObserverHelper() {
-    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::DB));
-    registrar_.RemoveAll();
-  }
-
-  void AddObserverTask(PasswordStore* password_store) {
-    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::DB));
-    registrar_.Add(&observer_,
-                   chrome::NOTIFICATION_LOGINS_CHANGED,
-                   content::Source<PasswordStore>(password_store));
-    done_event_.Signal();
-  }
-
-  WaitableEvent done_event_;
+ private:
   content::NotificationRegistrar registrar_;
   content::MockNotificationObserver observer_;
 };
 
 class FailingBackend : public PasswordStoreX::NativeBackend {
  public:
   virtual bool Init() OVERRIDE { return true; }
 
   virtual bool AddLogin(const PasswordForm& form) OVERRIDE { return false; }
   virtual bool UpdateLogin(const PasswordForm& form) OVERRIDE { return false; }
@@ skipping 155 matching lines @@
 }  // anonymous namespace
 
 enum BackendType {
   NO_BACKEND,
   FAILING_BACKEND,
   WORKING_BACKEND
 };
 
 class PasswordStoreXTest : public testing::TestWithParam<BackendType> {
  protected:
-  PasswordStoreXTest()
-      : ui_thread_(BrowserThread::UI, &message_loop_),
-        db_thread_(BrowserThread::DB) {
-  }
-
   virtual void SetUp() {
-    ASSERT_TRUE(db_thread_.Start());
     ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
 
     profile_.reset(new TestingProfile());
 
     login_db_.reset(new LoginDatabase());
     ASSERT_TRUE(login_db_->Init(temp_dir_.path().Append("login_test")));
   }
 
   virtual void TearDown() {
-    base::MessageLoop::current()->PostTask(FROM_HERE,
-                                           base::MessageLoop::QuitClosure());
-    base::MessageLoop::current()->Run();
-    db_thread_.Stop();
+    base::RunLoop().RunUntilIdle();

[Ilya Sherman, 2013/07/12 01:59:40]

When is it appropriate to use this vs. RunAllPendingInMessageLoop() from
content/public/test/test_utils.h?

[awong, 2013/07/12 07:17:39]

The two are interchangeable in a unittest.  In a browser test,
RunAllPendingInMessageLoop is required on certain platforms since it enables
nested message loops.

Note this is different from RunAllPendingInMessageLoop(BrowserThread::ID).  That
particular variation is smart enough to flush the target thread safely whether
or not it is real.

   }
 
   PasswordStoreX::NativeBackend* GetBackend() {
     switch (GetParam()) {
       case FAILING_BACKEND:
         return new FailingBackend();
       case WORKING_BACKEND:
         return new MockBackend();
       default:
         return NULL;
     }
   }
 
-  base::MessageLoopForUI message_loop_;
-  content::TestBrowserThread ui_thread_;
-  // PasswordStore, WDS schedule work on this thread.
-  content::TestBrowserThread db_thread_;
+  content::TestBrowserThreadBundle thread_bundle_;
 
   scoped_ptr<LoginDatabase> login_db_;
   scoped_ptr<TestingProfile> profile_;
   base::ScopedTempDir temp_dir_;
 };
 
 ACTION(STLDeleteElements0) {
   STLDeleteContainerPointers(arg0.begin(), arg0.end());
 }
 
-ACTION(QuitUIMessageLoop) {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
-  base::MessageLoop::current()->Quit();
-}
-
 TEST_P(PasswordStoreXTest, Notifications) {
   scoped_refptr<PasswordStoreX> store(
       new PasswordStoreX(login_db_.release(),
                          profile_.get(),
                          GetBackend()));
   store->Init();
 
   PasswordFormData form_data =
   { PasswordForm::SCHEME_HTML,
     "http://bar.example.com",
     "http://bar.example.com/origin",
     "http://bar.example.com/action",
     L"submit_element",
     L"username_element",
     L"password_element",
     L"username_value",
     L"password_value",
     true, false, 1 };
   scoped_ptr<PasswordForm> form(CreatePasswordFormFromData(form_data));
 
-  scoped_refptr<DBThreadObserverHelper> helper = new DBThreadObserverHelper;
-  helper->Init(store.get());
+  DBThreadObserverHelper helper;
+  helper.Init(store.get());
 
   const PasswordStoreChange expected_add_changes[] = {
     PasswordStoreChange(PasswordStoreChange::ADD, *form),
   };
 
   EXPECT_CALL(
-      helper->observer(),
+      helper.observer(),
       Observe(int(chrome::NOTIFICATION_LOGINS_CHANGED),
               content::Source<PasswordStore>(store.get()),
               Property(&content::Details<const PasswordStoreChangeList>::ptr,
                        Pointee(ElementsAreArray(expected_add_changes)))));
 
   // Adding a login should trigger a notification.
   store->AddLogin(*form);
 
-  // The PasswordStore schedules tasks to run on the DB thread so we schedule
-  // yet another task to notify us that it's safe to carry on with the test.
-  WaitableEvent done(false, false);
-  BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
-      base::Bind(&WaitableEvent::Signal, base::Unretained(&done)));
-  done.Wait();
+  // The PasswordStore schedules tasks to run on the DB thread. Wait for them
+  // to complete.
+  base::RunLoop().RunUntilIdle();
 
   // Change the password.
   form->password_value = WideToUTF16(L"a different password");
 
   const PasswordStoreChange expected_update_changes[] = {
     PasswordStoreChange(PasswordStoreChange::UPDATE, *form),
   };
 
   EXPECT_CALL(
-      helper->observer(),
+      helper.observer(),
       Observe(int(chrome::NOTIFICATION_LOGINS_CHANGED),
               content::Source<PasswordStore>(store.get()),
               Property(&content::Details<const PasswordStoreChangeList>::ptr,
                        Pointee(ElementsAreArray(expected_update_changes)))));
 
   // Updating the login with the new password should trigger a notification.
   store->UpdateLogin(*form);
 
-  // Wait for PasswordStore to send the notification.
-  BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
-      base::Bind(&WaitableEvent::Signal, base::Unretained(&done)));
-  done.Wait();
+  // Wait for PasswordStore to send execute.
+  base::RunLoop().RunUntilIdle();
 
   const PasswordStoreChange expected_delete_changes[] = {
     PasswordStoreChange(PasswordStoreChange::REMOVE, *form),
   };
 
   EXPECT_CALL(
-      helper->observer(),
+      helper.observer(),
       Observe(int(chrome::NOTIFICATION_LOGINS_CHANGED),
               content::Source<PasswordStore>(store.get()),
               Property(&content::Details<const PasswordStoreChangeList>::ptr,
                        Pointee(ElementsAreArray(expected_delete_changes)))));
 
   // Deleting the login should trigger a notification.
   store->RemoveLogin(*form);
 
-  // Wait for PasswordStore to send the notification.
-  BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
-      base::Bind(&WaitableEvent::Signal, base::Unretained(&done)));
-  done.Wait();
+  // Wait for PasswordStore to execute.
+  base::RunLoop().RunUntilIdle();
 
   // Public in PasswordStore, protected in PasswordStoreX.
   static_cast<PasswordStore*>(store.get())->ShutdownOnUIThread();
 }
 
 TEST_P(PasswordStoreXTest, NativeMigration) {
   VectorOfForms expected_autofillable;
   InitExpectedForms(true, 50, &expected_autofillable);
 
   VectorOfForms expected_blacklisted;
   InitExpectedForms(false, 50, &expected_blacklisted);
 
   // Get the initial size of the login DB file, before we populate it.
   // This will be used later to make sure it gets back to this size.
   const base::FilePath login_db_file = temp_dir_.path().Append("login_test");
   base::PlatformFileInfo db_file_start_info;
   ASSERT_TRUE(file_util::GetFileInfo(login_db_file, &db_file_start_info));
 
   LoginDatabase* login_db = login_db_.get();
 
   // Populate the login DB with logins that should be migrated.
   for (VectorOfForms::iterator it = expected_autofillable.begin();
        it != expected_autofillable.end(); ++it) {
-    BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
-                            base::Bind(
-                                base::IgnoreResult(&LoginDatabase::AddLogin),
-                                base::Unretained(login_db), **it));
+    login_db->AddLogin(**it);
   }
   for (VectorOfForms::iterator it = expected_blacklisted.begin();
        it != expected_blacklisted.end(); ++it) {
-    BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
-                            base::Bind(
-                                base::IgnoreResult(&LoginDatabase::AddLogin),
-                                base::Unretained(login_db), **it));
+    login_db->AddLogin(**it);
   }
 
-  // Schedule another task on the DB thread to notify us that it's safe to
-  // carry on with the test.
-  WaitableEvent done(false, false);
-  BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
-      base::Bind(&WaitableEvent::Signal, base::Unretained(&done)));
-  done.Wait();
-
   // Get the new size of the login DB file. We expect it to be larger.
   base::PlatformFileInfo db_file_full_info;
   ASSERT_TRUE(file_util::GetFileInfo(login_db_file, &db_file_full_info));
   EXPECT_GT(db_file_full_info.size, db_file_start_info.size);
 
   // Initializing the PasswordStore shouldn't trigger a native migration (yet).
   scoped_refptr<PasswordStoreX> store(
       new PasswordStoreX(login_db_.release(),
                          profile_.get(),
                          GetBackend()));
   store->Init();
 
   MockPasswordStoreConsumer consumer;
 
-  // Make sure we quit the MessageLoop even if the test fails.
-  ON_CALL(consumer, OnPasswordStoreRequestDone(_, _))
-      .WillByDefault(QuitUIMessageLoop());
-
   // The autofillable forms should have been migrated to the native backend.
   EXPECT_CALL(consumer,
       OnPasswordStoreRequestDone(_,
           ContainsAllPasswordForms(expected_autofillable)))
-      .WillOnce(DoAll(WithArg<1>(STLDeleteElements0()), QuitUIMessageLoop()));
+      .WillOnce(WithArg<1>(STLDeleteElements0()));
 
   store->GetAutofillableLogins(&consumer);
-  base::MessageLoop::current()->Run();
+  base::RunLoop().RunUntilIdle();
 
   // The blacklisted forms should have been migrated to the native backend.
   EXPECT_CALL(consumer,
       OnPasswordStoreRequestDone(_,
           ContainsAllPasswordForms(expected_blacklisted)))
-      .WillOnce(DoAll(WithArg<1>(STLDeleteElements0()), QuitUIMessageLoop()));
+      .WillOnce(WithArg<1>(STLDeleteElements0()));
 
   store->GetBlacklistLogins(&consumer);
-  base::MessageLoop::current()->Run();
+  base::RunLoop().RunUntilIdle();
 
   VectorOfForms empty;
   MockLoginDatabaseReturn ld_return;
 
   if (GetParam() == WORKING_BACKEND) {
     // No autofillable logins should be left in the login DB.
     EXPECT_CALL(ld_return,
                 OnLoginDatabaseQueryDone(ContainsAllPasswordForms(empty)));
   } else {
     // The autofillable logins should still be in the login DB.
     EXPECT_CALL(ld_return,
                 OnLoginDatabaseQueryDone(
                     ContainsAllPasswordForms(expected_autofillable)))
         .WillOnce(WithArg<0>(STLDeleteElements0()));
   }
 
-  BrowserThread::PostTask(
-      BrowserThread::DB, FROM_HERE,
-      base::Bind(&LoginDatabaseQueryCallback, login_db, true, &ld_return));
+  LoginDatabaseQueryCallback(login_db, true, &ld_return);
 
-  // Wait for the login DB methods to execute on the DB thread.
-  BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
-      base::Bind(&WaitableEvent::Signal, base::Unretained(&done)));
-  done.Wait();
+  // Wait for the login DB methods to execute.
+  base::RunLoop().RunUntilIdle();
 
   if (GetParam() == WORKING_BACKEND) {
     // Likewise, no blacklisted logins should be left in the login DB.
     EXPECT_CALL(ld_return,
                 OnLoginDatabaseQueryDone(ContainsAllPasswordForms(empty)));
   } else {
     // The blacklisted logins should still be in the login DB.
     EXPECT_CALL(ld_return,
                 OnLoginDatabaseQueryDone(
                     ContainsAllPasswordForms(expected_blacklisted)))
         .WillOnce(WithArg<0>(STLDeleteElements0()));
   }
 
-  BrowserThread::PostTask(
-      BrowserThread::DB, FROM_HERE,
-      base::Bind(&LoginDatabaseQueryCallback, login_db, false, &ld_return));
+  LoginDatabaseQueryCallback(login_db, false, &ld_return);
 
-  // Wait for the login DB methods to execute on the DB thread.
-  BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
-      base::Bind(&WaitableEvent::Signal, base::Unretained(&done)));
-  done.Wait();
+  // Wait for the login DB methods to execute.
+  base::RunLoop().RunUntilIdle();
 
   if (GetParam() == WORKING_BACKEND) {
     // If the migration succeeded, then not only should there be no logins left
     // in the login DB, but also the file should have been deleted and then
     // recreated. We approximate checking for this by checking that the file
     // size is equal to the size before we populated it, even though it was
     // larger after populating it.
     base::PlatformFileInfo db_file_end_info;
     ASSERT_TRUE(file_util::GetFileInfo(login_db_file, &db_file_end_info));
     EXPECT_EQ(db_file_start_info.size, db_file_end_info.size);
   }
 
   STLDeleteElements(&expected_autofillable);
   STLDeleteElements(&expected_blacklisted);
 
   // Public in PasswordStore, protected in PasswordStoreX.
   static_cast<PasswordStore*>(store.get())->ShutdownOnUIThread();
 }
 
 INSTANTIATE_TEST_CASE_P(NoBackend,
                         PasswordStoreXTest,
                         testing::Values(NO_BACKEND));
 INSTANTIATE_TEST_CASE_P(FailingBackend,
                         PasswordStoreXTest,
                         testing::Values(FAILING_BACKEND));
 INSTANTIATE_TEST_CASE_P(WorkingBackend,
                         PasswordStoreXTest,
                         testing::Values(WORKING_BACKEND));