Implement WebBluetooth getDescriptor[s]

content/shell/browser/layout_test/layout_test_bluetooth_adapter_provider.cc

 // Copyright 2015 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 "content/shell/browser/layout_test/layout_test_bluetooth_adapter_provider.h"
 
 #include <utility>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/format_macros.h"
 #include "base/location.h"
 #include "base/memory/ptr_util.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_split.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "device/bluetooth/bluetooth_adapter.h"
 #include "device/bluetooth/bluetooth_device.h"
 #include "device/bluetooth/bluetooth_discovery_session.h"
 #include "device/bluetooth/bluetooth_uuid.h"
 #include "device/bluetooth/test/mock_bluetooth_adapter.h"
 #include "device/bluetooth/test/mock_bluetooth_discovery_session.h"
 #include "device/bluetooth/test/mock_bluetooth_gatt_connection.h"
+#include "device/bluetooth/test/mock_bluetooth_gatt_descriptor.h"
 #include "device/bluetooth/test/mock_bluetooth_gatt_notify_session.h"
 #include "testing/gmock/include/gmock/gmock.h"
 
 using base::StringPiece;
 using device::BluetoothAdapter;
 using device::BluetoothDevice;
+using device::BluetoothGattCharacteristic;
 using device::BluetoothRemoteGattCharacteristic;
+using device::BluetoothRemoteGattDescriptor;
 using device::BluetoothRemoteGattService;
 using device::BluetoothUUID;
 using device::MockBluetoothAdapter;
 using device::MockBluetoothDevice;
 using device::MockBluetoothDiscoverySession;
 using device::MockBluetoothGattCharacteristic;
 using device::MockBluetoothGattConnection;
+using device::MockBluetoothGattDescriptor;
 using device::MockBluetoothGattNotifySession;
 using device::MockBluetoothGattService;
 using testing::ElementsAre;
 using testing::Invoke;
 using testing::InvokeWithoutArgs;
 using testing::ResultOf;
 using testing::Return;
 using testing::_;
 
 typedef testing::NiceMock<MockBluetoothAdapter> NiceMockBluetoothAdapter;
 typedef testing::NiceMock<MockBluetoothDevice> NiceMockBluetoothDevice;
 typedef testing::NiceMock<MockBluetoothDiscoverySession>
     NiceMockBluetoothDiscoverySession;
+typedef testing::NiceMock<MockBluetoothGattDescriptor>
+    NiceMockBluetoothGattDescriptor;
 typedef testing::NiceMock<MockBluetoothGattCharacteristic>
     NiceMockBluetoothGattCharacteristic;
 typedef testing::NiceMock<MockBluetoothGattConnection>
     NiceMockBluetoothGattConnection;
 typedef testing::NiceMock<MockBluetoothGattService>
     NiceMockBluetoothGattService;
 typedef testing::NiceMock<MockBluetoothGattNotifySession>
     NiceMockBluetoothGattNotifySession;
 
 namespace {
@@ skipping 14 matching lines @@
 const char kBlocklistExcludeReadsCharacteristicUUID[] =
     "bad1c9a2-9a5b-4015-8b60-1579bbbf2135";
 const char kRequestDisconnectionCharacteristicUUID[] =
     "01d7d88a-7451-419f-aeb8-d65e7b9277af";
 const char kBodySensorLocation[] = "2a38";
 const char kDeviceNameUUID[] = "2a00";
 const char kMeasurementIntervalUUID[] = "2a21";
 const char kHeartRateMeasurementUUID[] = "2a37";
 const char kSerialNumberStringUUID[] = "2a25";
 const char kPeripheralPrivacyFlagUUID[] = "2a02";
+// Descriptors:
+const char kUserDescriptionUUID[] = "2901";
+// Client Config is in our blocklist.  It must not be writable
+const char kClientConfigUUID[] = "2902";
+// Blocklisted descriptor
+const char kBlocklistedDescriptorUUID[] = "bad0";
 
 // Invokes Run() on the k-th argument of the function with no arguments.
 ACTION_TEMPLATE(RunCallback,
                 HAS_1_TEMPLATE_PARAMS(int, k),
                 AND_0_VALUE_PARAMS()) {
   return ::testing::get<k>(args).Run();
 }
 
 // Invokes Run() on the k-th argument of the function with 1 argument.
 ACTION_TEMPLATE(RunCallback,
@@ skipping 550 matching lines @@
 LayoutTestBluetoothAdapterProvider::GetHeartRateAdapter() {
   scoped_refptr<NiceMockBluetoothAdapter> adapter(GetEmptyAdapter());
   std::unique_ptr<NiceMockBluetoothDevice> device(
       GetHeartRateDevice(adapter.get()));
 
   // TODO(ortuno): Implement the rest of the service's characteristics
   // See: http://crbug.com/529975
 
   device->AddMockService(GetGenericAccessService(device.get()));
   device->AddMockService(GetHeartRateService(adapter.get(), device.get()));
+  adapter->AddMockDevice(std::move(device));
+  return adapter;
+}
+// static
+void LayoutTestBluetoothAdapterProvider::AddDescriptorsToCharacteristic(
+    device::MockBluetoothGattCharacteristic* characteristic) {
+  std::unique_ptr<NiceMockBluetoothGattDescriptor> user_description(
+      new NiceMockBluetoothGattDescriptor(
+          characteristic, "gatt.characteristic_user_description",
+          BluetoothUUID(kUserDescriptionUUID), false,
+          device::BluetoothGattCharacteristic::Permission::PERMISSION_READ));
 
-  adapter->AddMockDevice(std::move(device));
+  std::unique_ptr<NiceMockBluetoothGattDescriptor> client_config(
+      new NiceMockBluetoothGattDescriptor(
+          characteristic, "gatt.client_characteristic_configuration",
+          BluetoothUUID(kClientConfigUUID), false,
+          device::BluetoothGattCharacteristic::Permission::PERMISSION_WRITE));
 
-  return adapter;
+  // add it here with full permission as the blocklist should prevent us from

[ortuno, 2016/12/07 08:05:12]

nit: s/add/Add/ Also this should DCHECK to match other operations on blacklisted
properties and also to fail the test.

[dougt, 2016/12/07 19:48:57]

You mean reading and writing to it, correct?  We have tests to ensure that the
blocklisted descriptors are prevented from being returned from getDescriptor[s]

[dougt, 2016/12/07 22:21:43]

In any case, in this CL, we don't read or write yet.

[ortuno, 2016/12/08 05:42:51]

For future reference. The intent is to make sure we never ever run read/write on
fully excluded descriptors. Having DCHECK when someone calls them ensure that if
there is a bug in our tests we still catch this. But as you said, since we are
not going read/write in this patch OK to leave out for now.

+  // accessing this descriptor
+  std::unique_ptr<NiceMockBluetoothGattDescriptor> blocklisted_descriptor(
+      new NiceMockBluetoothGattDescriptor(
+          characteristic, "bad0", BluetoothUUID(kBlocklistedDescriptorUUID),
+          false,
+          device::BluetoothRemoteGattCharacteristic::PROPERTY_READ |
+              device::BluetoothRemoteGattCharacteristic::PROPERTY_WRITE));
+
+  characteristic->AddMockDescriptor(std::move(user_description));
+  characteristic->AddMockDescriptor(std::move(client_config));
 }
 
 // static
 scoped_refptr<NiceMockBluetoothAdapter>
 LayoutTestBluetoothAdapterProvider::GetDisconnectingHealthThermometer() {
   scoped_refptr<NiceMockBluetoothAdapter> adapter(GetEmptyAdapter());
   NiceMockBluetoothAdapter* adapter_ptr = adapter.get();
 
   std::unique_ptr<NiceMockBluetoothDevice> device(GetConnectableDevice(
       adapter_ptr, "Disconnecting Health Thermometer",
@@ skipping 31 matching lines @@
 
   ON_CALL(*measurement_interval, WriteRemoteCharacteristic(_, _, _))
       .WillByDefault(RunCallback<1 /* success_callback */>());
 
   ON_CALL(*measurement_interval, StartNotifySession(_, _))
       .WillByDefault(
           RunCallbackWithResult<0 /* success_callback */>([measurement_ptr]() {
             return GetBaseGATTNotifySession(measurement_ptr->GetWeakPtr());
           }));
 
+  AddDescriptorsToCharacteristic(measurement_interval.get());
+
   health_thermometer->AddMockCharacteristic(std::move(measurement_interval));
   device->AddMockService(std::move(health_thermometer));
 
   adapter->AddMockDevice(std::move(device));
 
   return adapter;
 }
 
 // static
 scoped_refptr<NiceMockBluetoothAdapter>
@@ skipping 859 matching lines @@
   // Write response.
   ON_CALL(*characteristic, WriteRemoteCharacteristic(_, _, _))
       .WillByDefault(
           RunCallback<2>(BluetoothRemoteGattService::GATT_ERROR_NOT_SUPPORTED));
 
   // StartNotifySession response
   ON_CALL(*characteristic, StartNotifySession(_, _))
       .WillByDefault(
           RunCallback<1>(BluetoothRemoteGattService::GATT_ERROR_NOT_SUPPORTED));
 
+  // getDescriptors response

[ortuno, 2016/12/07 08:05:12]

nit: I don't think the comment is necessary.

[dougt, 2016/12/07 19:48:57]

I agree.  I will also remove the three other comments above the ON_CALL lines.

+  ON_CALL(*characteristic, GetDescriptors())
+      .WillByDefault(
+          Invoke(characteristic.get(),
+                 &MockBluetoothGattCharacteristic::GetMockDescriptors));
+
+  // getDescriptor response
+  ON_CALL(*characteristic, GetDescriptor(_))
+      .WillByDefault(
+          Invoke(characteristic.get(),
+                 &MockBluetoothGattCharacteristic::GetMockDescriptor));
+
   return characteristic;
 }
 
 // static
 std::unique_ptr<NiceMockBluetoothGattCharacteristic>
 LayoutTestBluetoothAdapterProvider::GetErrorCharacteristic(
     MockBluetoothGattService* service,
     BluetoothRemoteGattService::GattErrorCode error_code) {
   uint32_t error_alias = error_code + 0xA1;  // Error UUIDs start at 0xA1.
   std::unique_ptr<NiceMockBluetoothGattCharacteristic> characteristic(
@@ skipping 91 matching lines @@
   return BluetoothUUID();
 }
 
 // static
 std::string LayoutTestBluetoothAdapterProvider::makeMACAddress(uint64_t addr) {
   return BluetoothDevice::CanonicalizeAddress(
       base::StringPrintf("%012" PRIx64, addr));
 }
 
 }  // namespace content