blob: 381a736101e18b627ca2bb846d7b324cae4ae51d [file] [log] [blame]
// 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 <memory>
#include <string>
#include "base/files/scoped_temp_dir.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "chrome/test/base/testing_profile.h"
#include "extensions/common/manifest.h"
class ExtensionPrefValueMap;
class PrefService;
namespace base {
class DictionaryValue;
class SequencedTaskRunner;
namespace sync_preferences {
class PrefServiceSyncable;
namespace user_prefs {
class PrefRegistrySyncable;
namespace extensions {
class ChromeAppSorting;
class Extension;
class ExtensionPrefs;
// This is a test class intended to make it easier to work with ExtensionPrefs
// in tests.
class TestExtensionPrefs {
explicit TestExtensionPrefs(
const scoped_refptr<base::SequencedTaskRunner>& task_runner);
virtual ~TestExtensionPrefs();
ExtensionPrefs* prefs();
TestingProfile* profile();
PrefService* pref_service();
const scoped_refptr<user_prefs::PrefRegistrySyncable>& pref_registry();
void ResetPrefRegistry();
const base::FilePath& temp_dir() const { return temp_dir_.GetPath(); }
const base::FilePath& extensions_dir() const { return extensions_dir_; }
ExtensionPrefValueMap* extension_pref_value_map() {
return extension_pref_value_map_.get();
// This will cause the ExtensionPrefs to be deleted and recreated, based on
// any existing backing file we had previously created.
void RecreateExtensionPrefs();
// Creates a new Extension with the given name in our temp dir, adds it to
// our ExtensionPrefs, and returns it.
scoped_refptr<Extension> AddExtension(const std::string& name);
// As above, but the extension is an app.
scoped_refptr<Extension> AddApp(const std::string& name);
// Similar to AddExtension, but takes a dictionary with manifest values.
scoped_refptr<Extension> AddExtensionWithManifest(
const base::DictionaryValue& manifest,
Manifest::Location location);
// Similar to AddExtension, but takes a dictionary with manifest values
// and extension flags.
scoped_refptr<Extension> AddExtensionWithManifestAndFlags(
const base::DictionaryValue& manifest,
Manifest::Location location,
int extra_flags);
// Similar to AddExtension, this adds a new test Extension. This is useful for
// cases when you don't need the Extension object, but just the id it was
// assigned.
std::string AddExtensionAndReturnId(const std::string& name);
// This will add extension in our ExtensionPrefs.
void AddExtension(const Extension* extension);
std::unique_ptr<PrefService> CreateIncognitoPrefService() const;
// Allows disabling the loading of preferences of extensions. Becomes
// active after calling RecreateExtensionPrefs(). Defaults to false.
void set_extensions_disabled(bool extensions_disabled);
ChromeAppSorting* app_sorting();
class IncrementalClock;
base::ScopedTempDir temp_dir_;
base::FilePath preferences_file_;
base::FilePath extensions_dir_;
scoped_refptr<user_prefs::PrefRegistrySyncable> pref_registry_;
std::unique_ptr<sync_preferences::PrefServiceSyncable> pref_service_;
std::unique_ptr<ExtensionPrefValueMap> extension_pref_value_map_;
const scoped_refptr<base::SequencedTaskRunner> task_runner_;
// |clock_| is injected to an ExtensionPrefs that associated to |profile_|.
// Put |clock_| above |profile_| to outlive it.
std::unique_ptr<IncrementalClock> clock_;
TestingProfile profile_;
bool extensions_disabled_;
} // namespace extensions