Add pyauto hook for getting and manipulating the data underneath the NTP....

chrome/browser/history/top_sites_unittest.cc

 // Copyright (c) 2010 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 "app/l10n_util.h"
 #include "base/file_util.h"
 #include "base/scoped_temp_dir.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/chrome_thread.h"
 #include "chrome/browser/history/top_sites.h"
 #include "chrome/browser/dom_ui/most_visited_handler.h"
 #include "chrome/browser/history/history_marshaling.h"
 #include "chrome/browser/history/top_sites_database.h"
 #include "chrome/browser/history/history_notifications.h"
 #include "chrome/common/chrome_paths.h"
 #include "chrome/test/testing_profile.h"
 #include "chrome/tools/profiles/thumbnail-inl.h"
 #include "gfx/codec/jpeg_codec.h"
 #include "googleurl/src/gurl.h"
 #include "grit/chromium_strings.h"
 #include "grit/generated_resources.h"
 #include "grit/locale_settings.h"
+#include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 
 
 namespace history {
 
 static const unsigned char kBlob[] =
     "12346102356120394751634516591348710478123649165419234519234512349134";
 
 class TopSitesTest : public testing::Test {
@@ skipping 87 matching lines @@
   scoped_refptr<RefCountedBytes> random_thumbnail_;
   scoped_refptr<RefCountedBytes> weewar_thumbnail_;
   MessageLoop message_loop_;
   CancelableRequestConsumer consumer_;
 
   DISALLOW_COPY_AND_ASSIGN(TopSitesTest);
 };
 
 
 // A mockup of a HistoryService used for testing TopSites.
-class MockHistoryServiceImpl : public TopSites::MockHistoryService {
+class MockHistoryServiceImpl
+    : public base::RefCountedThreadSafe<MockHistoryServiceImpl>,
+      public TopSites::MockHistoryService {
  public:
-  MockHistoryServiceImpl() : num_thumbnail_requests_(0) {}
+  MockHistoryServiceImpl() : num_thumbnail_requests_(0), handle_num_(0) {}
 
   // Calls the callback directly with the results.
   HistoryService::Handle QueryMostVisitedURLs(
       int result_count, int days_back,
       CancelableRequestConsumerBase* consumer,
       HistoryService::QueryMostVisitedURLsCallback* callback) {
-    callback->Run(CancelableRequestProvider::Handle(0),  // Handle is unused.
-                  most_visited_urls_);
+    CancelableRequestProvider::Handle handle(++handle_num_);
+    // Run the callback on another task in order that the handle can be
+    // returned before the callback is run, which is necessary for the
+    // refresh callback mechanism to work in |TopSites|.
+    MessageLoop::current()->PostTask(
+        FROM_HERE,
+        NewRunnableMethod(this,
+                          &MockHistoryServiceImpl::RunCallback,
+                          callback,
+                          handle));
+    return handle;
+  }
+
+  void RunCallback(HistoryService::QueryMostVisitedURLsCallback* callback,
+                   CancelableRequestProvider::Handle handle) {
+    callback->Run(handle, most_visited_urls_);
     delete callback;
-    return 0;
   }
 
   // Add a page to the end of the pages list.
   void AppendMockPage(const GURL& url,
                       const string16& title) {
     MostVisitedURL page;
     page.url = url;
     page.title = title;
     page.redirects = RedirectList();
     page.redirects.push_back(url);
@@ skipping 26 matching lines @@
     num_thumbnail_requests_ = 0;
   }
 
   int GetNumberOfThumbnailRequests() {
     return num_thumbnail_requests_;
   }
 
  private:
   MostVisitedURLList most_visited_urls_;
   int num_thumbnail_requests_;  // Number of calls to GetPageThumbnail.
+  int handle_num_;
 };
 
 
 // A mockup of a TopSitesDatabase used for testing TopSites.
 class MockTopSitesDatabaseImpl : public TopSitesDatabase {
  public:
   virtual void GetPageThumbnails(MostVisitedURLList* urls,
                                  std::map<GURL, Images>* thumbnails) {
     // Return a copy of the vector.
     *urls = top_sites_list_;
@@ skipping 256 matching lines @@
                                                          result->size()));
   EXPECT_EQ(0, memcmp(thumbnail.getPixels(), out_bitmap->getPixels(),
                       thumbnail.getSize()));
 }
 
 TEST_F(TopSitesTest, GetMostVisited) {
   ChromeThread db_loop(ChromeThread::DB, MessageLoop::current());
   GURL news("http://news.google.com/");
   GURL google("http://google.com/");
 
-  MockHistoryServiceImpl hs;
-  hs.AppendMockPage(news, ASCIIToUTF16("Google News"));
-  hs.AppendMockPage(google, ASCIIToUTF16("Google"));
-  top_sites().SetMockHistoryService(&hs);
+  scoped_refptr<MockHistoryServiceImpl> hs(new MockHistoryServiceImpl);
+  hs->AppendMockPage(news, ASCIIToUTF16("Google News"));
+  hs->AppendMockPage(google, ASCIIToUTF16("Google"));
+  top_sites().SetMockHistoryService(hs.get());
 
   top_sites().StartQueryForMostVisited();
   MessageLoop::current()->RunAllPending();
   top_sites().GetMostVisitedURLs(
       consumer(),
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
   // 2 extra prepopulated URLs.
   ASSERT_EQ(4u, urls().size());
   EXPECT_EQ(news, urls()[0].url);
@@ skipping 48 matching lines @@
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
   ASSERT_EQ(4u, urls().size());
   EXPECT_EQ(google_url, urls()[0].url);
   EXPECT_EQ(google_title, urls()[0].title);
   EXPECT_EQ(asdf_url, urls()[1].url);
   EXPECT_EQ(asdf_title, urls()[1].title);
   EXPECT_EQ(welcome_url(), urls()[2].url);
   EXPECT_EQ(themes_url(), urls()[3].url);
 
-  MockHistoryServiceImpl hs;
+  scoped_refptr<MockHistoryServiceImpl> hs(new MockHistoryServiceImpl);
   // Add one old, one new URL to the history.
-  hs.AppendMockPage(google_url, google_title);
-  hs.AppendMockPage(news_url, news_title);
-  top_sites().SetMockHistoryService(&hs);
+  hs->AppendMockPage(google_url, google_title);
+  hs->AppendMockPage(news_url, news_title);
+  top_sites().SetMockHistoryService(hs.get());
 
   // This writes the new data to the DB.
   top_sites().StartQueryForMostVisited();
   MessageLoop::current()->RunAllPending();
 
   std::map<GURL, Images> thumbnails;
   MostVisitedURLList result;
   db->GetPageThumbnails(&result, &thumbnails);
   ASSERT_EQ(4u, result.size());
   EXPECT_EQ(google_title, result[0].title);
@@ skipping 156 matching lines @@
   ASSERT_EQ(3u, urls()[0].redirects.size());
   EXPECT_EQ(google1_url, urls()[0].redirects[0]);
   EXPECT_EQ(google2_url, urls()[0].redirects[1]);
   EXPECT_EQ(google3_url, urls()[0].redirects[2]);
 
   EXPECT_EQ(asdf_url, urls()[1].url);
   EXPECT_EQ(asdf_title, urls()[1].title);
   EXPECT_EQ(welcome_url(), urls()[2].url);
   EXPECT_EQ(themes_url(), urls()[3].url);
 
-  MockHistoryServiceImpl hs;
+  scoped_refptr<MockHistoryServiceImpl> hs(new MockHistoryServiceImpl);
   // Add one old, one new URL to the history.
-  hs.AppendMockPage(google1_url, google_title);
-  hs.AppendMockPage(news_url, news_title);
-  top_sites().SetMockHistoryService(&hs);
+  hs->AppendMockPage(google1_url, google_title);
+  hs->AppendMockPage(news_url, news_title);
+  top_sites().SetMockHistoryService(hs.get());
 
   // This requests data from History Service and  writes it to the DB.
   top_sites().StartQueryForMostVisited();
   MessageLoop::current()->RunAllPending();
 
   std::map<GURL, Images> thumbnails;
   MostVisitedURLList results;
   db->GetPageThumbnails(&results, &thumbnails);
   ASSERT_EQ(4u, results.size());
   EXPECT_EQ(google_title, results[0].title);
@@ skipping 47 matching lines @@
 
 TEST_F(TopSitesTest, DeleteNotifications) {
   ChromeThread db_loop(ChromeThread::DB, MessageLoop::current());
   GURL google1_url("http://google.com");
   GURL google2_url("http://google.com/redirect");
   GURL google3_url("http://www.google.com");
   string16 google_title(ASCIIToUTF16("Google"));
   GURL news_url("http://news.google.com");
   string16 news_title(ASCIIToUTF16("Google News"));
 
-  MockHistoryServiceImpl hs;
+  scoped_refptr<MockHistoryServiceImpl> hs(new MockHistoryServiceImpl);
 
   top_sites().Init(file_name());
 
-  hs.AppendMockPage(google1_url, google_title);
-  hs.AppendMockPage(news_url, news_title);
-  top_sites().SetMockHistoryService(&hs);
+  hs->AppendMockPage(google1_url, google_title);
+  hs->AppendMockPage(news_url, news_title);
+  top_sites().SetMockHistoryService(hs.get());
 
   top_sites().StartQueryForMostVisited();
   MessageLoop::current()->RunAllPending();
 
   top_sites().GetMostVisitedURLs(
       consumer(),
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
   // 2 extra prepopulated URLs.
   ASSERT_EQ(4u, urls().size());
 
-  hs.RemoveMostVisitedURL();
+  hs->RemoveMostVisitedURL();
 
   history::URLsDeletedDetails history_details;
   history_details.all_history = false;
   Details<URLsDeletedDetails> details(&history_details);
   top_sites().Observe(NotificationType::HISTORY_URLS_DELETED,
                       Source<Profile> (&profile()),
                       details);
   MessageLoop::current()->RunAllPending();
 
   top_sites().GetMostVisitedURLs(
       consumer(),
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
   ASSERT_EQ(3u, urls().size());
   EXPECT_EQ(google_title, urls()[0].title);
   EXPECT_EQ(welcome_url(), urls()[1].url);
   EXPECT_EQ(themes_url(), urls()[2].url);
 
-  hs.RemoveMostVisitedURL();
+  hs->RemoveMostVisitedURL();
   history_details.all_history = true;
   details = Details<HistoryDetails>(&history_details);
   top_sites().Observe(NotificationType::HISTORY_URLS_DELETED,
                       Source<Profile> (&profile()),
                       details);
   MessageLoop::current()->RunAllPending();
   top_sites().GetMostVisitedURLs(
       consumer(),
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
   ASSERT_EQ(2u, urls().size());
   EXPECT_EQ(welcome_url(), urls()[0].url);
   EXPECT_EQ(themes_url(), urls()[1].url);
 }
 
 TEST_F(TopSitesTest, PinnedURLsDeleted) {
   ChromeThread db_loop(ChromeThread::DB, MessageLoop::current());
   GURL google1_url("http://google.com");
   GURL google2_url("http://google.com/redirect");
   GURL google3_url("http://www.google.com");
   string16 google_title(ASCIIToUTF16("Google"));
   GURL news_url("http://news.google.com");
   string16 news_title(ASCIIToUTF16("Google News"));
 
-  MockHistoryServiceImpl hs;
+  scoped_refptr<MockHistoryServiceImpl> hs(new MockHistoryServiceImpl);
 
   top_sites().Init(file_name());
 
-  hs.AppendMockPage(google1_url, google_title);
-  hs.AppendMockPage(news_url, news_title);
-  top_sites().SetMockHistoryService(&hs);
+  hs->AppendMockPage(google1_url, google_title);
+  hs->AppendMockPage(news_url, news_title);
+  top_sites().SetMockHistoryService(hs.get());
 
   top_sites().StartQueryForMostVisited();
   MessageLoop::current()->RunAllPending();
   top_sites().GetMostVisitedURLs(
       consumer(),
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
   MessageLoop::current()->RunAllPending();
   EXPECT_EQ(1u, number_of_callbacks());
   // 2 extra prepopulated URLs.
   ASSERT_EQ(4u, urls().size());
 
   top_sites().AddPinnedURL(news_url, 3);
   EXPECT_TRUE(top_sites().IsURLPinned(news_url));
 
-  hs.RemoveMostVisitedURL();
+  hs->RemoveMostVisitedURL();
   history::URLsDeletedDetails history_details;
   history_details.all_history = false;
   history_details.urls.insert(news_url);
   Details<URLsDeletedDetails> details(&history_details);
   top_sites().Observe(NotificationType::HISTORY_URLS_DELETED,
                       Source<Profile> (&profile()),
                       details);
   MessageLoop::current()->RunAllPending();
   top_sites().GetMostVisitedURLs(
       consumer(),
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
   MessageLoop::current()->RunAllPending();
   EXPECT_EQ(2u, number_of_callbacks());
   ASSERT_EQ(3u, urls().size());
   EXPECT_FALSE(top_sites().IsURLPinned(news_url));
 
-  hs.RemoveMostVisitedURL();
+  hs->RemoveMostVisitedURL();
   history_details.all_history = true;
   details = Details<HistoryDetails>(&history_details);
   top_sites().Observe(NotificationType::HISTORY_URLS_DELETED,
                       Source<Profile> (&profile()),
                       details);
   MessageLoop::current()->RunAllPending();
   top_sites().GetMostVisitedURLs(
       consumer(),
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
@@ skipping 26 matching lines @@
   EXPECT_EQ(1, top_sites().GetUpdateDelay().InMinutes());
 }
 
 TEST_F(TopSitesTest, Migration) {
   ChromeThread db_loop(ChromeThread::DB, MessageLoop::current());
   GURL google1_url("http://google.com");
   string16 google_title(ASCIIToUTF16("Google"));
   GURL news_url("http://news.google.com");
   string16 news_title(ASCIIToUTF16("Google News"));
 
-  MockHistoryServiceImpl hs;
+  scoped_refptr<MockHistoryServiceImpl> hs(new MockHistoryServiceImpl);
 
   top_sites().Init(file_name());
 
-  hs.AppendMockPage(google1_url, google_title);
-  hs.AppendMockPage(news_url, news_title);
-  top_sites().SetMockHistoryService(&hs);
+  hs->AppendMockPage(google1_url, google_title);
+  hs->AppendMockPage(news_url, news_title);
+  top_sites().SetMockHistoryService(hs.get());
   MessageLoop::current()->RunAllPending();
 
   top_sites().StartMigration();
   EXPECT_TRUE(top_sites().migration_in_progress_);
   MessageLoop::current()->RunAllPending();
-  EXPECT_EQ(2, hs.GetNumberOfThumbnailRequests());
+  EXPECT_EQ(2, hs->GetNumberOfThumbnailRequests());
   EXPECT_FALSE(top_sites().migration_in_progress_);
 }
 
 TEST_F(TopSitesTest, QueueingRequestsForTopSites) {
   ChromeThread db_loop(ChromeThread::DB, MessageLoop::current());
   CancelableRequestConsumer c1;
   CancelableRequestConsumer c2;
   CancelableRequestConsumer c3;
   top_sites().GetMostVisitedURLs(
       &c1,
@@ skipping 14 matching lines @@
   EXPECT_EQ(0u, urls().size());
 
   MostVisitedURLList pages;
   MostVisitedURL url;
   url.url = GURL("http://1.com/");
   url.redirects.push_back(url.url);
   pages.push_back(url);
   url.url = GURL("http://2.com/");
   url.redirects.push_back(url.url);
   pages.push_back(url);
-  top_sites().OnTopSitesAvailable(0, pages);
+  top_sites().OnTopSitesAvailable(1, pages);
   MessageLoop::current()->RunAllPending();
 
   EXPECT_EQ(3u, number_of_callbacks());
 
   ASSERT_EQ(4u, urls().size());
   EXPECT_EQ("http://1.com/", urls()[0].url.spec());
   EXPECT_EQ("http://2.com/", urls()[1].url.spec());
   EXPECT_EQ(welcome_url(), urls()[2].url);
   EXPECT_EQ(themes_url(), urls()[3].url);
 
 
   url.url = GURL("http://3.com/");
   url.redirects.push_back(url.url);
   pages.push_back(url);
-  top_sites().OnTopSitesAvailable(0, pages);
+  top_sites().OnTopSitesAvailable(1, pages);
   MessageLoop::current()->RunAllPending();
 
   top_sites().GetMostVisitedURLs(
       &c3,
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
 
   EXPECT_EQ(4u, number_of_callbacks());
 
   ASSERT_EQ(5u, urls().size());
@@ skipping 33 matching lines @@
   EXPECT_EQ(0u, urls().size());
 
   MostVisitedURLList pages;
   MostVisitedURL url;
   url.url = GURL("http://1.com/");
   url.redirects.push_back(url.url);
   pages.push_back(url);
   url.url = GURL("http://2.com/");
   pages.push_back(url);
 
-  top_sites().OnTopSitesAvailable(0, pages);
+  top_sites().OnTopSitesAvailable(1, pages);
   MessageLoop::current()->RunAllPending();
 
   // 1 request was canceled.
   EXPECT_EQ(2u, number_of_callbacks());
 
   // 2 extra prepopulated URLs.
   ASSERT_EQ(4u, urls().size());
   EXPECT_EQ("http://1.com/", urls()[0].url.spec());
   EXPECT_EQ("http://2.com/", urls()[1].url.spec());
 }
@@ skipping 50 matching lines @@
   pages.push_back(url);
   url1.url = GURL("http://google.com/");
   url1.redirects.push_back(url1.url);
   pages.push_back(url1);
 
   CancelableRequestConsumer c;
   top_sites().GetMostVisitedURLs(
       &c,
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
-  top_sites().OnTopSitesAvailable(0, pages);
+  top_sites().OnTopSitesAvailable(1, pages);
   MessageLoop::current()->RunAllPending();
   {
     Lock& l = lock();
     AutoLock lock(l);  // IsBlacklisted must be in a lock.
     EXPECT_FALSE(top_sites().IsBlacklisted(GURL("http://bbc.com/")));
   }
 
   EXPECT_EQ(1u, number_of_callbacks());
 
   ASSERT_EQ(4u, urls().size());
@@ skipping 73 matching lines @@
   pages.push_back(url);
   url1.url = GURL("http://google.com/");
   url1.redirects.push_back(url1.url);
   pages.push_back(url1);
 
   CancelableRequestConsumer c;
   top_sites().GetMostVisitedURLs(
       &c,
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
-  top_sites().OnTopSitesAvailable(0, pages);
+  top_sites().OnTopSitesAvailable(1, pages);
   MessageLoop::current()->RunAllPending();
   EXPECT_FALSE(top_sites().IsURLPinned(GURL("http://bbc.com/")));
 
   ASSERT_EQ(4u, urls().size());
   EXPECT_EQ("http://bbc.com/", urls()[0].url.spec());
   EXPECT_EQ("http://google.com/", urls()[1].url.spec());
   EXPECT_EQ(welcome_url(), urls()[2].url);
   EXPECT_EQ(themes_url(), urls()[3].url);
 
   top_sites().AddPinnedURL(GURL("http://google.com/"), 3);
@@ skipping 56 matching lines @@
 }
 
 TEST_F(TopSitesTest, BlacklistingAndPinnedURLs) {
   ChromeThread db_loop(ChromeThread::DB, MessageLoop::current());
   MostVisitedURLList pages;
   CancelableRequestConsumer c;
   top_sites().GetMostVisitedURLs(
       &c,
       NewCallback(static_cast<TopSitesTest*>(this),
                   &TopSitesTest::OnTopSitesAvailable));
-  top_sites().OnTopSitesAvailable(0, pages);
+  top_sites().OnTopSitesAvailable(1, pages);
   MessageLoop::current()->RunAllPending();
 
   ASSERT_EQ(2u, urls().size());
   EXPECT_EQ(welcome_url(), urls()[0].url);
   EXPECT_EQ(themes_url(), urls()[1].url);
 
   top_sites().AddPinnedURL(themes_url(), 1);
   top_sites().AddBlacklistedURL(welcome_url());
 
   top_sites().GetMostVisitedURLs(
@@ skipping 20 matching lines @@
   pages.push_back(url);
 
   top_sites().AddPrepopulatedPages(&pages);
 
   // Themes URL is already in pages; should not be added twice.
   ASSERT_EQ(2u, pages.size());
   EXPECT_EQ(themes_url(), pages[0].url);
   EXPECT_EQ(welcome_url(), pages[1].url);
 }
 
+class MockRefreshObserver {
+ public:
+  MOCK_METHOD0(OnRefresh, void ());  // NOLINT
+};
+
+ACTION_P3(GetMostVisitedURLs, top_sites, consumer, callback_obj) {
+  top_sites->GetMostVisitedURLs(
+      consumer,
+      NewCallback(static_cast<TopSitesTest*>(callback_obj),
+                  &TopSitesTest::OnTopSitesAvailable));
+}
+
+TEST_F(TopSitesTest, RefreshCallback) {
+  ChromeThread db_loop(ChromeThread::DB, MessageLoop::current());
+
+  scoped_refptr<MockHistoryServiceImpl> hs(new MockHistoryServiceImpl);
+  hs->AppendMockPage(GURL("http://google.com"), ASCIIToUTF16("Google"));
+  top_sites().SetMockHistoryService(hs.get());
+
+  top_sites().StartQueryForMostVisited();
+  MessageLoop::current()->RunAllPending();
+
+  // Test that the callback is called.
+  MockRefreshObserver refresh_mock;
+  EXPECT_CALL(refresh_mock, OnRefresh())
+      .WillOnce(GetMostVisitedURLs(&top_sites(), consumer(), this));
+  top_sites().RefreshAndCallback(
+      consumer(),
+      NewCallback(&refresh_mock, &MockRefreshObserver::OnRefresh));
+  MessageLoop::current()->RunAllPending();
+  MessageLoop::current()->RunAllPending();
+  ASSERT_EQ(3u, urls().size());
+
+  // Test that the callback is not called again.
+  top_sites().GetMostVisitedURLs(
+      consumer(),
+      NewCallback(static_cast<TopSitesTest*>(this),
+                  &TopSitesTest::OnTopSitesAvailable));
+  MessageLoop::current()->RunAllPending();
+}
+
 }  // namespace history