base/prefs/testing_pref_store.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 BASE_PREFS_TESTING_PREF_STORE_H_
   6 #define BASE_PREFS_TESTING_PREF_STORE_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/compiler_specific.h"
  12 #include "base/observer_list.h"
  13 #include "base/prefs/persistent_pref_store.h"
  14 #include "base/prefs/pref_value_map.h"
  15
  16 // |TestingPrefStore| is a preference store implementation that allows tests to
  17 // explicitly manipulate the contents of the store, triggering notifications
  18 // where appropriate.
  19 class TestingPrefStore : public PersistentPrefStore {
  20  public:
  21   TestingPrefStore();
  22
  23   // Overriden from PrefStore.
  24   bool GetValue(const std::string& key,
  25                 const base::Value** result) const override;
  26   void AddObserver(PrefStore::Observer* observer) override;
  27   void RemoveObserver(PrefStore::Observer* observer) override;
  28   bool HasObservers() const override;
  29   bool IsInitializationComplete() const override;
  30
  31   // PersistentPrefStore overrides:
  32   bool GetMutableValue(const std::string& key, base::Value** result) override;
  33   void ReportValueChanged(const std::string& key) override;
  34   void SetValue(const std::string& key, base::Value* value) override;
  35   void SetValueSilently(const std::string& key, base::Value* value) override;
  36   void RemoveValue(const std::string& key) override;
  37   bool ReadOnly() const override;
  38   PrefReadError GetReadError() const override;
  39   PersistentPrefStore::PrefReadError ReadPrefs() override;
  40   void ReadPrefsAsync(ReadErrorDelegate* error_delegate) override;
  41   void CommitPendingWrite() override;
  42
  43   // Marks the store as having completed initialization.
  44   void SetInitializationCompleted();
  45
  46   // Used for tests to trigger notifications explicitly.
  47   void NotifyPrefValueChanged(const std::string& key);
  48   void NotifyInitializationCompleted();
  49
  50   // Some convenience getters/setters.
  51   void SetString(const std::string& key, const std::string& value);
  52   void SetInteger(const std::string& key, int value);
  53   void SetBoolean(const std::string& key, bool value);
  54
  55   bool GetString(const std::string& key, std::string* value) const;
  56   bool GetInteger(const std::string& key, int* value) const;
  57   bool GetBoolean(const std::string& key, bool* value) const;
  58
  59   // Determines whether ReadPrefsAsync completes immediately. Defaults to false
  60   // (non-blocking). To block, invoke this with true (blocking) before the call
  61   // to ReadPrefsAsync. To unblock, invoke again with false (non-blocking) after
  62   // the call to ReadPrefsAsync.
  63   void SetBlockAsyncRead(bool block_async_read);
  64
  65   // Getter and Setter methods for setting and getting the state of the
  66   // |TestingPrefStore|.
  67   virtual void set_read_only(bool read_only);
  68   void set_read_success(bool read_success);
  69   void set_read_error(PersistentPrefStore::PrefReadError read_error);
  70   bool committed() { return committed_; }
  71
  72  protected:
  73   ~TestingPrefStore() override;
  74
  75  private:
  76   // Stores the preference values.
  77   PrefValueMap prefs_;
  78
  79   // Flag that indicates if the PrefStore is read-only
  80   bool read_only_;
  81
  82   // The result to pass to PrefStore::Observer::OnInitializationCompleted
  83   bool read_success_;
  84
  85   // The result to return from ReadPrefs or ReadPrefsAsync.
  86   PersistentPrefStore::PrefReadError read_error_;
  87
  88   // Whether a call to ReadPrefsAsync should block.
  89   bool block_async_read_;
  90
  91   // Whether there is a pending call to ReadPrefsAsync.
  92   bool pending_async_read_;
  93
  94   // Whether initialization has been completed.
  95   bool init_complete_;
  96
  97   // Whether the store contents have been committed to disk since the last
  98   // mutation.
  99   bool committed_;
 100
 101   scoped_ptr<ReadErrorDelegate> error_delegate_;
 102   ObserverList<PrefStore::Observer, true> observers_;
 103
 104   DISALLOW_COPY_AND_ASSIGN(TestingPrefStore);
 105 };
 106
 107 #endif  // BASE_PREFS_TESTING_PREF_STORE_H_