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

chrome/browser/sync/test/integration/passwords_helper.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/sync/test/integration/passwords_helper.h"
 
 #include <sstream>
 #include <string>
 #include <utility>
 
 #include "base/compiler_specific.h"
 #include "base/macros.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_store_factory.h"
 #include "chrome/browser/sync/profile_sync_service_factory.h"
-#include "chrome/browser/sync/test/integration/multi_client_status_change_checker.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_datatype_helper.h"
 #include "components/browser_sync/profile_sync_service.h"
 #include "components/password_manager/core/browser/password_manager_test_utils.h"
 #include "components/password_manager/core/browser/password_store.h"
 #include "components/password_manager/core/browser/password_store_consumer.h"
 #include "content/public/test/test_utils.h"
 
 using autofill::PasswordForm;
 using password_manager::PasswordStore;
 using sync_datatype_helper::test;
@@ skipping 157 matching lines @@
   for (int i = 1; i < test()->num_clients(); ++i) {
     if (!ProfilesContainSamePasswordForms(0, i)) {
       DVLOG(1) << "Profile " << i << " does not contain the same password"
                                      " forms as Profile 0.";
       return false;
     }
   }
   return true;
 }
 
-namespace {
+int GetPasswordCount(int index) {
+  return GetLogins(GetPasswordStore(index)).size();
+}
 
-// Helper class used in the implementation of
-// AwaitAllProfilesContainSamePasswordForms.
-class SamePasswordFormsChecker : public MultiClientStatusChangeChecker {
- public:
-  SamePasswordFormsChecker();
-  ~SamePasswordFormsChecker() override;
+int GetVerifierPasswordCount() {
+  return GetLogins(GetVerifierPasswordStore()).size();
+}
 
-  bool IsExitConditionSatisfied() override;
-  std::string GetDebugMessage() const override;
+PasswordForm CreateTestPasswordForm(int index) {
+  PasswordForm form;
+  form.signon_realm = kFakeSignonRealm;
+  form.origin = GURL(base::StringPrintf(kIndexedFakeOrigin, index));
+  form.username_value =
+      base::ASCIIToUTF16(base::StringPrintf("username%d", index));
+  form.password_value =
+      base::ASCIIToUTF16(base::StringPrintf("password%d", index));
+  form.date_created = base::Time::Now();
+  return form;
+}
 
- private:
-  bool in_progress_;
-  bool needs_recheck_;
-};
+}  // namespace passwords_helper
 
 SamePasswordFormsChecker::SamePasswordFormsChecker()
     : MultiClientStatusChangeChecker(
         sync_datatype_helper::test()->GetSyncServices()),
       in_progress_(false),
       needs_recheck_(false) {}
 
-SamePasswordFormsChecker::~SamePasswordFormsChecker() {}
-
 // This method needs protection against re-entrancy.
 //
 // This function indirectly calls GetLogins(), which starts a RunLoop on the UI
 // thread.  This can be a problem, since the next task to execute could very
 // well contain a ProfileSyncService::OnStateChanged() event, which would
 // trigger another call to this here function, and start another layer of
 // nested RunLoops.  That makes the StatusChangeChecker's Quit() method
 // ineffective.
 //
 // The work-around is to not allow re-entrancy.  But we can't just drop
 // IsExitConditionSatisifed() calls if one is already in progress.  Instead, we
 // set a flag to ask the current execution of IsExitConditionSatisfied() to be
 // re-run.  This ensures that the return value is always based on the most
 // up-to-date state.
 bool SamePasswordFormsChecker::IsExitConditionSatisfied() {
   if (in_progress_) {
     LOG(WARNING) << "Setting flag and returning early to prevent nesting.";
     needs_recheck_ = true;
     return false;
   }
 
   // Keep retrying until we get a good reading.
   bool result = false;
   in_progress_ = true;
   do {
     needs_recheck_ = false;
-    result = AllProfilesContainSamePasswordForms();
+    result = passwords_helper::AllProfilesContainSamePasswordForms();
   } while (needs_recheck_);
   in_progress_ = false;
   return result;
 }
 
 std::string SamePasswordFormsChecker::GetDebugMessage() const {
   return "Waiting for matching passwords";
 }
 
-}  //  namespace
-
-bool AwaitAllProfilesContainSamePasswordForms() {
-  SamePasswordFormsChecker checker;
-  checker.Wait();
-  return !checker.TimedOut();
-}
-
-namespace {
-
-// Helper class used in the implementation of
-// AwaitProfileContainSamePasswordFormsAsVerifier.
-class SamePasswordFormsAsVerifierChecker
-    : public SingleClientStatusChangeChecker {
- public:
-  explicit SamePasswordFormsAsVerifierChecker(int index);
-  ~SamePasswordFormsAsVerifierChecker() override;
-
-  bool IsExitConditionSatisfied() override;
-  std::string GetDebugMessage() const override;
-
- private:
-  int index_;
-
-  bool in_progress_;
-  bool needs_recheck_;
-};
-
 SamePasswordFormsAsVerifierChecker::SamePasswordFormsAsVerifierChecker(int i)
     : SingleClientStatusChangeChecker(
           sync_datatype_helper::test()->GetSyncService(i)),
       index_(i),
       in_progress_(false),
       needs_recheck_(false) {
 }
 
-SamePasswordFormsAsVerifierChecker::~SamePasswordFormsAsVerifierChecker() {
-}
-
 // This method uses the same re-entrancy prevention trick as
 // the SamePasswordFormsChecker.
 bool SamePasswordFormsAsVerifierChecker::IsExitConditionSatisfied() {
   if (in_progress_) {
     LOG(WARNING) << "Setting flag and returning early to prevent nesting.";
     needs_recheck_ = true;
     return false;
   }
 
   // Keep retrying until we get a good reading.
   bool result = false;
   in_progress_ = true;
   do {
     needs_recheck_ = false;
-    result = ProfileContainsSamePasswordFormsAsVerifier(index_);
+    result =
+        passwords_helper::ProfileContainsSamePasswordFormsAsVerifier(index_);
   } while (needs_recheck_);
   in_progress_ = false;
   return result;
 }
 
 std::string SamePasswordFormsAsVerifierChecker::GetDebugMessage() const {
   return "Waiting for passwords to match verifier";
 }
-
-}  //  namespace
-
-bool AwaitProfileContainsSamePasswordFormsAsVerifier(int index) {
-  SamePasswordFormsAsVerifierChecker checker(index);
-  checker.Wait();
-  return !checker.TimedOut();
-}
-
-int GetPasswordCount(int index) {
-  return GetLogins(GetPasswordStore(index)).size();
-}
-
-int GetVerifierPasswordCount() {
-  return GetLogins(GetVerifierPasswordStore()).size();
-}
-
-PasswordForm CreateTestPasswordForm(int index) {
-  PasswordForm form;
-  form.signon_realm = kFakeSignonRealm;
-  form.origin = GURL(base::StringPrintf(kIndexedFakeOrigin, index));
-  form.username_value =
-      base::ASCIIToUTF16(base::StringPrintf("username%d", index));
-  form.password_value =
-      base::ASCIIToUTF16(base::StringPrintf("password%d", index));
-  form.date_created = base::Time::Now();
-  return form;
-}
-
-}  // namespace passwords_helper