ShellUtil: Add generic methods to add/delete Windows file associations.

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 "chrome/installer/util/shell_util.h"
 
 #include <vector>
 
 #include "base/base_paths.h"
 #include "base/base_paths_win.h"
+#include "base/command_line.h"
 #include "base/files/file_enumerator.h"
+#include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/md5.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/strings/string16.h"
 #include "base/strings/string_util.h"
 #include "base/synchronization/cancellation_flag.h"
 #include "base/test/scoped_path_override.h"
+#include "base/test/test_reg_util_win.h"
 #include "base/test/test_shortcut_win.h"
+#include "base/win/registry.h"
 #include "base/win/shortcut.h"
 #include "base/win/windows_version.h"
 #include "chrome/installer/util/browser_distribution.h"
 #include "chrome/installer/util/product.h"
 #include "chrome/installer/util/util_constants.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 
 const wchar_t kManganeseExe[] = L"manganese.exe";
 const wchar_t kIronExe[] = L"iron.exe";
 const wchar_t kOtherIco[] = L"other.ico";
 
+// For registry tests.
+const wchar_t kTestProgid[] = L"TestApp";
+const wchar_t kTestOpenCommand[] = L"C:\\test.exe";
+const wchar_t kTestFileTypeName[] = L"Test File Type";
+const wchar_t kTestIconPath[] = L"D:\\test.ico";
+const wchar_t* kTestFileExtensions[] = {
+    L"test1",
+    L"test2",
+};
+
 // TODO(huangs): Separate this into generic shortcut tests and Chrome-specific
 // tests. Specifically, we should not overly rely on getting shortcut properties
 // from product_->AddDefaultShortcutProperties().
 class ShellUtilShortcutTest : public testing::Test {
  protected:
   ShellUtilShortcutTest() : test_properties_(ShellUtil::CURRENT_USER) {}
 
   virtual void SetUp() OVERRIDE {
     dist_ = BrowserDistribution::GetDistribution();
     ASSERT_TRUE(dist_ != NULL);
@@ skipping 741 matching lines @@
   // The shortcut shouldn't be removed as it was installed pointing to
   // |other_chrome_exe| and RemoveChromeShortcut() is being told that the
   // removed shortcut should point to |chrome_exe_|.
   ASSERT_TRUE(ShellUtil::RemoveShortcuts(
       ShellUtil::SHORTCUT_LOCATION_DESKTOP, dist_, ShellUtil::CURRENT_USER,
       chrome_exe_));
   ASSERT_TRUE(base::PathExists(shortcut_path));
   ASSERT_TRUE(base::PathExists(shortcut_path.DirName()));
 }
 
+class ShellUtilRegistryTest : public testing::Test {

[gab, 2014/10/01 14:31:11]

I didn't re-review the expectation below in details, I assume the code below was
moved as-is from the unittest file in patch set 16.

[Matt Giuca, 2014/10/02 09:36:34]

Correct.

+ public:
+  ShellUtilRegistryTest() {}
+
+ protected:
+  virtual void SetUp() OVERRIDE {
+    registry_overrides_.OverrideRegistry(HKEY_CURRENT_USER);
+
+    // .test2 files already have a default application.
+    base::win::RegKey key;
+    ASSERT_EQ(
+        ERROR_SUCCESS,
+        key.Create(
+            HKEY_CURRENT_USER, L"Software\\Classes\\.test2", KEY_ALL_ACCESS));
+    EXPECT_EQ(ERROR_SUCCESS, key.WriteValue(L"", L"SomeOtherApp"));
+  }
+
+  static base::CommandLine OpenCommand() {
+    base::FilePath open_command_path(kTestOpenCommand);
+    return base::CommandLine(open_command_path);
+  }
+
+  static std::set<base::string16> FileExtensions() {
+    std::set<base::string16> file_extensions;
+    for (size_t i = 0; i < arraysize(kTestFileExtensions); ++i)
+      file_extensions.insert(kTestFileExtensions[i]);
+    return file_extensions;
+  }
+
+ private:
+  registry_util::RegistryOverrideManager registry_overrides_;
+
+  DISALLOW_COPY_AND_ASSIGN(ShellUtilRegistryTest);
+};
+
+TEST_F(ShellUtilRegistryTest, AddFileAssociations) {
+  // Create file associations.
+  EXPECT_TRUE(ShellUtil::AddFileAssociations(kTestProgid,
+                                             OpenCommand(),
+                                             kTestFileTypeName,
+                                             base::FilePath(kTestIconPath),
+                                             FileExtensions()));
+
+  // Ensure that the registry keys have been correctly set.
+  base::win::RegKey key;
+  std::wstring value;
+  ASSERT_EQ(
+      ERROR_SUCCESS,
+      key.Open(HKEY_CURRENT_USER, L"Software\\Classes\\TestApp", KEY_READ));
+  EXPECT_EQ(ERROR_SUCCESS, key.ReadValue(L"", &value));
+  EXPECT_EQ(L"Test File Type", value);
+  ASSERT_EQ(ERROR_SUCCESS,
+            key.Open(HKEY_CURRENT_USER,
+                     L"Software\\Classes\\TestApp\\DefaultIcon",
+                     KEY_READ));
+  EXPECT_EQ(ERROR_SUCCESS, key.ReadValue(L"", &value));
+  EXPECT_EQ(L"D:\\test.ico,0", value);
+  ASSERT_EQ(ERROR_SUCCESS,
+            key.Open(HKEY_CURRENT_USER,
+                     L"Software\\Classes\\TestApp\\shell\\open\\command",
+                     KEY_READ));
+  EXPECT_EQ(ERROR_SUCCESS, key.ReadValue(L"", &value));
+  EXPECT_EQ(L"\"C:\\test.exe\"", value);
+
+  // .test1 should be default-associated with our test app.
+  ASSERT_EQ(
+      ERROR_SUCCESS,
+      key.Open(HKEY_CURRENT_USER, L"Software\\Classes\\.test1", KEY_READ));
+  EXPECT_EQ(ERROR_SUCCESS, key.ReadValue(L"", &value));
+  EXPECT_EQ(L"TestApp", value);
+  ASSERT_EQ(ERROR_SUCCESS,
+            key.Open(HKEY_CURRENT_USER,
+                     L"Software\\Classes\\.test1\\OpenWithProgids",
+                     KEY_READ));
+  EXPECT_TRUE(key.HasValue(L"TestApp"));
+  EXPECT_EQ(ERROR_SUCCESS, key.ReadValue(L"TestApp", &value));
+  EXPECT_EQ(L"", value);
+
+  // .test2 should still be associated with the other app (should not have been
+  // overridden). But it should have our app in its Open With list.
+  ASSERT_EQ(
+      ERROR_SUCCESS,
+      key.Open(HKEY_CURRENT_USER, L"Software\\Classes\\.test2", KEY_READ));
+  EXPECT_EQ(ERROR_SUCCESS, key.ReadValue(L"", &value));
+  EXPECT_EQ(L"SomeOtherApp", value);
+  ASSERT_EQ(ERROR_SUCCESS,
+            key.Open(HKEY_CURRENT_USER,
+                     L"Software\\Classes\\.test2\\OpenWithProgids",
+                     KEY_READ));
+  EXPECT_TRUE(key.HasValue(L"TestApp"));
+  EXPECT_EQ(ERROR_SUCCESS, key.ReadValue(L"TestApp", &value));
+  EXPECT_EQ(L"", value);
+}
+
+TEST_F(ShellUtilRegistryTest, DeleteFileAssociations) {
+  // Create file associations.
+  EXPECT_TRUE(ShellUtil::AddFileAssociations(kTestProgid,
+                                             OpenCommand(),
+                                             kTestFileTypeName,
+                                             base::FilePath(kTestIconPath),
+                                             FileExtensions()));
+
+  // Delete them.
+  EXPECT_TRUE(ShellUtil::DeleteFileAssociations(kTestProgid));
+
+  // The class key should have been completely deleted.
+  base::win::RegKey key;
+  std::wstring value;
+  ASSERT_NE(
+      ERROR_SUCCESS,
+      key.Open(HKEY_CURRENT_USER, L"Software\\Classes\\TestApp", KEY_READ));
+
+  // We don't need to delete the associations with the particular extensions

[gab, 2014/10/01 14:31:11]

It's not true (as discussed) that we should not delete them.

Add TODO to delete them (i.e. add an expectation that they're not for now with a
TODO to flip that expectation when the TODO in the code is fixed).

[Matt Giuca, 2014/10/02 09:36:34]

Done.

+  // (Windows will ignore those). However, we must ensure that .test2 is still
+  // associated with the other app.
+  ASSERT_EQ(
+      ERROR_SUCCESS,
+      key.Open(HKEY_CURRENT_USER, L"Software\\Classes\\.test2", KEY_READ));
+  EXPECT_EQ(ERROR_SUCCESS, key.ReadValue(L"", &value));
+  EXPECT_EQ(L"SomeOtherApp", value);
+}
+
 TEST(ShellUtilTest, BuildAppModelIdBasic) {
   std::vector<base::string16> components;
   BrowserDistribution* dist = BrowserDistribution::GetDistribution();
   const base::string16 base_app_id(dist->GetBaseAppId());
   components.push_back(base_app_id);
   ASSERT_EQ(base_app_id, ShellUtil::BuildAppModelId(components));
 }
 
 TEST(ShellUtilTest, BuildAppModelIdManySmall) {
   std::vector<base::string16> components;
@@ skipping 59 matching lines @@
 
   const base::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));
   }
 }