Fix the path of shortcuts with an icon in the current install dir.

chrome/installer/setup/install_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 <objbase.h>
 #include <stddef.h>
 
 #include <string>
 
 #include "base/base_paths.h"
 #include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/macros.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/path_service.h"
 #include "base/strings/string16.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/test/scoped_path_override.h"
 #include "base/test/test_shortcut_win.h"
 #include "base/version.h"
 #include "base/win/shortcut.h"
 #include "chrome/installer/setup/install.h"
 #include "chrome/installer/setup/install_worker.h"
 #include "chrome/installer/setup/setup_constants.h"
 #include "chrome/installer/util/browser_distribution.h"
 #include "chrome/installer/util/install_util.h"
 #include "chrome/installer/util/installer_state.h"
 #include "chrome/installer/util/master_preferences.h"
 #include "chrome/installer/util/master_preferences_constants.h"
 #include "chrome/installer/util/product.h"
 #include "chrome/installer/util/shell_util.h"
 #include "chrome/installer/util/util_constants.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 
+base::FilePath GetNormalizedFilePath(const base::FilePath& path) {
+  base::FilePath normalized_path;
+  ASSERT_TRUE(base::NormalizeFilePath(path, &normalized_path));
+  return normalized_path;
+}
+
 class CreateVisualElementsManifestTest : public testing::Test {
  protected:
   void SetUp() override {
     // Create a temp directory for testing.
     ASSERT_TRUE(test_dir_.CreateUniqueTempDir());
 
     version_ = Version("0.0.0.0");
 
     version_dir_ = test_dir_.path().AppendASCII(version_.GetString());
     ASSERT_TRUE(base::CreateDirectory(version_dir_));
@@ skipping 15 matching lines @@
 
   // The path to |test_dir_|\|version_|.
   base::FilePath version_dir_;
 
   // The path to VisualElementsManifest.xml.
   base::FilePath manifest_path_;
 };
 
 class InstallShortcutTest : public testing::Test {
  protected:
+  struct UpdateShortcutsTestCase {
+    const base::FilePath::CharType* target_path;
+    const base::FilePath::CharType* icon_path;

[gab, 2016/03/18 16:21:24]

Comments on each member's meaning (relative path, etc.) and whether it's
optional (can be null)

[fdoray, 2016/03/18 17:01:01]

Done.

+    bool should_update;
+  };
+
   void SetUp() override {
     EXPECT_EQ(S_OK, CoInitialize(NULL));
 
     dist_ = BrowserDistribution::GetDistribution();
     ASSERT_TRUE(dist_ != NULL);
     product_.reset(new installer::Product(dist_));
 
     ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
     chrome_exe_ = temp_dir_.path().Append(installer::kChromeExe);
     EXPECT_EQ(0, base::WriteFile(chrome_exe_, "", 0));
@@ skipping 86 matching lines @@
       master_prefs += (i == 0 ? "\"" : ",\"");
       master_prefs += desired_prefs[i].pref_name;
       master_prefs += "\":";
       master_prefs += desired_prefs[i].is_desired ? "true" : "false";
     }
     master_prefs += "}}";
 
     return new installer::MasterPreferences(master_prefs);
   }
 
+  // Creates the shortcuts defined by |test_cases|. Tries to update the target
+  // path of these shortcuts to |new_target_path| using

[gab, 2016/03/18 16:21:24]

|new_target_path_relative|

[fdoray, 2016/03/18 17:01:01]

Done.

+  // UpdatePerUserShortcutsInLocation(). Verifies that the right shortcuts have
+  // been updated.
+  void TestUpdateShortcuts(const UpdateShortcutsTestCase* test_cases,
+                           size_t num_test_cases,
+                           const base::FilePath& new_target_path_relative) {
+    // Create shortcuts.
+    for (size_t i = 0; i < num_test_cases; ++i) {
+      // Make sure that the target exists.
+      const base::FilePath target_path =
+          temp_dir_.path().Append(test_cases[i].target_path);
+      ASSERT_TRUE(base::CreateDirectory(target_path.DirName()));
+      base::File file(target_path,
+                      base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE);
+      ASSERT_TRUE(file.IsValid());
+      static const char kDummyData[] = "dummy";
+      ASSERT_EQ(arraysize(kDummyData),
+                file.WriteAtCurrentPos(kDummyData, arraysize(kDummyData)));

[gab, 2016/03/18 16:21:25]

Wrap lines 204-210 in
if (!base::PathExists(target_path)) {}

[fdoray, 2016/03/18 17:01:01]

Done.

+
+      // Create the shortcut.
+      base::win::ShortcutProperties properties;
+      properties.set_target(target_path);
+      properties.set_icon(temp_dir_.path().Append(test_cases[i].icon_path), 1);
+      ASSERT_TRUE(base::win::CreateOrUpdateShortcutLink(
+          user_desktop_shortcut_.InsertBeforeExtension(
+              base::SizeTToString16(i)),
+          properties, base::win::SHORTCUT_CREATE_ALWAYS));
+    }
+
+    // Update shortcuts.
+    const base::FilePath new_target_path =
+        temp_dir_.path().Append(new_target_path_relative);
+    installer::UpdatePerUserShortcutsInLocation(
+        ShellUtil::SHORTCUT_LOCATION_DESKTOP, dist_,
+        new_target_path.DirName().DirName(), new_target_path.BaseName(),
+        new_target_path);
+
+    // Verify that shortcuts were updated correctly.
+    for (size_t i = 0; i < num_test_cases; ++i) {
+      base::FilePath target_path;
+      ASSERT_TRUE(base::win::ResolveShortcut(
+          user_desktop_shortcut_.InsertBeforeExtension(
+              base::SizeTToString16(i)),
+          &target_path, nullptr));
+
+      if (test_cases[i].should_update) {
+        EXPECT_EQ(GetNormalizedFilePath(new_target_path),
+                  GetNormalizedFilePath(target_path));
+      } else {
+        EXPECT_EQ(GetNormalizedFilePath(
+                      temp_dir_.path().Append(test_cases[i].target_path)),
+                  GetNormalizedFilePath(target_path));
+      }
+    }
+  }
+
   base::win::ShortcutProperties expected_properties_;
   base::win::ShortcutProperties expected_start_menu_properties_;
 
   BrowserDistribution* dist_;
   base::FilePath chrome_exe_;
   scoped_ptr<installer::Product> product_;
   scoped_ptr<installer::MasterPreferences> prefs_;
 
   base::ScopedTempDir temp_dir_;
   base::ScopedTempDir fake_user_desktop_;
   base::ScopedTempDir fake_common_desktop_;
   base::ScopedTempDir fake_user_quick_launch_;
   base::ScopedTempDir fake_start_menu_;
   base::ScopedTempDir fake_common_start_menu_;
   scoped_ptr<base::ScopedPathOverride> user_desktop_override_;
   scoped_ptr<base::ScopedPathOverride> common_desktop_override_;
   scoped_ptr<base::ScopedPathOverride> user_quick_launch_override_;
   scoped_ptr<base::ScopedPathOverride> start_menu_override_;
   scoped_ptr<base::ScopedPathOverride> common_start_menu_override_;
 
   base::FilePath user_desktop_shortcut_;
   base::FilePath user_quick_launch_shortcut_;
   base::FilePath user_start_menu_shortcut_;
   base::FilePath user_start_menu_subdir_shortcut_;
   base::FilePath system_desktop_shortcut_;
   base::FilePath system_start_menu_shortcut_;
   base::FilePath system_start_menu_subdir_shortcut_;
 };
 
-base::FilePath GetNormalizedFilePath(const base::FilePath& path) {
-  base::FilePath normalized_path;
-  base::NormalizeFilePath(path, &normalized_path);
-  return normalized_path;
-}
-
 }  // namespace
 
 // Test that VisualElementsManifest.xml is not created when VisualElements are
 // not present.
 TEST_F(CreateVisualElementsManifestTest, VisualElementsManifestNotCreated) {
   ASSERT_TRUE(
       installer::CreateVisualElementsManifest(test_dir_.path(), version_));
   ASSERT_FALSE(base::PathExists(manifest_path_));
 }
 
@@ skipping 235 matching lines @@
   installer::CreateOrUpdateShortcuts(
       chrome_exe_, *product_, *prefs_, installer::CURRENT_USER,
       installer::INSTALL_SHORTCUT_CREATE_EACH_IF_NO_SYSTEM_LEVEL);
   ASSERT_FALSE(base::PathExists(user_desktop_shortcut_));
   base::win::ValidateShortcut(user_quick_launch_shortcut_,
                               expected_properties_);
   base::win::ValidateShortcut(user_start_menu_shortcut_,
                               expected_start_menu_properties_);
 }
 
 TEST_F(InstallShortcutTest, UpdatePerUserShortcuts) {

[gab, 2016/03/18 16:21:25]

UpdatePerUserChromeShortcuts

[fdoray, 2016/03/18 17:01:01]

Done.

-  static const struct TestCase {
-    const base::FilePath::CharType* relative_target_path;
-    bool should_update;
-  } kTargetPathsToUpdate[] = {
+  static const UpdateShortcutsTestCase kTestCases[] = {
+      // Target in the Chrome Canary install directory. No icon.

[gab, 2016/03/18 16:21:25]

s/Target/Shortcut target/ (same below)

(there are multiple "targets" in this test so being specific is easier to parse)

[fdoray, 2016/03/18 17:01:01]

Done.

       {FILE_PATH_LITERAL("AppData\\Local\\Google\\Chrome "
                          "SxS\\Temp\\scoped_dir\\new_chrome.exe"),
-       false},
+       nullptr, false},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome SxS\\Temp\\scoped_dir\\chrome.exe"),
-       false},
+       nullptr, false},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome SxS\\Application\\chrome.exe"),
-       false},
+       nullptr, false},
       {FILE_PATH_LITERAL("AppData\\Local\\Google\\Chrome "
                          "SxS\\Application\\something_else.exe"),
-       false},
+       nullptr, false},
+
+      // Target in the Chrome install directory. No icon.
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome\\Temp\\scoped_dir\\new_chrome.exe"),
-       true},
+       nullptr, true},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome\\Temp\\scoped_dir\\chrome.exe"),
-       true},
+       nullptr, true},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome\\Application\\chrome.exe"),
-       true},
+       nullptr, true},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome\\Application\\something_else.exe"),
+       nullptr, false},
+

[gab, 2016/03/18 16:21:24]

Also add a section pointing to system-level Chrome the set of test cases (here
and in the other tests).

And also add a new test whose target is system-level Chrome.

[fdoray, 2016/03/18 17:01:01]

Done.

+      // Dummy target. Icon in the Chrome Canary install directory.
+      {FILE_PATH_LITERAL("dummy.exe"),
+       FILE_PATH_LITERAL(
+           "AppData\\Local\\Google\\Chrome SxS\\Application\\chrome.exe"),
        false},
-      {FILE_PATH_LITERAL("something_else.exe"), false},
+      {FILE_PATH_LITERAL("dummy.exe"),
+       FILE_PATH_LITERAL("AppData\\Local\\Google\\Chrome "
+                         "SxS\\Application\\User Data\\Profile 1\\Google "
+                         "Profile.ico"),
+       false},
+
+      // Dummy target. Icon in the Chrome install directory.
+      {FILE_PATH_LITERAL("dummy.exe"),
+       FILE_PATH_LITERAL(
+           "AppData\\Local\\Google\\Chrome\\Application\\chrome.exe"),
+       true},
+      {FILE_PATH_LITERAL("dummy.exe"),
+       FILE_PATH_LITERAL("AppData\\Local\\Google\\Chrome\\Application\\User "
+                         "Data\\Profile 1\\Google Profile.ico"),
+       true},
+
+      // Shortcuts that don't belong to Chrome.
+      {FILE_PATH_LITERAL("something_else.exe"), nullptr, false},
+      {FILE_PATH_LITERAL("something_else.exe"),
+       FILE_PATH_LITERAL("AppData\\Local\\Google\\Something Else.ico"), false},
   };
 
-  // Create shortcuts.
-  for (size_t i = 0; i < arraysize(kTargetPathsToUpdate); ++i) {
-    const base::FilePath target_path =
-        temp_dir_.path().Append(kTargetPathsToUpdate[i].relative_target_path);
-    ASSERT_TRUE(base::CreateDirectory(target_path.DirName()));
-    base::File file(target_path, base::File::FLAG_CREATE);
-    ASSERT_TRUE(file.IsValid());
-
-    base::win::ShortcutProperties properties;
-    properties.set_target(target_path);
-    ASSERT_TRUE(base::win::CreateOrUpdateShortcutLink(
-        user_desktop_shortcut_.InsertBeforeExtension(base::SizeTToString16(i)),
-        properties, base::win::SHORTCUT_CREATE_ALWAYS));
-  }
-
-  // Update shortcuts.
-  const base::FilePath new_target_path =
-      temp_dir_.path().Append(FILE_PATH_LITERAL(
-          "AppData\\Local\\Google\\Chrome\\Application\\chrome.exe"));
-  installer::UpdatePerUserShortcutsInLocation(
-      ShellUtil::SHORTCUT_LOCATION_DESKTOP, dist_,
-      new_target_path.DirName().DirName(), new_target_path.BaseName(),
-      new_target_path);
-
-  // Verify that shortcuts were updated correctly.
-  for (size_t i = 0; i < arraysize(kTargetPathsToUpdate); ++i) {
-    base::FilePath target_path;
-    ASSERT_TRUE(base::win::ResolveShortcut(
-        user_desktop_shortcut_.InsertBeforeExtension(base::SizeTToString16(i)),
-        &target_path, nullptr));
-
-    if (kTargetPathsToUpdate[i].should_update) {
-      EXPECT_EQ(GetNormalizedFilePath(new_target_path),
-                GetNormalizedFilePath(target_path));
-    } else {
-      EXPECT_EQ(GetNormalizedFilePath(temp_dir_.path().Append(
-                    kTargetPathsToUpdate[i].relative_target_path)),
-                GetNormalizedFilePath(target_path));
-    }
-  }
+  TestUpdateShortcuts(
+      kTestCases, arraysize(kTestCases),
+      base::FilePath(FILE_PATH_LITERAL(
+          "AppData\\Local\\Google\\Chrome\\Application\\chrome.exe")));
 }
 
 TEST_F(InstallShortcutTest, UpdatePerUserShortcutsCanary) {

[gab, 2016/03/18 16:21:25]

UpdatePerUserCanaryShortcuts

[fdoray, 2016/03/18 17:01:01]

Done.

-  static const struct TestCase {
-    const base::FilePath::CharType* relative_target_path;
-    bool should_update;
-  } kTargetPathsToUpdate[] = {
+  static const UpdateShortcutsTestCase kTestCases[] = {
+      // Target in the Chrome Canary install directory. No icon.
       {FILE_PATH_LITERAL("AppData\\Local\\Google\\Chrome "
                          "SxS\\Temp\\scoped_dir\\new_chrome.exe"),
-       true},
+       nullptr, true},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome SxS\\Temp\\scoped_dir\\chrome.exe"),
-       true},
+       nullptr, true},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome SxS\\Application\\chrome.exe"),
-       true},
+       nullptr, true},
       {FILE_PATH_LITERAL("AppData\\Local\\Google\\Chrome "
                          "SxS\\Application\\something_else.exe"),
-       false},
+       nullptr, false},
+
+      // Target in the Chrome install directory. No icon.
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome\\Temp\\scoped_dir\\new_chrome.exe"),
-       false},
+       nullptr, false},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome\\Temp\\scoped_dir\\chrome.exe"),
-       false},
+       nullptr, false},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome\\Application\\chrome.exe"),
-       false},
+       nullptr, false},
       {FILE_PATH_LITERAL(
            "AppData\\Local\\Google\\Chrome\\Application\\something_else.exe"),
+       nullptr, false},
+
+      // Dummy target. Icon in the Chrome Canary install directory.
+      {FILE_PATH_LITERAL("dummy.exe"),
+       FILE_PATH_LITERAL(
+           "AppData\\Local\\Google\\Chrome SxS\\Application\\chrome.exe"),
+       true},
+      {FILE_PATH_LITERAL("dummy.exe"),
+       FILE_PATH_LITERAL("AppData\\Local\\Google\\Chrome "
+                         "SxS\\Application\\User Data\\Profile 1\\Google "
+                         "Profile.ico"),
+       true},
+
+      // Dummy target. Icon in the Chrome install directory.
+      {FILE_PATH_LITERAL("dummy.exe"),
+       FILE_PATH_LITERAL(
+           "AppData\\Local\\Google\\Chrome\\Application\\chrome.exe"),
        false},
-      {FILE_PATH_LITERAL("something_else.exe"), false},
+      {FILE_PATH_LITERAL("dummy.exe"),
+       FILE_PATH_LITERAL("AppData\\Local\\Google\\Chrome\\Application\\User "
+                         "Data\\Profile 1\\Google Profile.ico"),
+       false},
+
+      // Shortcuts that don't belong to Chrome.
+      {FILE_PATH_LITERAL("something_else.exe"), nullptr, false},
+      {FILE_PATH_LITERAL("something_else.exe"),
+       FILE_PATH_LITERAL("AppData\\Local\\Google\\Something Else.ico"), false},
   };
 
-  // Create shortcuts.
-  for (size_t i = 0; i < arraysize(kTargetPathsToUpdate); ++i) {
-    const base::FilePath target_path =
-        temp_dir_.path().Append(kTargetPathsToUpdate[i].relative_target_path);
-    ASSERT_TRUE(base::CreateDirectory(target_path.DirName()));
-    base::File file(target_path, base::File::FLAG_CREATE);
-    ASSERT_TRUE(file.IsValid());
-
-    base::win::ShortcutProperties properties;
-    properties.set_target(target_path);
-    ASSERT_TRUE(base::win::CreateOrUpdateShortcutLink(
-        user_desktop_shortcut_.InsertBeforeExtension(base::SizeTToString16(i)),
-        properties, base::win::SHORTCUT_CREATE_ALWAYS));
-  }
-
-  // Update shortcuts.
-  const base::FilePath new_target_path =
-      temp_dir_.path().Append(FILE_PATH_LITERAL(
-          "AppData\\Local\\Google\\Chrome SxS\\Application\\chrome.exe"));
-  installer::UpdatePerUserShortcutsInLocation(
-      ShellUtil::SHORTCUT_LOCATION_DESKTOP, dist_,
-      new_target_path.DirName().DirName(), new_target_path.BaseName(),
-      new_target_path);
-
-  // Verify that shortcuts were updated correctly.
-  for (size_t i = 0; i < arraysize(kTargetPathsToUpdate); ++i) {
-    base::FilePath target_path;
-    ASSERT_TRUE(base::win::ResolveShortcut(
-        user_desktop_shortcut_.InsertBeforeExtension(base::SizeTToString16(i)),
-        &target_path, nullptr));
-
-    if (kTargetPathsToUpdate[i].should_update) {
-      EXPECT_EQ(GetNormalizedFilePath(new_target_path),
-                GetNormalizedFilePath(target_path));
-    } else {
-      EXPECT_EQ(GetNormalizedFilePath(temp_dir_.path().Append(
-                    kTargetPathsToUpdate[i].relative_target_path)),
-                GetNormalizedFilePath(target_path));
-    }
-  }
+  TestUpdateShortcuts(
+      kTestCases, arraysize(kTestCases),
+      base::FilePath(FILE_PATH_LITERAL(
+          "AppData\\Local\\Google\\Chrome SxS\\Application\\chrome.exe")));
 }
 
 TEST(EscapeXmlAttributeValueTest, EscapeCrazyValue) {
   base::string16 val(L"This has 'crazy' \"chars\" && < and > signs.");
   static const wchar_t kExpectedEscapedVal[] =
       L"This has &apos;crazy&apos; \"chars\" &amp;&amp; &lt; and > signs.";
   installer::EscapeXmlAttributeValueInSingleQuotes(&val);
   ASSERT_STREQ(kExpectedEscapedVal, val.c_str());
 }
 
 TEST(EscapeXmlAttributeValueTest, DontEscapeNormalValue) {
   base::string16 val(L"Google Chrome");
   static const wchar_t kExpectedEscapedVal[] = L"Google Chrome";
   installer::EscapeXmlAttributeValueInSingleQuotes(&val);
   ASSERT_STREQ(kExpectedEscapedVal, val.c_str());
 }