Basic implementation of the Sync C++ fake server

chrome/browser/sync/test/integration/sync_test.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_SYNC_TEST_H_
 #define CHROME_BROWSER_SYNC_TEST_INTEGRATION_SYNC_TEST_H_
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/scoped_vector.h"
 #include "chrome/test/base/in_process_browser_test.h"
 #include "net/dns/mock_host_resolver.h"
 #include "net/http/http_status_code.h"
 #include "net/url_request/url_request_status.h"
 #include "sync/internal_api/public/base/model_type.h"
+#include "sync/internal_api/public/test/fake_server.h"
 #include "sync/protocol/sync_protocol_error.h"
 #include "sync/test/local_sync_test_server.h"
 
 
 class CommandLine;
 class Profile;
 class ProfileSyncServiceHarness;
 
 namespace net {
 class FakeURLFetcherFactory;
@@ skipping 28 matching lines @@
   enum ServerType {
     SERVER_TYPE_UNDECIDED,
     LOCAL_PYTHON_SERVER,   // The mock python server that runs locally and is
                            // part of the Chromium checkout.
     LOCAL_LIVE_SERVER,     // Some other server (maybe the real binary used by
                            // Google's sync service) that can be started on
                            // a per-test basis by running a command
     EXTERNAL_LIVE_SERVER,  // A remote server that the test code has no control
                            // over whatsoever; cross your fingers that the
                            // account state is initially clean.
+    FAKE_SERVER,           // The fake, in-process server (FakeServer) that

[rlarocque, 2013/12/18 20:22:01]

I'm not sure if FAKE_SERVER is the best name for this.  Wouldn't that be an
equally appropriate name for the python server?

How about IN_PROCESS_SERVER?  Maybe someone else on the review has a better
idea.

[Raghu Simha, 2013/12/18 22:37:12]

I like the name IN_PROCESS_SERVER, but there's already an in-process server in
net/test/embedded_test_server/embedded_test_server.h. It's started with every
browser test, but  the sync integration tests don't use it. Maybe call this
IN_PROCESS_SYNC_SERVER?

Also, it might make sense to rename the files fake_server.* based on what name
you pick here.

[pval...(no longer on Chromium), 2013/12/19 01:16:56]

I changed this to IN_PROCESS_FAKE_SERVER so that it fully describes the setup:
the fake server running in-process.

[pval...(no longer on Chromium), 2013/12/19 01:16:56]

I think the IN_PROCESS_FAKE_SERVER naming makes it clear what's happening here.
I'd prefer to not use IN_PROCESS_SYNC_SERVER because it sounds like it's a real
Sync server being used.

As for renaming the FakeServer-related classes, I'd like to keep those as is
(it's the fake server and how it's used doesn't really matter). 

+                           // will replace LOCAL_PYTHON_SERVER.
   };
 
   // NOTE: IMPORTANT the enum here should match with
   // the enum defined on the chromiumsync.py test server impl.
   enum SyncErrorFrequency {
     // Uninitialized state.
     ERROR_FREQUENCY_NONE,
 
     // Server sends the error on all requests.
     ERROR_FREQUENCY_ALWAYS,
@@ skipping 166 matching lines @@
 
   // Creates Profile, Browser and ProfileSyncServiceHarness instances for
   // |index|. Used by SetupClients().
   virtual void InitializeInstance(int index);
 
   // Implementations of the EnableNotifications() and DisableNotifications()
   // functions defined above.
   void DisableNotificationsImpl();
   void EnableNotificationsImpl();
 
+  // Set up the test to use the in-process fake server. This must be called
+  // before SetUp().
+  // TODO(pvalenzuela): Remove this method when the C++ fake server becomes
+  // the default server type.
+  void UseFakeServer();
+
   // GAIA account used by the test case.
   std::string username_;
 
   // GAIA password used by the test case.
   std::string password_;
 
   // Locally available plain text file in which GAIA credentials are stored.
   base::FilePath password_file_;
 
+  // The FakeServer used in tests with server type FAKE_SERVER.
+  scoped_ptr<syncer::FakeServer> fake_server_;
+
  private:
   // Helper to ProfileManager::CreateProfile that handles path creation.
   static Profile* MakeProfile(const base::FilePath::StringType name);
 
   // Helper method used to read GAIA credentials from a local password file
   // specified via the "--password-file-for-test" command line switch.
   // Note: The password file must be a plain text file with exactly two lines --
   // the username on the first line and the password on the second line.
   void ReadPasswordFile();
 
@@ skipping 101 matching lines @@
   scoped_ptr<net::URLFetcherImplFactory> factory_;
 
   // Number of default entries (as determined by the existing entries at setup
   // time on client 0).
   size_t number_of_default_sync_items_;
 
   DISALLOW_COPY_AND_ASSIGN(SyncTest);
 };
 
 #endif  // CHROME_BROWSER_SYNC_TEST_INTEGRATION_SYNC_TEST_H_