ProfileSyncServiceTest refactoring

chrome/browser/sync/profile_sync_service_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/compiler_specific.h"
-#include "base/file_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/run_loop.h"
 #include "base/values.h"
 #include "chrome/browser/invalidation/invalidation_service_factory.h"
 #include "chrome/browser/signin/signin_manager.h"
 #include "chrome/browser/signin/signin_manager_factory.h"
 #include "chrome/browser/signin/token_service.h"
 #include "chrome/browser/signin/token_service_factory.h"
 #include "chrome/browser/sync/fake_oauth2_token_service.h"
 #include "chrome/browser/sync/glue/bookmark_data_type_controller.h"
@@ skipping 61 matching lines @@
     service_.reset();
     profile_.reset();
 
     // Pump messages posted by the sync thread (which may end up
     // posting on the IO thread).
     base::RunLoop().RunUntilIdle();
     content::RunAllPendingInMessageLoop(content::BrowserThread::IO);
     base::RunLoop().RunUntilIdle();
   }
 
-  // TODO(akalin): Refactor the StartSyncService*() functions below.
-
-  void StartSyncService() {
-    StartSyncServiceAndSetInitialSyncEnded(
-        true, true, false, true, syncer::STORAGE_IN_MEMORY);
-  }
-
-  void StartSyncServiceAndSetInitialSyncEnded(
-      bool set_initial_sync_ended,
-      bool issue_auth_token,
-      bool synchronous_sync_configuration,
-      bool sync_setup_completed,
-      syncer::StorageOption storage_option) {
+  void StartSyncServiceAndSetInitialSyncEnded() {
     if (service_)
       return;
 
     SigninManagerBase* signin =
         SigninManagerFactory::GetForProfile(profile_.get());
     signin->SetAuthenticatedUsername("test");
     ProfileOAuth2TokenService* oauth2_token_service =
         ProfileOAuth2TokenServiceFactory::GetForProfile(profile_.get());
     ProfileSyncComponentsFactoryMock* factory =
         new ProfileSyncComponentsFactoryMock();
     service_.reset(new TestProfileSyncService(
         factory,
         profile_.get(),
         signin,
         oauth2_token_service,
         ProfileSyncService::AUTO_START,
         true));
-    if (!set_initial_sync_ended)
-      service_->dont_set_initial_sync_ended_on_init();
 
-    if (synchronous_sync_configuration)
-      service_->set_synchronous_sync_configuration();
-
-    service_->set_storage_option(storage_option);
-    if (!sync_setup_completed)
-      profile_->GetPrefs()->SetBoolean(prefs::kSyncHasSetupCompleted, false);
 
     // Register the bookmark data type.
     ON_CALL(*factory, CreateDataTypeManager(_, _, _, _, _, _)).
         WillByDefault(ReturnNewDataTypeManager());
 
-    if (issue_auth_token)
-      IssueTestTokens();
-
     service_->Initialize();
   }
 
   void WaitForBackendInitDone() {
     for (int i = 0; i < 5; ++i) {
       base::WaitableEvent done(false, false);
       service_->GetBackendForTest()->GetSyncLoopForTesting()
           ->PostTask(FROM_HERE, base::Bind(&SignalDone, &done));
       done.Wait();
       base::RunLoop().RunUntilIdle();
@@ skipping 300 matching lines @@
   EXPECT_TRUE(service()->sync_initialized());
   EXPECT_FALSE(profile()->GetPrefs()->GetBoolean(prefs::kSyncSuppressStart));
 
   SigninManagerFactory::GetForProfile(profile())->SignOut();
   EXPECT_FALSE(service()->sync_initialized());
 }
 
 #endif  // !defined(OS_CHROMEOS)
 
 TEST_F(ProfileSyncServiceTest, JsControllerHandlersBasic) {
-  StartSyncService();
+  StartSyncServiceAndSetInitialSyncEnded();
+  IssueTestTokens();
   EXPECT_TRUE(service_->sync_initialized());
   EXPECT_TRUE(service_->GetBackendForTest() != NULL);
 
   base::WeakPtr<syncer::JsController> js_controller =
       service_->GetJsController();
   StrictMock<syncer::MockJsEventHandler> event_handler;
   js_controller->AddJsEventHandler(&event_handler);
   js_controller->RemoveJsEventHandler(&event_handler);
 }
 
 TEST_F(ProfileSyncServiceTest,
        JsControllerHandlersDelayedBackendInitialization) {
-  StartSyncServiceAndSetInitialSyncEnded(true, false, false, true,
-                                                  syncer::STORAGE_IN_MEMORY);
+  StartSyncServiceAndSetInitialSyncEnded();
 
   StrictMock<syncer::MockJsEventHandler> event_handler;
   EXPECT_CALL(event_handler, HandleJsEvent(_, _)).Times(AtLeast(1));
 
   EXPECT_EQ(NULL, service_->GetBackendForTest());
   EXPECT_FALSE(service_->sync_initialized());
 
   base::WeakPtr<syncer::JsController> js_controller =
       service_->GetJsController();
   js_controller->AddJsEventHandler(&event_handler);
   // Since we're doing synchronous initialization, backend should be
   // initialized by this call.
   IssueTestTokens();
   EXPECT_TRUE(service_->sync_initialized());
   js_controller->RemoveJsEventHandler(&event_handler);
 }
 
 TEST_F(ProfileSyncServiceTest, JsControllerProcessJsMessageBasic) {
-  StartSyncService();
+  StartSyncServiceAndSetInitialSyncEnded();
+  IssueTestTokens();
   WaitForBackendInitDone();
 
   StrictMock<syncer::MockJsReplyHandler> reply_handler;
 
   ListValue arg_list1;
   arg_list1.Append(Value::CreateStringValue("INVALIDATIONS_ENABLED"));
   syncer::JsArgList args1(&arg_list1);
   EXPECT_CALL(reply_handler,
               HandleJsReply("getNotificationState", HasArgs(args1)));
 
@@ skipping 12 matching lines @@
   done.Wait();
 
   // Call TearDown() to flush the message loops before the mock is destroyed.
   // TearDown() is idempotent, so it's not a problem that it gets called by the
   // test fixture again later.
   TearDown();
 }
 
 TEST_F(ProfileSyncServiceTest,
        JsControllerProcessJsMessageBasicDelayedBackendInitialization) {
-  StartSyncServiceAndSetInitialSyncEnded(true, false, false, true,
-                                                  syncer::STORAGE_IN_MEMORY);
+  StartSyncServiceAndSetInitialSyncEnded();
 
   StrictMock<syncer::MockJsReplyHandler> reply_handler;
 
   ListValue arg_list1;
   arg_list1.Append(Value::CreateStringValue("INVALIDATIONS_ENABLED"));
   syncer::JsArgList args1(&arg_list1);
   EXPECT_CALL(reply_handler,
               HandleJsReply("getNotificationState", HasArgs(args1)));
 
   {
     base::WeakPtr<syncer::JsController> js_controller =
         service_->GetJsController();
     js_controller->ProcessJsMessage("getNotificationState",
                                     args1, reply_handler.AsWeakHandle());
   }
 
   IssueTestTokens();
   WaitForBackendInitDone();
 
   // This forces the sync thread to process the message and reply.
   base::WaitableEvent done(false, false);
   service_->GetBackendForTest()->GetSyncLoopForTesting()
       ->PostTask(FROM_HERE,
                  base::Bind(&SignalDone, &done));
   done.Wait();
 }
 
-// Make sure that things still work if sync is not enabled, but some old sync
-// databases are lingering in the "Sync Data" folder.
-TEST_F(ProfileSyncServiceTest, TestStartupWithOldSyncData) {
-  const char* nonsense1 = "reginald";
-  const char* nonsense2 = "beartato";
-  const char* nonsense3 = "harrison";
-  base::FilePath temp_directory =
-      profile_->GetPath().AppendASCII("Sync Data");
-  base::FilePath sync_file1 =
-      temp_directory.AppendASCII("BookmarkSyncSettings.sqlite3");
-  base::FilePath sync_file2 = temp_directory.AppendASCII("SyncData.sqlite3");
-  base::FilePath sync_file3 = temp_directory.AppendASCII("nonsense_file");
-  ASSERT_TRUE(file_util::CreateDirectory(temp_directory));
-  ASSERT_NE(-1,
-            file_util::WriteFile(sync_file1, nonsense1, strlen(nonsense1)));
-  ASSERT_NE(-1,
-            file_util::WriteFile(sync_file2, nonsense2, strlen(nonsense2)));
-  ASSERT_NE(-1,
-            file_util::WriteFile(sync_file3, nonsense3, strlen(nonsense3)));
-
-  StartSyncServiceAndSetInitialSyncEnded(true, false, true, false,
-                                                  syncer::STORAGE_ON_DISK);
-  EXPECT_FALSE(service_->HasSyncSetupCompleted());
-  EXPECT_FALSE(service_->sync_initialized());
-
-  // Since we're doing synchronous initialization, backend should be
-  // initialized by this call.
+TEST_F(ProfileSyncServiceTest, GetSyncTokenStatus) {
+  StartSyncServiceAndSetInitialSyncEnded();
   IssueTestTokens();
-
-  // Stop the service so we can read the new Sync Data files that were
-  // created.
-  service_->Shutdown();
-  service_.reset();
-
-  // This file should have been deleted when the whole directory was nuked.
-  ASSERT_FALSE(base::PathExists(sync_file3));
-  ASSERT_FALSE(base::PathExists(sync_file1));
-
-  // This will still exist, but the text should have changed.
-  ASSERT_TRUE(base::PathExists(sync_file2));
-  std::string file2text;
-  ASSERT_TRUE(base::ReadFileToString(sync_file2, &file2text));
-  ASSERT_NE(file2text.compare(nonsense2), 0);
-}
-
-// Simulates a scenario where a database is corrupted and it is impossible to
-// recreate it.  This test is useful mainly when it is run under valgrind.  Its
-// expectations are not very interesting.
-TEST_F(ProfileSyncServiceTest, FailToOpenDatabase) {
-  StartSyncServiceAndSetInitialSyncEnded(false, true, true, true,
-                                                  syncer::STORAGE_INVALID);
-
-  // The backend is not ready.  Ensure the PSS knows this.
-  EXPECT_FALSE(service_->sync_initialized());
-}
-
-// This setup will allow the database to exist, but leave it empty.  The attempt
-// to download control types will silently fail (no downloads have any effect in
-// these tests).  The sync_backend_host will notice this and inform the profile
-// sync service of the failure to initialize the backed.
-TEST_F(ProfileSyncServiceTest, FailToDownloadControlTypes) {
-  StartSyncServiceAndSetInitialSyncEnded(false, true, true, true,
-                                                  syncer::STORAGE_IN_MEMORY);
-
-  // The backend is not ready.  Ensure the PSS knows this.
-  EXPECT_FALSE(service_->sync_initialized());
-}
-
-TEST_F(ProfileSyncServiceTest, GetSyncTokenStatus) {
-  StartSyncService();
   ProfileSyncService::SyncTokenStatus token_status =
       service_->GetSyncTokenStatus();
   EXPECT_EQ(syncer::CONNECTION_NOT_ATTEMPTED, token_status.connection_status);
   EXPECT_TRUE(token_status.connection_status_update_time.is_null());
   EXPECT_TRUE(token_status.token_request_time.is_null());
   EXPECT_TRUE(token_status.token_receive_time.is_null());
 
   // Sync engine is given invalid token at initialization and will report
   // auth error when trying to connect.
   service_->OnConnectionStatusChange(syncer::CONNECTION_AUTH_ERROR);
   token_status = service_->GetSyncTokenStatus();
   EXPECT_EQ(syncer::CONNECTION_AUTH_ERROR, token_status.connection_status);
   EXPECT_FALSE(token_status.connection_status_update_time.is_null());
   EXPECT_FALSE(token_status.token_request_time.is_null());
   EXPECT_FALSE(token_status.token_receive_time.is_null());
   EXPECT_EQ(GoogleServiceAuthError::AuthErrorNone(),
             token_status.last_get_token_error);
   EXPECT_TRUE(token_status.next_token_request_time.is_null());
 
   // Simulate successful connection.
   service_->OnConnectionStatusChange(syncer::CONNECTION_OK);
   token_status = service_->GetSyncTokenStatus();
   EXPECT_EQ(syncer::CONNECTION_OK, token_status.connection_status);
 }
 
 }  // namespace
 }  // namespace browser_sync