Implement BluetoothRemoteGattCharacteristicWin::StartNotifySession and related unit tests

device/bluetooth/bluetooth_low_energy_win_fake.cc

 // Copyright 2016 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 "device/bluetooth/bluetooth_low_energy_win_fake.h"
 
 #include "base/strings/stringprintf.h"
 #include "device/bluetooth/bluetooth_low_energy_defs_win.h"
 
 namespace {
 const char kPlatformNotSupported[] =
     "Bluetooth Low energy is only supported on Windows 8 and later.";
 }  // namespace
 
 namespace device {
 namespace win {
 
 BLEDevice::BLEDevice() {}
 BLEDevice::~BLEDevice() {}
 
 GattService::GattService() {}
 GattService::~GattService() {}
 
 GattCharacteristic::GattCharacteristic() {}
 GattCharacteristic::~GattCharacteristic() {}
 
 GattDescriptor::GattDescriptor() {}
 GattDescriptor::~GattDescriptor() {}
 
+GattServiceObserver::GattServiceObserver() {}
+GattServiceObserver::~GattServiceObserver() {}
+
 BluetoothLowEnergyWrapperFake::BluetoothLowEnergyWrapperFake()
     : observer_(nullptr) {}
 BluetoothLowEnergyWrapperFake::~BluetoothLowEnergyWrapperFake() {}
 
 bool BluetoothLowEnergyWrapperFake::IsBluetoothLowEnergySupported() {
   return true;
 }
 
 bool BluetoothLowEnergyWrapperFake::EnumerateKnownBluetoothLowEnergyDevices(
     ScopedVector<BluetoothLowEnergyDeviceInfo>* devices,
@@ skipping 157 matching lines @@
     return hr;
   }
 
   PBTH_LE_GATT_CHARACTERISTIC_VALUE ret_value =
       (PBTH_LE_GATT_CHARACTERISTIC_VALUE)(
           new UCHAR[sizeof(ULONG) + target_characteristic->value->DataSize]);
   ret_value->DataSize = target_characteristic->value->DataSize;
   for (ULONG i = 0; i < ret_value->DataSize; i++)
     ret_value->Data[i] = target_characteristic->value->Data[i];
   out_value->reset(ret_value);
+  if (observer_)
+    observer_->OnReadGattCharacteristicValue();
   return S_OK;
 }
 
 HRESULT BluetoothLowEnergyWrapperFake::WriteCharacteristicValue(
     base::FilePath& service_path,
     const PBTH_LE_GATT_CHARACTERISTIC characteristic,
     PBTH_LE_GATT_CHARACTERISTIC_VALUE new_value) {
   GattCharacteristic* target_characteristic =
       GetSimulatedGattCharacteristic(service_path, characteristic);
   if (target_characteristic == nullptr)
-    return ERROR_NOT_FOUND;
+    return HRESULT_FROM_WIN32(ERROR_NOT_FOUND);
 
   // Return error simulated by SimulateGattCharacteristicWriteError.
   if (target_characteristic->write_errors.size()) {
     HRESULT hr = *(target_characteristic->write_errors.begin());
     target_characteristic->write_errors.erase(
         target_characteristic->write_errors.begin());
     return hr;
   }
 
   PBTH_LE_GATT_CHARACTERISTIC_VALUE win_value =
       (PBTH_LE_GATT_CHARACTERISTIC_VALUE)(
           new UCHAR[new_value->DataSize + sizeof(ULONG)]);
   for (ULONG i = 0; i < new_value->DataSize; i++)
     win_value->Data[i] = new_value->Data[i];
   win_value->DataSize = new_value->DataSize;
   target_characteristic->value.reset(win_value);
   if (observer_)
-    observer_->onWriteGattCharacteristicValue(win_value);
+    observer_->OnWriteGattCharacteristicValue(win_value);
   return S_OK;
 }
 
+HRESULT BluetoothLowEnergyWrapperFake::RegisterGattEvents(

[ortuno, 2016/03/14 01:37:37]

I hope that from the description of the tests it becomes clear that this fake is
much more complicated than it should. This function should either:

1. Increase the value of gatt_notify_characteristic_attempts_, create the
observer and succeed
or 2. Fail with some windows specific error.

[gogerald1, 2016/03/15 00:48:19]

Done. until now I don't see specific error needs to be tested. 

+    base::FilePath& service_path,
+    BTH_LE_GATT_EVENT_TYPE type,
+    PVOID event_parameter,
+    PFNBLUETOOTH_GATT_EVENT_CALLBACK callback,
+    PVOID context,
+    BLUETOOTH_GATT_EVENT_HANDLE* out_handle) {
+  base::string16 device_address =
+      ExtractDeviceAddressFromDevicePath(service_path.value());
+  BLEDevice* target_device = GetSimulatedBLEDevice(
+      std::string(device_address.begin(), device_address.end()));
+  if (target_device == nullptr)
+    return HRESULT_FROM_WIN32(ERROR_NOT_FOUND);
+  const std::vector<std::string> service_att_handles =
+      ExtractServiceAttributeHandlesFromDevicePath(service_path.value());
+  GattService* target_service =
+      GetSimulatedGattService(target_device, service_att_handles);
+  if (target_service == nullptr)
+    return HRESULT_FROM_WIN32(ERROR_NOT_FOUND);
+
+  PBLUETOOTH_GATT_VALUE_CHANGED_EVENT_REGISTRATION parameter =
+      (PBLUETOOTH_GATT_VALUE_CHANGED_EVENT_REGISTRATION)event_parameter;
+  for (USHORT i = 0; i < parameter->NumCharacteristics; i++) {
+    GattCharacteristic* target_characteristic = GetSimulatedGattCharacteristic(
+        target_service,
+        std::to_string(parameter->Characteristics[i].AttributeHandle));
+    CHECK(target_characteristic);
+
+    // Return error simulated by SimulateGattCharacteristicSetNotifyError.
+    if (target_characteristic->notify_errors.size()) {
+      HRESULT error = target_characteristic->notify_errors[0];
+      target_characteristic->notify_errors.erase(
+          target_characteristic->notify_errors.begin());
+      return error;
+    }
+
+    // Get CCC descriptor.
+    GattDescriptor* target_descriptor = GetCCCDescriptor(target_characteristic);
+    if (target_descriptor == nullptr)
+      return E_BLUETOOTH_ATT_REQUEST_NOT_SUPPORTED;
+    if (observer_)
+      observer_->OnStartCharacteristicNotification();
+
+    // Return error simualted by SimulateGattDescriptorWriteError.
+    if (target_descriptor->write_errors.size()) {
+      HRESULT error = target_descriptor->write_errors[0];
+      target_descriptor->write_errors.erase(
+          target_descriptor->write_errors.begin());
+      return error;
+    }
+
+    // Write CCC descriptor.
+    std::vector<uint8_t> new_value;
+    if (target_characteristic->characteristic_info->IsNotifiable)
+      new_value.push_back(1);
+    else if (target_characteristic->characteristic_info->IsIndicatable)
+      new_value.push_back(2);
+    else
+      return E_BLUETOOTH_ATT_REQUEST_NOT_SUPPORTED;
+    new_value.push_back(0);
+    SimulateGattDescriptorWrite(target_descriptor, new_value);
+  }
+
+  scoped_ptr<GattServiceObserver> observer(new GattServiceObserver());
+  observer->callback = callback;
+  observer->context = context;
+  *out_handle = (BLUETOOTH_GATT_EVENT_HANDLE)observer.get();
+  gatt_service_observers_[*out_handle] = std::move(observer);
+  target_service->observers.push_back(*out_handle);
+
+  return S_OK;
+}
+
+HRESULT BluetoothLowEnergyWrapperFake::UnregisterGattEvent(
+    BLUETOOTH_GATT_EVENT_HANDLE event_handle) {
+  gatt_service_observers_.erase(event_handle);
+  return S_OK;
+}
+
 BLEDevice* BluetoothLowEnergyWrapperFake::SimulateBLEDevice(
     std::string device_name,
     BLUETOOTH_ADDRESS device_address) {
   BLEDevice* device = new BLEDevice();
   BluetoothLowEnergyDeviceInfo* device_info =
       new BluetoothLowEnergyDeviceInfo();
   std::string string_device_address =
       BluetoothAddressToCanonicalString(device_address);
   device_info->path =
       base::FilePath(GenerateBLEDevicePath(string_device_address));
@@ skipping 121 matching lines @@
   CHECK(characteristic);
   PBTH_LE_GATT_CHARACTERISTIC_VALUE win_value =
       (PBTH_LE_GATT_CHARACTERISTIC_VALUE)(
           new UCHAR[value.size() + sizeof(ULONG)]);
   win_value->DataSize = (ULONG)value.size();
   for (std::size_t i = 0; i < value.size(); i++)
     win_value->Data[i] = value[i];
   characteristic->value.reset(win_value);
 }
 
+void BluetoothLowEnergyWrapperFake::
+    SimulateCharacteristicValueChangeNotification(
+        GattService* parent_service,
+        GattCharacteristic* characteristic) {
+  for (auto observer : parent_service->observers) {

[ortuno, 2016/03/14 01:37:37]

Here you are making copies of the "BLUETOOTH_GATT_EVENT_HANDLE" in the vector.
Is this what want? Consider using const auto& if not.

[gogerald1, 2016/03/15 00:48:19]

Done.

+    GattServiceObserverTable::iterator it =

[ortuno, 2016/03/14 01:37:37]

nit: You can use auto for iterators.

[gogerald1, 2016/03/15 00:48:19]

Acknowledged. Here use GattServiceObserverTable::iterator can explicitly
indicate 'it' is a iterator

+        gatt_service_observers_.find(observer);
+    // Check if |observer| has been unregistered by UnregisterGattEvent.
+    if (it != gatt_service_observers_.end()) {
+      BLUETOOTH_GATT_VALUE_CHANGED_EVENT event;
+      event.ChangedAttributeHandle =
+          characteristic->characteristic_info->AttributeHandle;
+      event.CharacteristicValueDataSize =
+          characteristic->value->DataSize + (ULONG)sizeof(ULONG);

[ortuno, 2016/03/14 01:37:37]

Why do you add the (ULONG)sizeof(ULONG)?

[gogerald1, 2016/03/15 00:48:19]

Done. Mistake

+      event.CharacteristicValue = characteristic->value.get();
+      it->second->callback(CharacteristicValueChangedEvent, &event,
+                           it->second->context);
+    }
+  }
+}
+
 void BluetoothLowEnergyWrapperFake::SimulateGattCharacteristicReadError(
     GattCharacteristic* characteristic,
     HRESULT error) {
   CHECK(characteristic);
   characteristic->read_errors.push_back(error);
 }
 
 void BluetoothLowEnergyWrapperFake::SimulateGattCharacteristicWriteError(
     GattCharacteristic* characteristic,
     HRESULT error) {
   CHECK(characteristic);
   characteristic->write_errors.push_back(error);
 }
 
+void BluetoothLowEnergyWrapperFake::SimulateGattCharacteristicSetNotifyError(
+    GattCharacteristic* characteristic,
+    HRESULT error) {
+  CHECK(characteristic);
+  characteristic->notify_errors.push_back(error);
+}
+
 void BluetoothLowEnergyWrapperFake::SimulateGattDescriptor(
     std::string device_address,
     GattCharacteristic* characteristic,
     const BTH_LE_UUID& uuid) {
   scoped_ptr<GattDescriptor> descriptor(new GattDescriptor());
   descriptor->descriptor_info.reset(new BTH_LE_GATT_DESCRIPTOR[1]);
   descriptor->descriptor_info->DescriptorUuid = uuid;
   descriptor->descriptor_info->AttributeHandle =
       GenerateAUniqueAttributeHandle(device_address);
   characteristic->included_descriptors[std::to_string(
       descriptor->descriptor_info->AttributeHandle)] = std::move(descriptor);
 }
 
+GattDescriptor* BluetoothLowEnergyWrapperFake::GetSimulatedDescriptor(
+    GattCharacteristic* parent_characteristic,
+    std::string attribute_handle) {
+  GattDescriptorsMap::const_iterator it =
+      parent_characteristic->included_descriptors.find(attribute_handle);
+  if (it != parent_characteristic->included_descriptors.end())
+    return it->second.get();
+  return nullptr;
+}
+
+void BluetoothLowEnergyWrapperFake::SimulateGattDescriptorWrite(
+    GattDescriptor* descriptor,
+    const std::vector<uint8_t>& value) {
+  ULONG length = (ULONG)(sizeof(BTH_LE_GATT_DESCRIPTOR_VALUE) + value.size());
+  descriptor->value.reset((BTH_LE_GATT_DESCRIPTOR_VALUE*)(new UCHAR[length]));
+  descriptor->value->DataSize = (ULONG)value.size();
+  for (size_t i = 0; i < value.size(); i++)
+    descriptor->value->Data[i] = value[i];
+  if (observer_)
+    observer_->OnWriteGattDescriptorValue(descriptor->value.get());
+}
+
+void BluetoothLowEnergyWrapperFake::SimulateGattDescriptorWriteError(
+    GattDescriptor* descriptor,
+    HRESULT error) {
+  descriptor->write_errors.push_back(error);
+}
+
 void BluetoothLowEnergyWrapperFake::AddObserver(Observer* observer) {
   observer_ = observer;
 }
 
 GattCharacteristic*
 BluetoothLowEnergyWrapperFake::GetSimulatedGattCharacteristic(
     base::FilePath& service_path,
     const PBTH_LE_GATT_CHARACTERISTIC characteristic) {
   base::string16 device_address =
       ExtractDeviceAddressFromDevicePath(service_path.value());
@@ skipping 89 matching lines @@
 }
 
 std::string BluetoothLowEnergyWrapperFake::BluetoothAddressToCanonicalString(
     const BLUETOOTH_ADDRESS& btha) {
   std::string result = base::StringPrintf(
       "%02X:%02X:%02X:%02X:%02X:%02X", btha.rgBytes[5], btha.rgBytes[4],
       btha.rgBytes[3], btha.rgBytes[2], btha.rgBytes[1], btha.rgBytes[0]);
   return result;
 }
 
+GattDescriptor* BluetoothLowEnergyWrapperFake::GetCCCDescriptor(
+    GattCharacteristic* characteristic) {
+  for (const auto& d : characteristic->included_descriptors) {
+    const BTH_LE_UUID* uuid = &(d.second->descriptor_info->DescriptorUuid);
+    if (uuid->IsShortUuid)
+      continue;
+
+    std::string uuid_string = base::StringPrintf(
+        "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
+        uuid->Value.LongUuid.Data1, uuid->Value.LongUuid.Data2,
+        uuid->Value.LongUuid.Data3, uuid->Value.LongUuid.Data4[0],
+        uuid->Value.LongUuid.Data4[1], uuid->Value.LongUuid.Data4[2],
+        uuid->Value.LongUuid.Data4[3], uuid->Value.LongUuid.Data4[4],
+        uuid->Value.LongUuid.Data4[5], uuid->Value.LongUuid.Data4[6],
+        uuid->Value.LongUuid.Data4[7]);
+    if (uuid_string != "00002902-0000-1000-8000-00805f9b34fb")
+      continue;
+
+    return d.second.get();
+  }
+
+  return nullptr;
+}
+
 }  // namespace win
 }  // namespace device