Add gallery permissions to Media Galleries Preferences

chrome/browser/media_gallery/media_galleries_preferences_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.
+
+// MediaGalleriesPreferences unit tests.
+
+#include "chrome/browser/media_gallery/media_galleries_preferences.h"
+
+#include "base/command_line.h"
+#include "base/file_util.h"
+#include "base/memory/ref_counted.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/message_loop.h"
+#include "base/utf_string_conversions.h"
+#include "base/values.h"
+#include "chrome/browser/extensions/extension_service.h"
+#include "chrome/browser/extensions/extension_system.h"
+#include "chrome/browser/extensions/test_extension_system.h"
+#include "chrome/browser/media_gallery/media_file_system_registry.h"
+#include "chrome/common/chrome_switches.h"
+#include "chrome/common/extensions/extension.h"
+#include "chrome/common/extensions/extension_manifest_constants.h"
+#include "chrome/test/base/testing_profile.h"
+#include "content/public/test/test_browser_thread.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace chrome {
+
+namespace {
+
+class TestMediaGalleriesPreferences : public MediaGalleriesPreferences {
+ public:
+  static string16 GetDisplayNameForPath(const FilePath& path) {
+    return MediaGalleriesPreferences::ComputeDisplayName(path);
+  }
+};
+
+class MediaGalleriesPreferencesTest : public testing::Test {
+ public:
+  MediaGalleriesPreferencesTest()
+      : ui_thread_(content::BrowserThread::UI, &loop_),
+        file_thread_(content::BrowserThread::FILE, &loop_),
+        profile_(new TestingProfile()),
+        extension_service_(NULL),
+        default_galleries_count_(0) {
+  }
+
+  virtual ~MediaGalleriesPreferencesTest() {}
+
+  virtual void SetUp() OVERRIDE {
+    CommandLine::ForCurrentProcess()->AppendSwitch(
+        switches::kEnableMediaGalleryUI);
+    extensions_dir_ = profile_->GetPath().AppendASCII("Extensions");
+    ASSERT_TRUE(file_util::CreateDirectory(extensions_dir_));
+
+    extensions::TestExtensionSystem* extension_system(
+        static_cast<extensions::TestExtensionSystem*>(
+            extensions::ExtensionSystem::Get(profile_.get())));
+    extension_service_ = extension_system->CreateExtensionService(
+        CommandLine::ForCurrentProcess(), extensions_dir_, false);
+
+    MediaGalleriesPreferences::RegisterUserPrefs(profile_->GetPrefs());
+    gallery_prefs_.reset(new MediaGalleriesPreferences(profile_.get()));
+
+    // Load the default galleries into the expectations.
+    if (gallery_prefs_->known_galleries().size()) {
+      const MediaGalleriesPrefInfoMap& known_galleries =
+          gallery_prefs_->known_galleries();
+      ASSERT_EQ(1U, known_galleries.size());
+      default_galleries_count_ = 1;
+      MediaGalleriesPrefInfoMap::const_iterator it = known_galleries.begin();
+      expected_galleries_[it->first] = it->second;
+      if (it->second.type == MediaGalleryPrefInfo::kAutoDetected)
+        expected_galleries_for_all.insert(it->first);
+    }
+
+    std::vector<std::string> all_permissions;
+    all_permissions.push_back("mediaGalleriesAllGalleries");
+    all_permissions.push_back("mediaGalleriesRead");
+    std::vector<std::string> read_permissions;
+    read_permissions.push_back("mediaGalleriesRead");
+
+    all_permission_extension = AddApp("all", all_permissions);
+    regular_permission_extension = AddApp("regular", read_permissions);
+    no_permissions_extension = AddApp("no", read_permissions);
+  }
+
+  virtual void TearDown() OVERRIDE {
+    Verify();
+  }
+
+  void Verify() {
+    const MediaGalleriesPrefInfoMap& known_galleries =
+        gallery_prefs_->known_galleries();
+    EXPECT_EQ(expected_galleries_.size(), known_galleries.size());
+    for (MediaGalleriesPrefInfoMap::const_iterator it = known_galleries.begin();
+         it != known_galleries.end();
+         ++it) {
+      VerifyGalleryInfo(&it->second, it->first);
+    }
+
+    std::set<MediaGalleryPrefId> galleries_for_all =
+        gallery_prefs_->GalleriesForExtension(*all_permission_extension.get());
+    EXPECT_EQ(expected_galleries_for_all, galleries_for_all);
+
+    std::set<MediaGalleryPrefId> galleries_for_regular =
+        gallery_prefs_->GalleriesForExtension(
+            *regular_permission_extension.get());
+    EXPECT_EQ(expected_galleries_for_regular, galleries_for_regular);
+
+    std::set<MediaGalleryPrefId> galleries_for_no =
+        gallery_prefs_->GalleriesForExtension(*no_permissions_extension.get());
+    EXPECT_EQ(0U, galleries_for_no.size());
+  }
+
+  void VerifyGalleryInfo(const MediaGalleryPrefInfo* actual,
+                         MediaGalleryPrefId expected_id) const {
+    MediaGalleriesPrefInfoMap::const_iterator in_expectation =
+      expected_galleries_.find(expected_id);
+    EXPECT_FALSE(in_expectation == expected_galleries_.end());
+    EXPECT_EQ(in_expectation->second.pref_id, actual->pref_id);
+    EXPECT_EQ(in_expectation->second.display_name, actual->display_name);
+    EXPECT_EQ(in_expectation->second.device_id, actual->device_id);
+    EXPECT_EQ(in_expectation->second.path.value(), actual->path.value());
+    EXPECT_EQ(in_expectation->second.type, actual->type);
+  }
+
+  MediaGalleriesPreferences* gallery_prefs() {
+    return gallery_prefs_.get();
+  }
+
+  uint64 default_galleries_count() {
+    return default_galleries_count_;
+  }
+
+  void AddGalleryExpectation(MediaGalleryPrefId id, std::string display_name,
+                             std::string device_id, FilePath::StringType path,
+                             MediaGalleryPrefInfo::Type type) {
+    expected_galleries_[id].pref_id = id;
+    expected_galleries_[id].display_name = ASCIIToUTF16(display_name);
+    expected_galleries_[id].device_id = device_id;
+    expected_galleries_[id].path = FilePath(path);
+    expected_galleries_[id].type = type;
+
+    if (type == MediaGalleryPrefInfo::kAutoDetected)
+      expected_galleries_for_all.insert(id);
+  }
+
+  scoped_refptr<extensions::Extension> all_permission_extension;
+  scoped_refptr<extensions::Extension> regular_permission_extension;
+  scoped_refptr<extensions::Extension> no_permissions_extension;
+
+  std::set<MediaGalleryPrefId> expected_galleries_for_all;
+  std::set<MediaGalleryPrefId> expected_galleries_for_regular;
+
+  MediaGalleriesPrefInfoMap expected_galleries_;
+
+ private:
+  scoped_refptr<extensions::Extension> AddApp(
+      std::string name,
+      std::vector<std::string> permissions) {
+    scoped_ptr<DictionaryValue> manifest(new DictionaryValue);
+    manifest->SetString(extension_manifest_keys::kName, name);
+    manifest->SetString(extension_manifest_keys::kVersion, "0.1");
+    manifest->SetInteger(extension_manifest_keys::kManifestVersion, 2);
+    ListValue* background_script_list = new ListValue;;
+    background_script_list->Append(Value::CreateStringValue("background.js"));
+    manifest->Set(extension_manifest_keys::kPlatformAppBackgroundScripts,
+                  background_script_list);
+    ListValue* permission_list = new ListValue;;
+    for (size_t i = 0; i < permissions.size(); i++)
+      permission_list->Append(Value::CreateStringValue(permissions[i]));
+    manifest->Set(extension_manifest_keys::kPermissions, permission_list);
+
+    FilePath path = extensions_dir_.AppendASCII(name);
+    std::string errors;
+    scoped_refptr<extensions::Extension> extension =
+        extensions::Extension::Create(path,
+                                      extensions::Extension::INTERNAL,
+                                      *manifest.get(),
+                                      extensions::Extension::NO_FLAGS,
+                                      &errors);
+    EXPECT_TRUE(extension.get() != NULL) << errors;
+    EXPECT_TRUE(extensions::Extension::IdIsValid(extension->id()));
+    if (!extension.get() ||
+        !extensions::Extension::IdIsValid(extension->id())) {
+      return NULL;
+    }
+
+    extension_service_->extension_prefs()->OnExtensionInstalled(
+        extension, extensions::Extension::ENABLED, false,
+        StringOrdinal::CreateInitialOrdinal());
+
+    return extension;
+  }
+
+  // Needed for extension service & friends to work.
+  MessageLoop loop_;
+  content::TestBrowserThread ui_thread_;
+  content::TestBrowserThread file_thread_;
+
+  scoped_ptr<TestingProfile> profile_;
+  scoped_ptr<MediaGalleriesPreferences> gallery_prefs_;
+  FilePath extensions_dir_;
+  ExtensionService* extension_service_;
+
+  uint64 default_galleries_count_;
+
+  DISALLOW_COPY_AND_ASSIGN(MediaGalleriesPreferencesTest);
+};
+
+FilePath MakePath(std::string dir) {
+#if defined(OS_WIN)
+  return FilePath(FILE_PATH_LITERAL("C:\\")).Append(UTF8ToWide(dir));
+#elif defined(OS_POSIX)
+  return FilePath(FILE_PATH_LITERAL("/")).Append(dir);
+#else
+  NOTREACHED();
+#endif
+}
+
+TEST_F(MediaGalleriesPreferencesTest, GalleryManagement) {
+  MediaGalleryPrefId auto_id, user_added_id, id;
+  FilePath path;
+  std::string device_id;
+  Verify();
+
+  // Add a new auto detected gallery.
+  path = MakePath("new_auto");
+  device_id = MediaFileSystemRegistry::GetInstance()->GetDeviceIdFromPath(path);
+  id = gallery_prefs()->AddGallery(device_id, ASCIIToUTF16("NewAutoGallery"),
+                                   path, false /*auto*/);
+  EXPECT_EQ(default_galleries_count() + 1UL, id);
+  auto_id = id;
+  AddGalleryExpectation(id, "NewAutoGallery", device_id,
+                        FILE_PATH_LITERAL("new_auto"),
+                        MediaGalleryPrefInfo::kAutoDetected);
+  Verify();
+
+  // Add it again (as user), nothing should happen.
+  id = gallery_prefs()->AddGallery(device_id, ASCIIToUTF16("NewAutoGallery"),
+                                   path, true /*user*/);
+  EXPECT_EQ(auto_id, id);
+  Verify();
+
+  // Add a new user added gallery.
+  path = MakePath("new_user");
+  device_id = MediaFileSystemRegistry::GetInstance()->GetDeviceIdFromPath(path);
+  id = gallery_prefs()->AddGallery(device_id, ASCIIToUTF16("NewUserGallery"),
+                                   path, true /*user*/);
+  EXPECT_EQ(default_galleries_count() + 2UL, id);
+  user_added_id = id;
+  AddGalleryExpectation(id, "NewUserGallery", device_id,
+                        FILE_PATH_LITERAL("new_user"),
+                        MediaGalleryPrefInfo::kUserAdded);
+  Verify();
+
+  // Lookup some galleries.
+  EXPECT_TRUE(gallery_prefs()->LookUpGalleryByPath(MakePath("new_auto"), NULL));
+  EXPECT_TRUE(gallery_prefs()->LookUpGalleryByPath(MakePath("new_user"), NULL));
+  EXPECT_FALSE(gallery_prefs()->LookUpGalleryByPath(MakePath("other"), NULL));
+
+  // Check that we always get the gallery info.
+  MediaGalleryPrefInfo gallery_info;
+  EXPECT_TRUE(gallery_prefs()->LookUpGalleryByPath(MakePath("new_auto"),
+                                                   &gallery_info));
+  VerifyGalleryInfo(&gallery_info, auto_id);
+  EXPECT_TRUE(gallery_prefs()->LookUpGalleryByPath(MakePath("new_user"),
+                                                   &gallery_info));
+  VerifyGalleryInfo(&gallery_info, user_added_id);
+
+  path = MakePath("other");
+  EXPECT_FALSE(gallery_prefs()->LookUpGalleryByPath(path, &gallery_info));
+  EXPECT_EQ(kInvalidMediaGalleryPrefId, gallery_info.pref_id);
+  EXPECT_EQ(TestMediaGalleriesPreferences::GetDisplayNameForPath(path),
+            gallery_info.display_name);
+  EXPECT_EQ(MediaFileSystemRegistry::GetInstance()->GetDeviceIdFromPath(path),
+            gallery_info.device_id);
+  EXPECT_EQ(FilePath(FILE_PATH_LITERAL("other")).value(),
+            gallery_info.path.value());
+
+  // Remove an auto added gallery (i.e. make it blacklisted).
+  gallery_prefs()->ForgetGalleryById(auto_id);
+  expected_galleries_[auto_id].type = MediaGalleryPrefInfo::kBlackListed;
+  expected_galleries_for_all.erase(auto_id);
+  Verify();
+
+  // Remove a user added gallery and it should go away.
+  gallery_prefs()->ForgetGalleryById(user_added_id);
+  expected_galleries_.erase(user_added_id);
+  Verify();
+}
+
+TEST_F(MediaGalleriesPreferencesTest, GalleryPermissions) {
+  MediaGalleryPrefId auto_id, user_added_id, to_blacklist_id, id;
+  FilePath path;
+  std::string device_id;
+  Verify();
+
+  // Add some galleries to test with.
+  path = MakePath("new_user");
+  device_id = MediaFileSystemRegistry::GetInstance()->GetDeviceIdFromPath(path);
+  id = gallery_prefs()->AddGallery(device_id, ASCIIToUTF16("NewUserGallery"),
+                                   path, true /*user*/);
+  EXPECT_EQ(default_galleries_count() + 1UL, id);
+  user_added_id = id;
+  AddGalleryExpectation(id, "NewUserGallery", device_id,
+                        FILE_PATH_LITERAL("new_user"),
+                        MediaGalleryPrefInfo::kUserAdded);
+  Verify();
+
+  path = MakePath("new_auto");
+  device_id = MediaFileSystemRegistry::GetInstance()->GetDeviceIdFromPath(path);
+  id = gallery_prefs()->AddGallery(device_id, ASCIIToUTF16("NewAutoGallery"),
+                                   path, false /*auto*/);
+  EXPECT_EQ(default_galleries_count() + 2UL, id);
+  auto_id = id;
+  AddGalleryExpectation(id, "NewAutoGallery", device_id,
+                        FILE_PATH_LITERAL("new_auto"),
+                        MediaGalleryPrefInfo::kAutoDetected);
+  Verify();
+
+  path = MakePath("to_blacklist");
+  device_id = MediaFileSystemRegistry::GetInstance()->GetDeviceIdFromPath(path);
+  id = gallery_prefs()->AddGallery(device_id,
+                                   ASCIIToUTF16("ToBlacklistGallery"), path,
+                                   false /*auto*/);
+  EXPECT_EQ(default_galleries_count() + 3UL, id);
+  to_blacklist_id = id;
+  AddGalleryExpectation(id, "ToBlacklistGallery", device_id,
+                        FILE_PATH_LITERAL("to_blacklist"),
+                        MediaGalleryPrefInfo::kAutoDetected);
+  Verify();
+
+  // Remove permission for all galleries from the all-permission extension.
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *all_permission_extension.get(), auto_id, false);
+  expected_galleries_for_all.erase(auto_id);
+  Verify();
+
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *all_permission_extension.get(), user_added_id, false);
+  expected_galleries_for_all.erase(user_added_id);
+  Verify();
+
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *all_permission_extension.get(), to_blacklist_id, false);
+  expected_galleries_for_all.erase(to_blacklist_id);
+  Verify();
+
+  // Add permission back for all galleries to the all-permission extension.
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *all_permission_extension.get(), auto_id, true);
+  expected_galleries_for_all.insert(auto_id);
+  Verify();
+
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *all_permission_extension.get(), user_added_id, true);
+  expected_galleries_for_all.insert(user_added_id);
+  Verify();
+
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *all_permission_extension.get(), to_blacklist_id, true);
+  expected_galleries_for_all.insert(to_blacklist_id);
+  Verify();
+
+  // Add permission for all galleries to the regular permission extension.
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *regular_permission_extension.get(), auto_id, true);
+  expected_galleries_for_regular.insert(auto_id);
+  Verify();
+
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *regular_permission_extension.get(), user_added_id, true);
+  expected_galleries_for_regular.insert(user_added_id);
+  Verify();
+
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *regular_permission_extension.get(), to_blacklist_id, true);
+  expected_galleries_for_regular.insert(to_blacklist_id);
+  Verify();
+
+  // Blacklist the to be black listed gallery
+  gallery_prefs()->ForgetGalleryById(to_blacklist_id);
+  expected_galleries_[to_blacklist_id].type =
+      MediaGalleryPrefInfo::kBlackListed;
+  expected_galleries_for_all.erase(to_blacklist_id);
+  expected_galleries_for_regular.erase(to_blacklist_id);
+  Verify();
+
+  // Remove permission for all galleries to the regular permission extension.
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *regular_permission_extension.get(), auto_id, false);
+  expected_galleries_for_regular.erase(auto_id);
+  Verify();
+
+  gallery_prefs()->SetGalleryPermissionForExtension(
+      *regular_permission_extension.get(), user_added_id, false);
+  expected_galleries_for_regular.erase(user_added_id);
+  Verify();
+}
+
+}  // namespace
+
+}  // namespace chrome