[Sync] Refactoring of sync integration test checkers to remove boilerplate await methods.

chrome/browser/sync/test/integration/sync_errors_test.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/macros.h"
 #include "base/run_loop.h"
 #include "build/build_config.h"
 #include "chrome/browser/sync/test/integration/bookmarks_helper.h"
 #include "chrome/browser/sync/test/integration/passwords_helper.h"
 #include "chrome/browser/sync/test/integration/profile_sync_service_harness.h"
 #include "chrome/browser/sync/test/integration/single_client_status_change_checker.h"
-#include "chrome/browser/sync/test/integration/sync_integration_test_util.h"
 #include "chrome/browser/sync/test/integration/sync_test.h"
+#include "chrome/browser/sync/test/integration/updated_progress_marker_checker.h"
 #include "chrome/common/pref_names.h"
 #include "components/browser_sync/profile_sync_service.h"
 #include "components/prefs/pref_member.h"
 #include "components/prefs/pref_service.h"
 #include "components/sync/protocol/sync_protocol_error.h"
 #include "google_apis/gaia/google_service_auth_error.h"
 
 using bookmarks::BookmarkNode;
 using bookmarks_helper::AddFolder;
 using bookmarks_helper::SetTitle;
 using browser_sync::ProfileSyncService;
-using sync_integration_test_util::AwaitCommitActivityCompletion;
 
 namespace {
 
 class SyncDisabledChecker : public SingleClientStatusChangeChecker {
  public:
   explicit SyncDisabledChecker(ProfileSyncService* service)
       : SingleClientStatusChangeChecker(service) {}
 
   bool IsExitConditionSatisfied() override {
     return !service()->IsSetupInProgress() &&
            !service()->IsFirstSetupComplete();
   }
 
   std::string GetDebugMessage() const override { return "Sync Disabled"; }
 };
 
 class SyncBackendStoppedChecker : public SingleClientStatusChangeChecker {
  public:
   explicit SyncBackendStoppedChecker(ProfileSyncService* service)
       : SingleClientStatusChangeChecker(service) {}
 
+  // StatusChangeChecker implementation.
   bool IsExitConditionSatisfied() override {
     return !service()->IsBackendInitialized();
   }
-
   std::string GetDebugMessage() const override { return "Sync stopped"; }
 };
 
 class TypeDisabledChecker : public SingleClientStatusChangeChecker {
  public:
   explicit TypeDisabledChecker(ProfileSyncService* service,
                                syncer::ModelType type)
       : SingleClientStatusChangeChecker(service), type_(type) {}
 
+  // StatusChangeChecker implementation.
   bool IsExitConditionSatisfied() override {
     return !service()->GetActiveDataTypes().Has(type_);
   }
+  std::string GetDebugMessage() const override { return "Type disabled"; }
 
-  std::string GetDebugMessage() const override { return "Type disabled"; }
  private:
-   syncer::ModelType type_;
+  syncer::ModelType type_;
 };
 
-bool AwaitSyncDisabled(ProfileSyncService* service) {
-  SyncDisabledChecker checker(service);
-  checker.Wait();
-  return !checker.TimedOut();
-}
-
-bool AwaitSyncBackendStopped(ProfileSyncService* service) {
-  SyncBackendStoppedChecker checker(service);
-  checker.Wait();
-  return !checker.TimedOut();
-}
-
-bool AwaitTypeDisabled(ProfileSyncService* service,
-                       syncer::ModelType type) {
-  TypeDisabledChecker checker(service, type);
-  checker.Wait();
-  return !checker.TimedOut();
-}
-
 class SyncErrorTest : public SyncTest {
  public:
   SyncErrorTest() : SyncTest(SINGLE_CLIENT) {}
   ~SyncErrorTest() override {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(SyncErrorTest);
 };
 
 // Helper class that waits until the sync engine has hit an actionable error.
@@ skipping 20 matching lines @@
  private:
   DISALLOW_COPY_AND_ASSIGN(ActionableErrorChecker);
 };
 
 IN_PROC_BROWSER_TEST_F(SyncErrorTest, BirthdayErrorTest) {
   ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
 
   // Add an item, wait for sync, and trigger a birthday error on the server.
   const BookmarkNode* node1 = AddFolder(0, 0, "title1");
   SetTitle(0, node1, "new_title1");
-  ASSERT_TRUE(AwaitCommitActivityCompletion(GetSyncService(0)));
+  ASSERT_TRUE(UpdatedProgressMarkerChecker(GetSyncService(0)).Wait());
   GetFakeServer()->ClearServerData();
 
   // Now make one more change so we will do another sync.
   const BookmarkNode* node2 = AddFolder(0, 0, "title2");
   SetTitle(0, node2, "new_title2");
-  ASSERT_TRUE(AwaitSyncDisabled(GetSyncService(0)));
+  ASSERT_TRUE(SyncDisabledChecker(GetSyncService(0)).Wait());
 }
 
 IN_PROC_BROWSER_TEST_F(SyncErrorTest, ActionableErrorTest) {
   ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
 
   const BookmarkNode* node1 = AddFolder(0, 0, "title1");
   SetTitle(0, node1, "new_title1");
-  ASSERT_TRUE(AwaitCommitActivityCompletion(GetSyncService(0)));
+  ASSERT_TRUE(UpdatedProgressMarkerChecker(GetSyncService(0)).Wait());
 
   std::string description = "Not My Fault";
   std::string url = "www.google.com";
   EXPECT_TRUE(GetFakeServer()->TriggerActionableError(
       sync_pb::SyncEnums::TRANSIENT_ERROR,
       description,
       url,
       sync_pb::SyncEnums::UPGRADE_CLIENT));
 
   // Now make one more change so we will do another sync.
   const BookmarkNode* node2 = AddFolder(0, 0, "title2");
   SetTitle(0, node2, "new_title2");
 
   // Wait until an actionable error is encountered.
-  ActionableErrorChecker actionable_error_checker(GetSyncService(0));
-  actionable_error_checker.Wait();
-  ASSERT_FALSE(actionable_error_checker.TimedOut());
+  ASSERT_TRUE(ActionableErrorChecker(GetSyncService(0)).Wait());
 
   ProfileSyncService::Status status;
   GetSyncService(0)->QueryDetailedSyncStatus(&status);
   ASSERT_EQ(status.sync_protocol_error.error_type, syncer::TRANSIENT_ERROR);
   ASSERT_EQ(status.sync_protocol_error.action, syncer::UPGRADE_CLIENT);
   ASSERT_EQ(status.sync_protocol_error.url, url);
   ASSERT_EQ(status.sync_protocol_error.error_description, description);
 }
 
 // This test verifies that sync keeps retrying if it encounters error during
@@ skipping 22 matching lines @@
   // recover and setup succesfully on the third attempt.
   ASSERT_TRUE(GetClient(0)->EnableSyncForDatatype(syncer::AUTOFILL));
 #endif
 }
 
 IN_PROC_BROWSER_TEST_F(SyncErrorTest, BirthdayErrorUsingActionableErrorTest) {
   ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
 
   const BookmarkNode* node1 = AddFolder(0, 0, "title1");
   SetTitle(0, node1, "new_title1");
-  ASSERT_TRUE(AwaitCommitActivityCompletion(GetSyncService(0)));
+  ASSERT_TRUE(UpdatedProgressMarkerChecker(GetSyncService(0)).Wait());
 
   std::string description = "Not My Fault";
   std::string url = "www.google.com";
   EXPECT_TRUE(GetFakeServer()->TriggerActionableError(
       sync_pb::SyncEnums::NOT_MY_BIRTHDAY,
       description,
       url,
       sync_pb::SyncEnums::DISABLE_SYNC_ON_CLIENT));
 
   // Now make one more change so we will do another sync.
   const BookmarkNode* node2 = AddFolder(0, 0, "title2");
   SetTitle(0, node2, "new_title2");
-  ASSERT_TRUE(AwaitSyncDisabled(GetSyncService(0)));
+  ASSERT_TRUE(SyncDisabledChecker(GetSyncService(0)).Wait());
   ProfileSyncService::Status status;
   GetSyncService(0)->QueryDetailedSyncStatus(&status);
   ASSERT_EQ(status.sync_protocol_error.error_type, syncer::NOT_MY_BIRTHDAY);
   ASSERT_EQ(status.sync_protocol_error.action, syncer::DISABLE_SYNC_ON_CLIENT);
   ASSERT_EQ(status.sync_protocol_error.url, url);
   ASSERT_EQ(status.sync_protocol_error.error_description, description);
 }
 
 // Tests that on receiving CLIENT_DATA_OBSOLETE sync backend gets restarted and
 // initialized with different cache_guld.
 IN_PROC_BROWSER_TEST_F(SyncErrorTest, ClientDataObsoleteTest) {
   ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
 
   const BookmarkNode* node1 = AddFolder(0, 0, "title1");
   SetTitle(0, node1, "new_title1");
-  ASSERT_TRUE(AwaitCommitActivityCompletion(GetSyncService(0)));
+  ASSERT_TRUE(UpdatedProgressMarkerChecker(GetSyncService(0)).Wait());
 
   std::string description = "Not My Fault";
   std::string url = "www.google.com";
 
   // Remember cache_guid before actionable error.
   ProfileSyncService::Status status;
   GetSyncService(0)->QueryDetailedSyncStatus(&status);
   std::string old_cache_guid = status.sync_id;
 
   EXPECT_TRUE(
       GetFakeServer()->TriggerError(sync_pb::SyncEnums::CLIENT_DATA_OBSOLETE));
 
   // Trigger sync by making one more change.
   const BookmarkNode* node2 = AddFolder(0, 0, "title2");
   SetTitle(0, node2, "new_title2");
 
-  ASSERT_TRUE(AwaitSyncBackendStopped(GetSyncService(0)));
+  ASSERT_TRUE(SyncBackendStoppedChecker(GetSyncService(0)).Wait());
 
   // Make server return SUCCESS so that sync can initialize.
   EXPECT_TRUE(GetFakeServer()->TriggerError(sync_pb::SyncEnums::SUCCESS));
 
   ASSERT_TRUE(GetClient(0)->AwaitBackendInitialization());
 
   // Ensure cache_guid changed.
   GetSyncService(0)->QueryDetailedSyncStatus(&status);
   ASSERT_NE(old_cache_guid, status.sync_id);
 }
 
 IN_PROC_BROWSER_TEST_F(SyncErrorTest, DisableDatatypeWhileRunning) {
   ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
   syncer::ModelTypeSet synced_datatypes =
       GetSyncService(0)->GetActiveDataTypes();
   ASSERT_TRUE(synced_datatypes.Has(syncer::TYPED_URLS));
   ASSERT_TRUE(synced_datatypes.Has(syncer::SESSIONS));
   GetProfile(0)->GetPrefs()->SetBoolean(
       prefs::kSavingBrowserHistoryDisabled, true);
 
   // Wait for reconfigurations.
-  ASSERT_TRUE(AwaitTypeDisabled(GetSyncService(0), syncer::TYPED_URLS));
-  ASSERT_TRUE(AwaitTypeDisabled(GetSyncService(0), syncer::SESSIONS));
+  ASSERT_TRUE(
+      TypeDisabledChecker(GetSyncService(0), syncer::TYPED_URLS).Wait());
+  ASSERT_TRUE(TypeDisabledChecker(GetSyncService(0), syncer::SESSIONS).Wait());
 
   const BookmarkNode* node1 = AddFolder(0, 0, "title1");
   SetTitle(0, node1, "new_title1");
-  ASSERT_TRUE(AwaitCommitActivityCompletion(GetSyncService(0)));
-  // TODO(lipalani)" Verify initial sync ended for typed url is false.
+  ASSERT_TRUE(UpdatedProgressMarkerChecker(GetSyncService(0)).Wait());
+  // TODO(lipalani): Verify initial sync ended for typed url is false.
 }
 
 }  // namespace