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

chrome/browser/sync/test/integration/preferences_helper.cc

 // Copyright (c) 2011 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/preferences_helper.h"
 
+#include <utility>
+
 #include "base/strings/stringprintf.h"
 #include "chrome/browser/profiles/profile.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/sync_datatype_helper.h"
 #include "chrome/browser/sync/test/integration/sync_test.h"
 #include "components/prefs/pref_change_registrar.h"
 #include "components/prefs/pref_service.h"
 #include "components/prefs/scoped_user_pref_update.h"
 
 using sync_datatype_helper::test;
 
 namespace preferences_helper {
@@ skipping 183 matching lines @@
   for (int i = 0; i < test()->num_clients(); ++i) {
     if (!reference_value->Equals(GetPrefs(i)->GetList(pref_name))) {
       DVLOG(1) << "List preference " << pref_name << " mismatched in"
                << " profile " << i << ".";
       return false;
     }
   }
   return true;
 }
 
-
-namespace {
-
-class PrefMatchChecker : public StatusChangeChecker {
- public:
-  explicit PrefMatchChecker(const char* path);
-  ~PrefMatchChecker() override;
-
-  // StatusChangeChecker implementation.
-  bool IsExitConditionSatisfied() override = 0;
-  std::string GetDebugMessage() const override;
-
-  // Wait for condition to become true.
-  void Wait();
-
- protected:
-  const char* GetPath() const;
-
- private:
-  void RegisterPrefListener(PrefService* pref_service);
-
-  ScopedVector<PrefChangeRegistrar> pref_change_registrars_;
-  const char* path_;
-};
+}  // namespace preferences_helper
 
 PrefMatchChecker::PrefMatchChecker(const char* path) : path_(path) {
+  if (test()->use_verifier()) {
+    RegisterPrefListener(preferences_helper::GetVerifierPrefs());
+  }
+  for (int i = 0; i < test()->num_clients(); ++i) {
+    RegisterPrefListener(preferences_helper::GetPrefs(i));
+  }
 }
 
-PrefMatchChecker::~PrefMatchChecker() {
-}
+PrefMatchChecker::~PrefMatchChecker() {}
 
 std::string PrefMatchChecker::GetDebugMessage() const {
   return base::StringPrintf("Waiting for pref '%s' to match", GetPath());
 }
 
-void PrefMatchChecker::Wait() {
-  if (test()->use_verifier()) {
-    RegisterPrefListener(GetVerifierPrefs());
-  }
-
-  for (int i = 0; i < test()->num_clients(); ++i) {
-    RegisterPrefListener(GetPrefs(i));
-  }
-
-  if (IsExitConditionSatisfied()) {
-    return;
-  }
-
-  StartBlockingWait();
-}
-
 const char* PrefMatchChecker::GetPath() const {
   return path_;
 }
 
 void PrefMatchChecker::RegisterPrefListener(PrefService* pref_service) {
   std::unique_ptr<PrefChangeRegistrar> registrar(new PrefChangeRegistrar());
   registrar->Init(pref_service);
   registrar->Add(path_,
                  base::Bind(&PrefMatchChecker::CheckExitCondition,
                             base::Unretained(this)));
-  pref_change_registrars_.push_back(registrar.release());
+  pref_change_registrars_.push_back(std::move(registrar));
 }
 
-// Helper class used in the implementation of AwaitListPrefMatches.
-class ListPrefMatchChecker : public PrefMatchChecker {
- public:
-  explicit ListPrefMatchChecker(const char* path);
-  ~ListPrefMatchChecker() override;
+ListPrefMatchChecker::ListPrefMatchChecker(const char* path)
+    : PrefMatchChecker(path) {}
 
-  // Implementation of PrefMatchChecker.
-  bool IsExitConditionSatisfied() override;
-};
-
-ListPrefMatchChecker::ListPrefMatchChecker(const char* path)
-    : PrefMatchChecker(path) {
+bool ListPrefMatchChecker::IsExitConditionSatisfied() {
+  return preferences_helper::ListPrefMatches(GetPath());
 }
 
-ListPrefMatchChecker::~ListPrefMatchChecker() {
+BooleanPrefMatchChecker::BooleanPrefMatchChecker(const char* path)
+    : PrefMatchChecker(path) {}
+
+bool BooleanPrefMatchChecker::IsExitConditionSatisfied() {
+  return preferences_helper::BooleanPrefMatches(GetPath());
 }
 
-bool ListPrefMatchChecker::IsExitConditionSatisfied() {
-  return ListPrefMatches(GetPath());
+IntegerPrefMatchChecker::IntegerPrefMatchChecker(const char* path)
+    : PrefMatchChecker(path) {}
+
+bool IntegerPrefMatchChecker::IsExitConditionSatisfied() {
+  return preferences_helper::IntegerPrefMatches(GetPath());
 }
 
-// Helper class used in the implementation of AwaitBooleanPrefMatches.
-class BooleanPrefMatchChecker : public PrefMatchChecker {
- public:
-  explicit BooleanPrefMatchChecker(const char* path);
-  ~BooleanPrefMatchChecker() override;
-
-  // Implementation of PrefMatchChecker.
-  bool IsExitConditionSatisfied() override;
-};
-
-BooleanPrefMatchChecker::BooleanPrefMatchChecker(const char* path)
-    : PrefMatchChecker(path) {
-}
-
-BooleanPrefMatchChecker::~BooleanPrefMatchChecker() {
-}
-
-bool BooleanPrefMatchChecker::IsExitConditionSatisfied() {
-  return BooleanPrefMatches(GetPath());
-}
-
-// Helper class used in the implementation of AwaitIntegerPrefMatches.
-class IntegerPrefMatchChecker : public PrefMatchChecker {
- public:
-  explicit IntegerPrefMatchChecker(const char* path);
-  ~IntegerPrefMatchChecker() override;
-
-  // Implementation of PrefMatchChecker.
-  bool IsExitConditionSatisfied() override;
-};
-
-IntegerPrefMatchChecker::IntegerPrefMatchChecker(const char* path)
-    : PrefMatchChecker(path) {
-}
-
-IntegerPrefMatchChecker::~IntegerPrefMatchChecker() {
-}
-
-bool IntegerPrefMatchChecker::IsExitConditionSatisfied() {
-  return IntegerPrefMatches(GetPath());
-}
-
-// Helper class used in the implementation of AwaitStringPrefMatches.
-class StringPrefMatchChecker : public PrefMatchChecker {
- public:
-  explicit StringPrefMatchChecker(const char* path);
-  ~StringPrefMatchChecker() override;
-
-  // Implementation of PrefMatchChecker.
-  bool IsExitConditionSatisfied() override;
-};
-
 StringPrefMatchChecker::StringPrefMatchChecker(const char* path)
-    : PrefMatchChecker(path) {
-}
-
-StringPrefMatchChecker::~StringPrefMatchChecker() {
-}
+    : PrefMatchChecker(path) {}
 
 bool StringPrefMatchChecker::IsExitConditionSatisfied() {
-  return StringPrefMatches(GetPath());
+  return preferences_helper::StringPrefMatches(GetPath());
 }
-
-}  //  namespace
-
-bool AwaitListPrefMatches(const char* pref_name) {

[maxbogue, 2016/09/30 16:27:55]

I'm not even halfway through this CL and I can't believe how many methods
exactly like this got made without someone considering changing things.

[skym, 2016/09/30 17:43:21]

Right!?

-  ListPrefMatchChecker checker(pref_name);
-  checker.Wait();
-  return !checker.TimedOut();
-}
-
-bool AwaitBooleanPrefMatches(const char* pref_name) {
-  BooleanPrefMatchChecker checker(pref_name);
-  checker.Wait();
-  return !checker.TimedOut();
-}
-
-bool AwaitIntegerPrefMatches(const char* pref_name) {
-  IntegerPrefMatchChecker checker(pref_name);
-  checker.Wait();
-  return !checker.TimedOut();
-}
-
-bool AwaitStringPrefMatches(const char* pref_name) {
-  StringPrefMatchChecker checker(pref_name);
-  checker.Wait();
-  return !checker.TimedOut();
-}
-
-}  // namespace preferences_helper