Sharing shell_util_unittest code to verify shortcuts

chrome/installer/util/shell_util_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 <windows.h>
 #include <shellapi.h>
 #include <shlobj.h>

[gab, 2012/08/07 19:18:25]

I don't think any of these include are needed anymore as well.

[Halli, 2012/08/07 20:52:16]

shlobj.h is used for IsUserAnAdmin()
Done.

 
 #include <fstream>
 #include <vector>
 
 #include "base/file_util.h"
 #include "base/path_service.h"
 #include "base/md5.h"
 #include "base/scoped_temp_dir.h"
 #include "base/string16.h"

[gab, 2012/08/07 19:18:25]

optional: Not your fault, but while you're at it cleaning includes... this file
includes string16.h and not <string> which is the correct thing to do, but also
means all std::wstring should be changed to string16 as per the Chromium style,
if you can clean this up with this CL that'd be greatly appreciated :)!

[Halli, 2012/08/07 20:52:16]

Done.

 #include "base/string_util.h"
 #include "base/win/scoped_comptr.h"

[gab, 2012/08/07 19:18:25]

Remove this include.

[Halli, 2012/08/07 20:52:16]

Done.

 #include "base/win/windows_version.h"
 #include "chrome/installer/util/browser_distribution.h"
 #include "chrome/installer/util/master_preferences.h"
 #include "chrome/installer/util/shell_util.h"
 #include "chrome/installer/util/util_constants.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {

[gab, 2012/08/07 19:18:25]

nit: Please add a blank line here (as per the Chromium style).

[Halli, 2012/08/07 20:52:16]

Done.

-bool VerifyChromeShortcut(const std::wstring& exe_path,
-                          const std::wstring& shortcut,
-                          const std::wstring& description,
-                          int icon_index) {
-  base::win::ScopedComPtr<IShellLink> i_shell_link;
-  base::win::ScopedComPtr<IPersistFile> i_persist_file;
-
-  // Get pointer to the IShellLink interface
-  bool failed = FAILED(i_shell_link.CreateInstance(CLSID_ShellLink, NULL,
-                                                   CLSCTX_INPROC_SERVER));
-  EXPECT_FALSE(failed) << "Failed to get IShellLink";
-  if (failed)
-    return false;
-
-  // Query IShellLink for the IPersistFile interface
-  failed = FAILED(i_persist_file.QueryFrom(i_shell_link));
-  EXPECT_FALSE(failed) << "Failed to get IPersistFile";
-  if (failed)
-    return false;
-
-  failed = FAILED(i_persist_file->Load(shortcut.c_str(), 0));
-  EXPECT_FALSE(failed) << "Failed to load shortcut " << shortcut.c_str();
-  if (failed)
-    return false;
-
-  wchar_t long_path[MAX_PATH] = {0};
-  wchar_t short_path[MAX_PATH] = {0};
-  failed = ((::GetLongPathName(exe_path.c_str(), long_path, MAX_PATH) == 0) ||
-            (::GetShortPathName(exe_path.c_str(), short_path, MAX_PATH) == 0));
-  EXPECT_FALSE(failed) << "Failed to get long and short path names for "
-                       << exe_path;
-  if (failed)
-    return false;
-
-  wchar_t file_path[MAX_PATH] = {0};
-  failed = ((FAILED(i_shell_link->GetPath(file_path, MAX_PATH, NULL,
-                                          SLGP_UNCPRIORITY))) ||
-            ((FilePath(file_path) != FilePath(long_path)) &&
-             (FilePath(file_path) != FilePath(short_path))));
-  EXPECT_FALSE(failed) << "File path " << file_path << " did not match with "
-                       << exe_path;
-  if (failed)
-    return false;
-
-  wchar_t desc[MAX_PATH] = {0};
-  failed = ((FAILED(i_shell_link->GetDescription(desc, MAX_PATH))) ||
-            (std::wstring(desc) != std::wstring(description)));
-  EXPECT_FALSE(failed) << "Description " << desc << " did not match with "
-                       << description;
-  if (failed)
-    return false;
-
-  wchar_t icon_path[MAX_PATH] = {0};
-  int index = 0;
-  failed = ((FAILED(i_shell_link->GetIconLocation(icon_path, MAX_PATH,
-                                                  &index))) ||
-            ((FilePath(file_path) != FilePath(long_path)) &&
-             (FilePath(file_path) != FilePath(short_path))) ||
-            (index != icon_index));
-  EXPECT_FALSE(failed);
-  if (failed)
-    return false;
-
-  return true;
-}
-
 class ShellUtilTestWithDirAndDist : public testing::Test {
  protected:
   virtual void SetUp() {
     ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
     dist_ = BrowserDistribution::GetDistribution();
     ASSERT_TRUE(dist_ != NULL);
   }
 
   BrowserDistribution* dist_;
 
   ScopedTempDir temp_dir_;
 };

[gab, 2012/08/07 19:18:25]

nit: Blank line here as well.

[Halli, 2012/08/07 20:52:16]

Done.

-};
+}
 
 // Test that we can open archives successfully.
 TEST_F(ShellUtilTestWithDirAndDist, UpdateChromeShortcutTest) {
   // Create an executable in test path by copying ourself to it.
   wchar_t exe_full_path_str[MAX_PATH];
   EXPECT_FALSE(::GetModuleFileName(NULL, exe_full_path_str, MAX_PATH) == 0);
   FilePath exe_full_path(exe_full_path_str);
 
   FilePath exe_path = temp_dir_.path().AppendASCII("setup.exe");
   EXPECT_TRUE(file_util::CopyFile(exe_full_path, exe_path));
 
   FilePath shortcut_path = temp_dir_.path().AppendASCII("shortcut.lnk");
   const std::wstring description(L"dummy description");
   EXPECT_TRUE(ShellUtil::UpdateChromeShortcut(
       dist_,
       exe_path.value(),
       shortcut_path.value(),
       L"",
       description,
       exe_path.value(),
       dist_->GetIconIndex(),
       ShellUtil::SHORTCUT_CREATE_ALWAYS));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    shortcut_path.value(),
                                    description, 0));
 
   // Now specify an icon index in master prefs and make sure it works.
   FilePath prefs_path = temp_dir_.path().AppendASCII(
       installer::kDefaultMasterPrefs);
   std::ofstream file;
   file.open(prefs_path.value().c_str());
   ASSERT_TRUE(file.is_open());
   file <<
 "{"
 " \"distribution\":{"
 "   \"chrome_shortcut_icon_index\" : 1"
 " }"
 "}";
   file.close();
   ASSERT_TRUE(file_util::Delete(shortcut_path, false));
   EXPECT_TRUE(ShellUtil::UpdateChromeShortcut(
       dist_,
       exe_path.value(),
       shortcut_path.value(),
       L"",
       description,
       exe_path.value(),
       dist_->GetIconIndex(),
       ShellUtil::SHORTCUT_CREATE_ALWAYS));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    shortcut_path.value(),

[gab, 2012/08/07 19:18:25]

ident variable to same level as the one above it (same comment for all other
changes below)

[Halli, 2012/08/07 20:52:16]

Done.

                                    description, 1));
 
   // Now change only description to update shortcut and make sure icon index
   // doesn't change.
   const std::wstring description2(L"dummy description 2");
   EXPECT_TRUE(ShellUtil::UpdateChromeShortcut(dist_,
                                               exe_path.value(),
                                               shortcut_path.value(),
                                               L"",
                                               description2,
                                               exe_path.value(),
                                               dist_->GetIconIndex(),
                                               ShellUtil::SHORTCUT_NO_OPTIONS));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    shortcut_path.value(),
                                    description2, 1));
 }
 
 TEST_F(ShellUtilTestWithDirAndDist, CreateChromeDesktopShortcutTest) {
   // Run this test on Vista+ only if we are running elevated.
   if (base::win::GetVersion() > base::win::VERSION_XP && !IsUserAnAdmin()) {
     LOG(ERROR) << "Must be admin to run this test on Vista+";
     return;
   }
@@ skipping 40 matching lines @@
   EXPECT_TRUE(ShellUtil::CreateChromeDesktopShortcut(
       dist_,
       exe_path.value(),
       description,
       L"",
       L"",
       exe_path.value(),
       dist_->GetIconIndex(),
       ShellUtil::CURRENT_USER,
       ShellUtil::SHORTCUT_CREATE_ALWAYS));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    user_shortcut_path.value(),
                                    description,
                                    0));
   EXPECT_TRUE(ShellUtil::RemoveChromeDesktopShortcut(
       dist_,
       ShellUtil::CURRENT_USER,
       ShellUtil::SHORTCUT_NO_OPTIONS));
 
   // Test simple creation of a system-level shortcut.
   EXPECT_TRUE(ShellUtil::CreateChromeDesktopShortcut(
       dist_,
       exe_path.value(),
       description,
       L"",
       L"",
       exe_path.value(),
       dist_->GetIconIndex(),
       ShellUtil::SYSTEM_LEVEL,
       ShellUtil::SHORTCUT_CREATE_ALWAYS));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    system_shortcut_path.value(),
                                    description,
                                    0));
   EXPECT_TRUE(ShellUtil::RemoveChromeDesktopShortcut(
       dist_,
       ShellUtil::SYSTEM_LEVEL,
       ShellUtil::SHORTCUT_NO_OPTIONS));
 
   // Test creation of a user-level shortcut when a system-level shortcut
   // is already present (should fail).
@@ skipping 10 matching lines @@
   EXPECT_FALSE(ShellUtil::CreateChromeDesktopShortcut(
       dist_,
       exe_path.value(),
       description,
       L"",
       L"",
       exe_path.value(),
       dist_->GetIconIndex(),
       ShellUtil::CURRENT_USER,
       ShellUtil::SHORTCUT_CREATE_ALWAYS));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    system_shortcut_path.value(),
                                    description,
                                    0));
   EXPECT_FALSE(file_util::PathExists(user_shortcut_path));
   EXPECT_TRUE(ShellUtil::RemoveChromeDesktopShortcut(
       dist_,
       ShellUtil::SYSTEM_LEVEL,
       ShellUtil::SHORTCUT_NO_OPTIONS));
 
   // Test creation of a system-level shortcut when a user-level shortcut
@@ skipping 11 matching lines @@
   EXPECT_TRUE(ShellUtil::CreateChromeDesktopShortcut(
       dist_,
       exe_path.value(),
       description,
       L"",
       L"",
       exe_path.value(),
       dist_->GetIconIndex(),
       ShellUtil::SYSTEM_LEVEL,
       ShellUtil::SHORTCUT_CREATE_ALWAYS));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    user_shortcut_path.value(),
                                    description,
                                    0));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    system_shortcut_path.value(),
                                    description,
                                    0));
   EXPECT_TRUE(ShellUtil::RemoveChromeDesktopShortcut(
       dist_,
       ShellUtil::CURRENT_USER,
       ShellUtil::SHORTCUT_NO_OPTIONS));
   EXPECT_TRUE(ShellUtil::RemoveChromeDesktopShortcut(
       dist_,
       ShellUtil::SYSTEM_LEVEL,
       ShellUtil::SHORTCUT_NO_OPTIONS));
 
   // Test creation of two profile-specific shortcuts (these are always
   // user-level).
   EXPECT_TRUE(ShellUtil::CreateChromeDesktopShortcut(
       dist_,
       exe_path.value(),
       description,
       default_profile_user_name,
       L"--profile-directory=\"Default\"",
       exe_path.value(),
       dist_->GetIconIndex(),
       ShellUtil::CURRENT_USER,
       ShellUtil::SHORTCUT_CREATE_ALWAYS));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    default_profile_shortcut_path.value(),
                                    description,
                                    0));
   EXPECT_TRUE(ShellUtil::CreateChromeDesktopShortcut(
       dist_,
       exe_path.value(),
       description,
       second_profile_user_name,
       L"--profile-directory=\"Profile 1\"",
       exe_path.value(),
       dist_->GetIconIndex(),
       ShellUtil::CURRENT_USER,
       ShellUtil::SHORTCUT_CREATE_ALWAYS));
-  EXPECT_TRUE(VerifyChromeShortcut(exe_path.value(),
+  EXPECT_TRUE(ShellUtil::VerifyChromeShortcut(exe_path.value(),
                                    second_profile_shortcut_path.value(),
                                    description,
                                    0));
   std::vector<string16> profile_names;
   profile_names.push_back(default_profile_shortcut_name);
   profile_names.push_back(second_profile_shortcut_name);
   EXPECT_TRUE(ShellUtil::RemoveChromeDesktopShortcutsWithAppendedNames(
       profile_names));
 }
 
@@ skipping 66 matching lines @@
 
   const string16 expected[] = { L"", L"MY", L"MZXQ", L"MZXW6", L"MZXW6YQ",
                                 L"MZXW6YTB", L"MZXW6YTBOI"};
 
   // Run the tests, with one more letter in the input every pass.
   for (int i = 0; i < arraysize(expected); ++i) {
     ASSERT_EQ(expected[i],
               ShellUtil::ByteArrayToBase32(test_array, i));
   }
 }