bluetooth: android: Implement & test CreateGattConnection.

device/bluetooth/bluetooth_device_unittest.cc

 // Copyright 2014 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_device.h"
 
 #include "base/macros.h"
 #include "base/run_loop.h"
 #include "base/strings/utf_string_conversions.h"
 #include "device/bluetooth/test/test_bluetooth_adapter_observer.h"
@@ skipping 107 matching lines @@
 }
 #endif  // defined(OS_ANDROID) || defined(OS_MACOSX)
 
 // TODO(scheib): Test with a device with no name. http://crbug.com/506415
 // BluetoothDevice::GetAddressWithLocalizedDeviceTypeName() will run, which
 // requires string resources to be loaded. For that, something like
 // InitSharedInstance must be run. See unittest files that call that. It will
 // also require build configuration to generate string resources into a .pak
 // file.
 
+#if defined(OS_ANDROID)
+// Basic CreateGattConnection test.
+TEST_F(BluetoothTest, CreateGattConnection) {
+  InitWithFakeAdapter();
+  TestBluetoothAdapterObserver observer(adapter_);
+
+  // Get a device.
+  adapter_->StartDiscoverySession(GetDiscoverySessionCallback(),
+                                  GetErrorCallback());
+  base::RunLoop().RunUntilIdle();
+  DiscoverLowEnergyDevice(3);
+  base::RunLoop().RunUntilIdle();
+  BluetoothDevice* device = observer.last_device();
+
+  callback_count_ = error_callback_count_ = 0;
+  device->CreateGattConnection(GetGattConnectionCallback(),
+                               GetConnectErrorCallback());
+  CompleteGattConnection(device);
+  EXPECT_EQ(1, callback_count_);
+  EXPECT_EQ(0, error_callback_count_);
+  ASSERT_EQ(1u, gatt_connections_.size());
+  EXPECT_TRUE(device->IsGattConnected());
+  EXPECT_TRUE(gatt_connections_[0]->IsConnected());
+}
+#endif  // defined(OS_ANDROID)
+
+#if defined(OS_ANDROID)
+// Creates BluetoothGattConnection instances and tests that the interface
+// functions even when some Disconnect and the BluetoothDevice is destroyed.
+TEST_F(BluetoothTest, BluetoothGattConnection) {
+  InitWithFakeAdapter();
+  TestBluetoothAdapterObserver observer(adapter_);
+
+  // Get a device.
+  adapter_->StartDiscoverySession(GetDiscoverySessionCallback(),
+                                  GetErrorCallback());
+  base::RunLoop().RunUntilIdle();
+  DiscoverLowEnergyDevice(3);
+  base::RunLoop().RunUntilIdle();
+  BluetoothDevice* device = observer.last_device();
+  std::string device_address = device->GetAddress();
+
+  // CreateGattConnection
+  callback_count_ = error_callback_count_ = 0;
+  device->CreateGattConnection(GetGattConnectionCallback(),
+                               GetConnectErrorCallback());
+  CompleteGattConnection(device);
+  EXPECT_EQ(1, callback_count_);
+  EXPECT_EQ(0, error_callback_count_);
+  ASSERT_EQ(1u, gatt_connections_.size());
+  EXPECT_TRUE(device->IsGattConnected());
+  EXPECT_TRUE(gatt_connections_[0]->IsConnected());
+
+  // Connect again once already connected.
+  device->CreateGattConnection(GetGattConnectionCallback(),
+                               GetConnectErrorCallback());
+  device->CreateGattConnection(GetGattConnectionCallback(),
+                               GetConnectErrorCallback());
+  EXPECT_EQ(3, callback_count_);
+  EXPECT_EQ(0, error_callback_count_);
+  ASSERT_EQ(3u, gatt_connections_.size());
+
+  // Test GetDeviceAddress
+  EXPECT_EQ(device_address, gatt_connections_[0]->GetDeviceAddress());
+
+  // Test IsConnected
+  EXPECT_TRUE(gatt_connections_[0]->IsConnected());
+  EXPECT_TRUE(gatt_connections_[1]->IsConnected());
+  EXPECT_TRUE(gatt_connections_[2]->IsConnected());
+
+  // Disconnect & Delete connection objects. Device stays connected.
+  gatt_connections_[0]->Disconnect();  // Disconnect first.
+  gatt_connections_.pop_back();        // Delete last.
+  EXPECT_FALSE(gatt_connections_[0]->IsConnected());
+  EXPECT_TRUE(gatt_connections_[1]->IsConnected());
+  EXPECT_TRUE(device->IsGattConnected());
+
+  // Delete device, connection objects should all be disconnected.
+  DeleteDevice(device);
+  EXPECT_FALSE(gatt_connections_[0]->IsConnected());
+  EXPECT_FALSE(gatt_connections_[1]->IsConnected());
+
+  // Test GetDeviceAddress after device deleted.
+  EXPECT_EQ(device_address, gatt_connections_[0]->GetDeviceAddress());
+  EXPECT_EQ(device_address, gatt_connections_[1]->GetDeviceAddress());
+}
+#endif  // defined(OS_ANDROID)
+
+#if defined(OS_ANDROID)
+// BluetoothGattConnection with several connect / disconnects.
+TEST_F(BluetoothTest, BluetoothGattConnection_ConnectDisconnect) {
+  InitWithFakeAdapter();
+  TestBluetoothAdapterObserver observer(adapter_);
+
+  // Get a device.
+  adapter_->StartDiscoverySession(GetDiscoverySessionCallback(),
+                                  GetErrorCallback());
+  base::RunLoop().RunUntilIdle();
+  DiscoverLowEnergyDevice(3);
+  base::RunLoop().RunUntilIdle();
+  BluetoothDevice* device = observer.last_device();
+
+  // CreateGattConnection, & multiple connection s from platform only invoke

[Jeffrey Yasskin, 2015/09/16 23:42:49]

sp: connection s

[scheib, 2015/09/20 02:53:35]

Done.

+  // callbacks once:
+  callback_count_ = error_callback_count_ = 0;
+  device->CreateGattConnection(GetGattConnectionCallback(),
+                               GetConnectErrorCallback());
+  CompleteGattConnection(device);
+  CompleteGattConnection(device);
+  EXPECT_EQ(1, callback_count_);
+  EXPECT_EQ(0, error_callback_count_);
+
+  // Become disconnected:
+  CompleteGattDisconnection(device);
+  EXPECT_EQ(1, callback_count_);
+  EXPECT_EQ(0, error_callback_count_);
+  EXPECT_FALSE(gatt_connections_[0]->IsConnected());
+
+  // Be already connected, then CreateGattConnection:
+  callback_count_ = error_callback_count_ = 0;
+  CompleteGattConnection(device);
+  device->CreateGattConnection(GetGattConnectionCallback(),
+                               GetConnectErrorCallback());
+  EXPECT_EQ(1, callback_count_);

[Jeffrey Yasskin, 2015/09/16 23:42:49]

Please add:

EXPECT_FALSE(gatt_connections_[0]->IsConnected())
    << "The disconnected connection shouldn't become connected if another
connection is created.";
EXPECT_TRUE(gatt_connections_[1]->IsConnected());

[scheib, 2015/09/20 02:53:35]

Done.

+  EXPECT_EQ(0, error_callback_count_);
+
+  // Disconnect all CreateGattConnection objects. But, don't yet simulate

[Jeffrey Yasskin, 2015/09/16 23:42:49]

Please also add a test in which the last connection is destroyed instead of
having Disconnect() called.

[scheib, 2015/09/20 02:53:35]

Done.

+  // the device disconnecting.
+  callback_count_ = error_callback_count_ = 0;
+  for (auto connection : gatt_connections_)

[Jeffrey Yasskin, 2015/09/16 23:42:49]

Can you write BluetoothGattConnection* for these for loops too?

[scheib, 2015/09/20 02:53:35]

Done.

+    connection->Disconnect();

[Jeffrey Yasskin, 2015/09/16 23:42:49]

Can you check that the implementation appropriately asked to disconnect after
this loop?

[scheib, 2015/09/20 02:53:35]

Done.

+  device->CreateGattConnection(GetGattConnectionCallback(),
+                               GetConnectErrorCallback());
+  EXPECT_EQ(1, callback_count_);  // Device is assumed still connected.

[Jeffrey Yasskin, 2015/09/16 23:42:49]

Check that gatt_connections_.back()->IsConnected().

[scheib, 2015/09/20 02:53:35]

Done.

+  EXPECT_EQ(0, error_callback_count_);
+  callback_count_ = error_callback_count_ = 0;
+
+  // Actually disconnect:
+  CompleteGattDisconnection(device);
+  EXPECT_EQ(0, callback_count_);
+  EXPECT_EQ(0, error_callback_count_);
+  for (auto connection : gatt_connections_)
+    EXPECT_FALSE(connection->IsConnected());

[Jeffrey Yasskin, 2015/09/16 23:42:49]

These were already false before the CompleteGattDisconnection() call, right?
It's only device->IsGattConnected() that I'd expect to change there.

[scheib, 2015/09/20 02:53:35]

The last connection reports connected. (It connected after the others
disconnected and initiated the disconnect request but before the device actually
disconnected).

+
+  // CreateGattConnection, but receive notice that device disconnected before
+  // it ever connects:
+  callback_count_ = error_callback_count_ = 0;
+  device->CreateGattConnection(GetGattConnectionCallback(),
+                               GetConnectErrorCallback());
+  CompleteGattDisconnection(device);

[Jeffrey Yasskin, 2015/09/16 23:42:49]

Does this happen naturally if you call device->Disconnect() before the gatt
connection completes?

[scheib, 2015/09/20 02:53:34]

I was planning on not failing a connect until the device state actually changes.
If a connect, then disconnect are sent then what is the state of the device? I
don't think we should fire error or disconnected callbacks until the device
actually transitions to those states. What if the device does connect in that
circumstance but doesn't disconnect for whatever reason?

Put another way, I don't think we should make any speculative logic about what a
device may actually do; all state and callbacks should reflect OS reported
changes in device state.

[Jeffrey Yasskin, 2015/09/22 01:22:10]

Right, that's fine. Calls to CompleteGattDisconnection() from this test simulate
what the OS would do. I guess I'm wondering if calling
device->CreateGattConnection(); device->Disconnect() results in
1==gatt_connection_attempt_count_==gatt_disconnection_attempt_count_, which
might cause the OS to CompleteGattDisconnection() before it ever finishes
connecting.

But I'm not sure that's worth changing in the test.

[scheib, 2015/09/22 18:21:48]

I've added 2 more test blocks:
device->CreateGattConnection(); device->Disconnect(); Connected.
device->CreateGattConnection(); device->Disconnect(); Disconnected.

+  EXPECT_EQ(0, callback_count_);
+  EXPECT_EQ(1, error_callback_count_);
+  EXPECT_EQ(BluetoothDevice::ERROR_FAILED, last_connect_error_code_);
+  for (auto connection : gatt_connections_)
+    EXPECT_FALSE(connection->IsConnected());
+
+  // CreateGattConnection, but error connecting. Also, Multiple errors only

[Jeffrey Yasskin, 2015/09/16 23:42:49]

s/Multiple/multiple/

[scheib, 2015/09/20 02:53:35]

Done.

+  // invoke callbacks once:
+  callback_count_ = error_callback_count_ = 0;
+  device->CreateGattConnection(GetGattConnectionCallback(),
+                               GetConnectErrorCallback());
+  FailGattConnection(device, BluetoothDevice::ERROR_AUTH_FAILED);
+  FailGattConnection(device, BluetoothDevice::ERROR_FAILED);
+  EXPECT_EQ(0, callback_count_);
+  EXPECT_EQ(1, error_callback_count_);
+  EXPECT_EQ(BluetoothDevice::ERROR_AUTH_FAILED, last_connect_error_code_);
+  for (auto connection : gatt_connections_)
+    EXPECT_FALSE(connection->IsConnected());
+}
+#endif  // defined(OS_ANDROID)
+
 }  // namespace device