Refactoring and tests for the highly undertested file_util::CreateOrUpdateShortcutLink() method.

chrome/browser/profiles/profile_shortcut_manager_unittest_win.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 "base/file_util.h"
 #include "base/message_loop.h"
 #include "base/path_service.h"
 #include "base/scoped_temp_dir.h"
 #include "base/utf_string_conversions.h"
+#include "base/test/test_shortcut_win.h"
+#include "base/win/shortcut.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/profiles/profile_shortcut_manager.h"
 #include "chrome/installer/util/browser_distribution.h"
 #include "chrome/installer/util/shell_util.h"
 #include "chrome/test/base/testing_browser_process.h"
 #include "chrome/test/base/testing_pref_service.h"
 #include "chrome/test/base/testing_profile.h"
 #include "chrome/test/base/testing_profile_manager.h"
 #include "content/public/test/test_browser_thread.h"
 #include "grit/theme_resources.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "ui/base/resource/resource_bundle.h"
 
 using content::BrowserThread;
 
 namespace {
 
-ShellUtil::VerifyShortcutStatus VerifyProfileShortcut(
+base::win::VerifyShortcutStatus VerifyProfileShortcut(
     const string16& profile_name) {
   FilePath exe_path;
-  CHECK(PathService::Get(base::FILE_EXE, &exe_path));
+  EXPECT_TRUE(PathService::Get(base::FILE_EXE, &exe_path));
 
   BrowserDistribution* dist = BrowserDistribution::GetDistribution();
 
   // Get the desktop path of the current user.
   FilePath shortcut_path;
   ShellUtil::GetDesktopPath(false, &shortcut_path);
   // Get the name of the shortcut with profile attached
   string16 shortcut_name;
   ShellUtil::GetChromeShortcutName(dist, false, profile_name,
                                    &shortcut_name);
   shortcut_path = shortcut_path.Append(shortcut_name);
 
-  return ShellUtil::VerifyChromeShortcut(
-          exe_path.value(), shortcut_path.value(), dist->GetAppDescription(),
-          0);
+  // TODO(hallielaine): With this new struct method for VerifyShortcut you can
+  // now test more properties like: arguments, icon, icon_index, and app_id.
+  base::win::ShortcutProperties expected_properties;
+  expected_properties.set_target(exe_path);
+  expected_properties.set_description(dist->GetAppDescription());
+  expected_properties.set_dual_mode(false);
+  return base::win::VerifyShortcut(shortcut_path, expected_properties);
 }
 
 }  // namespace
 
 class ProfileShortcutManagerTest : public testing::Test {
  protected:
   ProfileShortcutManagerTest()
       : ui_thread_(BrowserThread::UI, &message_loop_),
         file_thread_(BrowserThread::FILE, &message_loop_) {
   }
@@ skipping 30 matching lines @@
           profile_manager_->profile_info_cache()->GetPathOfProfileAtIndex(0);
       string16 profile_name;
       if (i != num_profiles - 1) {
         profile_name =
             profile_manager_->profile_info_cache()->GetNameOfProfileAtIndex(0);
       }
       profile_manager_->profile_info_cache()->DeleteProfileFromCache(
           profile_path);
       MessageLoop::current()->PostTask(FROM_HERE, MessageLoop::QuitClosure());
       MessageLoop::current()->Run();
-      EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+      EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
                 VerifyProfileShortcut(profile_name));
       ASSERT_FALSE(file_util::PathExists(profile_path.Append(
           FILE_PATH_LITERAL("Google Profile.ico"))));
     }
   }
 
   void SetupDefaultProfileShortcut() {
-    EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+    EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
               VerifyProfileShortcut(profile_name_));
 
     profile_manager_->profile_info_cache()->AddProfileToCache(
         dest_path_, profile_name_, string16(), 0);
     profile_manager_->profile_manager()->profile_shortcut_manager()->
         CreateProfileShortcut(dest_path_);
     MessageLoop::current()->PostTask(FROM_HERE, MessageLoop::QuitClosure());
     MessageLoop::current()->Run();
     // We now have 1 profile, so we expect a new shortcut with no profile
     // information.
-    EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+    EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
               VerifyProfileShortcut(string16()));
   }
 
   void SetupAndCreateTwoShortcuts() {
     ASSERT_EQ(0, profile_manager_->profile_info_cache()->GetNumberOfProfiles());
-    EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+    EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
               VerifyProfileShortcut(profile_name_));
-    EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+    EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
               VerifyProfileShortcut(second_profile_name_));
 
     profile_manager_->profile_info_cache()->AddProfileToCache(
         dest_path_, profile_name_, string16(), 0);
     profile_manager_->profile_info_cache()->AddProfileToCache(
         second_dest_path_, second_profile_name_, string16(), 0);
     profile_manager_->profile_manager()->profile_shortcut_manager()->
         CreateProfileShortcut(dest_path_);
     profile_manager_->profile_manager()->profile_shortcut_manager()->
         CreateProfileShortcut(second_dest_path_);
     MessageLoop::current()->PostTask(FROM_HERE, MessageLoop::QuitClosure());
     MessageLoop::current()->Run();
-    EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+    EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
               VerifyProfileShortcut(profile_name_));
-    EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+    EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
               VerifyProfileShortcut(second_profile_name_));
   }
 
   MessageLoopForUI message_loop_;
   content::TestBrowserThread ui_thread_;
   content::TestBrowserThread file_thread_;
   scoped_ptr<TestingProfileManager> profile_manager_;
   FilePath dest_path_;
   string16 profile_name_;
   FilePath second_dest_path_;
   string16 second_profile_name_;
 };
 
 TEST_F(ProfileShortcutManagerTest, DesktopShortcutsCreate) {
   if (!profile_manager_->profile_manager()->profile_shortcut_manager())
     return;
   ProfileShortcutManagerTest::SetupDefaultProfileShortcut();
 
   profile_manager_->profile_info_cache()->AddProfileToCache(
       second_dest_path_, second_profile_name_, string16(), 0);
   profile_manager_->profile_manager()->profile_shortcut_manager()->
       CreateProfileShortcut(second_dest_path_);
   MessageLoop::current()->PostTask(FROM_HERE, MessageLoop::QuitClosure());
   MessageLoop::current()->Run();
 
   // We now have 2 profiles, so we expect a new shortcut with profile
   // information for this 2nd profile.
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
             VerifyProfileShortcut(second_profile_name_));
   ASSERT_TRUE(file_util::PathExists(second_dest_path_.Append(
       FILE_PATH_LITERAL("Google Profile.ico"))));
 }
 
 TEST_F(ProfileShortcutManagerTest, DesktopShortcutsUpdate) {
   if (!profile_manager_->profile_manager()->profile_shortcut_manager())
     return;
   ProfileShortcutManagerTest::SetupDefaultProfileShortcut();
 
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
             VerifyProfileShortcut(second_profile_name_));
 
   profile_manager_->profile_info_cache()->AddProfileToCache(
       second_dest_path_, second_profile_name_, string16(), 0);
   profile_manager_->profile_manager()->profile_shortcut_manager()->
       CreateProfileShortcut(second_dest_path_);
   MessageLoop::current()->PostTask(FROM_HERE, MessageLoop::QuitClosure());
   MessageLoop::current()->Run();
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
             VerifyProfileShortcut(second_profile_name_));
 
   // Cause an update in ProfileShortcutManager by modifying the profile info
   // cache.
   string16 new_profile_name = ASCIIToUTF16("New Profile Name");
   profile_manager_->profile_info_cache()->SetNameOfProfileAtIndex(
       profile_manager_->profile_info_cache()->GetIndexOfProfileWithPath(
           second_dest_path_),
       new_profile_name);
   MessageLoop::current()->PostTask(FROM_HERE, MessageLoop::QuitClosure());
   MessageLoop::current()->Run();
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
             VerifyProfileShortcut(second_profile_name_));
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
             VerifyProfileShortcut(new_profile_name));
 }
 
 TEST_F(ProfileShortcutManagerTest, DesktopShortcutsDeleteSecondToLast) {
   if (!profile_manager_->profile_manager()->profile_shortcut_manager())
     return;
   ProfileShortcutManagerTest::SetupAndCreateTwoShortcuts();
 
   // Delete one shortcut
   profile_manager_->profile_info_cache()->DeleteProfileFromCache(
       second_dest_path_);
   MessageLoop::current()->PostTask(FROM_HERE, MessageLoop::QuitClosure());
   MessageLoop::current()->Run();
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
             VerifyProfileShortcut(second_profile_name_));
 
   // Verify that the profile name has been removed from the remaining shortcut
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
             VerifyProfileShortcut(string16()));
   // Verify that an additional shortcut, with the default profile's name does
   // not exist
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
             VerifyProfileShortcut(profile_name_));
 }
 
 TEST_F(ProfileShortcutManagerTest, DesktopShortcutsCreateSecond) {
   if (!profile_manager_->profile_manager()->profile_shortcut_manager())
     return;
   ProfileShortcutManagerTest::SetupAndCreateTwoShortcuts();
 
   // Delete one shortcut
   profile_manager_->profile_info_cache()->DeleteProfileFromCache(
       second_dest_path_);
   MessageLoop::current()->PostTask(FROM_HERE, MessageLoop::QuitClosure());
   MessageLoop::current()->Run();
 
   // Verify that a default shortcut exists (no profile name/avatar)
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
             VerifyProfileShortcut(string16()));
   // Verify that an additional shortcut, with the default profile's name does
   // not exist
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
             VerifyProfileShortcut(profile_name_));
 
   // Create a second profile and shortcut
   profile_manager_->profile_info_cache()->AddProfileToCache(
        second_dest_path_, second_profile_name_, string16(), 0);
   profile_manager_->profile_manager()->profile_shortcut_manager()->
       CreateProfileShortcut(second_dest_path_);
   MessageLoop::current()->PostTask(FROM_HERE, MessageLoop::QuitClosure());
   MessageLoop::current()->Run();
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
             VerifyProfileShortcut(second_profile_name_));
 
   // Verify that the original shortcut received the profile's name
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_SUCCESS,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_SUCCESS,
             VerifyProfileShortcut(profile_name_));
   // Verify that a default shortcut no longer exists
-  EXPECT_EQ(ShellUtil::VERIFY_SHORTCUT_FAILURE_UNEXPECTED,
+  EXPECT_EQ(base::win::VERIFY_SHORTCUT_FAILURE_FILE_NOT_FOUND,
             VerifyProfileShortcut(string16()));
 }