Always select best favicon bitmap

components/favicon/core/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 "components/favicon/core/favicon_handler.h"
 
 #include <stddef.h>
 
+#include <map>
 #include <memory>
 #include <set>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "base/strings/stringprintf.h"
 #include "components/favicon/core/favicon_driver.h"
@@ skipping 862 matching lines @@
   const GURL kInvalidFormatURL("invalid");
   ASSERT_TRUE(kInvalidFormatURL.is_empty());
 
   EXPECT_CALL(delegate_, OnFaviconUpdated(_, _, _, _, _)).Times(0);
 
   RunHandlerWithSimpleFaviconCandidates({kInvalidFormatURL});
   EXPECT_THAT(delegate_.downloads(), IsEmpty());
 }
 
 TEST_F(FaviconHandlerTest, TestSortFavicon) {
+  // Names represent the bitmap sizes per icon.
+  const GURL kIconURL1_17("http://www.google.com/a");
+  const GURL kIconURL1024_512("http://www.google.com/b");
+  const GURL kIconURL16_14("http://www.google.com/c");
+  const GURL kIconURLWithoutSize1("http://www.google.com/d");
+  const GURL kIconURLWithoutSize2("http://www.google.com/e");
+
   const std::vector<favicon::FaviconURL> kSourceIconURLs{
-      FaviconURL(GURL("http://www.google.com/a"), FAVICON,
-                 {gfx::Size(1, 1), gfx::Size(17, 17)}),
-      FaviconURL(GURL("http://www.google.com/b"), FAVICON,
+      FaviconURL(kIconURL1_17, FAVICON, {gfx::Size(1, 1), gfx::Size(17, 17)}),
+      FaviconURL(kIconURL1024_512, FAVICON,
                  {gfx::Size(1024, 1024), gfx::Size(512, 512)}),
-      FaviconURL(GURL("http://www.google.com/c"), FAVICON,
+      FaviconURL(kIconURL16_14, FAVICON,
                  {gfx::Size(16, 16), gfx::Size(14, 14)}),
-      FaviconURL(GURL("http://www.google.com/d"), FAVICON, kEmptySizes),
-      FaviconURL(GURL("http://www.google.com/e"), FAVICON, kEmptySizes)};
+      FaviconURL(kIconURLWithoutSize1, FAVICON, kEmptySizes),
+      FaviconURL(kIconURLWithoutSize2, FAVICON, kEmptySizes)};
 
   std::unique_ptr<FaviconHandler> handler = RunHandlerWithCandidates(
       FaviconDriverObserver::NON_TOUCH_LARGEST, kSourceIconURLs);
 
-  struct ExpectedResult {
-    // The favicon's index in kSourceIconURLs.
-    size_t favicon_index;
-    // Width of largest bitmap.
-    int width;
-  } results[] = {
-      // First is icon2, though its size larger than maximal.
-      {1, 1024},
-      // Second is icon1
-      // The 17x17 is largest.
-      {0, 17},
-      // Third is icon3.
-      // The 16x16 is largest.
-      {2, 16},
-      // The rest of bitmaps come in order, there is no "sizes" attribute.
-      {3, -1},
-      {4, -1},
-  };
-  const std::vector<FaviconURL>& icons = handler->image_urls();
-  ASSERT_EQ(5u, icons.size());
-  for (size_t i = 0; i < icons.size(); ++i) {
-    EXPECT_EQ(kSourceIconURLs[results[i].favicon_index].icon_url,
-              icons[i].icon_url);
-    if (results[i].width != -1)
-      EXPECT_EQ(results[i].width, icons[i].icon_sizes[0].width());
-  }
+  EXPECT_THAT(
+      handler->GetIconURLs(),
+      ElementsAre(
+          // The 512x512 bitmap is the best match for the desired size.
+          kIconURL1024_512, kIconURL1_17, kIconURL16_14,
+          // The rest of bitmaps come in order, there is no "sizes" attribute.
+          kIconURLWithoutSize1, kIconURLWithoutSize2));
 }
 
 TEST_F(FaviconHandlerTest, TestDownloadLargestFavicon) {
   // Names represent the bitmap sizes per icon.
   const GURL kIconURL1024_512("http://www.google.com/a");
   const GURL kIconURL15_14("http://www.google.com/b");
   const GURL kIconURL16_512("http://www.google.com/c");
   const GURL kIconURLWithoutSize1("http://www.google.com/d");
   const GURL kIconURLWithoutSize2("http://www.google.com/e");
 
@@ skipping 32 matching lines @@
 
   RunHandlerWithCandidates(
       FaviconDriverObserver::NON_TOUCH_LARGEST,
       {FaviconURL(kIconURL1, FAVICON, {gfx::Size(15, 15)}),
        FaviconURL(kIconURL2, FAVICON, {gfx::Size(14, 14), gfx::Size(16, 16)})});
 
   EXPECT_THAT(delegate_.downloads(), ElementsAre(kIconURL2));
 }
 
 TEST_F(FaviconHandlerTest, TestFaviconWasScaledAfterDownload) {
-  const int kMaximalSize = FaviconHandler::GetMaximalIconSize(FAVICON);
+  const int kMaximalSize = FaviconHandler::GetMaximalIconSize(
+      FaviconDriverObserver::NON_TOUCH_LARGEST);
 
   const GURL kIconURL1("http://www.google.com/b");
   const GURL kIconURL2("http://www.google.com/c");
 
   const int kOriginalSize1 = kMaximalSize + 1;
   const int kOriginalSize2 = kMaximalSize + 2;
 
   delegate_.fake_downloader().AddWithOriginalSizes(
       kIconURL1, IntVector{kMaximalSize}, IntVector{kOriginalSize1});
   delegate_.fake_downloader().AddWithOriginalSizes(
       kIconURL2, IntVector{kMaximalSize}, IntVector{kOriginalSize2});
 
-  // Verify the largest bitmap was selected although it was scaled down to
-  // maximal size and smaller than |kIconURL1| now.
+  // Verify the best bitmap was selected (although smaller than |kIconURL2|)
+  // and that it was scaled down to |kMaximalSize|.
   EXPECT_CALL(delegate_,
-              OnFaviconUpdated(_, _, kIconURL2, _,
+              OnFaviconUpdated(_, _, kIconURL1, _,
                                ImageSizeIs(kMaximalSize, kMaximalSize)));
 
   RunHandlerWithCandidates(
       FaviconDriverObserver::NON_TOUCH_LARGEST,
       {FaviconURL(kIconURL1, FAVICON,
                   SizeVector{gfx::Size(kOriginalSize1, kOriginalSize1)}),
        FaviconURL(kIconURL2, FAVICON,
                   SizeVector{gfx::Size(kOriginalSize2, kOriginalSize2)})});
 
-  EXPECT_THAT(delegate_.downloads(), ElementsAre(kIconURL2));
+  EXPECT_THAT(delegate_.downloads(), ElementsAre(kIconURL1));
 }
 
 // Test that if several icons are downloaded because the icons are smaller than
 // expected that OnFaviconUpdated() is called with the largest downloaded
 // bitmap.
 TEST_F(FaviconHandlerTest, TestKeepDownloadedLargestFavicon) {
   EXPECT_CALL(delegate_,
               OnFaviconUpdated(_, _, kIconURL12x12, _, ImageSizeIs(12, 12)));
 
   RunHandlerWithCandidates(
       FaviconDriverObserver::NON_TOUCH_LARGEST,
       {FaviconURL(kIconURL10x10, FAVICON, SizeVector{gfx::Size(16, 16)}),
        FaviconURL(kIconURL12x12, FAVICON, SizeVector{gfx::Size(15, 15)}),
        FaviconURL(kIconURL16x16, FAVICON, kEmptySizes)});
 }
 
 }  // namespace
 }  // namespace favicon