test cases for server directed error handling code.

chrome/browser/sync/profile_sync_service_harness.h

 // 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.
 
 #ifndef CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_HARNESS_H_
 #define CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_HARNESS_H_
 #pragma once
 
 #include <string>
 #include <vector>
@@ skipping 49 matching lines @@
   // Same as the above method, but enables sync only for the datatypes contained
   // in |synced_datatypes|.
   bool SetupSync(const syncable::ModelTypeSet& synced_datatypes);
 
   // ProfileSyncServiceObserver implementation.
   virtual void OnStateChanged() OVERRIDE;
 
   // MigrationObserver implementation.
   virtual void OnMigrationStateChange() OVERRIDE;
 
-  // Blocks the caller until the sync backend host associated with this harness
+  // Blocks the caller until sync backend host associated with this harness

[Raghu Simha, 2011/09/19 22:25:02]

Undo this change.

[lipalani1, 2011/09/22 20:42:46]

Done.

   // has been initialized.  Returns true if the wait was successful.
   bool AwaitBackendInitialized();
 
   // Blocks the caller until the datatype manager is configured and sync has
   // been initialized (for example, after a browser restart).  Returns true if
   // the wait was successful.
   bool AwaitSyncRestart();
 
   // 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 AwaitSyncCycleCompletion(const std::string& reason);
 
-  // Blocks the caller until the sync has been disabled for this client. Returns
+  // Blocks the caller until sync has been disabled for this client. Returns
   // true if sync is disabled.
   bool AwaitSyncDisabled(const std::string& reason);
 
   // Blocks the caller until exponential backoff has been verified to happen.
   bool AwaitExponentialBackoffVerification();
 
+  // Blocks the caller until the syncer receives an actionable error. And
+  // return true if sync client had received an actionable error.

[Raghu Simha, 2011/09/19 22:25:02]

s/And return true if sync client had received/Returns true if the sync client
received/

[lipalani1, 2011/09/22 20:42:46]

Done.

[Raghu Simha, 2011/09/22 21:15:10]

This isn't done yet.
s/And returns true if sync client received/Returns true if the sync client
received/

[lipalani1, 2011/09/22 21:23:57]

Done.

+  bool AwaitActionableError();
+
   // Blocks until the given set of data types are migrated.
   bool AwaitMigration(const syncable::ModelTypeSet& expected_migrated_types);
 
-  // Blocks the caller until this harness has observed that the sync engine
+  // Blocks the caller until this harness has observed that sync engine

[Raghu Simha, 2011/09/19 22:25:02]

Undo this change.

[lipalani1, 2011/09/22 20:42:46]

Done.

   // has downloaded all the changes seen by the |partner| harness's client.
   bool WaitUntilTimestampMatches(
       ProfileSyncServiceHarness* partner, const std::string& reason);
 
   // Calling this acts as a barrier and blocks the caller until |this| and
   // |partner| have both completed a sync cycle.  When calling this method,
   // the |partner| should be the passive responder who responds to the actions
   // of |this|.  This method relies upon the synchronization of callbacks
   // from the message queue. Returns true if two sync cycles have completed.
   // Note: Use this method when exactly one client makes local change(s), and
@@ skipping 14 matching lines @@
   static bool AwaitQuiescence(
       std::vector<ProfileSyncServiceHarness*>& clients);
 
   // Blocks the caller until |service_| indicates that a passphrase is required.
   bool AwaitPassphraseRequired();
 
   // Blocks the caller until |service_| indicates that the passphrase set by
   // calling SetPassphrase has been accepted.
   bool AwaitPassphraseAccepted();
 
-  // Returns the ProfileSyncService member of the the sync client.
+  // Returns the ProfileSyncService member of sync client.

[Raghu Simha, 2011/09/19 22:25:02]

s/of sync client/of the sync client/

[lipalani1, 2011/09/22 20:42:46]

Done.

   ProfileSyncService* service() { return service_; }
 
-  // Returns the status of the ProfileSyncService member of the the sync client.
+  // Returns the status of the ProfileSyncService member of sync client.

[Raghu Simha, 2011/09/19 22:25:02]

s/of sync client/of the sync client/

[lipalani1, 2011/09/22 20:42:46]

Done.

   ProfileSyncService::Status GetStatus();
 
   // See ProfileSyncService::ShouldPushChanges().
   bool ServiceIsPushingChanges() { return service_->ShouldPushChanges(); }
 
   // Enables sync for a particular sync datatype. Returns true on success.
   bool EnableSyncForDatatype(syncable::ModelType datatype);
 
   // Disables sync for a particular sync datatype. Returns true on success.
   bool DisableSyncForDatatype(syncable::ModelType datatype);
 
   // Enables sync for all sync datatypes. Returns true on success.
   bool EnableSyncForAllDatatypes();
 
   // Disables sync for all sync datatypes. Returns true on success.
   bool DisableSyncForAllDatatypes();
 
   // Returns a snapshot of the current sync session.
   const browser_sync::sessions::SyncSessionSnapshot*
       GetLastSessionSnapshot() const;
 
-  // Encrypt the datatype |type|. This method will block while the sync backend
+  // Encrypt the datatype |type|. This method will block while sync backend

[Raghu Simha, 2011/09/19 22:25:02]

Undo this change.

[lipalani1, 2011/09/22 20:42:46]

Done.

   // host performs the encryption or a timeout is reached.
   // PostCondition:
   //   returns: True if |type| was encrypted and we are fully synced.
   //            False if we timed out.
   bool EnableEncryptionForType(syncable::ModelType type);
 
   // Wait until |type| is encrypted or we time out.
   // PostCondition:
   //   returns: True if |type| is currently encrypted and we are fully synced.
   //            False if we timed out.
@@ skipping 36 matching lines @@
     WAITING_FOR_PASSPHRASE_ACCEPTED,
 
     // The sync client anticipates encryption of new datatypes.
     WAITING_FOR_ENCRYPTION,
 
     // The sync client is waiting for the datatype manager to be configured and
     // for sync to be fully initialized. Used after a browser restart, where a
     // full sync cycle is not expected to occur.
     WAITING_FOR_SYNC_CONFIGURATION,
 
-    // The sync client is waiting for the sync to be disabled for this client.
+    // The sync client is waiting for sync to be disabled for this client.
     WAITING_FOR_SYNC_DISABLED,
 
     // The sync client is in the exponential backoff mode. Verify that
     // backoffs are triggered correctly.
     WAITING_FOR_EXPONENTIAL_BACKOFF_VERIFICATION,
 
     // The sync client is waiting for migration to start.
     WAITING_FOR_MIGRATION_TO_START,
 
     // The sync client is waiting for migration to finish.
     WAITING_FOR_MIGRATION_TO_FINISH,
 
+    // The sync client is waiting for an actionable error from the server.
+    WAITING_FOR_ACTIONABLE_ERROR,
+
     // The client verification is complete. We don't care about the state of
     // the syncer any more.
     WAITING_FOR_NOTHING,
 
     // The sync client needs a passphrase in order to decrypt data.
     SET_PASSPHRASE_FAILED,
 
     // The sync client cannot reach the server.
     SERVER_UNREACHABLE,
 
@@ skipping 80 matching lines @@
   const std::string profile_debug_name_;
 
   // Keeps track of the number of attempts at exponential backoff and its
   // related bookkeeping information for verification.
   browser_sync::RetryVerifier retry_verifier_;
 
   DISALLOW_COPY_AND_ASSIGN(ProfileSyncServiceHarness);
 };
 
 #endif  // CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_HARNESS_H_