Allow sync integration tests to operate on multiple datatypes: Preferences + Bookmarks

chrome/test/live_sync/live_sync_test.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_TEST_LIVE_SYNC_LIVE_SYNC_TEST_H_
 #define CHROME_TEST_LIVE_SYNC_LIVE_SYNC_TEST_H_
 #pragma once
 
 #include "chrome/test/in_process_browser_test.h"
 
@@ skipping 88 matching lines @@
   // Returns a reference to the collection of sync clients. Callee owns the
   // object and manages its lifetime.
   std::vector<ProfileSyncServiceHarness*>& clients() WARN_UNUSED_RESULT {
     return clients_.get();
   }
 
   // Returns a pointer to the sync profile that is used to verify changes to
   // individual sync profiles. Callee owns the object and manages its lifetime.
   Profile* verifier() WARN_UNUSED_RESULT;
 
+  // Used to determine whether the verifier profile should be updated or not.
+  bool use_verifier_prefs() WARN_UNUSED_RESULT { return use_verifier_prefs_; }
+
+  // After calling this method, changes made to a profile will no longer be
+  // reflected in the verifier profile. Note: Not all datatypes use this.
+  // TODO(rsimha): Hook up all datatypes to this mechanism.
+  void DisableVerifier();

[ncarter (slow), 2011/07/06 17:48:52]

Best to avoid per-datatype methods in LiveSyncTest -- if allowed to mushroom,
they'll muddy the capabilities of this class.  Here's a counterproposal: an
EnableVerifier(ModelType) and DisableVerifier(ModelType) pair.  Any unsupported
modeltypes can then become test failures.  (if you really wanted, you could use
varargs to make the call site cleaner for multiple datatypes)

[Raghu Simha, 2011/07/07 02:14:04]

It may not be readily evident yet, but this should ideally be a sync-wide
method. Over time, I had added copies of it to a bunch of different datatypes,
but now, I'm moving it into the base class so that each datatype can simply use
the mechanism that's in here. Now, if a test wants to make (racy) changes where
the end state is non-deterministic, it simply calls
LiveSyncTest::DisableVerifier(). In upcoming patches, I'll be removing the
copies in other datatypes.

+
   // Initializes sync clients and profiles but does not sync any of them.
   virtual bool SetupClients() WARN_UNUSED_RESULT;
 
   // Initializes sync clients and profiles if required and syncs each of them.
   virtual bool SetupSync() WARN_UNUSED_RESULT;
 
   // Enable outgoing network connections for the given profile.
   virtual void EnableNetwork(Profile* profile);
 
   // Disable outgoing network connections for the given profile.
@@ skipping 106 matching lines @@
   // Collection of sync clients used by a test. A sync client is associated with
   // a sync profile, and implements methods that sync the contents of the
   // profile with the server.
   ScopedVector<ProfileSyncServiceHarness> clients_;
 
   // Sync profile against which changes to individual profiles are verified. We
   // don't need a corresponding verifier sync client because the contents of the
   // verifier profile are strictly local, and are not meant to be synced.
   scoped_ptr<Profile> verifier_;
 
+  // Indicates whether changes to a profile should also change the verifier
+  // profile or not.
+  bool use_verifier_prefs_;
+
   // Sync integration tests need to make live DNS requests for access to
   // GAIA and sync server URLs under google.com. We use a scoped version
   // to override the default resolver while the test is active.
   scoped_ptr<net::ScopedDefaultHostResolverProc> mock_host_resolver_override_;
 
   // Used to start and stop the local test server.
   base::ProcessHandle test_server_handle_;
 
   // Fake URLFetcher factory used to mock out GAIA signin.
   scoped_ptr<FakeURLFetcherFactory> factory_;
 
   // URLFetcher factory used to contact sync server.
   scoped_ptr<URLFetcherFactory> integration_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(LiveSyncTest);
 };
 
 #endif  // CHROME_TEST_LIVE_SYNC_LIVE_SYNC_TEST_H_