Add CombinedDesktopMediaList class

chrome/browser/media/combined_desktop_media_list_unittest.cc

Index: chrome/browser/media/combined_desktop_media_list_unittest.cc
diff --git a/chrome/browser/media/combined_desktop_media_list_unittest.cc b/chrome/browser/media/combined_desktop_media_list_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..ed3934cac30d777167e41123f4becd5849d728d9
--- /dev/null
+++ b/chrome/browser/media/combined_desktop_media_list_unittest.cc
@@ -0,0 +1,373 @@
+// Copyright 2016 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 "chrome/browser/media/combined_desktop_media_list.h"
+
+#include "base/message_loop/message_loop.h"
+#include "base/single_thread_task_runner.h"
+#include "base/strings/utf_string_conversions.h"
+#include "chrome/browser/media/desktop_media_list_base.h"
+#include "chrome/browser/media/desktop_media_list_observer.h"
+#include "content/public/test/test_browser_thread.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "ui/gfx/image/image_skia.h"
+
+using testing::DoAll;
+using content::DesktopMediaID;
+
+static const int kThumbnailSize = 50;
+static const int kDefaultSouceCount = 2;  // >=2.

[qiangchen, 2016/01/26 20:43:09]

kDefaultSourceCount

[GeorgeZ, 2016/01/27 00:17:38]

Done.

+
+// Create a greyscale image with certain size and grayscale value.
+gfx::ImageSkia CreateGrayscaleImage(gfx::Size size, int greyscale_value) {
+  SkBitmap result;
+  result.allocN32Pixels(size.width(), size.height(), true);
+
+  result.lockPixels();
+  uint8_t* pixels_data = reinterpret_cast<uint8_t*>(result.getPixels());
+
+  // Set greyscale value for all pixels.
+  for (int y = 0; y < result.height(); ++y) {
+    for (int x = 0; x < result.width(); ++x) {
+      pixels_data[result.rowBytes() * y + x * result.bytesPerPixel()] =
+          greyscale_value;
+      pixels_data[result.rowBytes() * y + x * result.bytesPerPixel() + 1] =
+          greyscale_value;
+      pixels_data[result.rowBytes() * y + x * result.bytesPerPixel() + 2] =
+          greyscale_value;
+      pixels_data[result.rowBytes() * y + x * result.bytesPerPixel() + 3] =
+          0xff;
+    }
+  }
+
+  result.unlockPixels();
+
+  return gfx::ImageSkia::CreateFrom1xBitmap(result);
+}
+
+// Fake Implementation of DesktopMediaListBase.
+class FakeDesktopMediaListBaseImpl : public DesktopMediaListBase {
+ public:
+  explicit FakeDesktopMediaListBaseImpl(DesktopMediaID::Type type)
+      : DesktopMediaListBase(base::TimeDelta::FromMilliseconds(1)),
+        media_type_(type) {
+    SetThumbnailSize(gfx::Size(kThumbnailSize, kThumbnailSize));
+
+    for (int i = 0; i < kDefaultSouceCount; ++i)
+      AddFakeSource(i, base::UTF8ToUTF16("Test media"),
+                    static_cast<uint8_t>(i));
+  }
+
+  ~FakeDesktopMediaListBaseImpl() override{};
+
+  void AddFakeSource(int index, base::string16 title, int greyscale_value) {
+    DesktopMediaID id(media_type_, index + 1);
+    fake_sources_.push_back(DesktopMediaListBase::SourceDescription(id, title));
+    fake_thumbnails_.push_back(
+        CreateGrayscaleImage(gfx::Size(10, 10), greyscale_value));
+    current_thumbnail_map_[id.id] = greyscale_value;
+  }
+
+  void RemoveFakeSource(int index) {
+    if (static_cast<size_t>(index) >= fake_sources_.size())
+      return;
+
+    current_thumbnail_map_.erase(fake_sources_[index].id.id);
+    fake_sources_.erase(fake_sources_.begin() + index);
+    fake_thumbnails_.erase(fake_thumbnails_.begin() + index);
+  }
+
+ private:
+  void Refresh() override {
+    UpdateSourcesList(fake_sources_);
+
+    // Update thumbnails.
+    for (size_t i = 0; i < fake_sources_.size(); i++) {
+      // only update when a thumbnail is added or changed.
+      const int id = fake_sources_[i].id.id;
+      if (!refreshed_thumbnail_map_.count(id) ||
+          (refreshed_thumbnail_map_[id] != current_thumbnail_map_[id])) {
+        UpdateSourceThumbnail(fake_sources_[i].id, fake_thumbnails_[i]);
+      }
+    }
+    refreshed_thumbnail_map_ = current_thumbnail_map_;
+
+    ScheduleNextRefresh();
+  }
+
+  std::vector<DesktopMediaListBase::SourceDescription> fake_sources_;
+  std::vector<gfx::ImageSkia> fake_thumbnails_;
+  DesktopMediaID::Type media_type_;
+  // The current and last refrehed maps of source id and thumbnail's greyscale.
+  // They are used for detect the thumbnail add or change.
+  std::map<int, int> current_thumbnail_map_, refreshed_thumbnail_map_;
+
+  DISALLOW_COPY_AND_ASSIGN(FakeDesktopMediaListBaseImpl);
+};
+
+class MockObserver : public DesktopMediaListObserver {
+ public:
+  MOCK_METHOD2(OnSourceAdded, void(DesktopMediaList* list, int index));
+  MOCK_METHOD2(OnSourceRemoved, void(DesktopMediaList* list, int index));
+  MOCK_METHOD3(OnSourceMoved,
+               void(DesktopMediaList* list, int old_index, int new_index));
+  MOCK_METHOD2(OnSourceNameChanged, void(DesktopMediaList* list, int index));
+  MOCK_METHOD2(OnSourceThumbnailChanged,
+               void(DesktopMediaList* list, int index));
+};
+
+ACTION_P2(CheckListSize, list, expected_list_size) {
+  EXPECT_EQ(expected_list_size, list->GetSourceCount());
+}
+
+ACTION_P(QuitMessageLoop, message_loop) {
+  message_loop->task_runner()->PostTask(
+      FROM_HERE, base::MessageLoop::QuitWhenIdleClosure());
+}
+
+class CombinedDesktopMediaListTest : public testing::Test {
+ public:
+  CombinedDesktopMediaListTest()
+      : ui_thread_(content::BrowserThread::UI, &message_loop_) {
+    list1_ = new FakeDesktopMediaListBaseImpl(DesktopMediaID::TYPE_SCREEN);
+    list2_ = new FakeDesktopMediaListBaseImpl(DesktopMediaID::TYPE_WINDOW);
+
+    scoped_ptr<DesktopMediaList> list1(list1_);
+    scoped_ptr<DesktopMediaList> list2(list2_);
+
+    std::vector<scoped_ptr<DesktopMediaList>> lists;
+    lists.push_back(std::move(list1));
+    lists.push_back(std::move(list2));
+
+    combined_list_.reset(new CombinedDesktopMediaList(lists));
+  }
+
+  // StartUpdating() and verify the first call of refresh().
+  void Verify() {

[qiangchen, 2016/01/26 20:43:09]

This function is more like initialize than verify.

Or can we merge it into the constructor?

[GeorgeZ, 2016/01/27 00:17:38]

Done.

+    {
+      testing::InSequence dummy;
+
+      // list1_'s refresh.
+      for (int i = 0; i < kDefaultSouceCount; ++i) {
+        EXPECT_CALL(observer_, OnSourceAdded(combined_list_.get(), i))
+            .WillOnce(CheckListSize(combined_list_.get(), i + 1));
+      }
+
+      for (int i = 0; i < kDefaultSouceCount; ++i) {
+        EXPECT_CALL(observer_,
+                    OnSourceThumbnailChanged(combined_list_.get(), i));
+      }
+
+      // list2_'s refresh.
+      for (int i = kDefaultSouceCount; i < 2 * kDefaultSouceCount; ++i) {
+        EXPECT_CALL(observer_, OnSourceAdded(combined_list_.get(), i))
+            .WillOnce(CheckListSize(combined_list_.get(), i + 1));
+      }
+
+      for (int i = kDefaultSouceCount; i < 2 * kDefaultSouceCount - 1; ++i) {
+        EXPECT_CALL(observer_,
+                    OnSourceThumbnailChanged(combined_list_.get(), i));
+      }
+
+      EXPECT_CALL(observer_,
+                  OnSourceThumbnailChanged(combined_list_.get(),
+                                           2 * kDefaultSouceCount - 1))
+          .WillOnce(QuitMessageLoop(&message_loop_));
+    }
+
+    combined_list_->StartUpdating(&observer_);
+    message_loop_.Run();
+
+    // list1_'s sources.
+    for (int i = 0; i < kDefaultSouceCount; ++i) {
+      EXPECT_EQ(combined_list_->GetSource(i).id.type,
+                content::DesktopMediaID::TYPE_SCREEN);
+      EXPECT_EQ(combined_list_->GetSource(i).id.id, i + 1);
+    }
+
+    // list2_'s sources.
+    for (int i = kDefaultSouceCount; i < 2 * kDefaultSouceCount; i++) {
+      EXPECT_EQ(combined_list_->GetSource(i).id.type,
+                content::DesktopMediaID::TYPE_WINDOW);
+      EXPECT_EQ(combined_list_->GetSource(i).id.id, i - kDefaultSouceCount + 1);
+    }
+
+    testing::Mock::VerifyAndClearExpectations(&observer_);

[qiangchen, 2016/01/26 20:43:09]

This is unsafe, it is better to let observer_ to have a public function called 
VerifyAndClearExpectations(). Implemented in this way

{
    testing::Mock::VerifyAndClearExpectations(this);
}

And we call observer_.VerifyAndClearExpectations() here.

Reason is that raw value of &observer_ could be different from this.

[GeorgeZ, 2016/01/27 00:17:38]

Done.

+  }
+
+ protected:
+  // Must be listed before |combined_list_|, so it's destroyed last.
+  MockObserver observer_;
+  FakeDesktopMediaListBaseImpl* list1_;
+  FakeDesktopMediaListBaseImpl* list2_;
+  scoped_ptr<CombinedDesktopMediaList> combined_list_;
+
+  base::MessageLoop message_loop_;
+  content::TestBrowserThread ui_thread_;
+
+  DISALLOW_COPY_AND_ASSIGN(CombinedDesktopMediaListTest);
+};
+
+TEST_F(CombinedDesktopMediaListTest, AddSource) {
+  Verify();
+
+  int index = kDefaultSouceCount;
+  list1_->AddFakeSource(index, base::UTF8ToUTF16("Test media"),
+                        static_cast<uint8_t>(index));
+
+  EXPECT_CALL(observer_, OnSourceAdded(combined_list_.get(), index))
+      .WillOnce(
+          CheckListSize(combined_list_.get(), 2 * kDefaultSouceCount + 1));
+  EXPECT_CALL(observer_, OnSourceThumbnailChanged(combined_list_.get(), index))
+      .WillOnce(QuitMessageLoop(&message_loop_));
+
+  message_loop_.Run();
+
+  list2_->AddFakeSource(index, base::UTF8ToUTF16("Test media"),
+                        static_cast<uint8_t>(index));
+
+  EXPECT_CALL(observer_,
+              OnSourceAdded(combined_list_.get(), 2 * kDefaultSouceCount + 1))
+      .WillOnce(
+          CheckListSize(combined_list_.get(), 2 * kDefaultSouceCount + 2));
+  EXPECT_CALL(observer_, OnSourceThumbnailChanged(combined_list_.get(),
+                                                  2 * kDefaultSouceCount + 1))
+      .WillOnce(QuitMessageLoop(&message_loop_));
+
+  message_loop_.Run();
+
+  // Verify last source for list1_ and first source for list2_.
+  EXPECT_EQ(combined_list_->GetSource(index).id.type,
+            content::DesktopMediaID::TYPE_SCREEN);
+  EXPECT_EQ(combined_list_->GetSource(index).id.id, index + 1);
+  EXPECT_EQ(combined_list_->GetSource(index + 1).id.type,
+            content::DesktopMediaID::TYPE_WINDOW);
+  EXPECT_EQ(combined_list_->GetSource(index + 1).id.id, 1);
+}
+
+TEST_F(CombinedDesktopMediaListTest, RemoveSource) {
+  Verify();
+
+  int index = kDefaultSouceCount - 1;
+  list1_->RemoveFakeSource(index);
+
+  EXPECT_CALL(observer_, OnSourceRemoved(combined_list_.get(), index))
+      .WillOnce(
+          DoAll(CheckListSize(combined_list_.get(), 2 * kDefaultSouceCount - 1),
+                QuitMessageLoop(&message_loop_)));
+
+  message_loop_.Run();
+
+  list2_->RemoveFakeSource(index);
+
+  EXPECT_CALL(observer_,
+              OnSourceRemoved(combined_list_.get(), 2 * kDefaultSouceCount - 2))
+      .WillOnce(
+          DoAll(CheckListSize(combined_list_.get(), 2 * kDefaultSouceCount - 2),
+                QuitMessageLoop(&message_loop_)));
+
+  message_loop_.Run();
+
+  // Verify last source for list1_ and first source for list2_.
+  EXPECT_EQ(combined_list_->GetSource(index - 1).id.type,
+            content::DesktopMediaID::TYPE_SCREEN);
+  EXPECT_EQ(combined_list_->GetSource(index - 1).id.id, index);
+  EXPECT_EQ(combined_list_->GetSource(index).id.type,
+            content::DesktopMediaID::TYPE_WINDOW);
+  EXPECT_EQ(combined_list_->GetSource(index).id.id, 1);
+}
+
+TEST_F(CombinedDesktopMediaListTest, MoveSource) {
+  Verify();
+
+  // Swap sources.
+  list1_->RemoveFakeSource(kDefaultSouceCount - 1);
+  list1_->RemoveFakeSource(kDefaultSouceCount - 2);
+  list1_->AddFakeSource(kDefaultSouceCount - 1, base::UTF8ToUTF16("Test media"),
+                        static_cast<uint8_t>(kDefaultSouceCount - 1));
+  list1_->AddFakeSource(kDefaultSouceCount - 2, base::UTF8ToUTF16("Test media"),
+                        static_cast<uint8_t>(kDefaultSouceCount - 2));
+
+  EXPECT_CALL(observer_,
+              OnSourceMoved(combined_list_.get(), kDefaultSouceCount - 1,
+                            kDefaultSouceCount - 2))
+      .WillOnce(QuitMessageLoop(&message_loop_));
+
+  message_loop_.Run();
+
+  // Swap sources.
+  list2_->RemoveFakeSource(kDefaultSouceCount - 1);
+  list2_->RemoveFakeSource(kDefaultSouceCount - 2);
+  list2_->AddFakeSource(kDefaultSouceCount - 1, base::UTF8ToUTF16("Test media"),
+                        static_cast<uint8_t>(kDefaultSouceCount - 1));
+  list2_->AddFakeSource(kDefaultSouceCount - 2, base::UTF8ToUTF16("Test media"),
+                        static_cast<uint8_t>(kDefaultSouceCount - 2));
+
+  EXPECT_CALL(observer_,
+              OnSourceMoved(combined_list_.get(), 2 * kDefaultSouceCount - 1,
+                            2 * kDefaultSouceCount - 2))
+      .WillOnce(QuitMessageLoop(&message_loop_));
+
+  message_loop_.Run();
+}
+
+TEST_F(CombinedDesktopMediaListTest, UpdateTitle) {
+  Verify();
+
+  // Change title.
+  list1_->RemoveFakeSource(kDefaultSouceCount - 1);
+  list1_->AddFakeSource(kDefaultSouceCount - 1,
+                        base::UTF8ToUTF16("New test media"),
+                        static_cast<uint8_t>(kDefaultSouceCount - 1));
+
+  EXPECT_CALL(observer_,
+              OnSourceNameChanged(combined_list_.get(), kDefaultSouceCount - 1))
+      .WillOnce(QuitMessageLoop(&message_loop_));
+
+  message_loop_.Run();
+
+  // Change title.
+  list2_->RemoveFakeSource(kDefaultSouceCount - 1);
+  list2_->AddFakeSource(kDefaultSouceCount - 1,
+                        base::UTF8ToUTF16("New test media"),
+                        static_cast<uint8_t>(kDefaultSouceCount - 1));
+
+  EXPECT_CALL(observer_, OnSourceNameChanged(combined_list_.get(),
+                                             2 * kDefaultSouceCount - 1))
+      .WillOnce(QuitMessageLoop(&message_loop_));
+
+  message_loop_.Run();
+
+  EXPECT_EQ(combined_list_->GetSource(kDefaultSouceCount - 1).name,
+            base::UTF8ToUTF16("New test media"));
+  EXPECT_EQ(combined_list_->GetSource(2 * kDefaultSouceCount - 1).name,
+            base::UTF8ToUTF16("New test media"));
+}
+
+TEST_F(CombinedDesktopMediaListTest, UpdateThumbnail) {
+  Verify();
+
+  // Change thumbnail.
+  list1_->RemoveFakeSource(kDefaultSouceCount - 1);
+  list1_->AddFakeSource(kDefaultSouceCount - 1, base::UTF8ToUTF16("Test media"),
+                        100);
+
+  EXPECT_CALL(observer_, OnSourceThumbnailChanged(combined_list_.get(),
+                                                  kDefaultSouceCount - 1))
+      .WillOnce(QuitMessageLoop(&message_loop_));
+
+  message_loop_.Run();
+
+  // Change thumbnail.
+  list2_->RemoveFakeSource(kDefaultSouceCount - 1);
+  list2_->AddFakeSource(kDefaultSouceCount - 1, base::UTF8ToUTF16("Test media"),
+                        100);
+
+  EXPECT_CALL(observer_, OnSourceThumbnailChanged(combined_list_.get(),
+                                                  2 * kDefaultSouceCount - 1))
+      .WillOnce(QuitMessageLoop(&message_loop_));
+
+  message_loop_.Run();
+}