blob: 21e76bd375b68ecd2566168576c7a624e712fcdc [file] [log] [blame]
// 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.
#include <string>
#include "base/memory/scoped_ptr.h"
#include "base/observer_list.h"
#include "chromeos/chromeos_export.h"
#include "chromeos/dbus/nfc_adapter_client.h"
#include "chromeos/dbus/nfc_client_helpers.h"
namespace chromeos {
// FakeNfcAdapterClient simulates the behavior of the NFC adapter objects
// and is used both in test cases in place of a mock and on the Linux desktop.
class CHROMEOS_EXPORT FakeNfcAdapterClient : public NfcAdapterClient {
// The object paths for the adapters that are being emulated.
static const char kAdapterPath0[];
static const char kAdapterPath1[];
// Properties structure that provides fake behavior for D-Bus calls.
struct Properties : public NfcAdapterClient::Properties {
explicit Properties(const PropertyChangedCallback& callback);
~Properties() override;
// dbus::PropertySet overrides.
void Get(dbus::PropertyBase* property,
dbus::PropertySet::GetCallback callback) override;
void GetAll() override;
void Set(dbus::PropertyBase* property,
dbus::PropertySet::SetCallback callback) override;
~FakeNfcAdapterClient() override;
// NfcAdapterClient overrides.
void Init(dbus::Bus* bus) override;
void AddObserver(Observer* observer) override;
void RemoveObserver(Observer* observer) override;
std::vector<dbus::ObjectPath> GetAdapters() override;
Properties* GetProperties(const dbus::ObjectPath& object_path) override;
void StartPollLoop(
const dbus::ObjectPath& object_path,
const std::string& mode,
const base::Closure& callback,
const nfc_client_helpers::ErrorCallback& error_callback) override;
void StopPollLoop(
const dbus::ObjectPath& object_path,
const base::Closure& callback,
const nfc_client_helpers::ErrorCallback& error_callback) override;
// Sets the adapter as |present|. Used for testing.
void SetAdapterPresent(bool present);
void SetSecondAdapterPresent(bool present);
// Tells the FakeNfcAdapterClient to add the device or tag with the given path
// to its corresponding list for |kAdapterPath0|, if it is not already in
// the list and promptly triggers a property changed signal. This method will
// also fail, if the polling property of the adapter is false and will set it
// to false on success.
void SetDevice(const dbus::ObjectPath& device_path);
void SetTag(const dbus::ObjectPath& tag_path);
// Tells the FakeNfcAdapterClient to remove the device or tag with the given
// path from its corresponding list exposed for |kAdapterPath0|, if it
// is in the list. On success, this method will mark the polling property of
// the adapter to true.
void UnsetDevice(const dbus::ObjectPath& device_path);
void UnsetTag(const dbus::ObjectPath& tag_path);
// Sets a flag that determines whether FakeNfcAdapterClient should notify
// FakeNfcDeviceClient or FakeNfcTagClient to start a pairing simulation as a
// result of a call to StartPollLoop(). This is enabled by default. If
// enabled, the first call to StartPollLoop, will initiate a tag pairing
// simulation. The simulation will alternate between device and tag pairing on
// each successive call to StartPollLoop. This behavior, which is meant for
// feature development based on fake classes, can be disabled to allow manual
// control for unit tests.
void EnablePairingOnPoll(bool enabled);
// Property changed callback passed when we create Properties* structures.
void OnPropertyChanged(const dbus::ObjectPath& object_path,
const std::string& property_name);
// List of observers interested in event notifications from us.
base::ObserverList<Observer> observers_;
// Fake properties that are returned for the emulated adapters.
scoped_ptr<Properties> properties_;
scoped_ptr<Properties> second_properties_;
// Whether the adapter and second adapter are present or not.
bool present_;
bool second_present_;
// If true, a pairing simulation is initiated on a successful call to
// StartPollLoop().
bool start_pairing_on_poll_;
// If true, device pairing will be simulated on the next call to
// StartPollLoop. Otherwise, tag pairing will be simulated.
bool device_pairing_;
} // namespace chromeos