Move the device enumerate/open/close work to device thread from IO thread

content/browser/renderer_host/media/audio_input_device_manager_unittest.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>
 
 #include "base/bind.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
+#include "content/browser/browser_main_loop.h"
 #include "content/browser/browser_thread_impl.h"
 #include "content/browser/renderer_host/media/audio_input_device_manager.h"
 #include "content/browser/renderer_host/media/audio_input_device_manager_event_handler.h"
 #include "media/audio/audio_manager_base.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
+using content::BrowserMainLoop;
 using content::BrowserThread;
 using content::BrowserThreadImpl;
 using media_stream::AudioInputDeviceManager;
 using testing::_;
 using testing::AnyNumber;
 using testing::InSequence;
 using testing::Return;
 
 namespace media_stream {
 
@@ skipping 70 matching lines @@
   bool CanRunAudioInputDeviceTests() {
     return audio_manager_->HasAudioInputDevices();
   }
 
  protected:
   virtual void SetUp() {
     // The test must run on Browser::IO.
     message_loop_.reset(new MessageLoop(MessageLoop::TYPE_IO));
     io_thread_.reset(new BrowserThreadImpl(BrowserThread::IO,
                                            message_loop_.get()));
-    audio_manager_.reset(media::AudioManager::Create());
 
-    manager_ = new AudioInputDeviceManager(audio_manager_.get());
+    device_thread_.reset(new base::Thread("AudioInputDeviceManagerTestThread"));

[scherkus (not reviewing), 2012/06/27 00:52:31]

given that you can inject message loops I'm curious whether you could (or want
to) use message_loop_ here and avoid the syncing between threads

[no longer working on chromium, 2012/06/27 14:07:16]

True, I did not do this simply because I was not sure if it was a good way to do
the testing.

Thanks for pointing out, done now. 

+    CHECK(device_thread_->Start());
+
+    manager_ = new AudioInputDeviceManager(
+        device_thread_->message_loop_proxy());
     audio_input_listener_.reset(new MockAudioInputDeviceManagerListener());
     manager_->Register(audio_input_listener_.get());
 
+    audio_manager_.reset(media::AudioManager::Create());
+    manager_->SetAudioManagerForTesting(audio_manager_.get());

[scherkus (not reviewing), 2012/06/27 00:52:31]

can't we recreate a BrowserMainLoop for each test + use its audio_manager()?
what are we gaining by recreating our own manager?

[no longer working on chromium, 2012/06/27 14:07:16]

Good idea, done.

+
     // Gets the enumerated device list from the AudioInputDeviceManager.
     manager_->EnumerateDevices();
     EXPECT_CALL(*audio_input_listener_, DevicesEnumerated(_))
         .Times(1);
 
-    // Waits for the callback.
-    message_loop_->RunAllPending();
+    // Sync up the threads to make sure we get the list.
+    SyncWithAudioInputDeviceManagerThread();
   }
 
   virtual void TearDown() {
     manager_->Unregister();
     io_thread_.reset();
+    device_thread_->Stop();
+  }
+
+  // Called on the device thread.
+  static void PostQuitMessageLoop(MessageLoop* message_loop) {
+    message_loop->PostTask(FROM_HERE, MessageLoop::QuitClosure());
+  }
+
+  // Called on the main thread.
+  static void PostQuitOnAudioInputDeviceManagerThread(
+      MessageLoop* message_loop, MessageLoop* device_message_loop) {
+    device_message_loop->PostTask(
+        FROM_HERE, base::Bind(&PostQuitMessageLoop, message_loop));
+  }
+
+  // SyncWithAudioInputDeviceManagerThread() waits until all pending tasks on
+  // the audio_input_device_manager thread are executed while also processing
+  // pending task in message_loop_ on the current thread.
+  void SyncWithAudioInputDeviceManagerThread() {
+    message_loop_->PostTask(
+        FROM_HERE,
+        base::Bind(&PostQuitOnAudioInputDeviceManagerThread,
+                   message_loop_.get(),
+                   device_thread_->message_loop()));
+    message_loop_->Run();
   }
 
   scoped_ptr<MessageLoop> message_loop_;
   scoped_ptr<BrowserThreadImpl> io_thread_;
+  scoped_ptr<base::Thread> device_thread_;
   scoped_refptr<AudioInputDeviceManager> manager_;
   scoped_ptr<MockAudioInputDeviceManagerListener> audio_input_listener_;
   scoped_ptr<media::AudioManager> audio_manager_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(AudioInputDeviceManagerTest);
 };
 
 // Opens and closes the devices.
 TEST_F(AudioInputDeviceManagerTest, OpenAndCloseDevice) {
@@ skipping 14 matching lines @@
     // Expected mock call with expected return value.
     EXPECT_CALL(*audio_input_listener_,
                 Opened(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                        session_id))
         .Times(1);
     EXPECT_CALL(*audio_input_listener_,
                 Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                        session_id))
         .Times(1);
 
-    // Waits for the callback.
-    message_loop_->RunAllPending();
+    SyncWithAudioInputDeviceManagerThread();
   }
 }
 
 // Opens multiple devices at one time and closes them later.
 TEST_F(AudioInputDeviceManagerTest, OpenMultipleDevices) {
   if (!CanRunAudioInputDeviceTests())
     return;
 
   ASSERT_FALSE(audio_input_listener_->devices_.empty());
 
   InSequence s;
 
   int index = 0;
   const int kDeviceSize = audio_input_listener_->devices_.size();
   scoped_array<int> session_id(new int[kDeviceSize]);
 
   // Opens the devices in a loop.
   for (StreamDeviceInfoArray::const_iterator iter =
        audio_input_listener_->devices_.begin();
        iter != audio_input_listener_->devices_.end(); ++iter, ++index) {
     // Opens the devices.
     session_id[index] = manager_->Open(*iter);
 
     // Expected mock call with expected returned value.
     EXPECT_CALL(*audio_input_listener_,
                 Opened(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                        session_id[index]))
         .Times(1);
 
-    // Waits for the callback.
-    message_loop_->RunAllPending();
+    SyncWithAudioInputDeviceManagerThread();
   }
 
   // Checks if the session_ids are unique.
   for (int i = 0; i < kDeviceSize - 1; ++i) {
     for (int k = i+1; k < kDeviceSize; ++k) {
       EXPECT_TRUE(session_id[i] != session_id[k]);
     }
   }
 
   for (int i = 0; i < kDeviceSize; ++i) {
     // Closes the devices.
     manager_->Close(session_id[i]);
     EXPECT_CALL(*audio_input_listener_,
                 Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                        session_id[i]))
         .Times(1);
 
-    // Waits for the callback.
-    message_loop_->RunAllPending();
+    SyncWithAudioInputDeviceManagerThread();
   }
 }
 
 // Opens a non-existing device.
 TEST_F(AudioInputDeviceManagerTest, OpenNotExistingDevice) {
   if (!CanRunAudioInputDeviceTests())
     return;
   InSequence s;
 
   MediaStreamType stream_type = content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE;
   std::string device_name("device_doesnt_exist");
   std::string device_id("id_doesnt_exist");
   StreamDeviceInfo dummy_device(stream_type, device_name, device_id, false);
 
   int session_id = manager_->Open(dummy_device);
   EXPECT_CALL(*audio_input_listener_,
               Opened(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      session_id))
       .Times(1);
 
-  // Waits for the callback.
-  message_loop_->RunAllPending();
+  SyncWithAudioInputDeviceManagerThread();
 }
 
 // Opens default device twice.
 TEST_F(AudioInputDeviceManagerTest, OpenDeviceTwice) {
   if (!CanRunAudioInputDeviceTests())
     return;
 
   ASSERT_FALSE(audio_input_listener_->devices_.empty());
 
   InSequence s;
@@ skipping 18 matching lines @@
       .Times(1);
   EXPECT_CALL(*audio_input_listener_,
               Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      first_session_id))
       .Times(1);
   EXPECT_CALL(*audio_input_listener_,
               Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      second_session_id))
       .Times(1);
 
-  // Waits for the callback.
-  message_loop_->RunAllPending();
+  SyncWithAudioInputDeviceManagerThread();
 }
 
 // Starts and closes the sessions after opening the devices.
 TEST_F(AudioInputDeviceManagerTest, StartAndStopSession) {
   if (!CanRunAudioInputDeviceTests())
     return;
 
   ASSERT_FALSE(audio_input_listener_->devices_.empty());
 
   InSequence s;
@@ skipping 12 matching lines @@
   for (StreamDeviceInfoArray::const_iterator iter =
        audio_input_listener_->devices_.begin();
        iter != audio_input_listener_->devices_.end(); ++iter, ++index) {
     // Note that no DeviceStopped() notification for Event Handler as we have
     // stopped the device before calling close.
     session_id[index] = manager_->Open(*iter);
     EXPECT_CALL(*audio_input_listener_,
                 Opened(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                        session_id[index]))
         .Times(1);
-    message_loop_->RunAllPending();
+    SyncWithAudioInputDeviceManagerThread();
 
     manager_->Start(session_id[index], audio_input_event_handler.get());
     EXPECT_CALL(*audio_input_event_handler,
                 DeviceStarted(session_id[index], iter->device_id))
         .Times(1);
     message_loop_->RunAllPending();
 
     manager_->Stop(session_id[index]);
     manager_->Close(session_id[index]);
     EXPECT_CALL(*audio_input_listener_,
                 Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                        session_id[index]))
         .Times(1);
-    message_loop_->RunAllPending();
+    SyncWithAudioInputDeviceManagerThread();
   }
 }
 
 // Tests the behavior of calling Close() without calling Stop().
 TEST_F(AudioInputDeviceManagerTest, CloseWithoutStopSession) {
   if (!CanRunAudioInputDeviceTests())
     return;
 
   ASSERT_FALSE(audio_input_listener_->devices_.empty());
 
@@ skipping 12 matching lines @@
   // Note that we do not call stop.
   for (StreamDeviceInfoArray::const_iterator iter =
        audio_input_listener_->devices_.begin();
        iter != audio_input_listener_->devices_.end(); ++iter, ++index) {
     // Calls Open()/Start()/Close() for each device.
     session_id[index] = manager_->Open(*iter);
     EXPECT_CALL(*audio_input_listener_,
                 Opened(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                        session_id[index]))
         .Times(1);
-    message_loop_->RunAllPending();
+    SyncWithAudioInputDeviceManagerThread();
 
     manager_->Start(session_id[index], audio_input_event_handler.get());
     EXPECT_CALL(*audio_input_event_handler,
                 DeviceStarted(session_id[index], iter->device_id))
         .Times(1);
     message_loop_->RunAllPending();
 
     // Event Handler should get a stop device notification as no stop is called
     // before closing the device.
     manager_->Close(session_id[index]);
     EXPECT_CALL(*audio_input_event_handler,
                 DeviceStopped(session_id[index]))
         .Times(1);
     EXPECT_CALL(*audio_input_listener_,
                 Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                        session_id[index]))
         .Times(1);
-    message_loop_->RunAllPending();
+    SyncWithAudioInputDeviceManagerThread();
   }
 }
 
 // Starts the same device twice.
 TEST_F(AudioInputDeviceManagerTest, StartDeviceTwice) {
   if (!CanRunAudioInputDeviceTests())
     return;
 
   ASSERT_FALSE(audio_input_listener_->devices_.empty());
 
@@ skipping 14 matching lines @@
   int second_session_id = manager_->Open(*iter);
   EXPECT_NE(first_session_id, second_session_id);
   EXPECT_CALL(*audio_input_listener_,
               Opened(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      first_session_id))
       .Times(1);
   EXPECT_CALL(*audio_input_listener_,
               Opened(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      second_session_id))
       .Times(1);
-  message_loop_->RunAllPending();
+  SyncWithAudioInputDeviceManagerThread();
 
   // Calls Start()/Stop()/Close() for the default device twice.
   manager_->Start(first_session_id, first_event_handler.get());
   manager_->Start(second_session_id, second_event_handler.get());
   EXPECT_CALL(*first_event_handler,
               DeviceStarted(first_session_id,
                             media::AudioManagerBase::kDefaultDeviceId))
       .Times(1);
   EXPECT_CALL(*second_event_handler,
               DeviceStarted(second_session_id,
                             media::AudioManagerBase::kDefaultDeviceId))
       .Times(1);
   message_loop_->RunAllPending();
 
   manager_->Stop(first_session_id);
   manager_->Stop(second_session_id);
   manager_->Close(first_session_id);
   manager_->Close(second_session_id);
   EXPECT_CALL(*audio_input_listener_,
               Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      first_session_id))
       .Times(1);
   EXPECT_CALL(*audio_input_listener_,
               Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      second_session_id))
       .Times(1);
-  message_loop_->RunAllPending();
+  SyncWithAudioInputDeviceManagerThread();
 }
 
 // Starts an invalid session.
 TEST_F(AudioInputDeviceManagerTest, StartInvalidSession) {
   if (!CanRunAudioInputDeviceTests())
     return;
   InSequence s;
 
   // Creates the EventHandlers for the sessions.
   scoped_ptr<MockAudioInputDeviceManagerEventHandler>
       audio_input_event_handler(
           new MockAudioInputDeviceManagerEventHandler(message_loop_.get()));
 
   // Opens the first device.
   StreamDeviceInfoArray::const_iterator iter =
       audio_input_listener_->devices_.begin();
   int session_id = manager_->Open(*iter);
   EXPECT_CALL(*audio_input_listener_,
               Opened(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      session_id))
       .Times(1);
-  message_loop_->RunAllPending();
+  SyncWithAudioInputDeviceManagerThread();
 
   // Starts a non-opened device.
   // This should fail and trigger error code 'kDeviceNotAvailable'.
   int invalid_session_id = session_id + 1;
   manager_->Start(invalid_session_id, audio_input_event_handler.get());
   EXPECT_CALL(*audio_input_event_handler,
               DeviceStarted(invalid_session_id,
                             AudioInputDeviceManager::kInvalidDeviceId))
       .Times(1);
   message_loop_->RunAllPending();
 
   manager_->Close(session_id);
   EXPECT_CALL(*audio_input_listener_,
               Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      session_id))
       .Times(1);
-  message_loop_->RunAllPending();
+  SyncWithAudioInputDeviceManagerThread();
 }
 
 // Starts a session twice, the first time should succeed, while the second
 // time should fail.
 TEST_F(AudioInputDeviceManagerTest, StartSessionTwice) {
   if (!CanRunAudioInputDeviceTests())
     return;
   InSequence s;
 
   // Creates the EventHandlers for the sessions.
   scoped_ptr<MockAudioInputDeviceManagerEventHandler>
       audio_input_event_handler(
           new MockAudioInputDeviceManagerEventHandler(message_loop_.get()));
 
   // Opens the first device.
   StreamDeviceInfoArray::const_iterator iter =
       audio_input_listener_->devices_.begin();
   int session_id = manager_->Open(*iter);
   EXPECT_CALL(*audio_input_listener_,
               Opened(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      session_id))
       .Times(1);
-  message_loop_->RunAllPending();
+  SyncWithAudioInputDeviceManagerThread();
 
   // Starts the session, it should succeed.
   manager_->Start(session_id, audio_input_event_handler.get());
   EXPECT_CALL(*audio_input_event_handler,
               DeviceStarted(session_id,
                             media::AudioManagerBase::kDefaultDeviceId))
       .Times(1);
   message_loop_->RunAllPending();
 
   // Starts the session for the second time, it should fail.
   manager_->Start(session_id, audio_input_event_handler.get());
   EXPECT_CALL(*audio_input_event_handler,
               DeviceStarted(session_id,
                             AudioInputDeviceManager::kInvalidDeviceId))
       .Times(1);
 
   manager_->Stop(session_id);
   manager_->Close(session_id);
   EXPECT_CALL(*audio_input_listener_,
               Closed(content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE,
                      session_id))
       .Times(1);
-  message_loop_->RunAllPending();
+  SyncWithAudioInputDeviceManagerThread();
 }
 
 }  // namespace media_stream