Add support for OfflinePagesDownloadBridge.

components/offline_pages/downloads/download_ui_adapter_unittest.cc

+// 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 "components/offline_pages/downloads/download_ui_adapter.h"
+
+#include <stdint.h>

[fgorski, 2016/07/26 16:25:21]

#include <map>
#include <memory>
#include <string>
#include <vector>

[Dmitry Titov, 2016/07/26 19:56:48]

Done.

+
+#include "base/bind.h"
+#include "base/callback.h"
+#include "base/files/file_path.h"
+#include "base/run_loop.h"
+#include "base/single_thread_task_runner.h"
+#include "base/test/test_mock_time_task_runner.h"
+#include "base/threading/thread_task_runner_handle.h"
+#include "base/time/time.h"
+#include "components/offline_pages/client_namespace_constants.h"
+#include "components/offline_pages/stub_offline_page_model.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace offline_pages {
+
+namespace {
+// Constants for a test OfflinePageItem.
+static const int kTestOfflineId1 = 1;
+static const int kTestOfflineId2 = 2;
+static const int kTestOfflineId3 = 3;
+static const char kTestUrl[] = "http://foo.com/bar.mhtml";
+static const char kTestGuid1[] =   "cccccccc-cccc-4ccc-0ccc-ccccccccccc1";
+static const char kTestGuid2[] =   "cccccccc-cccc-4ccc-0ccc-ccccccccccc2";
+static const char kTestBadGuid[] = "ccccccc-cccc-0ccc-0ccc-ccccccccccc0";
+static const ClientId kTestClientIdOtherNamespace(kLastNNamespace, kTestGuid1);
+static const ClientId kTestClientIdOtherGuid(kLastNNamespace, kTestBadGuid);
+static const ClientId kTestClientId1(kAsyncNamespace, kTestGuid1);
+static const ClientId kTestClientId2(kAsyncNamespace, kTestGuid2);
+static const base::FilePath kTestFilePath =
+    base::FilePath(FILE_PATH_LITERAL("foo/bar.mhtml"));
+static const int kFileSize = 1000;
+static const base::Time kTestCreationTime = base::Time::Now();
+}  // namespace
+
+// Mock OfflinePageModel for testing the SavePage calls.
+class MockOfflinePageModel : public StubOfflinePageModel {
+ public:
+  MockOfflinePageModel(base::TestMockTimeTaskRunner* task_runner)
+      : observer_(nullptr),
+        task_runner_(task_runner) {
+    adapter.reset(new DownloadUIAdapter(this));
+    // Add one page.
+    OfflinePageItem page(GURL(kTestUrl),
+                         kTestOfflineId1,
+                         kTestClientId1,
+                         kTestFilePath,
+                         kFileSize,
+                         kTestCreationTime);
+    pages[kTestOfflineId1] = page;
+  }
+
+  ~MockOfflinePageModel() override {}
+
+  // OfflinePageModel overrides.
+  void AddObserver(Observer* observer) {

[fgorski, 2016/07/26 18:03:59]

mark as override

[Dmitry Titov, 2016/07/26 19:56:48]

Done.

+    EXPECT_TRUE(observer != nullptr);
+    observer_ = observer;
+  }
+
+  void RemoveObserver(Observer* observer) {

[fgorski, 2016/07/26 18:03:59]

mark as override

[Dmitry Titov, 2016/07/26 19:56:48]

Done.

+    EXPECT_TRUE(observer != nullptr);
+    EXPECT_EQ(observer, observer_);
+    observer_ = nullptr;
+  }
+
+  // PostTask instead of just running callback to simpulate the real class.
+  void GetAllPages(const MultipleOfflinePageItemCallback& callback) {

[fgorski, 2016/07/26 18:03:59]

mark as override

[Dmitry Titov, 2016/07/26 19:56:48]

Done.

+    task_runner_->PostTask(
+        FROM_HERE, base::Bind(&MockOfflinePageModel::GetAllPagesImpl,
+        base::Unretained(this), callback));
+  }
+
+  void GetAllPagesImpl(const MultipleOfflinePageItemCallback& callback) {
+    std::vector<OfflinePageItem> result;
+    for (const auto& page : pages) {

[fgorski, 2016/07/26 16:25:21]

nit: {} not needed.

[Dmitry Titov, 2016/07/26 19:56:48]

Done.

+      result.push_back(page.second);
+    }
+    callback.Run(result);
+  }
+
+  void DeletePageAndNotifyAdapter(const std::string& guid) {
+    for(const auto& page : pages) {
+      if (page.second.client_id.id == guid) {
+        observer_->OfflinePageDeleted(page.second.offline_id,
+                                      page.second.client_id);
+        pages.erase(page.first);
+        return;
+      }
+    }
+  }
+
+  void AddPageAndNotifyAdapter(const OfflinePageItem& page) {
+    EXPECT_EQ(pages.end(), pages.find(page.offline_id));
+    pages[page.offline_id] = page;
+    observer_->OfflinePageModelChanged(this);
+  }
+
+  // Normally, OfflinePageModel owns this adapter, so lets test it this way.
+  // Public for testing.
+  std::unique_ptr<DownloadUIAdapter> adapter;

[fgorski, 2016/07/26 16:25:21]

I think this should still be adapter_ and exposed through adapter()

[Dmitry Titov, 2016/07/26 19:56:48]

I'd like to keep it as this in test code, since it's accessed a lot, making test
cases clearer...

I do the same in the test class below as well, making members that are accesses
in tests just public...

[fgorski, 2016/07/26 20:10:58]

Acknowledged.

+
+  std::map<int64_t, OfflinePageItem> pages;

[fgorski, 2016/07/26 16:25:21]

same here.

[Dmitry Titov, 2016/07/26 19:56:48]

Same here.

[fgorski, 2016/07/26 20:10:58]

Acknowledged.

+
+ private:
+  OfflinePageModel::Observer* observer_;
+  base::TestMockTimeTaskRunner* task_runner_;
+
+    DISALLOW_COPY_AND_ASSIGN(MockOfflinePageModel);

[fgorski, 2016/07/26 16:25:21]

nit: fix alignment please.

[Dmitry Titov, 2016/07/26 19:56:48]

Done.

+};
+
+class DownloadUIAdapterTest
+    : public testing::Test,
+      public DownloadUIAdapter::Observer {
+ public:
+  DownloadUIAdapterTest();
+  ~DownloadUIAdapterTest() override;
+
+  // testing::Test
+  void SetUp() override;
+  void TearDown() override;
+
+  // DownloadUIAdapter::Observer
+  void ItemsLoaded() override;
+  void ItemAdded(const DownloadUIItem& item) override;
+  void ItemUpdated(const DownloadUIItem& item) override;
+  void ItemDeleted(std::string guid) override;
+
+  // Runs until all of the tasks that are not delayed are gone from the task
+  // queue.
+  void PumpLoop();
+
+  bool items_loaded;
+  std::vector<std::string> added_guids, updated_guids, deleted_guids;
+  std::unique_ptr<MockOfflinePageModel> model;
+
+ private:
+  scoped_refptr<base::TestMockTimeTaskRunner> task_runner_;
+};
+
+DownloadUIAdapterTest::DownloadUIAdapterTest()
+    : items_loaded(false),
+      task_runner_(new base::TestMockTimeTaskRunner) {
+}
+
+DownloadUIAdapterTest::~DownloadUIAdapterTest() {
+}
+
+void DownloadUIAdapterTest::SetUp() {
+  model.reset(new MockOfflinePageModel(task_runner_.get()));
+  model->adapter->AddObserver(this);
+}
+
+void DownloadUIAdapterTest::TearDown() {

[fgorski, 2016/07/26 16:25:21]

You don't need this method if it is empty.
You will use the base class implementation.

[Dmitry Titov, 2016/07/26 19:56:48]

Done.

+}
+
+void DownloadUIAdapterTest::ItemsLoaded() {
+  items_loaded = true;
+}
+
+void DownloadUIAdapterTest::ItemAdded(const DownloadUIItem& item) {
+  added_guids.push_back(item.guid);
+}
+
+void DownloadUIAdapterTest::ItemUpdated(const DownloadUIItem& item) {
+  updated_guids.push_back(item.guid);
+}
+
+void DownloadUIAdapterTest::ItemDeleted(std::string guid) {
+  deleted_guids.push_back(guid);
+}
+
+void DownloadUIAdapterTest::PumpLoop() {
+  task_runner_->RunUntilIdle();
+}
+
+TEST_F(DownloadUIAdapterTest, InitialLoad) {
+  EXPECT_NE(nullptr, model->adapter);
+  EXPECT_FALSE(items_loaded);
+  PumpLoop();
+  EXPECT_TRUE(items_loaded);
+  const DownloadUIItem* item = model->adapter->GetItem(kTestGuid1);
+  EXPECT_NE(nullptr, item);
+}
+
+TEST_F(DownloadUIAdapterTest, InitialItemConversion) {
+  EXPECT_EQ(1, model->pages.size());

[fgorski, 2016/07/26 18:03:59]

1UL (as size() is size_t)

[Dmitry Titov, 2016/07/26 19:56:48]

Done.

+  EXPECT_EQ(kTestGuid1, model->pages[kTestOfflineId1].client_id.id);
+  PumpLoop();
+  const DownloadUIItem* item = model->adapter->GetItem(kTestGuid1);
+  EXPECT_EQ(kTestGuid1, item->guid);
+  EXPECT_EQ(kTestUrl, item->url.spec());
+  EXPECT_EQ(kTestFilePath, item->target_path);
+  EXPECT_EQ(kTestCreationTime, item->start_time);
+  EXPECT_EQ(kFileSize, item->total_bytes);
+}
+
+TEST_F(DownloadUIAdapterTest, ItemDeletedAdded) {
+  PumpLoop();
+  // Add page, notify adapter.
+  OfflinePageItem page(GURL(kTestUrl),
+                       kTestOfflineId2,
+                       kTestClientId2,
+                       base::FilePath(kTestFilePath),
+                       kFileSize,
+                       kTestCreationTime);
+  model->AddPageAndNotifyAdapter(page);
+  PumpLoop();
+  EXPECT_EQ(1, added_guids.size());
+  EXPECT_EQ(kTestGuid2, added_guids[0]);
+  // Remove pages, notify adapter.
+  model->DeletePageAndNotifyAdapter(kTestGuid1);
+  model->DeletePageAndNotifyAdapter(kTestGuid2);
+  PumpLoop();
+  EXPECT_EQ(2, deleted_guids.size());
+  EXPECT_EQ(kTestGuid1, deleted_guids[0]);
+  EXPECT_EQ(kTestGuid2, deleted_guids[1]);
+}
+
+TEST_F(DownloadUIAdapterTest, ItemWithWrongNamespace) {
+  PumpLoop();
+  OfflinePageItem page1(GURL(kTestUrl),
+                        kTestOfflineId2,
+                        kTestClientIdOtherNamespace,
+                        base::FilePath(kTestFilePath),
+                        kFileSize,
+                        kTestCreationTime);
+  model->AddPageAndNotifyAdapter(page1);
+  PumpLoop();
+  // Should not add the page with wrong namespace.
+  EXPECT_EQ(0, added_guids.size());
+
+  OfflinePageItem page2(GURL(kTestUrl),
+                        kTestOfflineId3,
+                        kTestClientIdOtherGuid,
+                        base::FilePath(kTestFilePath),
+                        kFileSize,
+                        kTestCreationTime);
+  model->AddPageAndNotifyAdapter(page2);
+  PumpLoop();
+  // Should not add the page with wrong guid.
+  EXPECT_EQ(0, added_guids.size());
+}
+
+TEST_F(DownloadUIAdapterTest, ItemUpdated) {
+  PumpLoop();
+  // Clear the initial page and replace it with updated one.
+  model->pages.clear();
+  // Add page with the same offline_id/guid, notify adapter.
+  // This should generate 'updated' notification.
+  OfflinePageItem page1(GURL(kTestUrl),
+                        kTestOfflineId1,
+                        kTestClientId1,
+                        base::FilePath(kTestFilePath),
+                        kFileSize,
+                        kTestCreationTime);
+  // Add a new page which did not exist before.
+  OfflinePageItem page2(GURL(kTestUrl),
+                        kTestOfflineId2,
+                        kTestClientId2,
+                        base::FilePath(kTestFilePath),
+                        kFileSize,
+                        kTestCreationTime);
+  model->AddPageAndNotifyAdapter(page1);
+  model->AddPageAndNotifyAdapter(page2);
+  PumpLoop();
+  EXPECT_EQ(1, added_guids.size());
+  EXPECT_EQ(kTestGuid2, added_guids[0]);
+  // TODO(dimich): we currently don't report updated items since OPM doesn't
+  // have support for that. Add as needed, this will have to be updated when
+  // support is added.
+  EXPECT_EQ(0, updated_guids.size());
+}
+
+}  // namespace offline_pages