Draft: Moving code out of ProfileSyncServiceHarness

chrome/browser/sync/test/integration/status_change_checker.h

 // Copyright 2013 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.
 
 #ifndef CHROME_BROWSER_SYNC_TEST_INTEGRATION_STATUS_CHANGE_CHECKER_H_
 #define CHROME_BROWSER_SYNC_TEST_INTEGRATION_STATUS_CHANGE_CHECKER_H_
 
 #include <string>
 
+#include "base/time/time.h"
+
+class ProfileSyncServiceObserver;
+
 // Interface for a helper class that can be used to check if a desired change in
 // the state of the sync engine has taken place. Used by the desktop sync
 // integration tests.
 //
 // Usage: Tests that want to use this class to wait for an arbitrary sync state
 // must implement a concrete StatusChangeChecker object and pass it to
 // ProfileSyncServiceHarness::AwaitStatusChange().
 class StatusChangeChecker {
  public:
-  explicit StatusChangeChecker(const std::string& source);
+  explicit StatusChangeChecker();
 
   // Called every time ProfileSyncServiceHarness is notified of a change in the
   // state of the sync engine. Returns true if the desired change has occurred.
   virtual bool IsExitConditionSatisfied() = 0;
 
-  std::string source() const { return source_; }
+  // Returns a string representing this current StatusChangeChecker, and
+  // possibly some small part of its state.  For example: "AwaitPassphraseError"
+  // or "AwaitMigrationDone(BOOKMARKS)".
+  virtual std::string GetDebugMessage() const = 0;
+
+  // The maximum length of time to wait for this operation before timing out.
+  virtual base::TimeDelta GetTimeoutDuration() = 0;
+
+  virtual void InitObserver(ProfileSyncServiceObserver*) = 0;
+  virtual void UninitObserver(ProfileSyncServiceObserver*) = 0;
+
+  // Exposed only for the StatusChangeCheckerRunner.  Please don't call this.
+  void set_is_waiting(bool value);
+
+  // Runs the StatusChangeChecker to completion.
+  static bool Run(StatusChangeChecker* checker);
 
  protected:
   virtual ~StatusChangeChecker();
 
+  // Returns true if the 'wait' is in progress.
+  bool IsWaiting();
+
+  // Asks that we stop waiting and return a successfully.  (ie. Don't time out).
+  void StopWaitingAndSucceed();
+
  private:
-  // Used for logging / debugging. Can be used to hold the name of the internal
-  // function called by IsExitConditionSatisfied. Logged along with select info
-  // when ProfileSyncServiceHarness observes a change in ProfileSyncService.
-  std::string source_;
+  bool is_waiting_;
 };
 
 #endif  // CHROME_BROWSER_SYNC_TEST_INTEGRATION_STATUS_CHANGE_CHECKER_H_