Change FaviconData to be able to return data for multiple bitmaps for same icon URL

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/profiles/profile.h"
 #include "chrome/test/base/chrome_render_view_host_test_harness.h"
 #include "content/public/browser/invalidate_type.h"
 #include "content/public/browser/navigation_entry.h"
@@ skipping 26 matching lines @@
   }
 }
 
 // Fill the given data buffer with valid png data.
 void FillBitmap(int w, int h, std::vector<unsigned char>* output) {
   SkBitmap bitmap;
   FillDataToBitmap(w, h, &bitmap);
   gfx::PNGCodec::EncodeBGRASkBitmap(bitmap, false, output);
 }
 
+void SetFaviconDataWithOneBitmap(const GURL& icon_url,
+                                 history::IconType icon_type,
+                                 bool expired,
+                                 history::FaviconData* favicon_data) {
+  scoped_refptr<base::RefCountedBytes> data(new base::RefCountedBytes());
+  FillBitmap(gfx::kFaviconSize, gfx::kFaviconSize, &data->data());
+  history::FaviconBitmapData favicon_bitmap_data;
+  favicon_bitmap_data.expired = expired;
+  favicon_bitmap_data.bitmap_data = data;
+  favicon_bitmap_data.pixel_size = gfx::Size();
+
+  favicon_data->known_icon = true;
+  favicon_data->icon_type = icon_type;
+  favicon_data->icon_url = icon_url;
+  favicon_data->bitmaps.clear();
+  favicon_data->bitmaps.push_back(favicon_bitmap_data);
+}
+
+void SetFaviconDataWithOneBitmap(const GURL& icon_url,
+                                 history::FaviconData* favicon_data) {
+  SetFaviconDataWithOneBitmap(icon_url, history::FAVICON, false /* expired */,
+                              favicon_data);
+}
+
 // This class is used to save the download request for verifying with test case.
 // It also will be used to invoke the onDidDownload callback.
 class DownloadHandler {
  public:
   explicit DownloadHandler(TestFaviconHandler* favicon_helper)
       : favicon_helper_(favicon_helper),
         failed_(false) {
   }
 
   virtual ~DownloadHandler() {
@@ skipping 46 matching lines @@
                         const FaviconService::FaviconDataCallback& callback)
     : page_url_(page_url),
       icon_url_(icon_url),
       icon_type_(icon_type),
       callback_(callback) {
   }
 
   HistoryRequestHandler(const GURL& page_url,
                         const GURL& icon_url,
                         int icon_type,
-                        const std::vector<unsigned char>& image_data,
+                        const std::vector<unsigned char>& bitmap_data,
                         const FaviconService::FaviconDataCallback& callback)
     : page_url_(page_url),
       icon_url_(icon_url),
       icon_type_(icon_type),
-      image_data_(image_data),
+      bitmap_data_(bitmap_data),
       callback_(callback) {
   }
 
   virtual ~HistoryRequestHandler() {}
   void InvokeCallback();
 
   const GURL page_url_;
   const GURL icon_url_;
   const int icon_type_;
-  const std::vector<unsigned char> image_data_;
+  const std::vector<unsigned char> bitmap_data_;
   history::FaviconData favicon_data_;
   FaviconService::FaviconDataCallback callback_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(HistoryRequestHandler);
 };
 
 }  // namespace
 
 
@@ skipping 107 matching lines @@
   }
 
   virtual int DownloadFavicon(const GURL& image_url, int image_size) OVERRIDE {
     download_id_++;
     download_handler_->AddDownload(download_id_, image_url, image_size);
     return download_id_;
   }
 
   virtual void SetHistoryFavicon(const GURL& page_url,
                                  const GURL& icon_url,
-                                 const std::vector<unsigned char>& image_data,
+                                 const std::vector<unsigned char>& bitmap_data,
                                  history::IconType icon_type) OVERRIDE {
     history_handler_.reset(new HistoryRequestHandler(
-        page_url, icon_url,icon_type, image_data,
+        page_url, icon_url,icon_type, bitmap_data,
         FaviconService::FaviconDataCallback()));
   }
 
   virtual FaviconService* GetFaviconService() OVERRIDE {
     // Just give none NULL value, so overridden methods can be hit.
     return (FaviconService*)(1);
   }
 
   virtual bool ShouldSaveFavicon(const GURL& url) OVERRIDE {
     return true;
@@ skipping 14 matching lines @@
   scoped_ptr<DownloadHandler> download_handler_;
   scoped_ptr<HistoryRequestHandler> history_handler_;
 
   DISALLOW_COPY_AND_ASSIGN(TestFaviconHandler);
 };
 
 namespace {
 
 void HistoryRequestHandler::InvokeCallback() {
   if (!callback_.is_null())
-    callback_.Run(0, favicon_data_);
+    callback_.Run(0, favicon_data_, std::vector<GURL>());
 }
 
 void DownloadHandler::InvokeCallback() {
   SkBitmap bitmap;
   int bitmap_size = (download_->image_size > 0) ?
       download_->image_size : gfx::kFaviconSize;
   FillDataToBitmap(bitmap_size, bitmap_size, &bitmap);
   gfx::Image image(bitmap);
   favicon_helper_->OnDidDownloadFavicon(
       download_->download_id, download_->image_url, failed_, image,
@@ skipping 14 matching lines @@
                             &delegate, FaviconHandler::FAVICON);
 
   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(history::FAVICON, history_handler->icon_type_);
 
-  // Set valid icon data.
-  history_handler->favicon_data_.known_icon = true;
-  history_handler->favicon_data_.icon_type = history::FAVICON;
-  history_handler->favicon_data_.expired = false;
-  history_handler->favicon_data_.icon_url = icon_url;
-  scoped_refptr<base::RefCountedBytes> data = new base::RefCountedBytes();
-  FillBitmap(gfx::kFaviconSize, gfx::kFaviconSize, &data->data());
-  history_handler->favicon_data_.image_data = data;
+  SetFaviconDataWithOneBitmap(icon_url, &history_handler->favicon_data_);
 
   // Send history response.
   history_handler->InvokeCallback();
   // Verify FaviconHandler status
   EXPECT_TRUE(helper.GetEntry()->GetFavicon().valid);
   EXPECT_EQ(icon_url, helper.GetEntry()->GetFavicon().url);
 
   // Simulates update favicon url.
   std::vector<FaviconURL> urls;
   urls.push_back(FaviconURL(icon_url, FaviconURL::FAVICON));
@@ skipping 21 matching lines @@
 
   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(history::FAVICON, history_handler->icon_type_);
 
   // Set icon data expired
-  history_handler->favicon_data_.known_icon = true;
-  history_handler->favicon_data_.icon_type = history::FAVICON;
-  history_handler->favicon_data_.expired = true;
-  history_handler->favicon_data_.icon_url = icon_url;
+  SetFaviconDataWithOneBitmap(icon_url, history::FAVICON, true /* expired */,
+                              &history_handler->favicon_data_);
   // Send history response.
   history_handler->InvokeCallback();
   // Verify FaviconHandler status
   EXPECT_TRUE(helper.GetEntry()->GetFavicon().valid);
   EXPECT_EQ(icon_url, helper.GetEntry()->GetFavicon().url);
 
   // Simulates update favicon url.
   std::vector<FaviconURL> urls;
   urls.push_back(FaviconURL(icon_url, FaviconURL::FAVICON));
   helper.OnUpdateFaviconURL(0, urls);
@@ skipping 16 matching lines @@
   helper.set_history_handler(NULL);
 
   // Smulates download done.
   download_handler->InvokeCallback();
 
   // New icon should be saved to history backend and navigation entry.
   history_handler = helper.history_handler();
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(icon_url, history_handler->icon_url_);
   EXPECT_EQ(FaviconURL::FAVICON, history_handler->icon_type_);
-  EXPECT_LT(0U, history_handler->image_data_.size());
+  EXPECT_LT(0U, history_handler->bitmap_data_.size());
   EXPECT_EQ(page_url, history_handler->page_url_);
 
   // Verify NavigationEntry.
   EXPECT_EQ(icon_url, helper.GetEntry()->GetFavicon().url);
   EXPECT_TRUE(helper.GetEntry()->GetFavicon().valid);
   EXPECT_FALSE(helper.GetEntry()->GetFavicon().image.IsEmpty());
 }
 
 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(contents());
   Profile* profile = Profile::FromBrowserContext(
       contents()->GetBrowserContext());
   TestFaviconHandler helper(page_url, profile,
                             &delegate, FaviconHandler::FAVICON);
 
   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(history::FAVICON, history_handler->icon_type_);
 
   // Set valid icon data.
-  history_handler->favicon_data_.known_icon = true;
-  history_handler->favicon_data_.icon_type = history::FAVICON;
-  history_handler->favicon_data_.expired = false;
-  history_handler->favicon_data_.icon_url = icon_url;
-  scoped_refptr<base::RefCountedBytes> data = new base::RefCountedBytes();
-  FillBitmap(gfx::kFaviconSize, gfx::kFaviconSize, &data->data());
-  history_handler->favicon_data_.image_data = data;
+  SetFaviconDataWithOneBitmap(icon_url, &history_handler->favicon_data_);
 
   // Send history response.
   history_handler->InvokeCallback();
   // Verify FaviconHandler status.
   EXPECT_TRUE(helper.GetEntry()->GetFavicon().valid);
   EXPECT_EQ(icon_url, helper.GetEntry()->GetFavicon().url);
 
   // Reset the history_handler to verify whether new icon is requested from
   // history.
   helper.set_history_handler(NULL);
@@ skipping 34 matching lines @@
   helper.set_history_handler(NULL);
 
   // Smulates download done.
   download_handler->InvokeCallback();
 
   // New icon should be saved to history backend and navigation entry.
   history_handler = helper.history_handler();
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(new_icon_url, history_handler->icon_url_);
   EXPECT_EQ(FaviconURL::FAVICON, history_handler->icon_type_);
-  EXPECT_LT(0U, history_handler->image_data_.size());
+  EXPECT_LT(0U, history_handler->bitmap_data_.size());
   EXPECT_EQ(page_url, history_handler->page_url_);
 
   // Verify NavigationEntry.
   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, 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(contents());
   Profile* profile = Profile::FromBrowserContext(
       contents()->GetBrowserContext());
   TestFaviconHandler helper(page_url, profile,
                             &delegate, FaviconHandler::FAVICON);
 
   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(history::FAVICON, history_handler->icon_type_);
 
-  // Set valid icon data.
-  history_handler->favicon_data_.known_icon = true;
-  history_handler->favicon_data_.icon_type = history::FAVICON;
-  history_handler->favicon_data_.expired = false;
-  history_handler->favicon_data_.icon_url = icon_url;
-  scoped_refptr<base::RefCountedBytes> data = new base::RefCountedBytes();
-  FillBitmap(gfx::kFaviconSize, gfx::kFaviconSize, &data->data());
-  history_handler->favicon_data_.image_data = data;
+  SetFaviconDataWithOneBitmap(icon_url, &history_handler->favicon_data_);
 
   // Send history response.
   history_handler->InvokeCallback();
   // Verify FaviconHandler status.
   EXPECT_TRUE(helper.GetEntry()->GetFavicon().valid);
   EXPECT_EQ(icon_url, helper.GetEntry()->GetFavicon().url);
 
   // Reset the history_handler to verify whether new icon is requested from
   // history.
   helper.set_history_handler(NULL);
@@ skipping 12 matching lines @@
   ASSERT_EQ(new_icon_url, helper.GetEntry()->GetFavicon().url);
 
   // Favicon should be requested from history.
   history_handler = helper.history_handler();
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(new_icon_url, history_handler->icon_url_);
   EXPECT_EQ(FaviconURL::FAVICON, history_handler->icon_type_);
   EXPECT_EQ(page_url, history_handler->page_url_);
 
   // Simulate find icon.
-  history_handler->favicon_data_.known_icon = true;
-  history_handler->favicon_data_.icon_type = history::FAVICON;
-  history_handler->favicon_data_.expired = false;
-  history_handler->favicon_data_.icon_url = new_icon_url;
-  history_handler->favicon_data_.image_data = data;
+  SetFaviconDataWithOneBitmap(new_icon_url, &history_handler->favicon_data_);
   history_handler->InvokeCallback();
 
   // Shouldn't request download favicon
   EXPECT_FALSE(helper.download_handler()->HasDownload());
 
   // Verify the favicon status.
   EXPECT_EQ(new_icon_url, helper.GetEntry()->GetFavicon().url);
   EXPECT_TRUE(helper.GetEntry()->GetFavicon().valid);
   EXPECT_FALSE(helper.GetEntry()->GetFavicon().image.IsEmpty());
 }
@@ skipping 79 matching lines @@
   // Favicon should be requested from history.
   history_handler = helper.history_handler();
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(new_icon_url, history_handler->icon_url_);
   EXPECT_EQ(FaviconURL::TOUCH_ICON, history_handler->icon_type_);
   EXPECT_EQ(page_url, history_handler->page_url_);
 
   // Reset download handler
   download_handler->Reset();
 
-  // Smulates getting a expired icon from history.
-  history_handler->favicon_data_.known_icon = true;
-  history_handler->favicon_data_.icon_type = history::TOUCH_ICON;
-  history_handler->favicon_data_.expired = true;
-  history_handler->favicon_data_.icon_url = new_icon_url;
-  scoped_refptr<base::RefCountedBytes> data = new base::RefCountedBytes();
-  FillBitmap(gfx::kFaviconSize, gfx::kFaviconSize, &data->data());
-  history_handler->favicon_data_.image_data = data;
+  // Simulates getting a expired icon from history.
+  SetFaviconDataWithOneBitmap(new_icon_url, history::TOUCH_ICON,
+      true /* expired */, &history_handler->favicon_data_);
   history_handler->InvokeCallback();
 
   // Verify the download request.
   EXPECT_TRUE(helper.download_handler()->HasDownload());
   EXPECT_EQ(new_icon_url, download_handler->GetImageUrl());
   EXPECT_EQ(0, download_handler->GetImageSize());
 
   helper.set_history_handler(NULL);
 
   // Simulates icon being downloaded.
   download_handler->InvokeCallback();
 
   // New icon should be saved to history backend.
   history_handler = helper.history_handler();
   ASSERT_TRUE(history_handler);
   EXPECT_EQ(new_icon_url, history_handler->icon_url_);
   EXPECT_EQ(FaviconURL::TOUCH_ICON, history_handler->icon_type_);
-  EXPECT_LT(0U, history_handler->image_data_.size());
+  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(contents());
   Profile* profile = Profile::FromBrowserContext(
@@ skipping 84 matching lines @@
   download_handler->InvokeCallback();
   // The downloaded icon should be thrown away as there is favicon update.
   EXPECT_FALSE(helper.history_handler());
 
   download_handler->Reset();
 
   // Simulates getting the icon from history.
   scoped_ptr<HistoryRequestHandler> handler;
   handler.reset(new HistoryRequestHandler(page_url, latest_icon_url,
                                           history::TOUCH_ICON, callback));
-  handler->favicon_data_.known_icon = true;
-  handler->favicon_data_.expired = false;
-  handler->favicon_data_.icon_type = history::TOUCH_ICON;
-  handler->favicon_data_.icon_url = latest_icon_url;
-  scoped_refptr<base::RefCountedBytes> data = new base::RefCountedBytes();
-  FillBitmap(gfx::kFaviconSize, gfx::kFaviconSize, &data->data());
-  handler->favicon_data_.image_data = data;
-
+  SetFaviconDataWithOneBitmap(latest_icon_url, history::TOUCH_ICON,
+                              false /* expired */, &handler->favicon_data_);
   handler->InvokeCallback();
 
   // No download request.
   EXPECT_FALSE(download_handler->HasDownload());
 }
 
 TEST_F(FaviconHandlerTest, MultipleFavicon) {
   const GURL page_url("http://www.google.com");
   const GURL icon_url("http://www.google.com/favicon");
   const GURL icon_url_small("http://www.google.com/favicon_small");
   const GURL icon_url_large("http://www.google.com/favicon_large");
   const GURL icon_url_preferred1("http://www.google.com/favicon_preferred1");
   const GURL icon_url_preferred2("http://www.google.com/favicon_preferred2");
 
   TestFaviconHandlerDelegate delegate(contents());
   Profile* profile = Profile::FromBrowserContext(
       contents()->GetBrowserContext());
   TestFaviconHandler handler(page_url, profile,
                              &delegate, FaviconHandler::FAVICON);
 
   handler.FetchFavicon(page_url);
   HistoryRequestHandler* history_handler = handler.history_handler();
 
-  // Set valid icon data.
-  history_handler->favicon_data_.known_icon = true;
-  history_handler->favicon_data_.icon_type = history::FAVICON;
-  history_handler->favicon_data_.expired = false;
-  history_handler->favicon_data_.icon_url = icon_url;
-  scoped_refptr<base::RefCountedBytes> data = new base::RefCountedBytes();
-  FillBitmap(gfx::kFaviconSize, gfx::kFaviconSize, &data->data());
-  history_handler->favicon_data_.image_data = data;
+  SetFaviconDataWithOneBitmap(icon_url, &history_handler->favicon_data_);
 
   // Send history response.
   history_handler->InvokeCallback();
 
   // Simulates update with the different favicon url.
   std::vector<FaviconURL> urls;
   // Note: the code will stop making requests when an icon matching the
   // preferred size is found, so icon_url_preferred must be last.
   urls.push_back(FaviconURL(icon_url_small, FaviconURL::FAVICON));
   urls.push_back(FaviconURL(icon_url_large, FaviconURL::FAVICON));
@@ skipping 49 matching lines @@
   TestFaviconHandlerDelegate delegate(contents());
   Profile* profile = Profile::FromBrowserContext(
       contents()->GetBrowserContext());
   TestFaviconHandler handler(page_url, profile,
                              &delegate, FaviconHandler::FAVICON);
 
   handler.FetchFavicon(page_url);
   HistoryRequestHandler* history_handler = handler.history_handler();
 
   // Set valid icon data.
-  history_handler->favicon_data_.known_icon = true;
-  history_handler->favicon_data_.icon_type = history::FAVICON;
-  history_handler->favicon_data_.expired = false;
-  history_handler->favicon_data_.icon_url = icon_url;
-  scoped_refptr<base::RefCountedBytes> data = new base::RefCountedBytes();
-  FillBitmap(gfx::kFaviconSize, gfx::kFaviconSize, &data->data());
-  history_handler->favicon_data_.image_data = data;
+  SetFaviconDataWithOneBitmap(icon_url, &history_handler->favicon_data_);
+  history_handler->favicon_data_.known_icon = false;
 
   // Send history response.
   history_handler->InvokeCallback();
 
   // Simulates update with the different favicon url.
   std::vector<FaviconURL> urls;
   // Note: the code will stop making requests when an icon matching the
   // preferred size is found, so icon_url_preferred must be last.
   urls.push_back(FaviconURL(icon_url_preferred1, FaviconURL::FAVICON));
   urls.push_back(FaviconURL(icon_url_large, FaviconURL::FAVICON));
@@ skipping 14 matching lines @@
 
   // Verify correct icon size chosen.
   EXPECT_EQ(icon_url_preferred1, handler.GetEntry()->GetFavicon().url);
   EXPECT_TRUE(handler.GetEntry()->GetFavicon().valid);
   EXPECT_FALSE(handler.GetEntry()->GetFavicon().image.IsEmpty());
   EXPECT_EQ(gfx::kFaviconSize,
             handler.GetEntry()->GetFavicon().image.ToSkBitmap()->width());
 }
 
 }  // namespace.