blob: 2e3684cf6119c69612352cac4ed2a2eba7a9c97b [file] [log] [blame]
// 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 SYNC_TEST_ENGINE_SINGLE_TYPE_MOCK_SERVER_H_
#define SYNC_TEST_ENGINE_SINGLE_TYPE_MOCK_SERVER_H_
#include "sync/internal_api/public/base/model_type.h"
#include "sync/internal_api/public/non_blocking_sync_common.h"
namespace syncer {
// A mock server used to test of happy-path update and commit logic.
//
// This object supports only one ModelType, which must be specified at
// initialization time. It does not support GetUpdates messages. It does not
// support simulated errors.
//
// This class is useful for testing UpdateHandlers and CommitContributors.
class SingleTypeMockServer {
public:
explicit SingleTypeMockServer(syncer::ModelType type);
~SingleTypeMockServer();
// Generates a SyncEntity representing a server-delivered update containing
// the root node for this SingleTypeMockServer's type.
sync_pb::SyncEntity TypeRootUpdate();
// Generates a SyncEntity representing a server-delivered update.
//
// The |version_offset| parameter allows the caller to simulate reflected
// updates, redeliveries, and genuine updates.
sync_pb::SyncEntity UpdateFromServer(
int64 version_offset,
const std::string& tag_hash,
const sync_pb::EntitySpecifics& specifics);
// Generates a SyncEntity representing a server-delivered update to delete
// an item.
sync_pb::SyncEntity TombstoneFromServer(int64 version_offset,
const std::string& tag_hash);
// Generates a response to the specified commit message.
//
// This does not perform any exhausive testing of the sync protocol. Many of
// the request's fields may safely be left blank, and much of the returned
// response will be empty, too.
//
// This is useful mainly for testing objects that implement the
// CommitContributor interface.
sync_pb::ClientToServerResponse DoSuccessfulCommit(
const sync_pb::ClientToServerMessage& message);
// Getters to return the commit messages sent to the server through
// DoSuccessfulCommit().
size_t GetNumCommitMessages() const;
sync_pb::ClientToServerMessage GetNthCommitMessage(size_t n) const;
// Getters to return the most recently committed entities for a given
// unique_client_tag hash.
bool HasCommitEntity(const std::string& tag_hash) const;
sync_pb::SyncEntity GetLastCommittedEntity(const std::string& tag_hash) const;
// Getters that create realistic-looking progress markers and data type
// context.
sync_pb::DataTypeProgressMarker GetProgress() const;
sync_pb::DataTypeContext GetContext() const;
private:
static std::string GenerateId(const std::string& tag_hash);
// Get and set our emulated server state.
int64 GetServerVersion(const std::string& tag_hash) const;
void SetServerVersion(const std::string& tag_hash, int64 version);
const ModelType type_;
const std::string type_root_id_;
// Server version state maps.
std::map<const std::string, int64> server_versions_;
// Log of messages sent to the server.
std::vector<sync_pb::ClientToServerMessage> commit_messages_;
// Map of most recent commits by tag_hash.
std::map<const std::string, sync_pb::SyncEntity> committed_items_;
DISALLOW_COPY_AND_ASSIGN(SingleTypeMockServer);
};
} // namespace syncer
#endif // SYNC_TEST_ENGINE_SINGLE_TYPE_MOCK_SERVER_H_