Move most of extension_file_util.cc into extensions/common/file_util.cc

chrome/common/extensions/extension_file_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/common/extensions/extension_file_util.h"
 
-#include "base/file_util.h"
-#include "base/files/scoped_temp_dir.h"
-#include "base/json/json_string_value_serializer.h"
+#include <set>
+
 #include "base/path_service.h"
-#include "base/strings/stringprintf.h"
-#include "base/strings/utf_string_conversions.h"
 #include "chrome/common/chrome_paths.h"
-#include "extensions/common/constants.h"
 #include "extensions/common/extension.h"
+#include "extensions/common/file_util.h"
 #include "extensions/common/manifest.h"
-#include "extensions/common/manifest_constants.h"
-#include "grit/generated_resources.h"
-#include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
-#include "ui/base/l10n/l10n_util.h"
 
-using extensions::Extension;
-using extensions::Manifest;
+namespace extensions {
 
-namespace keys = extensions::manifest_keys;
+typedef testing::Test ExtensionFileUtilTest;
 
-class ExtensionFileUtilTest : public testing::Test {
-};
-
-TEST_F(ExtensionFileUtilTest, InstallUninstallGarbageCollect) {
-  base::ScopedTempDir temp;
-  ASSERT_TRUE(temp.CreateUniqueTempDir());
-
-  // Create a source extension.
-  std::string extension_id("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
-  std::string version("1.0");
-  base::FilePath src = temp.path().AppendASCII(extension_id);
-  ASSERT_TRUE(base::CreateDirectory(src));
-
-  // Create a extensions tree.
-  base::FilePath all_extensions = temp.path().AppendASCII("extensions");
-  ASSERT_TRUE(base::CreateDirectory(all_extensions));
-
-  // Install in empty directory. Should create parent directories as needed.
-  base::FilePath version_1 = extension_file_util::InstallExtension(
-      src,
-      extension_id,
-      version,
-      all_extensions);
-  ASSERT_EQ(version_1.value(),
-            all_extensions.AppendASCII(extension_id).AppendASCII("1.0_0")
-                .value());
-  ASSERT_TRUE(base::DirectoryExists(version_1));
-
-  // Should have moved the source.
-  ASSERT_FALSE(base::DirectoryExists(src));
-
-  // Install again. Should create a new one with different name.
-  ASSERT_TRUE(base::CreateDirectory(src));
-  base::FilePath version_2 = extension_file_util::InstallExtension(
-      src,
-      extension_id,
-      version,
-      all_extensions);
-  ASSERT_EQ(version_2.value(),
-            all_extensions.AppendASCII(extension_id).AppendASCII("1.0_1")
-                .value());
-  ASSERT_TRUE(base::DirectoryExists(version_2));
-
-  // Should have moved the source.
-  ASSERT_FALSE(base::DirectoryExists(src));
-
-  // Install yet again. Should create a new one with a different name.
-  ASSERT_TRUE(base::CreateDirectory(src));
-  base::FilePath version_3 = extension_file_util::InstallExtension(
-      src,
-      extension_id,
-      version,
-      all_extensions);
-  ASSERT_EQ(version_3.value(),
-            all_extensions.AppendASCII(extension_id).AppendASCII("1.0_2")
-                .value());
-  ASSERT_TRUE(base::DirectoryExists(version_3));
-
-  // Uninstall. Should remove entire extension subtree.
-  extension_file_util::UninstallExtension(all_extensions, extension_id);
-  ASSERT_FALSE(base::DirectoryExists(version_1.DirName()));
-  ASSERT_FALSE(base::DirectoryExists(version_2.DirName()));
-  ASSERT_FALSE(base::DirectoryExists(version_3.DirName()));
-  ASSERT_TRUE(base::DirectoryExists(all_extensions));
-}
-
-TEST_F(ExtensionFileUtilTest, LoadExtensionWithValidLocales) {
+// Test that a browser action extension returns a path to an icon.
+TEST_F(ExtensionFileUtilTest, GetBrowserImagePaths) {
   base::FilePath install_dir;
   ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &install_dir));
   install_dir = install_dir.AppendASCII("extensions")
-      .AppendASCII("good")
-      .AppendASCII("Extensions")
-      .AppendASCII("behllobkkfkfnphdnhnkndlbkcpglgmj")
-      .AppendASCII("1.0.0.0");
+                    .AppendASCII("api_test")
+                    .AppendASCII("browser_action")
+                    .AppendASCII("basics");
 
   std::string error;
-  scoped_refptr<Extension> extension(extension_file_util::LoadExtension(
+  scoped_refptr<Extension> extension(file_util::LoadExtension(
       install_dir, Manifest::UNPACKED, Extension::NO_FLAGS, &error));
-  ASSERT_TRUE(extension.get() != NULL);
-  EXPECT_EQ("The first extension that I made.", extension->description());
+  ASSERT_TRUE(extension.get());
+
+  // The extension contains one icon.
+  std::set<base::FilePath> paths =
+      extension_file_util::GetBrowserImagePaths(extension.get());
+  ASSERT_EQ(1u, paths.size());
+  EXPECT_EQ("icon.png", paths.begin()->BaseName().AsUTF8Unsafe());
 }
 
-TEST_F(ExtensionFileUtilTest, LoadExtensionWithoutLocalesFolder) {
-  base::FilePath install_dir;
-  ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &install_dir));
-  install_dir = install_dir.AppendASCII("extensions")
-      .AppendASCII("good")
-      .AppendASCII("Extensions")
-      .AppendASCII("bjafgdebaacbbbecmhlhpofkepfkgcpa")
-      .AppendASCII("1.0");
-
-  std::string error;
-  scoped_refptr<Extension> extension(extension_file_util::LoadExtension(
-      install_dir, Manifest::UNPACKED, Extension::NO_FLAGS, &error));
-  ASSERT_FALSE(extension.get() == NULL);
-  EXPECT_TRUE(error.empty());
-}
-
-TEST_F(ExtensionFileUtilTest, CheckIllegalFilenamesNoUnderscores) {
-  base::ScopedTempDir temp;
-  ASSERT_TRUE(temp.CreateUniqueTempDir());
-
-  base::FilePath src_path = temp.path().AppendASCII("some_dir");
-  ASSERT_TRUE(base::CreateDirectory(src_path));
-
-  std::string data = "{ \"name\": { \"message\": \"foobar\" } }";
-  ASSERT_TRUE(base::WriteFile(src_path.AppendASCII("some_file.txt"),
-                              data.c_str(), data.length()));
-  std::string error;
-  EXPECT_TRUE(extension_file_util::CheckForIllegalFilenames(temp.path(),
-                                                            &error));
-}
-
-TEST_F(ExtensionFileUtilTest, CheckIllegalFilenamesOnlyReserved) {
-  base::ScopedTempDir temp;
-  ASSERT_TRUE(temp.CreateUniqueTempDir());
-
-  const base::FilePath::CharType* folders[] =
-      { extensions::kLocaleFolder, extensions::kPlatformSpecificFolder };
-
-  for (size_t i = 0; i < arraysize(folders); i++) {
-    base::FilePath src_path = temp.path().Append(folders[i]);
-    ASSERT_TRUE(base::CreateDirectory(src_path));
-  }
-
-  std::string error;
-  EXPECT_TRUE(extension_file_util::CheckForIllegalFilenames(temp.path(),
-                                                            &error));
-}
-
-TEST_F(ExtensionFileUtilTest, CheckIllegalFilenamesReservedAndIllegal) {
-  base::ScopedTempDir temp;
-  ASSERT_TRUE(temp.CreateUniqueTempDir());
-
-  base::FilePath src_path = temp.path().Append(extensions::kLocaleFolder);
-  ASSERT_TRUE(base::CreateDirectory(src_path));
-
-  src_path = temp.path().AppendASCII("_some_dir");
-  ASSERT_TRUE(base::CreateDirectory(src_path));
-
-  std::string error;
-  EXPECT_FALSE(extension_file_util::CheckForIllegalFilenames(temp.path(),
-                                                             &error));
-}
-
-TEST_F(ExtensionFileUtilTest,
-       LoadExtensionGivesHelpfullErrorOnMissingManifest) {
-  base::FilePath install_dir;
-  ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &install_dir));
-  install_dir = install_dir.AppendASCII("extensions")
-      .AppendASCII("bad")
-      .AppendASCII("Extensions")
-      .AppendASCII("dddddddddddddddddddddddddddddddd")
-      .AppendASCII("1.0");
-
-  std::string error;
-  scoped_refptr<Extension> extension(extension_file_util::LoadExtension(
-      install_dir, Manifest::UNPACKED, Extension::NO_FLAGS, &error));
-  ASSERT_TRUE(extension.get() == NULL);
-  ASSERT_FALSE(error.empty());
-  ASSERT_STREQ("Manifest file is missing or unreadable.", error.c_str());
-}
-
-TEST_F(ExtensionFileUtilTest, LoadExtensionGivesHelpfullErrorOnBadManifest) {
-  base::FilePath install_dir;
-  ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &install_dir));
-  install_dir = install_dir.AppendASCII("extensions")
-      .AppendASCII("bad")
-      .AppendASCII("Extensions")
-      .AppendASCII("eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee")
-      .AppendASCII("1.0");
-
-  std::string error;
-  scoped_refptr<Extension> extension(extension_file_util::LoadExtension(
-      install_dir, Manifest::UNPACKED, Extension::NO_FLAGS, &error));
-  ASSERT_TRUE(extension.get() == NULL);
-  ASSERT_FALSE(error.empty());
-  ASSERT_STREQ("Manifest is not valid JSON.  "
-               "Line: 2, column: 16, Syntax error.", error.c_str());
-}
-
-TEST_F(ExtensionFileUtilTest, FailLoadingNonUTF8Scripts) {
-  base::FilePath install_dir;
-  ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &install_dir));
-  install_dir = install_dir.AppendASCII("extensions")
-      .AppendASCII("bad")
-      .AppendASCII("bad_encoding");
-
-  std::string error;
-  scoped_refptr<Extension> extension(extension_file_util::LoadExtension(
-      install_dir, Manifest::UNPACKED, Extension::NO_FLAGS, &error));
-  ASSERT_TRUE(extension.get() == NULL);
-  ASSERT_STREQ("Could not load file 'bad_encoding.js' for content script. "
-               "It isn't UTF-8 encoded.",
-               error.c_str());
-}
-
-static scoped_refptr<Extension> LoadExtensionManifest(
-    base::DictionaryValue* manifest,
-    const base::FilePath& manifest_dir,
-    Manifest::Location location,
-    int extra_flags,
-    std::string* error) {
-  scoped_refptr<Extension> extension = Extension::Create(
-      manifest_dir, location, *manifest, extra_flags, error);
-  return extension;
-}
-
-static scoped_refptr<Extension> LoadExtensionManifest(
-    const std::string& manifest_value,
-    const base::FilePath& manifest_dir,
-    Manifest::Location location,
-    int extra_flags,
-    std::string* error) {
-  JSONStringValueSerializer serializer(manifest_value);
-  scoped_ptr<base::Value> result(serializer.Deserialize(NULL, error));
-  if (!result.get())
-    return NULL;
-  CHECK_EQ(base::Value::TYPE_DICTIONARY, result->GetType());
-  return LoadExtensionManifest(
-      static_cast<base::DictionaryValue*>(result.get()),
-      manifest_dir,
-      location,
-      extra_flags,
-      error);
-}
-
-TEST_F(ExtensionFileUtilTest, ValidateThemeUTF8) {
-  base::ScopedTempDir temp;
-  ASSERT_TRUE(temp.CreateUniqueTempDir());
-
-  // "aeo" with accents. Use http://0xcc.net/jsescape/ to decode them.
-  std::string non_ascii_file = "\xC3\xA0\xC3\xA8\xC3\xB2.png";
-  base::FilePath non_ascii_path =
-      temp.path().Append(base::FilePath::FromUTF8Unsafe(non_ascii_file));
-  base::WriteFile(non_ascii_path, "", 0);
-
-  std::string kManifest =
-      base::StringPrintf(
-          "{ \"name\": \"Test\", \"version\": \"1.0\", "
-          "  \"theme\": { \"images\": { \"theme_frame\": \"%s\" } }"
-          "}", non_ascii_file.c_str());
-  std::string error;
-  scoped_refptr<Extension> extension = LoadExtensionManifest(
-      kManifest, temp.path(), Manifest::UNPACKED, 0, &error);
-  ASSERT_TRUE(extension.get()) << error;
-
-  std::vector<extensions::InstallWarning> warnings;
-  EXPECT_TRUE(extension_file_util::ValidateExtension(
-      extension.get(), &error, &warnings)) << error;
-  EXPECT_EQ(0U, warnings.size());
-}
-
-TEST_F(ExtensionFileUtilTest, BackgroundScriptsMustExist) {
-  base::ScopedTempDir temp;
-  ASSERT_TRUE(temp.CreateUniqueTempDir());
-
-  scoped_ptr<base::DictionaryValue> value(new base::DictionaryValue());
-  value->SetString("name", "test");
-  value->SetString("version", "1");
-  value->SetInteger("manifest_version", 1);
-
-  base::ListValue* scripts = new base::ListValue();
-  scripts->Append(new base::StringValue("foo.js"));
-  value->Set("background.scripts", scripts);
-
-  std::string error;
-  std::vector<extensions::InstallWarning> warnings;
-  scoped_refptr<Extension> extension = LoadExtensionManifest(
-      value.get(), temp.path(), Manifest::UNPACKED, 0, &error);
-  ASSERT_TRUE(extension.get()) << error;
-
-  EXPECT_FALSE(extension_file_util::ValidateExtension(
-      extension.get(), &error, &warnings));
-  EXPECT_EQ(l10n_util::GetStringFUTF8(
-      IDS_EXTENSION_LOAD_BACKGROUND_SCRIPT_FAILED,
-      base::ASCIIToUTF16("foo.js")),
-           error);
-  EXPECT_EQ(0U, warnings.size());
-
-  scripts->Clear();
-  scripts->Append(new base::StringValue("http://google.com/foo.js"));
-
-  extension = LoadExtensionManifest(value.get(), temp.path(),
-                                    Manifest::UNPACKED, 0, &error);
-  ASSERT_TRUE(extension.get()) << error;
-
-  warnings.clear();
-  EXPECT_FALSE(extension_file_util::ValidateExtension(
-      extension.get(), &error, &warnings));
-  EXPECT_EQ(l10n_util::GetStringFUTF8(
-      IDS_EXTENSION_LOAD_BACKGROUND_SCRIPT_FAILED,
-      base::ASCIIToUTF16("http://google.com/foo.js")),
-           error);
-  EXPECT_EQ(0U, warnings.size());
-}
-
-// Private key, generated by Chrome specifically for this test, and
-// never used elsewhere.
-const char private_key[] =
-    "-----BEGIN PRIVATE KEY-----\n"
-    "MIICdgIBADANBgkqhkiG9w0BAQEFAASCAmAwggJcAgEAAoGBAKt02SR0FYaYy6fpW\n"
-    "MAA+kU1BgK3d+OmmWfdr+JATIjhRkyeSF4lTd/71JQsyKqPzYkQPi3EeROWM+goTv\n"
-    "EhJqq07q63BolpsFmlV+S4ny+sBA2B4aWwRYXlBWikdrQSA0mJMzvEHc6nKzBgXik\n"
-    "QSVbyyBNAsxlDB9WaCxRVOpK3AgMBAAECgYBGvSPlrVtAOAQ2V8j9FqorKZA8SLPX\n"
-    "IeJC/yzU3RB2nPMjI17aMOvrUHxJUhzMeh4jwabVvSzzDtKFozPGupW3xaI8sQdi2\n"
-    "WWMTQIk/Q9HHDWoQ9qA6SwX2qWCc5SyjCKqVp78ye+000kqTJYjBsDgXeAlzKcx2B\n"
-    "4GAAeWonDdkQJBANNb8wrqNWFn7DqyQTfELzcRTRnqQ/r1pdeJo6obzbnwGnlqe3t\n"
-    "KhLjtJNIGrQg5iC0OVLWFuvPJs0t3z62A1ckCQQDPq2JZuwTwu5Pl4DJ0r9O1FdqN\n"
-    "JgqPZyMptokCDQ3khLLGakIu+TqB9YtrzI69rJMSG2Egb+6McaDX+dh3XmR/AkB9t\n"
-    "xJf6qDnmA2td/tMtTc0NOk8Qdg/fD8xbZ/YfYMnVoYYs9pQoilBaWRePDRNURMLYZ\n"
-    "vHAI0Llmw7tj7jv17pAkEAz44uXRpjRKtllUIvi5pUENAHwDz+HvdpGH68jpU3hmb\n"
-    "uOwrmnQYxaMReFV68Z2w9DcLZn07f7/R9Wn72z89CxwJAFsDoNaDes4h48bX7plct\n"
-    "s9ACjmTwcCigZjN2K7AGv7ntCLF3DnV5dK0dTHNaAdD3SbY3jl29Rk2CwiURSX6Ee\n"
-    "g==\n"
-    "-----END PRIVATE KEY-----\n";
-
-TEST_F(ExtensionFileUtilTest, FindPrivateKeyFiles) {
-  base::ScopedTempDir temp;
-  ASSERT_TRUE(temp.CreateUniqueTempDir());
-
-  base::FilePath src_path = temp.path().AppendASCII("some_dir");
-  ASSERT_TRUE(base::CreateDirectory(src_path));
-
-  ASSERT_TRUE(base::WriteFile(src_path.AppendASCII("a_key.pem"),
-                              private_key, arraysize(private_key)));
-  ASSERT_TRUE(base::WriteFile(src_path.AppendASCII("second_key.pem"),
-                              private_key, arraysize(private_key)));
-  // Shouldn't find a key with a different extension.
-  ASSERT_TRUE(base::WriteFile(src_path.AppendASCII("key.diff_ext"),
-                              private_key, arraysize(private_key)));
-  // Shouldn't find a key that isn't parsable.
-  ASSERT_TRUE(base::WriteFile(src_path.AppendASCII("unparsable_key.pem"),
-                              private_key, arraysize(private_key) - 30));
-  std::vector<base::FilePath> private_keys =
-      extension_file_util::FindPrivateKeyFiles(temp.path());
-  EXPECT_EQ(2U, private_keys.size());
-  EXPECT_THAT(private_keys,
-              testing::Contains(src_path.AppendASCII("a_key.pem")));
-  EXPECT_THAT(private_keys,
-              testing::Contains(src_path.AppendASCII("second_key.pem")));
-}
-
-TEST_F(ExtensionFileUtilTest, WarnOnPrivateKey) {
-  base::ScopedTempDir temp;
-  ASSERT_TRUE(temp.CreateUniqueTempDir());
-
-  base::FilePath ext_path = temp.path().AppendASCII("ext_root");
-  ASSERT_TRUE(base::CreateDirectory(ext_path));
-
-  const char manifest[] =
-      "{\n"
-      "  \"name\": \"Test Extension\",\n"
-      "  \"version\": \"1.0\",\n"
-      "  \"manifest_version\": 2,\n"
-      "  \"description\": \"The first extension that I made.\"\n"
-      "}\n";
-  ASSERT_TRUE(base::WriteFile(ext_path.AppendASCII("manifest.json"),
-                              manifest, strlen(manifest)));
-  ASSERT_TRUE(base::WriteFile(ext_path.AppendASCII("a_key.pem"),
-                              private_key, strlen(private_key)));
-
-  std::string error;
-  scoped_refptr<Extension> extension(extension_file_util::LoadExtension(
-      ext_path, "the_id", Manifest::EXTERNAL_PREF,
-      Extension::NO_FLAGS, &error));
-  ASSERT_TRUE(extension.get()) << error;
-  ASSERT_EQ(1u, extension->install_warnings().size());
-  EXPECT_THAT(
-      extension->install_warnings(),
-      testing::ElementsAre(
-          testing::Field(
-              &extensions::InstallWarning::message,
-              testing::ContainsRegex(
-                  "extension includes the key file.*ext_root.a_key.pem"))));
-
-  // Turn the warning into an error with ERROR_ON_PRIVATE_KEY.
-  extension = extension_file_util::LoadExtension(
-      ext_path, "the_id", Manifest::EXTERNAL_PREF,
-      Extension::ERROR_ON_PRIVATE_KEY, &error);
-  EXPECT_FALSE(extension.get());
-  EXPECT_THAT(error,
-              testing::ContainsRegex(
-                  "extension includes the key file.*ext_root.a_key.pem"));
-}
-
-TEST_F(ExtensionFileUtilTest, CheckZeroLengthImageFile) {
-  base::FilePath install_dir;
-  ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &install_dir));
-
-  // Try to install an extension with a zero-length icon file.
-  base::FilePath ext_dir = install_dir.AppendASCII("extensions")
-      .AppendASCII("bad")
-      .AppendASCII("Extensions")
-      .AppendASCII("ffffffffffffffffffffffffffffffff");
-
-  std::string error;
-  scoped_refptr<Extension> extension(extension_file_util::LoadExtension(
-      ext_dir, Manifest::UNPACKED, Extension::NO_FLAGS, &error));
-  EXPECT_TRUE(extension.get() == NULL);
-  EXPECT_STREQ("Could not load extension icon 'icon.png'.", error.c_str());
-
-  // Try to install an extension with a zero-length browser action icon file.
-  ext_dir = install_dir.AppendASCII("extensions")
-      .AppendASCII("bad")
-      .AppendASCII("Extensions")
-      .AppendASCII("gggggggggggggggggggggggggggggggg");
-
-  scoped_refptr<Extension> extension2(extension_file_util::LoadExtension(
-      ext_dir, Manifest::UNPACKED, Extension::NO_FLAGS, &error));
-  EXPECT_TRUE(extension2.get() == NULL);
-  EXPECT_STREQ("Could not load icon 'icon.png' for browser action.",
-               error.c_str());
-
-  // Try to install an extension with a zero-length page action icon file.
-  ext_dir = install_dir.AppendASCII("extensions")
-      .AppendASCII("bad")
-      .AppendASCII("Extensions")
-      .AppendASCII("hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh");
-
-  scoped_refptr<Extension> extension3(extension_file_util::LoadExtension(
-      ext_dir, Manifest::UNPACKED, Extension::NO_FLAGS, &error));
-  EXPECT_TRUE(extension3.get() == NULL);
-  EXPECT_STREQ("Could not load icon 'icon.png' for page action.",
-               error.c_str());
-}
-
-// TODO(aa): More tests as motivation allows. Maybe steal some from
-// ExtensionService? Many of them could probably be tested here without the
-// MessageLoop shenanigans.
+}  // namespace extensions