chrome/browser/extensions/test_extension_prefs.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_EXTENSIONS_TEST_EXTENSION_PREFS_H_
   6 #define CHROME_BROWSER_EXTENSIONS_TEST_EXTENSION_PREFS_H_
   7
   8 #include <string>
   9
  10 #include "base/files/scoped_temp_dir.h"
  11 #include "base/memory/ref_counted.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "chrome/test/base/testing_profile.h"
  14 #include "extensions/common/manifest.h"
  15
  16 class ExtensionPrefValueMap;
  17 class PrefService;
  18
  19 namespace base {
  20 class DictionaryValue;
  21 class SequencedTaskRunner;
  22 }
  23
  24 namespace syncable_prefs {
  25 class PrefServiceSyncable;
  26 }
  27
  28 namespace user_prefs {
  29 class PrefRegistrySyncable;
  30 }
  31
  32 namespace extensions {
  33 class ChromeAppSorting;
  34 class Extension;
  35 class ExtensionPrefs;
  36
  37 // This is a test class intended to make it easier to work with ExtensionPrefs
  38 // in tests.
  39 class TestExtensionPrefs {
  40  public:
  41   explicit TestExtensionPrefs(
  42       const scoped_refptr<base::SequencedTaskRunner>& task_runner);
  43   virtual ~TestExtensionPrefs();
  44
  45   ExtensionPrefs* prefs();
  46
  47   PrefService* pref_service();
  48   const scoped_refptr<user_prefs::PrefRegistrySyncable>& pref_registry();
  49   void ResetPrefRegistry();
  50   const base::FilePath& temp_dir() const { return temp_dir_.path(); }
  51   const base::FilePath& extensions_dir() const { return extensions_dir_; }
  52   ExtensionPrefValueMap* extension_pref_value_map() {
  53     return extension_pref_value_map_.get();
  54   }
  55
  56   // This will cause the ExtensionPrefs to be deleted and recreated, based on
  57   // any existing backing file we had previously created.
  58   void RecreateExtensionPrefs();
  59
  60   // Creates a new Extension with the given name in our temp dir, adds it to
  61   // our ExtensionPrefs, and returns it.
  62   scoped_refptr<Extension> AddExtension(const std::string& name);
  63
  64   // As above, but the extension is an app.
  65   scoped_refptr<Extension> AddApp(const std::string& name);
  66
  67   // Similar to AddExtension, but takes a dictionary with manifest values.
  68   scoped_refptr<Extension> AddExtensionWithManifest(
  69       const base::DictionaryValue& manifest,
  70       Manifest::Location location);
  71
  72   // Similar to AddExtension, but takes a dictionary with manifest values
  73   // and extension flags.
  74   scoped_refptr<Extension> AddExtensionWithManifestAndFlags(
  75       const base::DictionaryValue& manifest,
  76       Manifest::Location location,
  77       int extra_flags);
  78
  79   // Similar to AddExtension, this adds a new test Extension. This is useful for
  80   // cases when you don't need the Extension object, but just the id it was
  81   // assigned.
  82   std::string AddExtensionAndReturnId(const std::string& name);
  83
  84   // This will add extension in our ExtensionPrefs.
  85   void AddExtension(Extension* extension);
  86
  87   PrefService* CreateIncognitoPrefService() const;
  88
  89   // Allows disabling the loading of preferences of extensions. Becomes
  90   // active after calling RecreateExtensionPrefs(). Defaults to false.
  91   void set_extensions_disabled(bool extensions_disabled);
  92
  93   ChromeAppSorting* app_sorting();
  94
  95  protected:
  96   base::ScopedTempDir temp_dir_;
  97   base::FilePath preferences_file_;
  98   base::FilePath extensions_dir_;
  99   scoped_refptr<user_prefs::PrefRegistrySyncable> pref_registry_;
 100   scoped_ptr<syncable_prefs::PrefServiceSyncable> pref_service_;
 101   scoped_ptr<ExtensionPrefValueMap> extension_pref_value_map_;
 102   const scoped_refptr<base::SequencedTaskRunner> task_runner_;
 103
 104  private:
 105   TestingProfile profile_;
 106   bool extensions_disabled_;
 107   DISALLOW_COPY_AND_ASSIGN(TestExtensionPrefs);
 108 };
 109
 110 }  // namespace extensions
 111
 112 #endif  // CHROME_BROWSER_EXTENSIONS_TEST_EXTENSION_PREFS_H_