[sync] Eliminate Await*SyncCompletion methods in integration tests

chrome/browser/sync/test/integration/profile_sync_service_harness.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_PROFILE_SYNC_SERVICE_HARNESS_H_
 #define CHROME_BROWSER_SYNC_TEST_INTEGRATION_PROFILE_SYNC_SERVICE_HARNESS_H_
 
 #include <string>
 #include <vector>
 
@@ skipping 57 matching lines @@
   bool SetupSync(syncer::ModelTypeSet synced_datatypes);
 
   // ProfileSyncServiceObserver implementation.
   virtual void OnStateChanged() OVERRIDE;
   virtual void OnSyncCycleCompleted() OVERRIDE;
 
   // Blocks the caller until the sync backend host associated with this harness
   // has been initialized.  Returns true if the wait was successful.
   bool AwaitBackendInitialized();
 
-  // Blocks the caller until this harness has completed a single sync cycle
-  // since the previous one.  Returns true if a sync cycle has completed.
-  bool AwaitDataSyncCompletion();
-
-  // Blocks the caller until this harness has completed as many sync cycles as
-  // are required to ensure its progress marker matches the latest available on
-  // the server.
-  //
-  // Note: When other clients are committing changes this will not be reliable.
-  // If your test involves changes to multiple clients, you should use one of
-  // the other Await* functions, such as AwaitMutualSyncCycleComplete.  Refer to
-  // the documentation of those functions for more details.
-  bool AwaitFullSyncCompletion();
+  // Blocks the caller until the client has nothing left to commit and its
+  // progress markers are up to date. Returns true if successful.
+  bool AwaitCommitActivityCompletion();
 
   // Blocks the caller until sync has been disabled for this client. Returns
   // true if sync is disabled.
   bool AwaitSyncDisabled();
 
   // Blocks the caller until this harness has observed that the sync engine
   // has downloaded all the changes seen by the |partner| harness's client.
   bool WaitUntilProgressMarkersMatch(ProfileSyncServiceHarness* partner);
 
   // Calling this acts as a barrier and blocks the caller until |this| and
@@ skipping 65 matching lines @@
   // Returns true if encryption is complete for all datatypes, and false
   // otherwise.
   bool IsEncryptionComplete() const;
 
   // Check if |type| is registered and the controller is running.
   bool IsTypeRunning(syncer::ModelType type);
 
   // Check if |type| is being synced.
   bool IsTypePreferred(syncer::ModelType type);
 
-  // Returns true if the sync client has no unsynced items.
-  bool IsDataSynced() const;
-
-  // Returns true if the sync client has no unsynced items and its progress
-  // markers are believed to be up to date.
-  //
-  // Although we can't detect when commits from other clients invalidate our
-  // local progress markers, we do know when our own commits have invalidated
-  // our timestmaps.  This check returns true when this client has, to the best
-  // of its knowledge, downloaded the latest progress markers.
-  bool IsFullySynced() const;
-
   // Get the number of sync entries this client has. This includes all top
   // level or permanent items, and can include recently deleted entries.
   size_t GetNumEntries() const;
 
   // Get the number of sync datatypes registered (ignoring whatever state
   // they're in).
   size_t GetNumDatatypes() const;
 
   // Gets the |auto_start_enabled_| variable from the |service_|.
   bool AutoStartEnabled();
 
+  // Runs the message loop and waits until all in-flight tasks are completed.
+  // Returns true if a steady state was reached within a timeout period, and
+  // false if a timeout was hit.
+  bool AwaitSteadyState();
+
   // Runs the UI message loop and waits until the Run() method of |checker|
   // returns true, indicating that the status change we are waiting for has
   // taken place. Caller retains ownership of |checker|, which must outlive this
   // method. Returns true if the status change was observed. In case of a
   // timeout, we log the |source| of the call to this method, and return false.
   bool AwaitStatusChange(StatusChangeChecker* checker,
                          const std::string& source);
 
   // Returns a string that can be used as the value of an oauth2 refresh token.
   // This function guarantees that a different string is returned each time
   // it is called.
   std::string GenerateFakeOAuth2RefreshTokenString();
 
   // Returns a string with relevant info about client's sync state (if
   // available), annotated with |message|. Useful for logging.
   std::string GetClientInfoString(const std::string& message) const;
 
   // Returns true if this client has downloaded all the items that the
   // other client has.
   bool MatchesPartnerClient() const;
 
-  // Returns true if there is a backend migration in progress.
-  bool HasPendingBackendMigration() const;
-
  private:
   ProfileSyncServiceHarness(
       Profile* profile,
       const std::string& username,
       const std::string& password,
       invalidation::P2PInvalidationService* invalidation_service);
 
+  // Runs the UI message loop. If |quit_when_idle| is true, the loop is quit
+  // soon after in-flight tasks are complete (or a timeout limit is hit).
+  // If |quit_when_idle| is false, the loop is run indefinitely until it is
+  // explicitly quit (or a timeout limit is hit). Returns false if the timeout
+  // limit was hit, and true otherwise.
+  bool RunMessageLoop(bool quit_when_idle);
+
   // Quits the current message loop. Called when the status change being waited
   // on has occurred, or in the event of a timeout.
   void QuitMessageLoop();
 
-  // A helper for implementing IsDataSynced() and IsFullySynced().
-  bool IsDataSyncedImpl() const;
-
   // Signals that sync setup is complete, and that PSS may begin syncing.
   void FinishSyncSetup();
 
   // Gets the current progress marker of the current sync session for a
   // particular datatype. Returns an empty string if the progress marker isn't
   // found.
   std::string GetSerializedProgressMarker(syncer::ModelType model_type) const;
 
+  // Returns true if a client has nothing left to commit and its progress
+  // markers are up to date.
+  bool IsCommitActivityComplete() const;
+
+  // Returns true if sync setup is complete. Called during first time sync setup
+  // and when sync is re-enabled after having been disabled.
+  bool IsSyncSetupComplete() const;
+
   // Gets detailed status from |service_| in pretty-printable form.
   std::string GetServiceStatus();
 
   // Sync profile associated with this sync client.
   Profile* profile_;
 
   // ProfileSyncService object associated with |profile_|.
   ProfileSyncService* service_;
 
   // P2PInvalidationService associated with |profile_|.
@@ skipping 15 matching lines @@
   const std::string profile_debug_name_;
 
   // Keeps track of the state change on which we are waiting. PSSHarness can
   // wait on only one status change at a time.
   StatusChangeChecker* status_change_checker_;
 
   DISALLOW_COPY_AND_ASSIGN(ProfileSyncServiceHarness);
 };
 
 #endif  // CHROME_BROWSER_SYNC_TEST_INTEGRATION_PROFILE_SYNC_SERVICE_HARNESS_H_