Chromium side of RequestDeviceOptions implementation.

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 "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 "testing/gmock/include/gmock/gmock.h"
 
 using device::BluetoothAdapter;
 using device::BluetoothAdapterFactory;
 using device::BluetoothDevice;
 using device::BluetoothDiscoverySession;
 using device::BluetoothGattConnection;
 using device::BluetoothGattService;
 using device::BluetoothUUID;
 using device::MockBluetoothAdapter;
 using device::MockBluetoothDevice;
 using device::MockBluetoothDiscoverySession;
 using device::MockBluetoothGattCharacteristic;
 using device::MockBluetoothGattConnection;
 using device::MockBluetoothGattService;
 using testing::Between;
+using testing::ElementsAre;
 using testing::Invoke;
+using testing::NiceMock;
+using testing::ResultOf;
 using testing::Return;
-using testing::NiceMock;
+using testing::WithArgs;
 using testing::_;
 
 namespace {
+// Bluetooth UUIDs suitable to pass to BluetoothUUID().
+const char kBatteryServiceUUID[] = "180f";
+const char kGenericAccessServiceUUID[] = "1800";
+const char kGenericAttributeServiceUUID[] = "1801";
+const char kGlucoseServiceUUID[] = "1808";
+const char kHeartRateServiceUUID[] = "180d";
+
 // 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,
                 HAS_1_TEMPLATE_PARAMS(int, k),
@@ skipping 29 matching lines @@
 LayoutTestBluetoothAdapterProvider::GetBluetoothAdapter(
     const std::string& fake_adapter_name) {
   if (fake_adapter_name == "EmptyAdapter")
     return GetEmptyAdapter();
   else if (fake_adapter_name == "SingleEmptyDeviceAdapter")
     return GetSingleEmptyDeviceAdapter();
   else if (fake_adapter_name == "ConnectableDeviceAdapter")
     return GetConnectableDeviceAdapter();
   else if (fake_adapter_name == "UnconnectableDeviceAdapter")
     return GetUnconnectableDeviceAdapter();
+  else if (fake_adapter_name == "ScanFilterCheckingAdapter")
+    return GetScanFilterCheckingAdapter();
+  else if (fake_adapter_name == "MultiDeviceAdapter")
+    return GetMultiDeviceAdapter();
   else if (fake_adapter_name == "")
     return NULL;
 
-  NOTREACHED();
+  NOTREACHED() << fake_adapter_name;
   return NULL;
 }
 
 // static
 scoped_refptr<NiceMock<MockBluetoothAdapter>>
 LayoutTestBluetoothAdapterProvider::GetEmptyAdapter() {
   scoped_refptr<NiceMock<MockBluetoothAdapter>> adapter(
       new NiceMock<MockBluetoothAdapter>());
 
-  ON_CALL(*adapter, StartDiscoverySession(_, _))
-      .WillByDefault(RunCallbackWithResult<0 /* success_callback */>(
+  ON_CALL(*adapter, StartDiscoverySessionWithFilterRaw(_, _, _))
+      .WillByDefault(RunCallbackWithResult<1 /* success_callback */>(
           []() { return GetDiscoverySession(); }));
 
   // Using Invoke allows the adapter returned from this method to be futher
   // modified and have devices added to it. The call to ::GetDevices will
   // invoke ::GetConstMockDevices, returning all devices added up to that time.
   ON_CALL(*adapter, GetDevices())
       .WillByDefault(
           Invoke(adapter.get(), &MockBluetoothAdapter::GetConstMockDevices));
 
   // The call to ::GetDevice will invoke GetMockDevice which returns a device
   // matching the address provided if the device was added to the mock.
   ON_CALL(*adapter, GetDevice(_)).WillByDefault(GetMockDevice(adapter.get()));
 
   return adapter.Pass();
 }
 
+static std::set<BluetoothUUID> GetUUIDs(

[scheib, 2015/06/15 23:47:21]

I have a style preference of keeping these methods at top of file in the
anonymous namespace, and keeping all class member definitions in order and
contiguous below.

[Jeffrey Yasskin, 2015/06/16 00:48:10]

Ick, but done, and for the definitions of MatchesFilter*(). I would have made
this a lambda, but ResultOf expects C++98 member typedefs.

+    const device::BluetoothDiscoveryFilter* filter) {
+  std::set<BluetoothUUID> result;
+  filter->GetUUIDs(result);
+  return result;
+};
+
+// static
+scoped_refptr<NiceMock<MockBluetoothAdapter>>
+LayoutTestBluetoothAdapterProvider::GetScanFilterCheckingAdapter() {
+  scoped_refptr<NiceMock<MockBluetoothAdapter>> adapter(
+      new NiceMock<MockBluetoothAdapter>());
+
+  // This fails the test with an error message listing actual and expected UUIDs
+  // if StartDiscoverySessionWithFilter() is called with the wrong argument.
+  EXPECT_CALL(
+      *adapter,
+      StartDiscoverySessionWithFilterRaw(
+          ResultOf(&GetUUIDs, ElementsAre(BluetoothUUID(kGlucoseServiceUUID),
+                                          BluetoothUUID(kHeartRateServiceUUID),
+                                          BluetoothUUID(kBatteryServiceUUID))),
+          _, _))
+      .WillRepeatedly(RunCallbackWithResult<1 /* success_callback */>(
+          []() { return GetDiscoverySession(); }));
+
+  // Any unexpected call results in the failure callback.
+  ON_CALL(*adapter, StartDiscoverySessionWithFilterRaw(_, _, _))
+      .WillByDefault(RunCallback<2 /* failure_callback */>());
+
+  // This adapter isn't further modified, so we just return a hard-coded empty
+  // list.
+  ON_CALL(*adapter, GetDevices())

[scheib, 2015/06/15 23:47:21]

Let's return something so that in JS the promise can be fullfilled demonstrating
that the session filter check was successful. Can ON_CALL...GetDevices() be set
in the anonymous function above as well, and in that case returning a device?
This location of setting the WillByDefault seems unnecessary as the mock by
default returns an empty list
https://code.google.com/p/chromium/codesearch#chromium/src/device/bluetooth/t...
But I'm OK with the redundancy to make it clear what is expected.

[Jeffrey Yasskin, 2015/06/16 00:48:10]

'k.
It makes more sense, I think, to set it here. The
StartDiscoverySessionWithFilterRaw(_, _, _) case already rejects the promise by
failing to start discovery.
There's no default: "BluetoothAdapter::ConstDeviceList()" is just the type of
the function.

+      .WillByDefault(Return(adapter->GetConstMockDevices()));
+
+  return adapter.Pass();
+}
+
 // static
 scoped_refptr<NiceMock<MockBluetoothAdapter>>
 LayoutTestBluetoothAdapterProvider::GetSingleEmptyDeviceAdapter() {
   scoped_refptr<NiceMock<MockBluetoothAdapter>> adapter(GetEmptyAdapter());
 
   adapter->AddMockDevice(GetEmptyDevice(adapter.get()));
 
   return adapter.Pass();
 }
 
 // static
 scoped_refptr<NiceMock<MockBluetoothAdapter>>
+LayoutTestBluetoothAdapterProvider::GetMultiDeviceAdapter() {
+  scoped_refptr<NiceMock<MockBluetoothAdapter>> adapter(GetEmptyAdapter());
+
+  scoped_ptr<NiceMock<MockBluetoothDevice>> heart_rate_device =
+      GetEmptyDevice(adapter.get(), "Heart Rate Device");
+  BluetoothDevice::UUIDList heart_rate_uuid_list;
+  heart_rate_uuid_list.push_back(BluetoothUUID(kHeartRateServiceUUID));
+  ON_CALL(*heart_rate_device, GetUUIDs())
+      .WillByDefault(Return(heart_rate_uuid_list));
+  adapter->AddMockDevice(heart_rate_device.Pass());
+
+  scoped_ptr<NiceMock<MockBluetoothDevice>> glucose_device =
+      GetEmptyDevice(adapter.get(), "Glucose Device");
+  BluetoothDevice::UUIDList glucose_uuid_list;
+  glucose_uuid_list.push_back(BluetoothUUID(kGlucoseServiceUUID));
+  ON_CALL(*glucose_device, GetUUIDs()).WillByDefault(Return(glucose_uuid_list));
+  adapter->AddMockDevice(glucose_device.Pass());
+
+  return adapter.Pass();
+}
+
+// static
+scoped_refptr<NiceMock<MockBluetoothAdapter>>
 LayoutTestBluetoothAdapterProvider::GetConnectableDeviceAdapter() {
   scoped_refptr<NiceMock<MockBluetoothAdapter>> adapter(GetEmptyAdapter());
 
   adapter->AddMockDevice(GetConnectableDevice(adapter.get()));
 
   return adapter.Pass();
 }
 
 // static
 scoped_refptr<NiceMock<MockBluetoothAdapter>>
@@ skipping 13 matching lines @@
 
   ON_CALL(*discovery_session, Stop(_, _))
       .WillByDefault(RunCallback<0 /* success_callback */>());
 
   return discovery_session.Pass();
 }
 
 // static
 scoped_ptr<NiceMock<MockBluetoothDevice>>
 LayoutTestBluetoothAdapterProvider::GetEmptyDevice(
-    MockBluetoothAdapter* adapter) {
+    MockBluetoothAdapter* adapter,
+    const std::string& device_name) {
   scoped_ptr<NiceMock<MockBluetoothDevice>> empty_device(
       new NiceMock<MockBluetoothDevice>(
-          adapter, 0x1F00 /* Bluetooth Class */, "Empty Mock Device name",
-          "Empty Mock Device instanceID", true /* Paired */,
+          adapter, 0x1F00 /* Bluetooth Class */, device_name,
+          device_name + " instanceID", true /* Paired */,
           true /* Connected */));
 
   ON_CALL(*empty_device, GetVendorIDSource())
       .WillByDefault(Return(BluetoothDevice::VENDOR_ID_BLUETOOTH));
   ON_CALL(*empty_device, GetVendorID()).WillByDefault(Return(0xFFFF));
   ON_CALL(*empty_device, GetProductID()).WillByDefault(Return(1));
   ON_CALL(*empty_device, GetDeviceID()).WillByDefault(Return(2));
 
   BluetoothDevice::UUIDList list;
-  list.push_back(BluetoothUUID("1800"));
-  list.push_back(BluetoothUUID("1801"));
+  list.push_back(BluetoothUUID(kGenericAccessServiceUUID));
+  list.push_back(BluetoothUUID(kGenericAttributeServiceUUID));
   ON_CALL(*empty_device, GetUUIDs()).WillByDefault(Return(list));
 
   scoped_ptr<NiceMock<MockBluetoothGattService>> generic_access(
-      GetGattService(empty_device.get(), "1800" /* Generic Access */));
-  scoped_ptr<NiceMock<MockBluetoothGattCharacteristic>> device_name(
-      GetGattCharacteristic(generic_access.get(), "2A00" /* Device Name */));
+      GetGattService(empty_device.get(), kGenericAccessServiceUUID));
+  scoped_ptr<NiceMock<MockBluetoothGattCharacteristic>>
+      device_name_characteristic(GetGattCharacteristic(
+          generic_access.get(), "2A00" /* Device Name */));
 
   std::string value_str("Empty Mock Device name");

[scheib, 2015/06/15 23:47:21]

Use 'device_name' instead of string literal here?

[Jeffrey Yasskin, 2015/06/16 00:48:10]

I just replaced this whole string with 'device_name'.

   std::vector<uint8_t> value(value_str.begin(), value_str.end());

[scheib, 2015/06/15 23:47:21]

While here, rename to 'device_name_value'.

[Jeffrey Yasskin, 2015/06/16 00:48:10]

Done.

-  ON_CALL(*device_name, ReadRemoteCharacteristic(_, _))
+  ON_CALL(*device_name_characteristic, ReadRemoteCharacteristic(_, _))
       .WillByDefault(RunCallback<0>(value));
 
-  generic_access->AddMockCharacteristic(device_name.Pass());
+  generic_access->AddMockCharacteristic(device_name_characteristic.Pass());
 
   scoped_ptr<NiceMock<MockBluetoothGattCharacteristic>> reconnection_address(
       GetGattCharacteristic(generic_access.get(),
                             "2A03" /* Reconnection Address */));
 
   ON_CALL(*reconnection_address, ReadRemoteCharacteristic(_, _))
       .WillByDefault(
           RunCallback<1>(BluetoothGattService::GATT_ERROR_NOT_PERMITTED));
 
   generic_access->AddMockCharacteristic(reconnection_address.Pass());
@@ skipping 73 matching lines @@
 scoped_ptr<NiceMock<MockBluetoothGattCharacteristic>>
 LayoutTestBluetoothAdapterProvider::GetGattCharacteristic(
     MockBluetoothGattService* service,
     const std::string& uuid) {
   return make_scoped_ptr(new NiceMock<MockBluetoothGattCharacteristic>(
       service, uuid /* identifier */, BluetoothUUID(uuid), false /* is_local */,
       NULL /* properties */, NULL /* permissions */));
 }
 
 }  // namespace content