bluetooth: Tests refactoring: BaseAdapter, FailStartDiscoveryAdapter...

content/shell/browser/layout_test/layout_test_bluetooth_adapter_provider.h

 // 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.
 
 #ifndef CONTENT_SHELL_BROWSER_LAYOUT_TEST_LAYOUT_TEST_BLUETOOTH_ADAPTER_PROVIDER_H_
 #define CONTENT_SHELL_BROWSER_LAYOUT_TEST_LAYOUT_TEST_BLUETOOTH_ADAPTER_PROVIDER_H_
 
 #include "base/callback.h"
 #include "device/bluetooth/bluetooth_adapter_factory.h"
 #include "device/bluetooth/test/mock_bluetooth_adapter.h"
 #include "device/bluetooth/test/mock_bluetooth_device.h"
 #include "device/bluetooth/test/mock_bluetooth_discovery_session.h"
 #include "device/bluetooth/test/mock_bluetooth_gatt_characteristic.h"
 #include "device/bluetooth/test/mock_bluetooth_gatt_service.h"
 
 namespace content {
 
 // Implements fake adapters with named mock data set for use in tests as a
 // result of layout tests calling testRunner.setBluetoothMockDataSet.
+
+// We have a complete “GenericAccessAdapter”, meaning it has a device which has
+// a Generic Access service with a Device Name characteristic with a descriptor.
+// The other adapters are named based on their particular non-expected behavior.
+
 class LayoutTestBluetoothAdapterProvider {
  public:
   // Returns a BluetoothAdapter. Its behavior depends on |fake_adapter_name|.
   static scoped_refptr<device::BluetoothAdapter> GetBluetoothAdapter(
       const std::string& fake_adapter_name);
 
  private:
-  // Returns "EmptyAdapter" fake BluetoothAdapter with the following
-  // characteristics:
-  //  - |StartDiscoverySessionWithFilter| runs the success callback with
-  //  |DiscoverySession|
-  //    as argument.
-  //  - |GetDevices| returns an empty list of devices.
+  // Adapters
+
+  // |BaseAdapter|
+  // Devices Added:
+  //  None.
+  // Mock Functions:
+  //  - GetDevices:
+  //      Returns a list of devices added to the adapter.
+  //  - GetDevice:
+  //      Returns a device matching the address provided if the device was
+  //      added to the adapter.
+  static scoped_refptr<testing::NiceMock<device::MockBluetoothAdapter>>
+  GetBaseAdapter();
+
+  // |FailStartDiscoveryAdapter|
+  // Inherits from |BaseAdapter|
+  // Devices added:
+  //  None.
+  // Mock Functions:
+  //  - StartDiscoverySessionWithFilter:
+  //      Run error callback.
+  static scoped_refptr<testing::NiceMock<device::MockBluetoothAdapter>>
+  GetFailStartDiscoveryAdapter();
+
+  // |EmptyAdapter|
+  // Inherits from |BaseAdapter|
+  // Devices added:
+  //  None.
+  // Mock Functions:
+  //  - StartDiscoverySessionWithFilter:
+  //      Run success callback with |DiscoverySession|.
   static scoped_refptr<testing::NiceMock<device::MockBluetoothAdapter>>
   GetEmptyAdapter();
 
+  // Discovery Sessions
+
+  // |DiscoverySession|
+  // Mock Functions:
+  //  - Stop:
+  //      Run success callback.
+  static scoped_ptr<testing::NiceMock<device::MockBluetoothDiscoverySession>>
+  GetDiscoverySession();
+
+  // The functions after this haven't been updated to the new design yet.
+
   // Returns a fake BluetoothAdapter that asserts that its
   // StartDiscoverySessionWithFilter() method is called with a filter consisting
   // of the standard battery, heart rate, and glucose services.
   //  - |StartDiscoverySessionWithFilter(correct arguments)| runs the success
   //    callback with |DiscoverySession| as the argument. With incorrect
   //    arguments, it runs the failure callback.
   //  - |GetDevices| returns a device with a Battery service.
   static scoped_refptr<testing::NiceMock<device::MockBluetoothAdapter>>
   GetScanFilterCheckingAdapter();
 
@@ skipping 30 matching lines @@
 
   // Returns "UnconnectableDeviceAdapter" fake BluetoothAdapter with the
   // following characteristics:
   //  - |StartDiscoverySessionWithFilter| runs the success callback with
   //  |DiscoverySession|
   //    as argument.
   //  - |GetDevices| returns a list with an |UnconnectableDevice|.
   static scoped_refptr<testing::NiceMock<device::MockBluetoothAdapter>>
   GetUnconnectableDeviceAdapter();
 
-  // Returns a fake |DiscoverySession| with the following characteristics:
-  //  - |Stop| runs the success callback.
-  static scoped_ptr<testing::NiceMock<device::MockBluetoothDiscoverySession>>
-  GetDiscoverySession();
-
   // Returns an |EmptyDevice| with the following characeteristics:
   //  - |GetAddress| returns "Empty Mock Device instanceID".
   //  - |GetName| returns "Empty Mock Device name".
   //  - |GetBluetoothClass| returns 0x1F00.  "Unspecified Device Class": see
   //    bluetooth.org/en-us/specification/assigned-numbers/baseband
   //  - |GetVendorIDSource| returns |BluetoothDevice::VENDOR_ID_BLUETOOTH|.
   //  - |GetVendorID| returns 0xFFFF.
   //  - |GetProductID| returns 1.
   //  - |GetDeviceID| returns 2.
   //  - |IsPaired| returns true.
@@ skipping 38 matching lines @@
   // - |GetService| returns |service|.
   // - |IsNotifying| returns false.
   static scoped_ptr<testing::NiceMock<device::MockBluetoothGattCharacteristic>>
   GetGattCharacteristic(device::MockBluetoothGattService* service,
                         const std::string& uuid);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_SHELL_BROWSER_LAYOUT_TEST_LAYOUT_TEST_BLUETOOTH_ADAPTER_PROVIDER_H_