Rename best icon to best primary icon in Web app related code.

chrome/browser/android/webapk/webapk_installer_unittest.cc

 // Copyright 2016 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/android/webapk/webapk_installer.h"
 
 #include <jni.h>
 #include <memory>
 #include <string>
 
@@ skipping 21 matching lines @@
 #include "url/gurl.h"
 
 namespace {
 
 const base::FilePath::CharType kTestDataDir[] =
     FILE_PATH_LITERAL("chrome/test/data");
 
 // URL of mock WebAPK server.
 const char* kServerUrl = "/webapkserver/";
 
-// The best icon URL from Web Manifest. We use a random file in the test data
-// directory. Since WebApkInstaller does not try to decode the file as an image
-// it is OK that the file is not an image.
-const char* kBestIconUrl = "/simple.html";
+// The best primary icon URL from Web Manifest. We use a random file in the test
+// data directory. Since WebApkInstaller does not try to decode the file as an
+// image it is OK that the file is not an image.
+const char* kBestPrimaryIconUrl = "/simple.html";
 
 // URL of file to download from the WebAPK server. We use a random file in the
 // test data directory.
 const char* kDownloadUrl = "/simple.html";
 
 // The package name of the downloaded WebAPK.
 const char* kDownloadedWebApkPackageName = "party.unicode";
 
 // WebApkInstaller subclass where
 // WebApkInstaller::StartInstallingDownloadedWebApk() and
@@ skipping 46 matching lines @@
   // available.
   bool can_use_google_play_install_service_;
 
   DISALLOW_COPY_AND_ASSIGN(TestWebApkInstaller);
 };
 
 // Runs the WebApkInstaller installation process/update and blocks till done.
 class WebApkInstallerRunner {
  public:
   WebApkInstallerRunner(content::BrowserContext* browser_context,
-                        const GURL& best_icon_url)
+                        const GURL& best_primary_icon_url)
       : browser_context_(browser_context),
-        best_icon_url_(best_icon_url),
+        best_primary_icon_url_(best_primary_icon_url),
         can_use_google_play_install_service_(false) {}
 
   ~WebApkInstallerRunner() {}
 
   void SetCanUseGooglePlayInstallService(
       bool can_use_google_play_install_service) {
     can_use_google_play_install_service_ = can_use_google_play_install_service;
   }
 
   void RunInstallWebApk() {
     WebApkInstaller::InstallAsyncForTesting(
-        CreateWebApkInstaller(),
-        base::Bind(&WebApkInstallerRunner::OnCompleted,
-                   base::Unretained(this)));
+        CreateWebApkInstaller(), base::Bind(&WebApkInstallerRunner::OnCompleted,
+                                            base::Unretained(this)));
     Run();
   }
 
   void RunUpdateWebApk() {
     const int kWebApkVersion = 1;
 
-    std::map<std::string, std::string> icon_url_to_murmur2_hash {
-      {best_icon_url_.spec(), "0"} };
+    std::map<std::string, std::string> icon_url_to_murmur2_hash{
+        {best_primary_icon_url_.spec(), "0"}};
 
     WebApkInstaller::UpdateAsyncForTesting(
-        CreateWebApkInstaller(),
-        kDownloadedWebApkPackageName,
-        kWebApkVersion,
-        icon_url_to_murmur2_hash,
-        false /* is_manifest_stale */,
+        CreateWebApkInstaller(), kDownloadedWebApkPackageName, kWebApkVersion,
+        icon_url_to_murmur2_hash, false /* is_manifest_stale */,
         base::Bind(&WebApkInstallerRunner::OnCompleted,
                    base::Unretained(this)));
     Run();
   }
 
   WebApkInstaller* CreateWebApkInstaller() {
     ShortcutInfo info(GURL::EmptyGURL());
-    info.best_icon_url = best_icon_url_;
+    info.best_primary_icon_url = best_primary_icon_url_;
 
     // WebApkInstaller owns itself.
     WebApkInstaller* installer =
         new TestWebApkInstaller(browser_context_, info, SkBitmap(),
                                 can_use_google_play_install_service_);
     installer->SetTimeoutMs(100);
     return installer;
   }
 
   void Run() {
     base::RunLoop run_loop;
     on_completed_callback_ = run_loop.QuitClosure();
     run_loop.Run();
   }
 
   bool success() { return success_; }
 
  private:
   void OnCompleted(bool success, const std::string& webapk_package) {
     success_ = success;
     on_completed_callback_.Run();
   }
 
   content::BrowserContext* browser_context_;
 
   // The Web Manifest's icon URL.
-  const GURL best_icon_url_;
+  const GURL best_primary_icon_url_;
 
   // Called after the installation process has succeeded or failed.
   base::Closure on_completed_callback_;
 
   // Whether the installation process succeeded.
   bool success_;
 
   // Whether Google Play Service can be used and the install delegate is
   // available.
   bool can_use_google_play_install_service_;
@@ skipping 21 matching lines @@
 
 // Builds WebApk proto and blocks till done.
 class BuildProtoRunner {
  public:
   explicit BuildProtoRunner(content::BrowserContext* browser_context)
       : browser_context_(browser_context) {}
 
   ~BuildProtoRunner() {}
 
   void BuildSync(
-      const GURL& best_icon_url,
+      const GURL& best_primary_icon_url,
       const std::map<std::string, std::string>& icon_url_to_murmur2_hash,
       bool is_manifest_stale) {
     ShortcutInfo info(GURL::EmptyGURL());
-    info.best_icon_url = best_icon_url;
+    info.best_primary_icon_url = best_primary_icon_url;
 
     // WebApkInstaller owns itself.
     WebApkInstaller* installer =
         new TestWebApkInstaller(browser_context_, info, SkBitmap(), false);
     installer->BuildWebApkProtoInBackgroundForTesting(
         base::Bind(&BuildProtoRunner::OnBuiltWebApkProto,
                    base::Unretained(this)),
-        icon_url_to_murmur2_hash,
-        is_manifest_stale);
+        icon_url_to_murmur2_hash, is_manifest_stale);
 
     base::RunLoop run_loop;
     on_completed_callback_ = run_loop.QuitClosure();
     run_loop.Run();
   }
 
   webapk::WebApk* GetWebApkRequest() { return webapk_request_.get(); }
 
  private:
   // Called when the |webapk_request_| is populated.
@@ skipping 19 matching lines @@
  public:
   typedef base::Callback<std::unique_ptr<net::test_server::HttpResponse>(void)>
       WebApkResponseBuilder;
 
   WebApkInstallerTest()
       : thread_bundle_(content::TestBrowserThreadBundle::IO_MAINLOOP) {}
   ~WebApkInstallerTest() override {}
 
   void SetUp() override {
     test_server_.AddDefaultHandlers(base::FilePath(kTestDataDir));
-    test_server_.RegisterRequestHandler(
-        base::Bind(&WebApkInstallerTest::HandleWebApkRequest,
-                   base::Unretained(this)));
+    test_server_.RegisterRequestHandler(base::Bind(
+        &WebApkInstallerTest::HandleWebApkRequest, base::Unretained(this)));
     ASSERT_TRUE(test_server_.Start());
 
     profile_.reset(new TestingProfile());
 
     SetDefaults();
   }
 
   void TearDown() override {
     profile_.reset();
     base::RunLoop().RunUntilIdle();
   }
 
-  // Sets the best Web Manifest's icon URL.
-  void SetBestIconUrl(const GURL& best_icon_url) {
-    best_icon_url_ = best_icon_url;
+  // Sets the best Web Manifest's primary icon URL.
+  void SetBestPrimaryIconUrl(const GURL& best_primary_icon_url) {
+    best_primary_icon_url_ = best_primary_icon_url;
   }
 
   // Sets the URL to send the webapk::CreateWebApkRequest to. WebApkInstaller
   // should fail if the URL is not |kServerUrl|.
   void SetWebApkServerUrl(const GURL& server_url) {
     base::CommandLine::ForCurrentProcess()->AppendSwitchASCII(
         switches::kWebApkServerUrl, server_url.spec());
   }
 
   // Sets the function that should be used to build the response to the
   // WebAPK creation request.
   void SetWebApkResponseBuilder(const WebApkResponseBuilder& builder) {
     webapk_response_builder_ = builder;
   }
 
   std::unique_ptr<WebApkInstallerRunner> CreateWebApkInstallerRunner() {
     return std::unique_ptr<WebApkInstallerRunner>(
-        new WebApkInstallerRunner(profile_.get(), best_icon_url_));
+        new WebApkInstallerRunner(profile_.get(), best_primary_icon_url_));
   }
 
   std::unique_ptr<BuildProtoRunner> CreateBuildProtoRunner() {
     return std::unique_ptr<BuildProtoRunner>(
         new BuildProtoRunner(profile_.get()));
   }
 
   net::test_server::EmbeddedTestServer* test_server() { return &test_server_; }
 
  private:
   // Sets default configuration for running WebApkInstaller.
   void SetDefaults() {
-    GURL best_icon_url = test_server_.GetURL(kBestIconUrl);
-    SetBestIconUrl(best_icon_url);
+    GURL best_primary_icon_url = test_server_.GetURL(kBestPrimaryIconUrl);
+    SetBestPrimaryIconUrl(best_primary_icon_url);
     GURL server_url = test_server_.GetURL(kServerUrl);
     SetWebApkServerUrl(server_url);
     GURL download_url = test_server_.GetURL(kDownloadUrl);
     SetWebApkResponseBuilder(
         base::Bind(&BuildValidWebApkResponse, download_url));
   }
 
   std::unique_ptr<net::test_server::HttpResponse> HandleWebApkRequest(
       const net::test_server::HttpRequest& request) {
     return (request.relative_url == kServerUrl)
                ? webapk_response_builder_.Run()
                : std::unique_ptr<net::test_server::HttpResponse>();
   }
 
   std::unique_ptr<TestingProfile> profile_;
   content::TestBrowserThreadBundle thread_bundle_;
   net::EmbeddedTestServer test_server_;
 
   // Web Manifest's icon URL.
-  GURL best_icon_url_;
+  GURL best_primary_icon_url_;
 
   // Builds response to the WebAPK creation request.
   WebApkResponseBuilder webapk_response_builder_;
 
   DISALLOW_COPY_AND_ASSIGN(WebApkInstallerTest);
 };
 
 // Test installation succeeding.
 TEST_F(WebApkInstallerTest, Success) {
   std::unique_ptr<WebApkInstallerRunner> runner = CreateWebApkInstallerRunner();
   runner->RunInstallWebApk();
   EXPECT_TRUE(runner->success());
 }
 
-// Test that installation fails if fetching the bitmap at the best icon URL
-// times out. In a perfect world the fetch would never time out because the
-// bitmap at the best icon URL should be in the HTTP cache.
-TEST_F(WebApkInstallerTest, BestIconUrlDownloadTimesOut) {
-  GURL best_icon_url = test_server()->GetURL("/slow?1000");
-  SetBestIconUrl(best_icon_url);
+// Test that installation fails if fetching the bitmap at the best primary icon
+// URL times out. In a perfect world the fetch would never time out because the
+// bitmap at the best primary icon URL should be in the HTTP cache.
+TEST_F(WebApkInstallerTest, BestPrimaryIconUrlDownloadTimesOut) {
+  GURL best_primary_icon_url = test_server()->GetURL("/slow?1000");
+  SetBestPrimaryIconUrl(best_primary_icon_url);
 
   std::unique_ptr<WebApkInstallerRunner> runner = CreateWebApkInstallerRunner();
   runner->RunInstallWebApk();
   EXPECT_FALSE(runner->success());
 }
 
 // Test that installation fails if the WebAPK creation request times out.
 TEST_F(WebApkInstallerTest, CreateWebApkRequestTimesOut) {
   GURL server_url = test_server()->GetURL("/slow?1000");
   SetWebApkServerUrl(server_url);
@@ skipping 55 matching lines @@
 }
 
 // Test installation succeeds using Google Play.
 TEST_F(WebApkInstallerTest, InstallFromGooglePlaySuccess) {
   std::unique_ptr<WebApkInstallerRunner> runner = CreateWebApkInstallerRunner();
   runner->SetCanUseGooglePlayInstallService(true);
   runner->RunInstallWebApk();
   EXPECT_TRUE(runner->success());
 }
 
-// When there is no Web Manifest available for a site, an empty |best_icon_url|
+// When there is no Web Manifest available for a site, an empty
+// |best_primary_icon_url|

[dominickn, 2017/02/02 23:34:13]

Nit: comment formatting

[F, 2017/02/03 00:47:15]

Done. Thanks!

 // is used to build a WebApk update request. Tests the request can be built
 // properly.
 TEST_F(WebApkInstallerTest, BuildWebApkProtoWhenManifestIsObsolete) {
   GURL icon_url_1 = test_server()->GetURL("/icon1.png");
   GURL icon_url_2 = test_server()->GetURL("/icon2.png");
   std::string icon_murmur2_hash_1 = "1";
   std::string icon_murmur2_hash_2 = "2";
   std::map<std::string, std::string> icon_url_to_murmur2_hash;
   icon_url_to_murmur2_hash[icon_url_1.spec()] = icon_murmur2_hash_1;
   icon_url_to_murmur2_hash[icon_url_2.spec()] = icon_murmur2_hash_2;
@@ skipping 21 matching lines @@
 
   EXPECT_EQ(icon_url_2.spec(), icons[2].src());
   EXPECT_EQ(icon_murmur2_hash_2, icons[2].hash());
   EXPECT_FALSE(icons[2].has_image_data());
 }
 
 // Tests a WebApk install or update request is built properly when the Chrome
 // knows the best icon URL of a site after fetching its Web Manifest.
 TEST_F(WebApkInstallerTest, BuildWebApkProtoWhenManifestIsAvailable) {
   GURL icon_url_1 = test_server()->GetURL("/icon.png");
-  GURL best_icon_url = test_server()->GetURL(kBestIconUrl);
+  GURL best_primary_icon_url = test_server()->GetURL(kBestPrimaryIconUrl);
   std::string icon_murmur2_hash_1 = "1";
-  std::string best_icon_murmur2_hash = "0";
+  std::string best_primary_icon_murmur2_hash = "0";
   std::map<std::string, std::string> icon_url_to_murmur2_hash;
   icon_url_to_murmur2_hash[icon_url_1.spec()] = icon_murmur2_hash_1;
-  icon_url_to_murmur2_hash[best_icon_url.spec()] =
-      best_icon_murmur2_hash;
+  icon_url_to_murmur2_hash[best_primary_icon_url.spec()] =
+      best_primary_icon_murmur2_hash;
 
   std::unique_ptr<BuildProtoRunner> runner = CreateBuildProtoRunner();
-  runner->BuildSync(best_icon_url, icon_url_to_murmur2_hash,
+  runner->BuildSync(best_primary_icon_url, icon_url_to_murmur2_hash,
                     false /* is_manifest_stale*/);
   webapk::WebApk* webapk_request = runner->GetWebApkRequest();
   ASSERT_NE(nullptr, webapk_request);
 
   webapk::WebAppManifest manifest = webapk_request->manifest();
   ASSERT_EQ(2, manifest.icons_size());
 
   webapk::Image icons[2];
   for (int i = 0; i < 2; ++i)
     icons[i] = manifest.icons(i);
 
-  EXPECT_EQ(best_icon_url.spec(), icons[0].src());
-  EXPECT_EQ(best_icon_murmur2_hash, icons[0].hash());
+  EXPECT_EQ(best_primary_icon_url.spec(), icons[0].src());
+  EXPECT_EQ(best_primary_icon_murmur2_hash, icons[0].hash());
   EXPECT_TRUE(icons[0].has_image_data());
 
   EXPECT_EQ(icon_url_1.spec(), icons[1].src());
   EXPECT_EQ(icon_murmur2_hash_1, icons[1].hash());
   EXPECT_FALSE(icons[1].has_image_data());
 }