Expose a way for unit tests to terminate the AudioManager singleton to avoid conflicts between te...

content/renderer/media/webrtc_audio_device_unittest.cc

 // Copyright (c) 2011 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 "base/environment.h"
 #include "base/test/test_timeouts.h"
 #include "content/renderer/media/webrtc_audio_device_impl.h"
 #include "content/test/webrtc_audio_device_test.h"
+#include "media/audio/audio_manager.h"
 #include "media/audio/audio_util.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "third_party/webrtc/voice_engine/main/interface/voe_audio_processing.h"
 #include "third_party/webrtc/voice_engine/main/interface/voe_base.h"
 #include "third_party/webrtc/voice_engine/main/interface/voe_external_media.h"
 #include "third_party/webrtc/voice_engine/main/interface/voe_file.h"
 #include "third_party/webrtc/voice_engine/main/interface/voe_network.h"
 
 using testing::_;
 using testing::AnyNumber;
@@ skipping 88 matching lines @@
   int channel_id_;
   webrtc::ProcessingTypes type_;
   int packet_size_;
   int sample_rate_;
   int channels_;
   DISALLOW_COPY_AND_ASSIGN(WebRTCMediaProcessImpl);
 };
 
 }  // end namespace
 
+// Utility class to delete the AudioManager

[henrika (OOO until Aug 14), 2011/11/20 18:43:03]

AudioManager.

[tommi (sloooow) - chröme, 2011/11/21 10:39:33]

Done.

+class AutoAudioManagerCleanup {
+ public:
+  AutoAudioManagerCleanup() {
+    if (DeleteAndResurrectIfExists()) {

[henrika (OOO until Aug 14), 2011/11/20 18:43:03]

I would call it DeleteAndRessurrect(). If not, it feels like the
delete-and-resurrect part can go wrong and it can't. You only return false for
!AudioManager::SingletonExists().

[tommi (sloooow) - chröme, 2011/11/21 10:39:33]

Done.  Although, FYI: The name says exactly what the method does. The case for
when it returns true and when it does not, is clearly documented. This is not a
public method, so it shouldn't confuse anyone using the class.

+      // In order to prevent this from happening, we sacrifice this test even
+      // though some other test must have caused this.  If we don't it won't
+      // get fixed.  Sorry :)
+      ADD_FAILURE()
+          << "AudioManager singleton was not cleaned up by some previous test!";
+    }
+  }
+  ~AutoAudioManagerCleanup() {
+    DeleteAndResurrectIfExists();
+  }
+
+ protected:
+  // Returns true iff the AudioManager existed and was deleted.
+  bool DeleteAndResurrectIfExists() {
+    if (AudioManager::SingletonExists()) {
+      AudioManager::Destroy(NULL);
+      AudioManager::Resurrect();
+      return true;
+    }
+    return false;
+  }
+};
+
 // Basic test that instantiates and initializes an instance of
 // WebRtcAudioDeviceImpl.
 TEST_F(WebRTCAudioDeviceTest, Construct) {

[henrika (OOO until Aug 14), 2011/11/20 18:43:03]

Why is this the only test were we don't add  if (IsRunningHeadless())?

[tommi (sloooow) - chröme, 2011/11/21 10:39:33]

This is the only test that can currently pass on the build bots.
Having 1 test that runs on the build bots is of course better than 0 and we've
already found several issues thanks to it.

+  AutoAudioManagerCleanup audio_manager_cleanup;
   AudioUtilNoHardware audio_util(48000.0, 48000.0);
   SetAudioUtilCallback(&audio_util);
   scoped_refptr<WebRtcAudioDeviceImpl> audio_device(
       new WebRtcAudioDeviceImpl());
   audio_device->SetSessionId(1);
 
   WebRTCAutoDelete<webrtc::VoiceEngine> engine(webrtc::VoiceEngine::Create());
   ASSERT_TRUE(engine.valid());
 
   ScopedWebRTCPtr<webrtc::VoEBase> base(engine.get());
   int err = base->Init(audio_device);
   EXPECT_EQ(0, err);
   EXPECT_EQ(0, base->Terminate());
 }
 
 // Verify that a call to webrtc::VoEBase::StartPlayout() starts audio output
 // with the correct set of parameters. A WebRtcAudioDeviceImpl instance will
 // be utilized to implement the actual audio path. The test registers a
 // webrtc::VoEExternalMedia implementation to hijack the output audio and
 // verify that streaming starts correctly.
 // Disabled when running headless since the bots don't have the required config.
 TEST_F(WebRTCAudioDeviceTest, StartPlayout) {
+  AutoAudioManagerCleanup audio_manager_cleanup;
+
   if (IsRunningHeadless())
     return;
 
   AudioUtil audio_util;
   SetAudioUtilCallback(&audio_util);
 
   EXPECT_CALL(media_observer(),
       OnSetAudioStreamStatus(_, 1, StrEq("created"))).Times(1);
   EXPECT_CALL(media_observer(),
       OnSetAudioStreamPlaying(_, 1, true)).Times(1);
@@ skipping 49 matching lines @@
 // Verify that a call to webrtc::VoEBase::StartRecording() starts audio input
 // with the correct set of parameters. A WebRtcAudioDeviceImpl instance will
 // be utilized to implement the actual audio path. The test registers a
 // webrtc::VoEExternalMedia implementation to hijack the input audio and
 // verify that streaming starts correctly. An external transport implementation
 // is also required to ensure that "sending" can start without actually trying
 // to send encoded packets to the network. Our main interest here is to ensure
 // that the audio capturing starts as it should.
 // Disabled when running headless since the bots don't have the required config.
 TEST_F(WebRTCAudioDeviceTest, StartRecording) {
+  AutoAudioManagerCleanup audio_manager_cleanup;
+
   if (IsRunningHeadless())
     return;
 
   AudioUtil audio_util;
   SetAudioUtilCallback(&audio_util);
 
   // TODO(tommi): extend MediaObserver and MockMediaObserver with support
   // for new interfaces, like OnSetAudioStreamRecording(). When done, add
   // EXPECT_CALL() macros here.
 
@@ skipping 44 matching lines @@
       ch, webrtc::kRecordingPerChannel));
   EXPECT_EQ(0, base->StopSend(ch));
 
   EXPECT_EQ(0, base->DeleteChannel(ch));
   EXPECT_EQ(0, base->Terminate());
 }
 
 // Uses WebRtcAudioDeviceImpl to play a local wave file.
 // Disabled when running headless since the bots don't have the required config.
 TEST_F(WebRTCAudioDeviceTest, PlayLocalFile) {
+  AutoAudioManagerCleanup audio_manager_cleanup;
+
   if (IsRunningHeadless())
     return;
 
   std::string file_path(
       GetTestDataPath(FILE_PATH_LITERAL("speechmusic_mono_16kHz.pcm")));
 
   AudioUtil audio_util;
   SetAudioUtilCallback(&audio_util);
 
   EXPECT_CALL(media_observer(),
@@ skipping 40 matching lines @@
 
 // Uses WebRtcAudioDeviceImpl to play out recorded audio in loopback.
 // An external transport implementation is utilized to feed back RTP packets
 // which are recorded, encoded, packetized into RTP packets and finally
 // "transmitted". The RTP packets are then fed back into the VoiceEngine
 // where they are decoded and played out on the default audio output device.
 // Disabled when running headless since the bots don't have the required config.
 // TODO(henrika): improve quality by using a wideband codec, enabling noise-
 // suppressions and perhaps also the digital AGC.
 TEST_F(WebRTCAudioDeviceTest, FullDuplexAudio) {
+  AutoAudioManagerCleanup audio_manager_cleanup;
+
   if (IsRunningHeadless())
     return;
 
   EXPECT_CALL(media_observer(),
       OnSetAudioStreamStatus(_, 1, StrEq("created")));
   EXPECT_CALL(media_observer(),
       OnSetAudioStreamPlaying(_, 1, true));
   EXPECT_CALL(media_observer(),
       OnSetAudioStreamStatus(_, 1, StrEq("closed")));
+  EXPECT_CALL(media_observer(),
+      OnDeleteAudioStream(_, 1)).Times(AnyNumber());
 
   AudioUtil audio_util;
   SetAudioUtilCallback(&audio_util);
 
   scoped_refptr<WebRtcAudioDeviceImpl> audio_device(
       new WebRtcAudioDeviceImpl());
   audio_device->SetSessionId(1);
   WebRTCAutoDelete<webrtc::VoiceEngine> engine(webrtc::VoiceEngine::Create());
   ASSERT_TRUE(engine.valid());
 
@@ skipping 17 matching lines @@
                                 new MessageLoop::QuitTask(),
                                 TestTimeouts::action_timeout_ms());
   message_loop_.Run();
 
   EXPECT_EQ(0, base->StopSend(ch));
   EXPECT_EQ(0, base->StopPlayout(ch));
 
   EXPECT_EQ(0, base->DeleteChannel(ch));
   EXPECT_EQ(0, base->Terminate());
 }