Reland - Replace FakeServer's implementation with LoopbackServer invocations.

components/sync/test/fake_server/fake_server.h

 // Copyright 2014 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 COMPONENTS_SYNC_TEST_FAKE_SERVER_FAKE_SERVER_H_
 #define COMPONENTS_SYNC_TEST_FAKE_SERVER_FAKE_SERVER_H_
 
 #include <stdint.h>
 
 #include <map>
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "base/callback.h"
+#include "base/files/scoped_temp_dir.h"
 #include "base/observer_list.h"
 #include "base/threading/thread_checker.h"
 #include "base/values.h"
 #include "components/sync/base/model_type.h"
+#include "components/sync/engine_impl/loopback_server/loopback_server.h"
+#include "components/sync/engine_impl/loopback_server/loopback_server_entity.h"
+#include "components/sync/engine_impl/loopback_server/persistent_bookmark_entity.h"
+#include "components/sync/engine_impl/loopback_server/persistent_tombstone_entity.h"
+#include "components/sync/engine_impl/loopback_server/persistent_unique_client_entity.h"
 #include "components/sync/protocol/sync.pb.h"
-#include "components/sync/test/fake_server/fake_server_entity.h"
 
 namespace fake_server {
 
 // A fake version of the Sync server used for testing. This class is not thread
 // safe.
-class FakeServer {
+class FakeServer : public syncer::LoopbackServer::ObserverForTests {
  public:
   class Observer {
    public:
     virtual ~Observer() {}
 
     // Called after FakeServer has processed a successful commit. The types
     // updated as part of the commit are passed in |committed_model_types|.
     virtual void OnCommit(const std::string& committer_id,
                           syncer::ModelTypeSet committed_model_types) = 0;
   };
 
   FakeServer();
-  virtual ~FakeServer();
+  ~FakeServer() override;
 
   // Handles a /command POST (with the given |request|) to the server. Three
   // output arguments, |error_code|, |response_code|, and |response|, are used
   // to pass data back to the caller. The command has failed if the value
   // pointed to by |error_code| is nonzero. |completion_closure| will be called
   // immediately before return.
   void HandleCommand(const std::string& request,
                      const base::Closure& completion_closure,
                      int* error_code,
                      int* response_code,
                      std::string* response);
 
   // Helpers for fetching the last Commit or GetUpdates messages, respectively.
   // Returns true if the specified message existed, and false if no message has
   // been received.
   bool GetLastCommitMessage(sync_pb::ClientToServerMessage* message);
   bool GetLastGetUpdatesMessage(sync_pb::ClientToServerMessage* message);
 
   // Creates a DicionaryValue representation of all entities present in the
   // server. The dictionary keys are the strings generated by ModelTypeToString
   // and the values are ListValues containing StringValue versions of entity
   // names.
   std::unique_ptr<base::DictionaryValue> GetEntitiesAsDictionaryValue();
 
   // Returns all entities stored by the server of the given |model_type|.
   // This method returns SyncEntity protocol buffer objects (instead of
-  // FakeServerEntity) so that callers can inspect datatype-specific data
+  // LoopbackServerEntity) so that callers can inspect datatype-specific data
   // (e.g., the URL of a session tab).
   std::vector<sync_pb::SyncEntity> GetSyncEntitiesByModelType(
       syncer::ModelType model_type);
 
   // Adds |entity| to the server's collection of entities. This method makes no
   // guarantees that the added entity will result in successful server
   // operations.
-  void InjectEntity(std::unique_ptr<FakeServerEntity> entity);
+  void InjectEntity(std::unique_ptr<syncer::LoopbackServerEntity> entity);
 
   // Modifies the entity on the server with the given |id|. The entity's
   // EntitySpecifics are replaced with |updated_specifics| and its version is
   // updated. If the given |id| does not exist or the ModelType of
   // |updated_specifics| does not match the entity, false is returned.
   // Otherwise, true is returned to represent a successful modification.
   //
   // This method sometimes updates entity data beyond EntitySpecifics. For
   // example, in the case of a bookmark, changing the BookmarkSpecifics title
   // field will modify the top-level entity's name field.
@@ skipping 47 matching lines @@
   // must be called if AddObserver was ever called with |observer|.
   void RemoveObserver(Observer* observer);
 
   // Undoes the effects of DisableNetwork.
   void EnableNetwork();
 
   // Forces every request to fail in a way that simulates a network failure.
   // This can be used to trigger exponential backoff in the client.
   void DisableNetwork();
 
-  // Returns the entity ID of the Bookmark Bar folder.
-  std::string GetBookmarkBarFolderId() const;
+  // Implement LoopbackServer::ObserverForTests:
+  void OnCommit(const std::string& committer_id,
+                syncer::ModelTypeSet committed_model_types) override;
 
   // Returns the current FakeServer as a WeakPtr.
   base::WeakPtr<FakeServer> AsWeakPtr();
 
-  using ResponseTypeProvider =
-      base::RepeatingCallback<sync_pb::CommitResponse::ResponseType(
-          const FakeServerEntity& entity)>;
-
   // Use this callback to generate response types for entities. They will still
   // be "committed" and stored as normal, this only affects the response type
   // the client sees. This allows tests to still inspect what the client has
   // done, although not as useful of a mechanism for multi client tests. Care
   // should be taken when failing responses, as the client will go into
   // exponential backoff, which can cause tests to be slow or time out.
-  void OverrideResponseType(ResponseTypeProvider response_type_override);
+  void OverrideResponseType(
+      syncer::LoopbackServer::ResponseTypeProvider response_type_override);
 
  private:
-  using EntityMap = std::map<std::string, std::unique_ptr<FakeServerEntity>>;
-
-  // Gets FakeServer ready for syncing.
-  void Init();
-
-  // Processes a GetUpdates call.
-  bool HandleGetUpdatesRequest(const sync_pb::GetUpdatesMessage& get_updates,
-                               sync_pb::GetUpdatesResponse* response);
-
-  // Processes a Commit call.
-  bool HandleCommitRequest(const sync_pb::CommitMessage& message,
-                           const std::string& invalidator_client_id,
-                           sync_pb::CommitResponse* response);
-
-  // Creates and saves a permanent folder for Bookmarks (e.g., Bookmark Bar).
-  bool CreatePermanentBookmarkFolder(const std::string& server_tag,
-                                     const std::string& name);
-
-  // Inserts the default permanent items in |entities_|.
-  bool CreateDefaultPermanentItems();
-
-  // Saves a |entity| to |entities_|.
-  void SaveEntity(std::unique_ptr<FakeServerEntity> entity);
-
-  // Commits a client-side SyncEntity to the server as a FakeServerEntity.
-  // The client that sent the commit is identified via |client_guid|. The
-  // parent ID string present in |client_entity| should be ignored in favor
-  // of |parent_id|. If the commit is successful, the entity's server ID string
-  // is returned and a new FakeServerEntity is saved in |entities_|.
-  std::string CommitEntity(
-      const sync_pb::SyncEntity& client_entity,
-      sync_pb::CommitResponse_EntryResponse* entry_response,
-      const std::string& client_guid,
-      const std::string& parent_id);
-
-  // Populates |entry_response| based on the stored entity identified by
-  // |entity_id|. It is assumed that the entity identified by |entity_id| has
-  // already been stored using SaveEntity.
-  void BuildEntryResponseForSuccessfulCommit(
-      const std::string& entity_id,
-      sync_pb::CommitResponse_EntryResponse* entry_response);
-
-  // Determines whether the SyncEntity with id_string |id| is a child of an
-  // entity with id_string |potential_parent_id|.
-  bool IsChild(const std::string& id, const std::string& potential_parent_id);
-
-  // Creates and saves tombstones for all children of the entity with the given
-  // |id|. A tombstone is not created for the entity itself.
-  void DeleteChildren(const std::string& id);
-
   // Returns whether a triggered error should be sent for the request.
   bool ShouldSendTriggeredError() const;
 
-  // Updates the |entity| to a new version and increments the version counter
-  // that the server uses to assign versions.
-  void UpdateEntityVersion(FakeServerEntity* entity);
-
-  // Returns the store birthday.
-  std::string GetStoreBirthday() const;
-
-  // This is the last version number assigned to an entity. The next entity will
-  // have a version number of version_ + 1.
-  int64_t version_;
-
-  // The current store birthday value.
-  int64_t store_birthday_;
-
   // Whether the server should act as if incoming connections are properly
   // authenticated.
   bool authenticated_;
 
-  // All SyncEntity objects saved by the server. The key value is the entity's
-  // id string.
-  EntityMap entities_;
-
   // All Keystore keys known to the server.
   std::vector<std::string> keystore_keys_;
 
   // Used as the error_code field of ClientToServerResponse on all responses
   // except when |triggered_actionable_error_| is set.
   sync_pb::SyncEnums::ErrorType error_type_;
 
   // Used as the error field of ClientToServerResponse when its pointer is not
   // null.
   std::unique_ptr<sync_pb::ClientToServerResponse_Error>
@@ skipping 13 matching lines @@
   base::ObserverList<Observer, true> observers_;
 
   // When true, the server operates normally. When false, a failure is returned
   // on every request. This is used to simulate a network failure on the client.
   bool network_enabled_;
 
   // The last received client to server messages.
   sync_pb::ClientToServerMessage last_commit_message_;
   sync_pb::ClientToServerMessage last_getupdates_message_;
 
-  ResponseTypeProvider response_type_override_;
-
   // Used to verify that FakeServer is only used from one thread.
   base::ThreadChecker thread_checker_;
 
+  std::unique_ptr<syncer::LoopbackServer> loopback_server_;
+  std::unique_ptr<base::ScopedTempDir> loopback_server_storage_;
+
   // Creates WeakPtr versions of the current FakeServer. This must be the last
   // data member!
   base::WeakPtrFactory<FakeServer> weak_ptr_factory_;
 };
 
 }  // namespace fake_server
 
 #endif  // COMPONENTS_SYNC_TEST_FAKE_SERVER_FAKE_SERVER_H_