10f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)// Copyright 2013 The Chromium Authors. All rights reserved. 20f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 30f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)// found in the LICENSE file. 40f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 50f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)#ifndef CHROMEOS_DBUS_FAKE_NFC_DEVICE_CLIENT_H_ 60f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)#define CHROMEOS_DBUS_FAKE_NFC_DEVICE_CLIENT_H_ 70f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 85d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 95d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "base/observer_list.h" 100f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)#include "chromeos/chromeos_export.h" 110f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)#include "chromeos/dbus/nfc_client_helpers.h" 120f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)#include "chromeos/dbus/nfc_device_client.h" 130f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 140f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)namespace chromeos { 150f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 160f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)// FakeNfcDeviceClient simulates the behavior of the NFC device objects 170f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)// and is used both in test cases in place of a mock and on the Linux desktop. 180f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)class CHROMEOS_EXPORT FakeNfcDeviceClient : public NfcDeviceClient { 190f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) public: 205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // The fake device object path. 215d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) static const char kDevicePath[]; 225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 235d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // The default simulation timeout interval. 245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) static const int kDefaultSimulationTimeoutMilliseconds; 255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Properties structure that provides fake behavior for D-Bus calls. 270f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) struct Properties : public NfcDeviceClient::Properties { 280f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) explicit Properties(const PropertyChangedCallback& callback); 290f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual ~Properties(); 300f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 310f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) // dbus::PropertySet overrides. 320f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual void Get(dbus::PropertyBase* property, 330f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) dbus::PropertySet::GetCallback callback) OVERRIDE; 340f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual void GetAll() OVERRIDE; 350f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual void Set(dbus::PropertyBase* property, 360f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) dbus::PropertySet::SetCallback callback) OVERRIDE; 370f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) }; 380f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 390f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) FakeNfcDeviceClient(); 400f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual ~FakeNfcDeviceClient(); 410f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 420f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) // NfcDeviceClient overrides. 430f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual void Init(dbus::Bus* bus) OVERRIDE; 440f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual void AddObserver(Observer* observer) OVERRIDE; 450f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual void RemoveObserver(Observer* observer) OVERRIDE; 465d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) virtual std::vector<dbus::ObjectPath> GetDevicesForAdapter( 475d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const dbus::ObjectPath& adapter_path) OVERRIDE; 480f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual Properties* GetProperties( 490f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) const dbus::ObjectPath& object_path) OVERRIDE; 500f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) virtual void Push( 510f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) const dbus::ObjectPath& object_path, 52a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::DictionaryValue& attributes, 530f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) const base::Closure& callback, 540f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) const nfc_client_helpers::ErrorCallback& error_callback) OVERRIDE; 550f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 565d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Simulates the appearance of a device. The fake device will show up after 575d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // exactly |visibility_delay| milliseconds, and will simulate pushing a single 585d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // record to the local fake adapter after exactly |record_push_delay| 595d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // milliseconds after the the device appears. |visibility_delay| must have a 605d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // non-negative value. |record_push_delay| CAN be negative: if it has a 615d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // negative value, the record push step will not be simulated. The 625d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // side-effects of this method occur asynchronously, i.e. even with arguments 635d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // with value 0, the pairing won't take place until after this method has 645d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // returned. 655d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void BeginPairingSimulation(int visibility_delay, int record_push_delay); 665d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 675d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // If device pairing was previously started, simulates the disappearance of 685d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // the device. Any device objects presented and their records will disappear 695d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // after this call. Delayed events that were set up by a previous call to 705d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // BeginPairing() will be canceled through a call to EndPairing(). 715d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void EndPairingSimulation(); 725d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 735d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Enables or disables automatic unpairing. When enabled, a pairing 745d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // simulation will end |simulation_timeout| milliseconds after records have 755d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // been exposed (or after the tag has been exposed, if |record_push_delay| was 765d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // given as a negative value to BeginPairingSimulation) This is enabled by 775d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // default and the timeout is set to |kDefaultSimulationTimeoutMilliseconds|. 785d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void EnableSimulationTimeout(int simulation_timeout); 795d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void DisableSimulationTimeout(); 805d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 815d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Tells the FakeNfcDeviceClient to add the records in |record_paths| to its 825d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // list of records exposed for |kDevicePath|. This method will immediately 835d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // assign the records and trigger a property changed signal, only if the 845d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // device is currently visible. 855d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void SetRecords(const std::vector<dbus::ObjectPath>& record_paths); 865d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 875d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Tells the FakeNfcDeviceClient to clear the list of records exposed for 885d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // |kDevicePath|. This method takes effect immediately and triggers a 895d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // property changed signal. 905d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void ClearRecords(); 915d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 925d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Returns true, if a pairing simulation is currently going on. 935d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool device_visible() const { return device_visible_; } 945d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 950f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) private: 965d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Property changed callback passed when we create Properties* structures. 975d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void OnPropertyChanged(const dbus::ObjectPath& object_path, 985d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const std::string& property_name); 995d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1005d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Makes the fake device visible (if it is not already so) and simulates a 1015d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // record push after |record_push_delay| seconds. Posted by BeginPairing(). 1025d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void MakeDeviceVisible(int record_push_delay); 1035d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1045d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Makes the fake records visible. Called by MakeDeviceVisible(). 1055d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void MakeRecordsVisible(); 1065d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1075d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Called when the simulation timeout expires. 1085d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void HandleSimulationTimeout(); 1095d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1105d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // List of observers interested in event notifications from us. 1115d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) ObserverList<Observer> observers_; 1125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1135d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Fake properties that are returned for the emulated device. 1145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) scoped_ptr<Properties> properties_; 1155d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1165d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // If true, a pairing simulation was started using BeginPairing() and no call 1175d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // to EndPairing() has been made. 1185d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool pairing_started_; 1195d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // If true, observers have been notified that a device has been created and 1215d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // the device properties are accessible. 1225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool device_visible_; 1235d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // If non-negative, the device will disappear this many milliseconds after 1255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // its records have been exposed. 1265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) int simulation_timeout_; 1275d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1280f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(FakeNfcDeviceClient); 1290f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)}; 1300f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 1310f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)} // namespace chromeos 1320f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 1330f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)#endif // CHROMEOS_DBUS_FAKE_NFC_DEVICE_CLIENT_H_ 134