chrome/browser/favicon_helper_unittest.cc

// Copyright (c) 2011 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 "chrome/browser/favicon_helper.h"

#include "content/browser/renderer_host/test_render_view_host.h"
#include "content/browser/tab_contents/navigation_entry.h"
#include "content/browser/tab_contents/test_tab_contents.h"
#include "ui/gfx/codec/png_codec.h"
#include "ui/gfx/favicon_size.h"

class TestFaviconHelper;

namespace {

// Fill the given bmp with valid png data.
void FillDataToBitmap(int w, int h, SkBitmap* bmp) {
  bmp->setConfig(SkBitmap::kARGB_8888_Config, w, h);
  bmp->allocPixels();

  unsigned char* src_data =
      reinterpret_cast<unsigned char*>(bmp->getAddr32(0, 0));
  for (int i = 0; i < w * h; i++) {
    src_data[i * 4 + 0] = static_cast<unsigned char>(i % 255);
    src_data[i * 4 + 1] = static_cast<unsigned char>(i % 255);
    src_data[i * 4 + 2] = static_cast<unsigned char>(i % 255);
    src_data[i * 4 + 3] = static_cast<unsigned char>(i % 255);
  }
}

// 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);
}

// 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:
  DownloadHandler(int download_id,
                  const GURL& image_url,
                  int image_size,
                  TestFaviconHelper* favicon_helper)
    : image_url_(image_url),
      image_size_(image_size),
      failed_(false),
      download_id_(download_id),
      favicon_helper_(favicon_helper) {
    FillDataToBitmap(16, 16, &bitmap_);
  }

  virtual ~DownloadHandler() {
  }

  static void UpdateFaviconURL(FaviconHelper* helper,
                               const std::vector<FaviconURL> urls);

  void InvokeCallback();

  void UpdateFaviconURL(const std::vector<FaviconURL> urls);

  const GURL image_url_;
  const int image_size_;

  // Simulates download failed or not.
  bool failed_;

 private:
  // Identified the specific download, will also be passed in
  // OnDidDownloadFavicon callback.
  int download_id_;
  TestFaviconHelper* favicon_helper_;
  SkBitmap bitmap_;

  DISALLOW_COPY_AND_ASSIGN(DownloadHandler);
};

// This class is used to save the history request for verifying with test case.
// It also will be used to simulate the history response.
class HistoryRequestHandler {
 public:
  HistoryRequestHandler(const GURL& page_url,
                        const GURL& icon_url,
                        int icon_type,
                        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,
                        FaviconService::FaviconDataCallback* callback)
    : page_url_(page_url),
      icon_url_(icon_url),
      icon_type_(icon_type),
      image_data_(image_data),
      callback_(callback) {
  }

  virtual ~HistoryRequestHandler() {
    delete callback_;
  }
  void InvokeCallback();

  const GURL page_url_;
  const GURL icon_url_;
  const int icon_type_;
  const std::vector<unsigned char> image_data_;
  history::FaviconData favicon_data_;
  FaviconService::FaviconDataCallback* callback_;

 private:
  DISALLOW_COPY_AND_ASSIGN(HistoryRequestHandler);
};

}  // namespace

// This class is used to catch the FaviconHelper's download and history request,
// and also provide the methods to access the FaviconHelper internal.
class TestFaviconHelper : public FaviconHelper {
 public:
  TestFaviconHelper(const GURL& page_url,
                    TabContents* tab_contents,
                    Type type)
    : FaviconHelper(tab_contents, type),
      download_image_size_(0),
      download_id_(0),
      tab_contents_(tab_contents){
    entry_.set_url(page_url);
  }

  virtual ~TestFaviconHelper() {
  }

  HistoryRequestHandler* history_handler() {
    return history_handler_.get();
  }

  // This method will take the ownership of the given handler.
  void set_history_handler(HistoryRequestHandler* handler) {
    history_handler_.reset(handler);
  }

  DownloadHandler* download_handler() {
    return download_handler_.get();
  }

  // This method will take the ownership of the given download_handler.
  void set_download_handler(DownloadHandler* download_handler) {
    download_handler_.reset(download_handler);
  }

  virtual NavigationEntry* GetEntry() {
    return &entry_;
  }

  const std::vector<FaviconURL>& urls() {
    return urls_;
  }

  void FetchFavicon(const GURL& url) {
    FaviconHelper::FetchFavicon(url);
  }

  // The methods to access favicon internal.
  FaviconURL* current_candidate() {
    return FaviconHelper::current_candidate();
  }

  void OnDidDownloadFavicon(int id,
                            const GURL& image_url,
                            bool errored,
                            const SkBitmap& image) {
    FaviconHelper::OnDidDownloadFavicon(id, image_url, errored, image);
  }

 protected:
  virtual void UpdateFaviconMappingAndFetch(
      const GURL& page_url,
      const GURL& icon_url,
      history::IconType icon_type,
      CancelableRequestConsumerBase* consumer,
      FaviconService::FaviconDataCallback* callback) OVERRIDE {
    history_handler_.reset(new HistoryRequestHandler(page_url, icon_url,
                                                     icon_type, callback));
  }

  virtual void GetFavicon(
      const GURL& icon_url,
      history::IconType icon_type,
      CancelableRequestConsumerBase* consumer,
      FaviconService::FaviconDataCallback* callback) OVERRIDE {
    history_handler_.reset(new HistoryRequestHandler(GURL(), icon_url,
                                                     icon_type, callback));
  }

  virtual void GetFaviconForURL(
      const GURL& page_url,
      int icon_types,
      CancelableRequestConsumerBase* consumer,
      FaviconService::FaviconDataCallback* callback) OVERRIDE {
    history_handler_.reset(new HistoryRequestHandler(page_url, GURL(),
                                                     icon_types, callback));
  }

  virtual int DownloadFavicon(const GURL& image_url, int image_size) OVERRIDE {
    download_id_++;
    download_handler_.reset(new DownloadHandler(download_id_, image_url,
                                                image_size, this));
    return download_id_;
  }

  virtual void SetHistoryFavicon(const GURL& page_url,
                                 const GURL& icon_url,
                                 const std::vector<unsigned char>& image_data,
                                 history::IconType icon_type) OVERRIDE {
    history_handler_.reset(new HistoryRequestHandler(page_url, icon_url,
        icon_type, image_data, NULL));
  }

  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;
  }

  GURL page_url_;

  GURL download_image_url_;
  int download_image_size_;

 private:
  NavigationEntry entry_;

  // The unique id of a download request. It will be returned to a
  // FaviconHelper.
  int download_id_;

  TabContents* tab_contents_;
  scoped_ptr<DownloadHandler> download_handler_;
  scoped_ptr<HistoryRequestHandler> history_handler_;

  DISALLOW_COPY_AND_ASSIGN(TestFaviconHelper);
};

namespace {

void DownloadHandler::UpdateFaviconURL(FaviconHelper* helper,
                                       const std::vector<FaviconURL> urls) {
  helper->OnUpdateFaviconURL(0, urls);
}

void DownloadHandler::UpdateFaviconURL(const std::vector<FaviconURL> urls) {
  UpdateFaviconURL(favicon_helper_, urls);
}

void DownloadHandler::InvokeCallback() {
  favicon_helper_->OnDidDownloadFavicon(download_id_, image_url_, failed_,
                                        bitmap_);
}

void HistoryRequestHandler::InvokeCallback() {
  callback_->Run(0, favicon_data_);
}

class FaviconHelperTest : public RenderViewHostTestHarness {
};

TEST_F(FaviconHelperTest, GetFaviconFromHistory) {
  const GURL page_url("http://www.google.com");
  const GURL icon_url("http://www.google.com/favicon");

  TestFaviconHelper helper(page_url, contents(), FaviconHelper::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<RefCountedBytes> data = new RefCountedBytes();
  FillBitmap(kFaviconSize, kFaviconSize, &data->data);
  history_handler->favicon_data_.image_data = data;

  // Send history response.
  history_handler->InvokeCallback();
  // Verify FaviconHelper status
  EXPECT_TRUE(helper.GetEntry()->favicon().is_valid());
  EXPECT_EQ(icon_url, helper.GetEntry()->favicon().url());

  // Simulates update favicon url.
  std::vector<FaviconURL> urls;
  urls.push_back(FaviconURL(icon_url, FaviconURL::FAVICON));
  DownloadHandler::UpdateFaviconURL(&helper, urls);

  // Verify FaviconHelper status
  EXPECT_EQ(1U, helper.urls().size());
  ASSERT_TRUE(helper.current_candidate());
  ASSERT_EQ(icon_url, helper.current_candidate()->icon_url);
  ASSERT_EQ(FaviconURL::FAVICON, helper.current_candidate()->icon_type);

  // Favicon shouldn't request to download icon.
  DownloadHandler* download_handler = helper.download_handler();
  ASSERT_FALSE(download_handler);
}

TEST_F(FaviconHelperTest, DownloadFavicon) {
  const GURL page_url("http://www.google.com");
  const GURL icon_url("http://www.google.com/favicon");

  TestFaviconHelper helper(page_url, contents(), FaviconHelper::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 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;
  // Send history response.
  history_handler->InvokeCallback();
  // Verify FaviconHelper status
  EXPECT_TRUE(helper.GetEntry()->favicon().is_valid());
  EXPECT_EQ(icon_url, helper.GetEntry()->favicon().url());

  // Simulates update favicon url.
  std::vector<FaviconURL> urls;
  urls.push_back(FaviconURL(icon_url, FaviconURL::FAVICON));
  DownloadHandler::UpdateFaviconURL(&helper, urls);

  // Verify FaviconHelper status
  EXPECT_EQ(1U, helper.urls().size());
  ASSERT_TRUE(helper.current_candidate());
  ASSERT_EQ(icon_url, helper.current_candidate()->icon_url);
  ASSERT_EQ(FaviconURL::FAVICON, helper.current_candidate()->icon_type);

  // Favicon should request to download icon now.
  DownloadHandler* download_handler = helper.download_handler();
  ASSERT_TRUE(download_handler);
  // Verify the download request.
  EXPECT_EQ(icon_url, download_handler->image_url_);
  EXPECT_EQ(kFaviconSize, download_handler->image_size_);

  // Reset the history_handler to verify whether favicon is set.
  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_EQ(page_url, history_handler->page_url_);

  // Verify NavigationEntry.
  EXPECT_EQ(icon_url, helper.GetEntry()->favicon().url());
  EXPECT_TRUE(helper.GetEntry()->favicon().is_valid());
  EXPECT_FALSE(helper.GetEntry()->favicon().bitmap().empty());
}

TEST_F(FaviconHelperTest, 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");

  TestFaviconHelper helper(page_url, contents(), FaviconHelper::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<RefCountedBytes> data = new RefCountedBytes();
  FillBitmap(kFaviconSize, kFaviconSize, &data->data);
  history_handler->favicon_data_.image_data = data;

  // Send history response.
  history_handler->InvokeCallback();
  // Verify FaviconHelper status.
  EXPECT_TRUE(helper.GetEntry()->favicon().is_valid());
  EXPECT_EQ(icon_url, helper.GetEntry()->favicon().url());

  // Reset the history_handler to verify whether new icon is requested from
  // history.
  helper.set_history_handler(NULL);

  // Simulates update with the different favicon url.
  std::vector<FaviconURL> urls;
  urls.push_back(FaviconURL(new_icon_url, FaviconURL::FAVICON));
  DownloadHandler::UpdateFaviconURL(&helper, urls);

  // Verify FaviconHelper status.
  EXPECT_EQ(1U, helper.urls().size());
  ASSERT_TRUE(helper.current_candidate());
  ASSERT_EQ(new_icon_url, helper.current_candidate()->icon_url);
  ASSERT_EQ(FaviconURL::FAVICON, helper.current_candidate()->icon_type);
  // The favicon status's url should be updated.
  ASSERT_EQ(new_icon_url, helper.GetEntry()->favicon().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 not find icon.
  history_handler->favicon_data_.known_icon = false;
  history_handler->InvokeCallback();

  // Favicon should request to download icon now.
  DownloadHandler* download_handler = helper.download_handler();
  ASSERT_TRUE(download_handler);
  // Verify the download request.
  EXPECT_EQ(new_icon_url, download_handler->image_url_);
  EXPECT_EQ(kFaviconSize, download_handler->image_size_);

  // Reset the history_handler to verify whether favicon is set.
  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_EQ(page_url, history_handler->page_url_);

  // Verify NavigationEntry.
  EXPECT_EQ(new_icon_url, helper.GetEntry()->favicon().url());
  EXPECT_TRUE(helper.GetEntry()->favicon().is_valid());
  EXPECT_FALSE(helper.GetEntry()->favicon().bitmap().empty());
}

TEST_F(FaviconHelperTest, 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");

  TestFaviconHelper helper(page_url, contents(), FaviconHelper::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<RefCountedBytes> data = new RefCountedBytes();
  FillBitmap(kFaviconSize, kFaviconSize, &data->data);
  history_handler->favicon_data_.image_data = data;

  // Send history response.
  history_handler->InvokeCallback();
  // Verify FaviconHelper status.
  EXPECT_TRUE(helper.GetEntry()->favicon().is_valid());
  EXPECT_EQ(icon_url, helper.GetEntry()->favicon().url());

  // Reset the history_handler to verify whether new icon is requested from
  // history.
  helper.set_history_handler(NULL);

  // Simulates update with the different favicon url.
  std::vector<FaviconURL> urls;
  urls.push_back(FaviconURL(new_icon_url, FaviconURL::FAVICON));
  DownloadHandler::UpdateFaviconURL(&helper, urls);

  // Verify FaviconHelper status.
  EXPECT_EQ(1U, helper.urls().size());
  ASSERT_TRUE(helper.current_candidate());
  ASSERT_EQ(new_icon_url, helper.current_candidate()->icon_url);
  ASSERT_EQ(FaviconURL::FAVICON, helper.current_candidate()->icon_type);
  // The favicon status's url should be updated.
  ASSERT_EQ(new_icon_url, helper.GetEntry()->favicon().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;
  history_handler->InvokeCallback();

  // Shouldn't request download favicon
  EXPECT_FALSE(helper.download_handler());

  // Verify the favicon status.
  EXPECT_EQ(new_icon_url, helper.GetEntry()->favicon().url());
  EXPECT_TRUE(helper.GetEntry()->favicon().is_valid());
  EXPECT_FALSE(helper.GetEntry()->favicon().bitmap().empty());
}

TEST_F(FaviconHelperTest, 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");

  TestFaviconHelper helper(page_url, contents(), FaviconHelper::TOUCH);

  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::TOUCH_PRECOMPOSED_ICON | history::TOUCH_ICON,
            history_handler->icon_type_);

  // Icon not found.
  history_handler->favicon_data_.known_icon = false;
  // Send history response.
  history_handler->InvokeCallback();
  // Verify FaviconHelper status.
  EXPECT_FALSE(helper.GetEntry()->favicon().is_valid());
  EXPECT_EQ(GURL(), helper.GetEntry()->favicon().url());

  // Reset the history_handler to verify whether new icon is requested from
  // history.
  helper.set_history_handler(NULL);

  // Simulates update with the different favicon url.
  std::vector<FaviconURL> urls;
  urls.push_back(FaviconURL(icon_url, FaviconURL::TOUCH_PRECOMPOSED_ICON));
  urls.push_back(FaviconURL(new_icon_url, FaviconURL::TOUCH_ICON));
  urls.push_back(FaviconURL(new_icon_url, FaviconURL::FAVICON));

  DownloadHandler::UpdateFaviconURL(&helper, urls);

  // Verify FaviconHelper status.
  EXPECT_EQ(2U, helper.urls().size());
  ASSERT_TRUE(helper.current_candidate());
  ASSERT_EQ(icon_url, helper.current_candidate()->icon_url);
  ASSERT_EQ(FaviconURL::TOUCH_PRECOMPOSED_ICON,
            helper.current_candidate()->icon_type);

  // Favicon should be requested from history.
  history_handler = helper.history_handler();
  ASSERT_TRUE(history_handler);
  EXPECT_EQ(icon_url, history_handler->icon_url_);
  EXPECT_EQ(FaviconURL::TOUCH_PRECOMPOSED_ICON, history_handler->icon_type_);
  EXPECT_EQ(page_url, history_handler->page_url_);

  // Simulate not find icon.
  history_handler->favicon_data_.known_icon = false;
  history_handler->InvokeCallback();

  // Should request download favicon.
  DownloadHandler* download_handler = helper.download_handler();
  EXPECT_TRUE(download_handler);
  // Verify the download request.
  EXPECT_EQ(icon_url, download_handler->image_url_);
  EXPECT_EQ(0, download_handler->image_size_);

  // Reset the history_handler to verify whether favicon is request from
  // history.
  helper.set_history_handler(NULL);
  // Smulates download failed.
  download_handler->failed_ = true;
  download_handler->InvokeCallback();

  // Left 1 url.
  EXPECT_EQ(1U, helper.urls().size());
  ASSERT_TRUE(helper.current_candidate());
  EXPECT_EQ(new_icon_url, helper.current_candidate()->icon_url);
  EXPECT_EQ(FaviconURL::TOUCH_ICON, helper.current_candidate()->icon_type);

  // 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
  helper.set_download_handler(NULL);

  // 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<RefCountedBytes> data = new RefCountedBytes();
  FillBitmap(kFaviconSize, kFaviconSize, &data->data);
  history_handler->favicon_data_.image_data = data;
  history_handler->InvokeCallback();

  // Verify the download request.
  download_handler = helper.download_handler();
  EXPECT_TRUE(download_handler);
  EXPECT_EQ(new_icon_url, download_handler->image_url_);
  EXPECT_EQ(0, download_handler->image_size_);

  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_EQ(page_url, history_handler->page_url_);
}

TEST_F(FaviconHelperTest, 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");

  TestFaviconHelper helper(page_url, contents(), FaviconHelper::TOUCH);

  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::TOUCH_PRECOMPOSED_ICON | history::TOUCH_ICON,
            history_handler->icon_type_);

  // Icon not found.
  history_handler->favicon_data_.known_icon = false;
  // Send history response.
  history_handler->InvokeCallback();
  // Verify FaviconHelper status.
  EXPECT_FALSE(helper.GetEntry()->favicon().is_valid());
  EXPECT_EQ(GURL(), helper.GetEntry()->favicon().url());

  // Reset the history_handler to verify whether new icon is requested from
  // history.
  helper.set_history_handler(NULL);

  // Simulates update with the different favicon url.
  std::vector<FaviconURL> urls;
  urls.push_back(FaviconURL(icon_url, FaviconURL::TOUCH_PRECOMPOSED_ICON));
  urls.push_back(FaviconURL(new_icon_url, FaviconURL::TOUCH_ICON));
  urls.push_back(FaviconURL(new_icon_url, FaviconURL::FAVICON));

  DownloadHandler::UpdateFaviconURL(&helper, urls);

  // Verify FaviconHelper status.
  EXPECT_EQ(2U, helper.urls().size());
  ASSERT_TRUE(helper.current_candidate());
  ASSERT_EQ(icon_url, helper.current_candidate()->icon_url);
  ASSERT_EQ(FaviconURL::TOUCH_PRECOMPOSED_ICON,
            helper.current_candidate()->icon_type);

  // Favicon should be requested from history.
  history_handler = helper.history_handler();
  ASSERT_TRUE(history_handler);
  EXPECT_EQ(icon_url, history_handler->icon_url_);
  EXPECT_EQ(FaviconURL::TOUCH_PRECOMPOSED_ICON, history_handler->icon_type_);
  EXPECT_EQ(page_url, history_handler->page_url_);

  // Simulate not find icon.
  history_handler->favicon_data_.known_icon = false;
  history_handler->InvokeCallback();

  // Should request download favicon.
  DownloadHandler* download_handler = helper.download_handler();
  EXPECT_TRUE(download_handler);
  // Verify the download request.
  EXPECT_EQ(icon_url, download_handler->image_url_);
  EXPECT_EQ(0, download_handler->image_size_);

  // Reset the history_handler to verify whether favicon is request from
  // history.
  helper.set_history_handler(NULL);
  const GURL latest_icon_url("http://www.google.com/latest_favicon");
  std::vector<FaviconURL> latest_urls;
  latest_urls.push_back(FaviconURL(latest_icon_url, FaviconURL::TOUCH_ICON));
  DownloadHandler::UpdateFaviconURL(&helper, latest_urls);
  EXPECT_EQ(1U, helper.urls().size());
  EXPECT_EQ(latest_icon_url, helper.current_candidate()->icon_url);
  EXPECT_EQ(FaviconURL::TOUCH_ICON, helper.current_candidate()->icon_type);

  // Whether new icon is requested from history
  history_handler = helper.history_handler();
  ASSERT_TRUE(history_handler);
  EXPECT_EQ(latest_icon_url, history_handler->icon_url_);
  EXPECT_EQ(FaviconURL::TOUCH_ICON, history_handler->icon_type_);
  EXPECT_EQ(page_url, history_handler->page_url_);

  // Reset the history_handler to verify whether favicon is request from
  // history.
  // Save the callback for late use.
  FaviconService::FaviconDataCallback* callback = history_handler->callback_;
  // Prevent the callback from being released.
  history_handler->callback_ = NULL;
  helper.set_history_handler(NULL);

  // Smulates download succeed.
  download_handler->InvokeCallback();
  // The downloaded icon should be thrown away as there is faviocn update.
  EXPECT_FALSE(helper.history_handler());

  helper.set_download_handler(NULL);

  // Smulates 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<RefCountedBytes> data = new RefCountedBytes();
  FillBitmap(kFaviconSize, kFaviconSize, &data->data);
  handler->favicon_data_.image_data = data;

  handler->InvokeCallback();

  // No download request.
  EXPECT_FALSE(helper.download_handler());
}

}  // namespace.