Renamed FaviconHandlerDelegate to FaviconDriver.

chrome/browser/favicon/favicon_handler_unittest.cc

 // Copyright (c) 2012 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 "base/memory/scoped_ptr.h"
 #include "chrome/browser/favicon/favicon_handler.h"
 #include "chrome/browser/favicon/favicon_service_factory.h"
 #include "chrome/browser/history/history_service_factory.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/test/base/chrome_render_view_host_test_harness.h"
@@ skipping 171 matching lines @@
   virtual ~TestFaviconClient() {};
 
   virtual FaviconService* GetFaviconService() OVERRIDE {
     // Just give none NULL value, so overridden methods can be hit.
     return (FaviconService*)(1);
   }
 
   virtual bool IsBookmarked(const GURL& url) OVERRIDE { return false; }
 };
 
-class TestFaviconHandlerDelegate : public FaviconHandlerDelegate {
+class TestFaviconDriver : public FaviconDriver {
  public:
-  TestFaviconHandlerDelegate() {
+  TestFaviconDriver() {
   }
 
-  virtual ~TestFaviconHandlerDelegate() {
+  virtual ~TestFaviconDriver() {
   }
 
   virtual bool IsOffTheRecord() OVERRIDE { return false; }
 
   virtual NavigationEntry* GetActiveEntry() OVERRIDE {
-    ADD_FAILURE() << "TestFaviconHandlerDelegate::GetActiveEntry() "
+    ADD_FAILURE() << "TestFaviconDriver::GetActiveEntry() "
                   << "should never be called in tests.";
     return NULL;
   }
 
   virtual int StartDownload(const GURL& url,
                             int max_bitmap_size) OVERRIDE {
-    ADD_FAILURE() << "TestFaviconHandlerDelegate::StartDownload() "
+    ADD_FAILURE() << "TestFaviconDriver::StartDownload() "
                   << "should never be called in tests.";
     return -1;
   }
 
   virtual void NotifyFaviconUpdated(bool icon_url_changed) OVERRIDE {
-    ADD_FAILURE() << "TestFaviconHandlerDelegate::NotifyFaviconUpdated() "
+    ADD_FAILURE() << "TestFaviconDriver::NotifyFaviconUpdated() "
                   << "should never be called in tests.";
   }
 
  private:
-  DISALLOW_COPY_AND_ASSIGN(TestFaviconHandlerDelegate);
+  DISALLOW_COPY_AND_ASSIGN(TestFaviconDriver);
 };
 
 // This class is used to catch the FaviconHandler's download and history
 // request, and also provide the methods to access the FaviconHandler
 // internals.
 class TestFaviconHandler : public FaviconHandler {
  public:
   TestFaviconHandler(const GURL& page_url,
                      FaviconClient* client,
-                     FaviconHandlerDelegate* delegate,
+                     FaviconDriver* driver,
                      Type type,
                      bool download_largest_icon)
-                     : FaviconHandler(client, delegate, type,
+                     : FaviconHandler(client, driver, type,
                                       download_largest_icon),
         entry_(NavigationEntry::Create()),
         download_id_(0),
         num_favicon_updates_(0) {
     entry_->SetURL(page_url);
     download_handler_.reset(new DownloadHandler(this));
   }
 
   virtual ~TestFaviconHandler() {
   }
@@ skipping 221 matching lines @@
   typedef scoped_ptr<ui::test::ScopedSetSupportedScaleFactors>
       ScopedSetSupportedScaleFactors;
   ScopedSetSupportedScaleFactors scoped_set_supported_scale_factors_;
   DISALLOW_COPY_AND_ASSIGN(FaviconHandlerTest);
 };
 
 TEST_F(FaviconHandlerTest, GetFaviconFromHistory) {
   const GURL page_url("http://www.google.com");
   const GURL icon_url("http://www.google.com/favicon");
 
-  TestFaviconHandlerDelegate delegate;
+  TestFaviconDriver driver;
   TestFaviconClient client;
   TestFaviconHandler helper(
-      page_url, &client, &delegate, FaviconHandler::FAVICON, false);
+      page_url, &client, &driver, FaviconHandler::FAVICON, false);
 
   helper.FetchFavicon(page_url);
   HistoryRequestHandler* history_handler = helper.history_handler();
   // Ensure the data given to history is correct.
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(page_url, history_handler->page_url_);
   EXPECT_EQ(GURL(), history_handler->icon_url_);
   EXPECT_EQ(favicon_base::FAVICON, history_handler->icon_type_);
 
   SetFaviconBitmapResult(icon_url, &history_handler->history_results_);
@@ skipping 17 matching lines @@
   ASSERT_EQ(FaviconURL::FAVICON, helper.current_candidate()->icon_type);
 
   // Favicon shouldn't request to download icon.
   EXPECT_FALSE(helper.download_handler()->HasDownload());
 }
 
 TEST_F(FaviconHandlerTest, DownloadFavicon) {
   const GURL page_url("http://www.google.com");
   const GURL icon_url("http://www.google.com/favicon");
 
-  TestFaviconHandlerDelegate delegate;
+  TestFaviconDriver driver;
   TestFaviconClient client;
   TestFaviconHandler helper(
-      page_url, &client, &delegate, FaviconHandler::FAVICON, false);
+      page_url, &client, &driver, FaviconHandler::FAVICON, false);
 
   helper.FetchFavicon(page_url);
   HistoryRequestHandler* history_handler = helper.history_handler();
   // Ensure the data given to history is correct.
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(page_url, history_handler->page_url_);
   EXPECT_EQ(GURL(), history_handler->icon_url_);
   EXPECT_EQ(favicon_base::FAVICON, history_handler->icon_type_);
 
   // Set icon data expired
@@ skipping 46 matching lines @@
   EXPECT_TRUE(favicon_status.valid);
   EXPECT_FALSE(favicon_status.image.IsEmpty());
   EXPECT_EQ(gfx::kFaviconSize, favicon_status.image.Width());
 }
 
 TEST_F(FaviconHandlerTest, UpdateAndDownloadFavicon) {
   const GURL page_url("http://www.google.com");
   const GURL icon_url("http://www.google.com/favicon");
   const GURL new_icon_url("http://www.google.com/new_favicon");
 
-  TestFaviconHandlerDelegate delegate;
+  TestFaviconDriver driver;
   TestFaviconClient client;
   TestFaviconHandler helper(
-      page_url, &client, &delegate, FaviconHandler::FAVICON, false);
+      page_url, &client, &driver, FaviconHandler::FAVICON, false);
 
   helper.FetchFavicon(page_url);
   HistoryRequestHandler* history_handler = helper.history_handler();
   // Ensure the data given to history is correct.
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(page_url, history_handler->page_url_);
   EXPECT_EQ(GURL(), history_handler->icon_url_);
   EXPECT_EQ(favicon_base::FAVICON, history_handler->icon_type_);
 
   // Set valid icon data.
@@ skipping 58 matching lines @@
   EXPECT_EQ(new_icon_url, favicon_status.url);
   EXPECT_TRUE(favicon_status.valid);
   EXPECT_FALSE(favicon_status.image.IsEmpty());
   EXPECT_EQ(gfx::kFaviconSize, favicon_status.image.Width());
 }
 
 TEST_F(FaviconHandlerTest, FaviconInHistoryInvalid) {
   const GURL page_url("http://www.google.com");
   const GURL icon_url("http://www.google.com/favicon");
 
-  TestFaviconHandlerDelegate delegate;
+  TestFaviconDriver driver;
   TestFaviconClient client;
   TestFaviconHandler helper(
-      page_url, &client, &delegate, FaviconHandler::FAVICON, false);
+      page_url, &client, &driver, FaviconHandler::FAVICON, false);
 
   helper.FetchFavicon(page_url);
   HistoryRequestHandler* history_handler = helper.history_handler();
   // Ensure the data given to history is correct.
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(page_url, history_handler->page_url_);
   EXPECT_EQ(GURL(), history_handler->icon_url_);
   EXPECT_EQ(favicon_base::FAVICON, history_handler->icon_type_);
 
   // Set non empty but invalid data.
@@ skipping 49 matching lines @@
   EXPECT_TRUE(favicon_status.valid);
   EXPECT_FALSE(favicon_status.image.IsEmpty());
   EXPECT_EQ(gfx::kFaviconSize, favicon_status.image.Width());
 }
 
 TEST_F(FaviconHandlerTest, UpdateFavicon) {
   const GURL page_url("http://www.google.com");
   const GURL icon_url("http://www.google.com/favicon");
   const GURL new_icon_url("http://www.google.com/new_favicon");
 
-  TestFaviconHandlerDelegate delegate;
+  TestFaviconDriver driver;
   TestFaviconClient client;
   TestFaviconHandler helper(
-      page_url, &client, &delegate, FaviconHandler::FAVICON, false);
+      page_url, &client, &driver, FaviconHandler::FAVICON, false);
 
   helper.FetchFavicon(page_url);
   HistoryRequestHandler* history_handler = helper.history_handler();
   // Ensure the data given to history is correct.
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(page_url, history_handler->page_url_);
   EXPECT_EQ(GURL(), history_handler->icon_url_);
   EXPECT_EQ(favicon_base::FAVICON, history_handler->icon_type_);
 
   SetFaviconBitmapResult(icon_url, &history_handler->history_results_);
@@ skipping 38 matching lines @@
   EXPECT_EQ(new_icon_url, helper.GetEntry()->GetFavicon().url);
   EXPECT_TRUE(helper.GetEntry()->GetFavicon().valid);
   EXPECT_FALSE(helper.GetEntry()->GetFavicon().image.IsEmpty());
 }
 
 TEST_F(FaviconHandlerTest, Download2ndFaviconURLCandidate) {
   const GURL page_url("http://www.google.com");
   const GURL icon_url("http://www.google.com/favicon");
   const GURL new_icon_url("http://www.google.com/new_favicon");
 
-  TestFaviconHandlerDelegate delegate;
+  TestFaviconDriver driver;
   TestFaviconClient client;
   TestFaviconHandler helper(
-      page_url, &client, &delegate, FaviconHandler::TOUCH, false);
+      page_url, &client, &driver, FaviconHandler::TOUCH, false);
 
   helper.FetchFavicon(page_url);
   HistoryRequestHandler* history_handler = helper.history_handler();
   // Ensure the data given to history is correct.
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(page_url, history_handler->page_url_);
   EXPECT_EQ(GURL(), history_handler->icon_url_);
   EXPECT_EQ(favicon_base::TOUCH_PRECOMPOSED_ICON | favicon_base::TOUCH_ICON,
             history_handler->icon_type_);
 
@@ skipping 90 matching lines @@
   EXPECT_EQ(FaviconURL::TOUCH_ICON, history_handler->icon_type_);
   EXPECT_LT(0U, history_handler->bitmap_data_.size());
   EXPECT_EQ(page_url, history_handler->page_url_);
 }
 
 TEST_F(FaviconHandlerTest, UpdateDuringDownloading) {
   const GURL page_url("http://www.google.com");
   const GURL icon_url("http://www.google.com/favicon");
   const GURL new_icon_url("http://www.google.com/new_favicon");
 
-  TestFaviconHandlerDelegate delegate;
+  TestFaviconDriver driver;
   TestFaviconClient client;
   TestFaviconHandler helper(
-      page_url, &client, &delegate, FaviconHandler::TOUCH, false);
+      page_url, &client, &driver, FaviconHandler::TOUCH, false);
 
   helper.FetchFavicon(page_url);
   HistoryRequestHandler* history_handler = helper.history_handler();
   // Ensure the data given to history is correct.
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(page_url, history_handler->page_url_);
   EXPECT_EQ(GURL(), history_handler->icon_url_);
   EXPECT_EQ(favicon_base::TOUCH_PRECOMPOSED_ICON | favicon_base::TOUCH_ICON,
             history_handler->icon_type_);
 
@@ skipping 118 matching lines @@
 
   // Set the supported scale factors to 1x and 2x. This affects the behavior of
   // SelectFaviconFrames().
   std::vector<ui::ScaleFactor> scale_factors;
   scale_factors.push_back(ui::SCALE_FACTOR_100P);
   scale_factors.push_back(ui::SCALE_FACTOR_200P);
   ui::test::ScopedSetSupportedScaleFactors scoped_supported(scale_factors);
 
   // 1) Test that if there are several single resolution favicons to choose from
   // that the largest exact match is chosen.
-  TestFaviconHandlerDelegate delegate1;
+  TestFaviconDriver driver1;
   TestFaviconClient client;
   TestFaviconHandler handler1(
-      kPageURL, &client, &delegate1, FaviconHandler::FAVICON, false);
+      kPageURL, &client, &driver1, FaviconHandler::FAVICON, false);
 
   const int kSizes1[] = { 16, 24, 32, 48, 256 };
   std::vector<FaviconURL> urls1(kSourceIconURLs,
                                 kSourceIconURLs + arraysize(kSizes1));
   DownloadTillDoneIgnoringHistory(&handler1, kPageURL, urls1, kSizes1);
 
   content::FaviconStatus favicon_status1(handler1.GetEntry()->GetFavicon());
   EXPECT_EQ(0u, handler1.image_urls().size());
   EXPECT_TRUE(favicon_status1.valid);
   EXPECT_FALSE(favicon_status1.image.IsEmpty());
   EXPECT_EQ(gfx::kFaviconSize, favicon_status1.image.Width());
 
   size_t expected_index = 2u;
   EXPECT_EQ(32, kSizes1[expected_index]);
   EXPECT_EQ(kSourceIconURLs[expected_index].icon_url,
             handler1.GetEntry()->GetFavicon().url);
 
   // 2) Test that if there are several single resolution favicons to choose
   // from, the exact match is preferred even if it results in upsampling.
-  TestFaviconHandlerDelegate delegate2;
+  TestFaviconDriver driver2;
   TestFaviconHandler handler2(
-      kPageURL, &client, &delegate2, FaviconHandler::FAVICON, false);
+      kPageURL, &client, &driver2, FaviconHandler::FAVICON, false);
 
   const int kSizes2[] = { 16, 24, 48, 256 };
   std::vector<FaviconURL> urls2(kSourceIconURLs,
                                 kSourceIconURLs + arraysize(kSizes2));
   DownloadTillDoneIgnoringHistory(&handler2, kPageURL, urls2, kSizes2);
   EXPECT_TRUE(handler2.GetEntry()->GetFavicon().valid);
   expected_index = 0u;
   EXPECT_EQ(16, kSizes2[expected_index]);
   EXPECT_EQ(kSourceIconURLs[expected_index].icon_url,
             handler2.GetEntry()->GetFavicon().url);
 
   // 3) Test that favicons which need to be upsampled a little or downsampled
   // a little are preferred over huge favicons.
-  TestFaviconHandlerDelegate delegate3;
+  TestFaviconDriver driver3;
   TestFaviconHandler handler3(
-      kPageURL, &client, &delegate3, FaviconHandler::FAVICON, false);
+      kPageURL, &client, &driver3, FaviconHandler::FAVICON, false);
 
   const int kSizes3[] = { 256, 48 };
   std::vector<FaviconURL> urls3(kSourceIconURLs,
                                 kSourceIconURLs + arraysize(kSizes3));
   DownloadTillDoneIgnoringHistory(&handler3, kPageURL, urls3, kSizes3);
   EXPECT_TRUE(handler3.GetEntry()->GetFavicon().valid);
   expected_index = 1u;
   EXPECT_EQ(48, kSizes3[expected_index]);
   EXPECT_EQ(kSourceIconURLs[expected_index].icon_url,
             handler3.GetEntry()->GetFavicon().url);
 
-  TestFaviconHandlerDelegate delegate4;
+  TestFaviconDriver driver4;
   TestFaviconHandler handler4(
-      kPageURL, &client, &delegate4, FaviconHandler::FAVICON, false);
+      kPageURL, &client, &driver4, FaviconHandler::FAVICON, false);
 
   const int kSizes4[] = { 17, 256 };
   std::vector<FaviconURL> urls4(kSourceIconURLs,
                                 kSourceIconURLs + arraysize(kSizes4));
   DownloadTillDoneIgnoringHistory(&handler4, kPageURL, urls4, kSizes4);
   EXPECT_TRUE(handler4.GetEntry()->GetFavicon().valid);
   expected_index = 0u;
   EXPECT_EQ(17, kSizes4[expected_index]);
   EXPECT_EQ(kSourceIconURLs[expected_index].icon_url,
             handler4.GetEntry()->GetFavicon().url);
@@ skipping 26 matching lines @@
                  FaviconURL::FAVICON,
                  icon3),
       FaviconURL(GURL("http://www.google.com/d"),
                  FaviconURL::FAVICON,
                  std::vector<gfx::Size>()),
       FaviconURL(GURL("http://www.google.com/e"),
                  FaviconURL::FAVICON,
                  std::vector<gfx::Size>())};
 
   TestFaviconClient client;
-  TestFaviconHandlerDelegate delegate1;
+  TestFaviconDriver driver1;
   TestFaviconHandler handler1(
-      kPageURL, &client, &delegate1, FaviconHandler::FAVICON, true);
+      kPageURL, &client, &driver1, FaviconHandler::FAVICON, true);
   std::vector<FaviconURL> urls1(kSourceIconURLs,
                                 kSourceIconURLs + arraysize(kSourceIconURLs));
   UpdateFaviconURL(&handler1, kPageURL, urls1);
 
   struct ExpectedResult {
     // The favicon's index in kSourceIconURLs.
     size_t favicon_index;
     // Width of largest bitmap.
     int width;
   } results[] = {
@@ skipping 42 matching lines @@
                  FaviconURL::FAVICON,
                  two_icons),
       FaviconURL(GURL("http://www.google.com/d"),
                  FaviconURL::FAVICON,
                  std::vector<gfx::Size>()),
       FaviconURL(GURL("http://www.google.com/e"),
                  FaviconURL::FAVICON,
                  std::vector<gfx::Size>())};
 
   TestFaviconClient client;
-  TestFaviconHandlerDelegate delegate1;
+  TestFaviconDriver driver1;
   TestFaviconHandler handler1(
-      kPageURL, &client, &delegate1, FaviconHandler::FAVICON, true);
+      kPageURL, &client, &driver1, FaviconHandler::FAVICON, true);
   std::vector<FaviconURL> urls1(kSourceIconURLs,
                                 kSourceIconURLs + arraysize(kSourceIconURLs));
   UpdateFaviconURL(&handler1, kPageURL, urls1);
 
   // Simulate the download failed, to check whether the icons were requested
   // to download according their size.
   struct ExpectedResult {
     // The size of image_urls_.
     size_t image_urls_size;
     // The favicon's index in kSourceIconURLs.
@@ skipping 49 matching lines @@
 
   const FaviconURL kSourceIconURLs[] = {
       FaviconURL(GURL("http://www.google.com/b"),
                  FaviconURL::FAVICON,
                  one_icon),
       FaviconURL(GURL("http://www.google.com/c"),
                  FaviconURL::FAVICON,
                  two_icons)};
 
   TestFaviconClient client;
-  TestFaviconHandlerDelegate delegate1;
+  TestFaviconDriver driver1;
   TestFaviconHandler handler1(
-      kPageURL, &client, &delegate1, FaviconHandler::FAVICON, true);
+      kPageURL, &client, &driver1, FaviconHandler::FAVICON, true);
   std::vector<FaviconURL> urls1(kSourceIconURLs,
                                 kSourceIconURLs + arraysize(kSourceIconURLs));
   UpdateFaviconURL(&handler1, kPageURL, urls1);
 
   ASSERT_EQ(2u, handler1.urls().size());
 
   // Index of largest favicon in kSourceIconURLs.
   size_t i = 1;
   // The largest bitmap's index in Favicon .
   int b = 1;
@@ skipping 45 matching lines @@
                  FaviconURL::FAVICON,
                  icon1),
       FaviconURL(GURL("http://www.google.com/c"),
                  FaviconURL::FAVICON,
                  icon2),
       FaviconURL(GURL("http://www.google.com/d"),
                  FaviconURL::FAVICON,
                  std::vector<gfx::Size>())};
 
   TestFaviconClient client;
-  TestFaviconHandlerDelegate delegate1;
+  TestFaviconDriver driver1;
   TestFaviconHandler handler1(
-      kPageURL, &client, &delegate1, FaviconHandler::FAVICON, true);
+      kPageURL, &client, &driver1, FaviconHandler::FAVICON, true);
   std::vector<FaviconURL> urls1(kSourceIconURLs,
                                 kSourceIconURLs + arraysize(kSourceIconURLs));
   UpdateFaviconURL(&handler1, kPageURL, urls1);
   ASSERT_EQ(3u, handler1.urls().size());
 
   // Simulate no favicon from history.
   handler1.history_handler()->history_results_.clear();
   handler1.history_handler()->InvokeCallback();
 
   // Verify the first icon was request to download
@@ skipping 111 matching lines @@
   download_id = favicon_tab_helper->StartDownload(missing_icon_url, 0);
   EXPECT_NE(0, download_id);
   // Report download success with HTTP 200 status.
   favicon_tab_helper->DidDownloadFavicon(download_id, 200, missing_icon_url,
       empty_icons, empty_icon_sizes);
   // Icon is not marked as UnableToDownload as HTTP status is not 404.
   EXPECT_FALSE(favicon_service->WasUnableToDownloadFavicon(missing_icon_url));
 }
 
 }  // namespace.