Factor out authorization from AudioRendererHost.

content/browser/renderer_host/media/audio_output_authorization_handler_unittest.cc

+// Copyright 2016 The Chromium Authors. All rights reserved.

[o1ka, 2016/11/14 13:24:04]

Awesome that you've done all that testing!

[Max Morin, 2016/11/16 08:49:49]

:)

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// Unit tests for AudioOutputAuthorizationHandler.
+
+#include "content/browser/renderer_host/media/audio_output_authorization_handler.h"
+
+#include "base/bind.h"
+#include "base/command_line.h"
+#include "base/run_loop.h"
+#include "content/browser/browser_thread_impl.h"
+#include "content/public/browser/browser_thread.h"
+#include "content/public/test/mock_render_process_host.h"
+#include "content/public/test/test_browser_context.h"
+#include "content/public/test/test_browser_thread.h"
+#include "content/public/test/test_browser_thread_bundle.h"
+#include "media/audio/audio_device_description.h"
+#include "media/audio/fake_audio_log_factory.h"
+#include "media/audio/fake_audio_manager.h"
+#include "media/base/media_switches.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "url/gurl.h"
+#include "url/origin.h"
+
+using ::testing::_;
+
+namespace content {
+
+namespace {
+const int kRenderProcessId = 42;
+const int kRenderFrameId = 31415;
+const char kSecurityOriginString[] = "http://localhost";
+const char kBadSecurityOriginString[] = "about:about";
+const char kDefaultDeviceId[] = "default";
+const char kEmptyDeviceId[] = "";
+const char kInvalidDeviceId[] = "invalid-device-id";
+const char kSalt[] = "salt";
+
+struct MockListener {
+  MOCK_METHOD3(MockAuthorizationCallback,
+               void(media::OutputDeviceStatus status,
+                    const media::AudioParameters& params,
+                    const std::string& id));
+
+  AudioOutputAuthorizationHandler::AuthorizationCompletedCallback
+  GetCallback() {
+    return base::Bind(&MockListener::MockAuthorizationCallback,
+                      base::Unretained(this));
+  }
+};
+
+url::Origin SecurityOrigin() {
+  return url::Origin(GURL(kSecurityOriginString));
+}
+
+url::Origin BadSecurityOrigin() {
+  return url::Origin(GURL(kBadSecurityOriginString));
+}
+}  //  namespace
+
+class AudioOutputAuthorizationHandlerTest : public testing::Test {
+ public:
+  AudioOutputAuthorizationHandlerTest() {
+    // Not threadsafe, thus set before threads are started:
+    base::CommandLine::ForCurrentProcess()->AppendSwitch(
+        switches::kUseFakeDeviceForMediaStream);
+
+    thread_bundle_ = base::MakeUnique<TestBrowserThreadBundle>(
+        TestBrowserThreadBundle::Options::REAL_IO_THREAD);
+    audio_thread_ = base::MakeUnique<base::Thread>("AudioThread");

[o1ka, 2016/11/14 13:24:04]

make audio_thread_ same as UI thread on Mac?

[Max Morin, 2016/11/16 08:49:49]

Done.

+
+// Since this is done in content/browser/browser_main_loop.cc when creating the
+// audio thread, we do it here as well. Since the audio manager is fake, we
+// don't need to special-case mac here.
+#if defined(OS_WIN)
+    audio_thread_->init_com_with_mta(true);
+#endif  // defined(OS_WIN)
+
+    CHECK(audio_thread_->Start());
+
+    audio_manager_.reset(new media::FakeAudioManager(
+        audio_thread_->task_runner(), audio_thread_->task_runner(),
+        &log_factory_));
+    media_stream_manager_ =
+        base::MakeUnique<MediaStreamManager>(audio_manager_.get());
+    // Make sure everything is done initializing:
+    SyncWithAllThreads();
+  }
+
+  ~AudioOutputAuthorizationHandlerTest() override {
+    SyncWithAllThreads();
+    // media_stream_manager_ must die after threads since it's a
+    // DestructionObserver, so we delete the threads explicitly here.

[o1ka, 2016/11/14 13:24:04]

can you do it by just declaring them in the correct order? (and adding the
comment on that :))

[Max Morin, 2016/11/16 08:49:49]

Done.

+    audio_manager_.reset();
+    audio_thread_.reset();
+    thread_bundle_.reset();
+  }
+
+ protected:
+  MediaStreamManager* GetMediaStreamManager() {
+    return media_stream_manager_.get();
+  }
+
+  void SyncWithAllThreads() {
+    CHECK(audio_manager_);
+    // New tasks might be posted while we are syncing, but looping 10 times
+    // ought to be enough for anybody.
+    for (int i = 0; i < 10; ++i) {
+      base::RunLoop().RunUntilIdle();
+      SyncWith(BrowserThread::GetTaskRunnerForThread(BrowserThread::IO));
+      SyncWith(audio_thread_->task_runner());
+    }
+  }
+
+  std::string GetRawNondefaultId() {
+    std::string id;
+    BrowserThread::PostTask(
+        BrowserThread::IO, FROM_HERE,
+        base::Bind(
+            &AudioOutputAuthorizationHandlerTest::GetRawNondefaultIdOnIOThread,
+            base::Unretained(this), base::Unretained(&id)));
+    SyncWithAllThreads();
+    return id;
+  }
+
+ private:
+  void SyncWith(scoped_refptr<base::SingleThreadTaskRunner> task_runner) {
+    CHECK(task_runner);
+    CHECK(!task_runner->BelongsToCurrentThread());
+    base::WaitableEvent e = {base::WaitableEvent::ResetPolicy::MANUAL,
+                             base::WaitableEvent::InitialState::NOT_SIGNALED};
+    task_runner->PostTask(FROM_HERE, base::Bind(&base::WaitableEvent::Signal,
+                                                base::Unretained(&e)));
+    e.Wait();
+  }
+
+  void GetRawNondefaultIdOnIOThread(std::string* out) {
+    DCHECK_CURRENTLY_ON(BrowserThread::IO);
+    MediaDevicesManager::BoolDeviceTypes devices_to_enumerate;
+    devices_to_enumerate[MEDIA_DEVICE_TYPE_AUDIO_OUTPUT] = true;
+
+    media_stream_manager_->media_devices_manager()->EnumerateDevices(
+        devices_to_enumerate,
+        base::Bind(
+            [](std::string* out, const MediaDeviceEnumeration& result) {
+              // Index 0 is default, so use 1.
+              CHECK(result[MediaDeviceType::MEDIA_DEVICE_TYPE_AUDIO_OUTPUT]
+                        .size() > 1)
+                  << "Expected to have a nondefault device.";
+              *out = result[MediaDeviceType::MEDIA_DEVICE_TYPE_AUDIO_OUTPUT][1]
+                         .device_id;
+            },
+            base::Unretained(out)));
+  }
+
+  std::unique_ptr<TestBrowserThreadBundle> thread_bundle_;
+  std::unique_ptr<base::Thread> audio_thread_;
+  media::FakeAudioLogFactory log_factory_;
+  media::ScopedAudioManagerPtr audio_manager_;
+  std::unique_ptr<MediaStreamManager> media_stream_manager_;
+
+  DISALLOW_COPY_AND_ASSIGN(AudioOutputAuthorizationHandlerTest);
+};
+
+TEST_F(AudioOutputAuthorizationHandlerTest, AuthorizeDefaultDevice_Ok) {
+  MockListener listener;
+  EXPECT_CALL(listener,
+              MockAuthorizationCallback(media::OUTPUT_DEVICE_STATUS_OK, _,
+                                        kDefaultDeviceId))
+      .Times(1);
+  std::unique_ptr<AudioOutputAuthorizationHandler> handler =
+      base::MakeUnique<AudioOutputAuthorizationHandler>(
+          GetMediaStreamManager(), kRenderProcessId, kSalt);
+
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      (base::Bind(&AudioOutputAuthorizationHandler::RequestDeviceAuthorization,
+                  base::Unretained(handler.get()), kRenderFrameId, 0,
+                  kDefaultDeviceId, SecurityOrigin(), listener.GetCallback())));
+
+  SyncWithAllThreads();
+  BrowserThread::DeleteSoon(BrowserThread::IO, FROM_HERE, handler.release());
+  SyncWithAllThreads();
+}
+
+TEST_F(AudioOutputAuthorizationHandlerTest,
+       AuthorizeDefaultDeviceByEmptyId_Ok) {
+  MockListener listener;
+  EXPECT_CALL(listener,
+              MockAuthorizationCallback(media::OUTPUT_DEVICE_STATUS_OK, _,
+                                        kDefaultDeviceId))
+      .Times(1);
+  std::unique_ptr<AudioOutputAuthorizationHandler> handler =
+      base::MakeUnique<AudioOutputAuthorizationHandler>(
+          GetMediaStreamManager(), kRenderProcessId, kSalt);
+
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      (base::Bind(&AudioOutputAuthorizationHandler::RequestDeviceAuthorization,
+                  base::Unretained(handler.get()), kRenderFrameId, 0,
+                  kEmptyDeviceId, SecurityOrigin(), listener.GetCallback())));
+
+  SyncWithAllThreads();
+  BrowserThread::DeleteSoon(BrowserThread::IO, FROM_HERE, handler.release());
+  SyncWithAllThreads();
+}
+
+TEST_F(AudioOutputAuthorizationHandlerTest,
+       AuthorizeNondefaultDeviceIdWithoutPermission_NotAuthorized) {
+  std::string raw_nondefault_id = GetRawNondefaultId();
+  std::string hashed_id = MediaStreamManager::GetHMACForMediaDeviceID(
+      kSalt, SecurityOrigin(), raw_nondefault_id);
+
+  MockListener listener;
+  std::unique_ptr<AudioOutputAuthorizationHandler> handler =
+      base::MakeUnique<AudioOutputAuthorizationHandler>(
+          GetMediaStreamManager(), kRenderProcessId, kSalt);
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      base::Bind(
+          &AudioOutputAuthorizationHandler::OverridePermissionsForTesting,
+          base::Unretained(handler.get()), false));
+  SyncWithAllThreads();
+
+  EXPECT_CALL(listener, MockAuthorizationCallback(
+                            media::OUTPUT_DEVICE_STATUS_ERROR_NOT_AUTHORIZED, _,
+                            std::string()))
+      .Times(1);
+
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      (base::Bind(&AudioOutputAuthorizationHandler::RequestDeviceAuthorization,
+                  base::Unretained(handler.get()), kRenderFrameId, 0, hashed_id,
+                  SecurityOrigin(), listener.GetCallback())));
+
+  SyncWithAllThreads();
+  BrowserThread::DeleteSoon(BrowserThread::IO, FROM_HERE, handler.release());
+  SyncWithAllThreads();
+}
+
+TEST_F(AudioOutputAuthorizationHandlerTest,
+       AuthorizeNondefaultDeviceIdWithPermission_Ok) {
+  std::string raw_nondefault_id = GetRawNondefaultId();
+  std::string hashed_id = MediaStreamManager::GetHMACForMediaDeviceID(
+      kSalt, SecurityOrigin(), raw_nondefault_id);
+  MockListener listener;
+  std::unique_ptr<AudioOutputAuthorizationHandler> handler =
+      base::MakeUnique<AudioOutputAuthorizationHandler>(
+          GetMediaStreamManager(), kRenderProcessId, kSalt);
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      base::Bind(
+          &AudioOutputAuthorizationHandler::OverridePermissionsForTesting,
+          base::Unretained(handler.get()), true));
+
+  EXPECT_CALL(listener,
+              MockAuthorizationCallback(media::OUTPUT_DEVICE_STATUS_OK, _,
+                                        raw_nondefault_id))
+      .Times(1);
+
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      (base::Bind(&AudioOutputAuthorizationHandler::RequestDeviceAuthorization,
+                  base::Unretained(handler.get()), kRenderFrameId, 0, hashed_id,
+                  SecurityOrigin(), listener.GetCallback())));
+
+  SyncWithAllThreads();
+  BrowserThread::DeleteSoon(BrowserThread::IO, FROM_HERE, handler.release());
+  SyncWithAllThreads();
+}
+
+TEST_F(AudioOutputAuthorizationHandlerTest,
+       AuthorizeInvalidDeviceId_BadMessage) {
+  std::unique_ptr<TestBrowserContext> context =
+      base::MakeUnique<TestBrowserContext>();
+  std::unique_ptr<MockRenderProcessHost> RPH =
+      base::MakeUnique<MockRenderProcessHost>(context.get());
+  MockListener listener;
+  std::unique_ptr<AudioOutputAuthorizationHandler> handler =
+      base::MakeUnique<AudioOutputAuthorizationHandler>(GetMediaStreamManager(),
+                                                        RPH->GetID(), kSalt);
+  EXPECT_EQ(RPH->bad_msg_count(), 0);
+
+  EXPECT_CALL(listener, MockAuthorizationCallback(_, _, _)).Times(0);
+
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      (base::Bind(&AudioOutputAuthorizationHandler::RequestDeviceAuthorization,
+                  base::Unretained(handler.get()), kRenderFrameId, 0,
+                  kInvalidDeviceId, SecurityOrigin(), listener.GetCallback())));
+
+  SyncWithAllThreads();
+  EXPECT_EQ(RPH->bad_msg_count(), 1);
+  BrowserThread::DeleteSoon(BrowserThread::IO, FROM_HERE, handler.release());
+  SyncWithAllThreads();
+  RPH.reset();
+  context.reset();
+}
+
+TEST_F(AudioOutputAuthorizationHandlerTest,
+       AuthorizeNondefaultDeviceIdWithBadOrigin_BadMessage) {
+  std::string raw_nondefault_id = GetRawNondefaultId();
+  std::string hashed_id = MediaStreamManager::GetHMACForMediaDeviceID(
+      kSalt, SecurityOrigin(), raw_nondefault_id);
+  std::unique_ptr<TestBrowserContext> context =
+      base::MakeUnique<TestBrowserContext>();
+  std::unique_ptr<MockRenderProcessHost> RPH =
+      base::MakeUnique<MockRenderProcessHost>(context.get());
+  MockListener listener;
+  std::unique_ptr<AudioOutputAuthorizationHandler> handler =
+      base::MakeUnique<AudioOutputAuthorizationHandler>(GetMediaStreamManager(),
+                                                        RPH->GetID(), kSalt);
+
+  EXPECT_EQ(RPH->bad_msg_count(), 0);
+  EXPECT_CALL(listener, MockAuthorizationCallback(_, _, _)).Times(0);
+
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      (base::Bind(&AudioOutputAuthorizationHandler::RequestDeviceAuthorization,
+                  base::Unretained(handler.get()), kRenderFrameId, 0, hashed_id,
+                  BadSecurityOrigin(), listener.GetCallback())));
+
+  SyncWithAllThreads();
+  EXPECT_EQ(RPH->bad_msg_count(), 1);
+  BrowserThread::DeleteSoon(BrowserThread::IO, FROM_HERE, handler.release());
+  SyncWithAllThreads();
+  RPH.reset();
+  context.reset();
+}
+
+}  // namespace content