Migrate chrome.bluetooth API backend to use device::BluetoothDiscoverySession.

chrome/browser/extensions/api/bluetooth/bluetooth_apitest.cc

 // Copyright (c) 2012 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 <string.h>
 
 #include "base/strings/stringprintf.h"
 #include "chrome/browser/extensions/api/bluetooth/bluetooth_api.h"
 #include "chrome/browser/extensions/api/bluetooth/bluetooth_event_router.h"
 #include "chrome/browser/extensions/extension_apitest.h"
 #include "chrome/browser/extensions/extension_function_test_utils.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/extension_test_message_listener.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/test/base/ui_test_utils.h"
 #include "device/bluetooth/bluetooth_adapter.h"
 #include "device/bluetooth/bluetooth_out_of_band_pairing_data.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_profile.h"
 #include "device/bluetooth/test/mock_bluetooth_socket.h"
 #include "testing/gmock/include/gmock/gmock.h"
 
 using device::BluetoothAdapter;
 using device::BluetoothDevice;
+using device::BluetoothDiscoverySession;
 using device::BluetoothOutOfBandPairingData;
 using device::BluetoothProfile;
 using device::MockBluetoothAdapter;
 using device::MockBluetoothDevice;
+using device::MockBluetoothDiscoverySession;
 using device::MockBluetoothProfile;
 using extensions::Extension;
 
 namespace utils = extension_function_test_utils;
 namespace api = extensions::api;
 
 namespace {
 
 static const char* kAdapterAddress = "A1:A2:A3:A4:A5:A6";
 static const char* kName = "whatsinaname";
@@ skipping 18 matching lines @@
     event_router()->SetAdapterForTest(mock_adapter_);
 
     device1_.reset(new testing::NiceMock<MockBluetoothDevice>(
         mock_adapter_, 0, "d1", "11:12:13:14:15:16",
         true /* paired */, true /* connected */));
     device2_.reset(new testing::NiceMock<MockBluetoothDevice>(
         mock_adapter_, 0, "d2", "21:22:23:24:25:26",
         false /* paired */, false /* connected */));
   }
 
+  void DiscoverySessionCallback(
+      const BluetoothAdapter::DiscoverySessionCallback& callback,
+      const BluetoothAdapter::ErrorCallback& error_callback) {
+    if (mock_session_.get()) {
+      callback.Run(
+          scoped_ptr<BluetoothDiscoverySession>(mock_session_.release()));
+      return;
+    }
+    error_callback.Run();
+  }
+
   template <class T>
   T* setupFunction(T* function) {
     function->set_extension(empty_extension_.get());
     function->set_has_callback(true);
     return function;
   }
 
  protected:
   testing::StrictMock<MockBluetoothAdapter>* mock_adapter_;
+  scoped_ptr<testing::NiceMock<MockBluetoothDiscoverySession> > mock_session_;
   scoped_ptr<testing::NiceMock<MockBluetoothDevice> > device1_;
   scoped_ptr<testing::NiceMock<MockBluetoothDevice> > device2_;
   scoped_ptr<testing::NiceMock<MockBluetoothProfile> > profile1_;
   scoped_ptr<testing::NiceMock<MockBluetoothProfile> > profile2_;
 
   extensions::ExtensionBluetoothEventRouter* event_router() {
     return extensions::BluetoothAPI::Get(browser()->profile())
         ->bluetooth_event_router();
   }
 
@@ skipping 35 matching lines @@
   memcpy(&(data.randomizer), kOutOfBandPairingDataRandomizer,
       device::kBluetoothOutOfBandPairingDataSize);
   return data;
 }
 
 static bool CallClosure(const base::Closure& callback) {
   callback.Run();
   return true;
 }
 
-static void CallDiscoveryCallback(
-    const base::Closure& callback,
-    const BluetoothAdapter::ErrorCallback& error_callback) {
+static void StopDiscoverySessionCallback(const base::Closure& callback,
+                                         const base::Closure& error_callback) {
   callback.Run();
 }
 
-static void CallDiscoveryErrorCallback(
-    const base::Closure& callback,
-    const BluetoothAdapter::ErrorCallback& error_callback) {
-  error_callback.Run();
-}
-
 static void CallOutOfBandPairingDataCallback(
     const BluetoothAdapter::BluetoothOutOfBandPairingDataCallback& callback,
     const BluetoothAdapter::ErrorCallback& error_callback) {
   callback.Run(GetOutOfBandPairingData());
 }
 
 }  // namespace
 
 IN_PROC_BROWSER_TEST_F(BluetoothApiTest, Profiles) {
   // Run in context of an extension that has permissions for the profiles
@@ skipping 155 matching lines @@
   std::string error(utils::RunFunctionAndReturnError(
       set_oob_function.get(), params, browser()));
   EXPECT_FALSE(error.empty());
 
   // TODO(bryeung): Also test setting the data when there is support for
   // ArrayBuffers in the arguments to the RunFunctionAnd* methods.
   // crbug.com/132796
 }
 
 IN_PROC_BROWSER_TEST_F(BluetoothApiTest, Discovery) {
-  // Try with a failure to start
-  EXPECT_CALL(*mock_adapter_, StartDiscovering(testing::_, testing::_))
-      .WillOnce(testing::Invoke(CallDiscoveryErrorCallback));
+  // Try with a failure to start. This will return an error as we haven't
+  // initialied a session object.
+  EXPECT_CALL(*mock_adapter_, StartDiscoverySession(testing::_, testing::_))
+      .WillOnce(
+          testing::Invoke(this, &BluetoothApiTest::DiscoverySessionCallback));
+
   // StartDiscovery failure will remove the adapter that is no longer used.
   EXPECT_CALL(*mock_adapter_, RemoveObserver(testing::_));
   scoped_refptr<api::BluetoothStartDiscoveryFunction> start_function;
   start_function = setupFunction(new api::BluetoothStartDiscoveryFunction);
   std::string error(
       utils::RunFunctionAndReturnError(start_function.get(), "[]", browser()));
   ASSERT_FALSE(error.empty());
 
-  // Reset for a successful start
+  // Reset the adapter and initiate a discovery session. The ownership of the
+  // mock session will be passed to the event router.
+  ASSERT_FALSE(mock_session_.get());
   SetUpMockAdapter();
-  EXPECT_CALL(*mock_adapter_, StartDiscovering(testing::_, testing::_))
-      .WillOnce(testing::Invoke(CallDiscoveryCallback));
 
+  // Create a mock session to be returned as a result. Get a handle to it as
+  // its ownership will be passed and |mock_session_| will be reset.
+  mock_session_.reset(new testing::NiceMock<MockBluetoothDiscoverySession>());
+  MockBluetoothDiscoverySession* session = mock_session_.get();
+  EXPECT_CALL(*mock_adapter_, StartDiscoverySession(testing::_, testing::_))
+      .WillOnce(
+          testing::Invoke(this, &BluetoothApiTest::DiscoverySessionCallback));
   start_function = setupFunction(new api::BluetoothStartDiscoveryFunction);
   (void)
       utils::RunFunctionAndReturnError(start_function.get(), "[]", browser());
 
-  // Reset to try stopping
+  // End the discovery session. The StopDiscovery function should succeed.
   testing::Mock::VerifyAndClearExpectations(mock_adapter_);
-  EXPECT_CALL(*mock_adapter_, StopDiscovering(testing::_, testing::_))
-      .WillOnce(testing::Invoke(CallDiscoveryCallback));
+  EXPECT_CALL(*session, IsActive()).WillOnce(testing::Return(true));
+  EXPECT_CALL(*session, Stop(testing::_, testing::_))
+      .WillOnce(testing::Invoke(StopDiscoverySessionCallback));
+
   // StopDiscovery success will remove the adapter that is no longer used.
   EXPECT_CALL(*mock_adapter_, RemoveObserver(testing::_));
   scoped_refptr<api::BluetoothStopDiscoveryFunction> stop_function;
   stop_function = setupFunction(new api::BluetoothStopDiscoveryFunction);
   (void) utils::RunFunctionAndReturnSingleResult(
       stop_function.get(), "[]", browser());
 
-  // Reset to try stopping with an error
+  // Reset the adapter. Simulate failure for stop discovery. The event router
+  // still owns the session. Make it appear inactive.
   SetUpMockAdapter();
-  EXPECT_CALL(*mock_adapter_, StopDiscovering(testing::_, testing::_))
-      .WillOnce(testing::Invoke(CallDiscoveryErrorCallback));
+  EXPECT_CALL(*session, IsActive()).WillOnce(testing::Return(false));
   EXPECT_CALL(*mock_adapter_, RemoveObserver(testing::_));
   stop_function = setupFunction(new api::BluetoothStopDiscoveryFunction);
   error =
       utils::RunFunctionAndReturnError(stop_function.get(), "[]", browser());
   ASSERT_FALSE(error.empty());
   SetUpMockAdapter();
 }
 
 IN_PROC_BROWSER_TEST_F(BluetoothApiTest, DiscoveryCallback) {
-  EXPECT_CALL(*mock_adapter_, StartDiscovering(testing::_, testing::_))
-      .WillOnce(testing::Invoke(CallDiscoveryCallback));
-  EXPECT_CALL(*mock_adapter_, StopDiscovering(testing::_, testing::_))
-      .WillOnce(testing::Invoke(CallDiscoveryCallback));
+  mock_session_.reset(new testing::NiceMock<MockBluetoothDiscoverySession>());
+  MockBluetoothDiscoverySession* session = mock_session_.get();
+  EXPECT_CALL(*mock_adapter_, StartDiscoverySession(testing::_, testing::_))
+      .WillOnce(
+          testing::Invoke(this, &BluetoothApiTest::DiscoverySessionCallback));
+  EXPECT_CALL(*session, IsActive()).WillOnce(testing::Return(true));
+  EXPECT_CALL(*session, Stop(testing::_, testing::_))
+      .WillOnce(testing::Invoke(StopDiscoverySessionCallback));
 
   ResultCatcher catcher;
   catcher.RestrictToProfile(browser()->profile());
 
   ExtensionTestMessageListener discovery_started("ready", true);
   ASSERT_TRUE(LoadExtension(
         test_data_dir_.AppendASCII("bluetooth/discovery_callback")));
   EXPECT_TRUE(discovery_started.WaitUntilSatisfied());
 
   event_router()->DeviceAdded(mock_adapter_, device1_.get());
@@ skipping 24 matching lines @@
   EXPECT_CALL(*mock_adapter_, IsDiscovering())
       .WillOnce(testing::Return(true));
   event_router()->AdapterDiscoveringChanged(mock_adapter_, true);
 
   // Cache a device before the extension starts discovering
   event_router()->DeviceAdded(mock_adapter_, device1_.get());
 
   ResultCatcher catcher;
   catcher.RestrictToProfile(browser()->profile());
 
-  EXPECT_CALL(*mock_adapter_, StartDiscovering(testing::_, testing::_))
-      .WillOnce(testing::Invoke(CallDiscoveryCallback));
-  EXPECT_CALL(*mock_adapter_, StopDiscovering(testing::_, testing::_))
-      .WillOnce(testing::Invoke(CallDiscoveryCallback));
+  mock_session_.reset(new testing::NiceMock<MockBluetoothDiscoverySession>());
+  MockBluetoothDiscoverySession* session = mock_session_.get();
+  EXPECT_CALL(*mock_adapter_, StartDiscoverySession(testing::_, testing::_))
+      .WillOnce(
+          testing::Invoke(this, &BluetoothApiTest::DiscoverySessionCallback));
+  EXPECT_CALL(*session, IsActive()).WillOnce(testing::Return(true));
+  EXPECT_CALL(*session, Stop(testing::_, testing::_))
+      .WillOnce(testing::Invoke(StopDiscoverySessionCallback));
 
   ExtensionTestMessageListener discovery_started("ready", true);
   ASSERT_TRUE(LoadExtension(
         test_data_dir_.AppendASCII("bluetooth/discovery_in_progress")));
   EXPECT_TRUE(discovery_started.WaitUntilSatisfied());
 
-  // This should be received in addition to the cached device above.
+  // Only this should be received. No additional notification should be sent for
+  // devices discovered before the discovery session started.
   event_router()->DeviceAdded(mock_adapter_, device2_.get());
 
   discovery_started.Reply("go");
   ExtensionTestMessageListener discovery_stopped("ready", true);
   EXPECT_CALL(*mock_adapter_, RemoveObserver(testing::_));
   EXPECT_TRUE(discovery_stopped.WaitUntilSatisfied());
 
   SetUpMockAdapter();
   // This should never be received.
   event_router()->DeviceAdded(mock_adapter_, device2_.get());
@@ skipping 138 matching lines @@
   // Load and wait for setup
   ExtensionTestMessageListener listener("ready", true);
   ASSERT_TRUE(LoadExtension(
         test_data_dir_.AppendASCII("bluetooth/get_devices_error")));
   EXPECT_TRUE(listener.WaitUntilSatisfied());
 
   listener.Reply("go");
 
   EXPECT_TRUE(catcher.GetNextResult()) << catcher.message();
 }