Add a unit test for the BookmarkSuggestionsProvider.

components/ntp_snippets/bookmarks/bookmark_suggestions_provider_unittest.cc

Index: components/ntp_snippets/bookmarks/bookmark_suggestions_provider_unittest.cc
diff --git a/components/ntp_snippets/bookmarks/bookmark_suggestions_provider_unittest.cc b/components/ntp_snippets/bookmarks/bookmark_suggestions_provider_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..6fc0569da6b97b1d89f08ce57f39c97ab5204819
--- /dev/null
+++ b/components/ntp_snippets/bookmarks/bookmark_suggestions_provider_unittest.cc
@@ -0,0 +1,148 @@
+// 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/ntp_snippets/bookmarks/bookmark_suggestions_provider.h"
+
+#include <memory>
+#include <string>
+#include <utility>
+
+#include "base/bind.h"
+#include "base/macros.h"
+#include "base/memory/ptr_util.h"
+#include "base/strings/utf_string_conversions.h"
+#include "components/bookmarks/browser/bookmark_model.h"
+#include "components/bookmarks/browser/bookmark_node.h"
+#include "components/bookmarks/test/test_bookmark_client.h"
+#include "components/ntp_snippets/bookmarks/bookmark_last_visit_utils.h"
+#include "components/ntp_snippets/category.h"
+#include "components/ntp_snippets/mock_content_suggestions_provider_observer.h"
+#include "components/prefs/testing_pref_service.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "url/gurl.h"
+
+namespace ntp_snippets {
+
+namespace {
+
+using ::testing::StrictMock;
+using ::testing::_;
+using ::testing::Eq;
+using ::testing::IsEmpty;
+using ::testing::Property;
+using ::testing::UnorderedElementsAre;
+
+class BookmarkSuggestionsProviderTest : public ::testing::Test {
+ public:
+  BookmarkSuggestionsProviderTest()
+      : model_(bookmarks::TestBookmarkClient::CreateModel()) {
+    EXPECT_CALL(observer_, OnNewSuggestions(_, Category::FromKnownCategory(
+                                                   KnownCategories::BOOKMARKS),
+                                            IsEmpty()))
+        .RetiresOnSaturation();
+    EXPECT_CALL(observer_,
+                OnCategoryStatusChanged(
+                    _, Category::FromKnownCategory(KnownCategories::BOOKMARKS),
+                    CategoryStatus::AVAILABLE_LOADING))
+        .RetiresOnSaturation();
+    EXPECT_CALL(observer_,
+                OnCategoryStatusChanged(
+                    _, Category::FromKnownCategory(KnownCategories::BOOKMARKS),
+                    CategoryStatus::AVAILABLE))
+        .RetiresOnSaturation();
+    BookmarkSuggestionsProvider::RegisterProfilePrefs(test_prefs_.registry());
+    provider_ = base::MakeUnique<BookmarkSuggestionsProvider>(
+        &observer_, model_.get(), &test_prefs_);
+  }
+
+ protected:
+  std::unique_ptr<bookmarks::BookmarkModel> model_;
+  StrictMock<MockContentSuggestionsProviderObserver> observer_;
+  TestingPrefServiceSimple test_prefs_;
+  std::unique_ptr<BookmarkSuggestionsProvider> provider_;
+};
+
+TEST_F(BookmarkSuggestionsProviderTest,
+       ShouldProvideBookmarkSuggestions) {
+  GURL url("http://my-new-bookmarked.url");
+  // Note, this update to the model does not trigger OnNewSuggestions() on the
+  // observer as the provider realizes no new nodes were added.
+  // don't have new data.
+  model_->AddURL(model_->bookmark_bar_node(), 0,
+                 base::ASCIIToUTF16("cool page's title"), url);
+
+  // Once we provided the last-visited meta information, an update with the
+  // suggestion containing the bookmark should follow.
+  EXPECT_CALL(
+      observer_,
+      OnNewSuggestions(
+          _, Category::FromKnownCategory(KnownCategories::BOOKMARKS),
+          UnorderedElementsAre(Property(&ContentSuggestion::url, GURL(url)))));
+  UpdateBookmarkOnURLVisitedInMainFrame(model_.get(), url,
+                                        /*is_mobile_platform=*/true);
+}
+
+TEST_F(BookmarkSuggestionsProviderTest,
+       ShouldEnsureToBeClearedBookmarksDontAppearAfterClear) {
+  // Set up the provider with 2 entries: one dismissed and one active.
+
+  // Add one bookmark (the one to be not dismissed) -- this will trigger a
+  // notification.
+  GURL active_bookmark("http://my-active-bookmarked.url");
+  EXPECT_CALL(observer_,
+              OnNewSuggestions(
+                  _, Category::FromKnownCategory(KnownCategories::BOOKMARKS),
+                  UnorderedElementsAre(Property(&ContentSuggestion::url,
+                                                GURL(active_bookmark)))))
+      .RetiresOnSaturation();
+  model_->AddURL(model_->bookmark_bar_node(), 0,
+                 base::ASCIIToUTF16("cool page's title"), active_bookmark);
+  UpdateBookmarkOnURLVisitedInMainFrame(model_.get(), active_bookmark,
+                                        /*is_mobile_platform=*/true);
+
+  // Add the other bookmark and mark it as dismissed -- this will trigger
+  // another notification.
+  GURL dismissed_bookmark("http://my-dismissed-bookmark.url");
+  EXPECT_CALL(
+      observer_,
+      OnNewSuggestions(
+          _, Category::FromKnownCategory(KnownCategories::BOOKMARKS),
+          UnorderedElementsAre(
+              Property(&ContentSuggestion::url, GURL(active_bookmark)),
+              Property(&ContentSuggestion::url, GURL(dismissed_bookmark)))));
+  const bookmarks::BookmarkNode* dismissed_node = model_->AddURL(
+      model_->bookmark_bar_node(), 1, base::ASCIIToUTF16("cool page's title"),
+      dismissed_bookmark);
+  UpdateBookmarkOnURLVisitedInMainFrame(model_.get(), dismissed_bookmark,
+                                        /*is_mobile_platform=*/true);
+  // TODO(tschumann): This seems lik a bug. When marking a bookmark as

[jkrcal, 2017/01/12 14:50:53]

This WAI. Suggestions should not be updated after dismissing a bookmark.

See the comment in
https://cs.chromium.org/chromium/src/components/ntp_snippets/content_suggesti...

If you still think this is a bug (because we should update other open NTPs), put
a TODO at content_suggestions_provider.h:83

[tschumann, 2017/01/12 15:06:23]

good to know :-) I'll re-phrase this comment then accordingly.

+  // dismissed the suggestions should get updated -- they don't as we didn't
+  // see a newer last-visited-date.
+  static_cast<ContentSuggestionsProvider*>(provider_.get())
+      ->DismissSuggestion(ContentSuggestion::ID(
+          Category::FromKnownCategory(KnownCategories::BOOKMARKS),
+          dismissed_bookmark.spec()));
+  EXPECT_THAT(IsDismissedFromNTPForBookmark(*dismissed_node), Eq(true));
+
+  // Clear history and make sure the suggestions actually get removed.
+  EXPECT_CALL(observer_, OnNewSuggestions(_, Category::FromKnownCategory(
+                                                 KnownCategories::BOOKMARKS),
+                                          IsEmpty()));
+  static_cast<ContentSuggestionsProvider*>(provider_.get())
+      ->ClearHistory(base::Time(), base::Time::Max(),
+                     base::Bind([] (const GURL& url) { return true; }));
+
+  // Verify the dismissed marker is gone.
+  EXPECT_THAT(IsDismissedFromNTPForBookmark(*dismissed_node), Eq(false));
+}
+
+// TODO(tschumann): There are plenty of test cases missing. Most importantly:
+// -- Remove a bookmark from the model
+// -- verifying handling of threshold time
+// -- dealing with fetches before the model is loaded.
+
+}  // namespace
+}  // namespace ntp_snippets
+