1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/prefs/testing_pref_store.h"
#include <memory>
#include <string>
#include <utility>
#include "base/json/json_writer.h"
#include "base/run_loop.h"
#include "base/strings/string_piece.h"
#include "base/values.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace {
class ChangedValueWaiter : public PrefStore::Observer {
public:
ChangedValueWaiter(scoped_refptr<PrefStore> store, std::string key)
: store_(std::move(store)), key_(std::move(key)) {
store_->AddObserver(this);
const base::Value* old_value = nullptr;
if (store_->GetValue(key_, &old_value)) {
old_value_ = old_value->Clone();
}
}
~ChangedValueWaiter() override { store_->RemoveObserver(this); }
void Wait() { run_loop_.Run(); }
private:
void QuitRunLoopIfNewValueIsPresent() {
absl::optional<base::Value> new_value;
{
const base::Value* value = nullptr;
if (store_->GetValue(key_, &value)) {
new_value = value->Clone();
}
}
if (new_value != old_value_) {
run_loop_.Quit();
}
}
void OnInitializationCompleted(bool succeeded) override {
QuitRunLoopIfNewValueIsPresent();
}
void OnPrefValueChanged(const std::string& key) override {
if (key == key_) {
QuitRunLoopIfNewValueIsPresent();
}
}
scoped_refptr<PrefStore> store_;
std::string key_;
absl::optional<base::Value> old_value_;
base::RunLoop run_loop_;
};
} // namespace
TestingPrefStore::TestingPrefStore()
: read_only_(true),
read_success_(true),
read_error_(PersistentPrefStore::PREF_READ_ERROR_NONE),
block_async_read_(false),
pending_async_read_(false),
init_complete_(false),
committed_(true) {}
bool TestingPrefStore::GetValue(base::StringPiece key,
const base::Value** value) const {
return prefs_.GetValue(key, value);
}
base::Value::Dict TestingPrefStore::GetValues() const {
return prefs_.AsDict();
}
bool TestingPrefStore::GetMutableValue(const std::string& key,
base::Value** value) {
return prefs_.GetValue(key, value);
}
void TestingPrefStore::AddObserver(PrefStore::Observer* observer) {
observers_.AddObserver(observer);
}
void TestingPrefStore::RemoveObserver(PrefStore::Observer* observer) {
observers_.RemoveObserver(observer);
}
bool TestingPrefStore::HasObservers() const {
return !observers_.empty();
}
bool TestingPrefStore::IsInitializationComplete() const {
return init_complete_;
}
void TestingPrefStore::SetValue(const std::string& key,
base::Value value,
uint32_t flags) {
if (prefs_.SetValue(key, std::move(value))) {
committed_ = false;
NotifyPrefValueChanged(key);
}
}
void TestingPrefStore::SetValueSilently(const std::string& key,
base::Value value,
uint32_t flags) {
CheckPrefIsSerializable(key, value);
if (prefs_.SetValue(key, std::move(value)))
committed_ = false;
}
void TestingPrefStore::RemoveValue(const std::string& key, uint32_t flags) {
if (prefs_.RemoveValue(key)) {
committed_ = false;
NotifyPrefValueChanged(key);
}
}
void TestingPrefStore::RemoveValuesByPrefixSilently(const std::string& prefix) {
prefs_.ClearWithPrefix(prefix);
}
bool TestingPrefStore::ReadOnly() const {
return read_only_;
}
PersistentPrefStore::PrefReadError TestingPrefStore::GetReadError() const {
return read_error_;
}
PersistentPrefStore::PrefReadError TestingPrefStore::ReadPrefs() {
NotifyInitializationCompleted();
return read_error_;
}
void TestingPrefStore::ReadPrefsAsync(ReadErrorDelegate* error_delegate) {
DCHECK(!pending_async_read_);
error_delegate_.reset(error_delegate);
if (block_async_read_)
pending_async_read_ = true;
else
NotifyInitializationCompleted();
}
void TestingPrefStore::CommitPendingWrite(
base::OnceClosure reply_callback,
base::OnceClosure synchronous_done_callback) {
committed_ = true;
PersistentPrefStore::CommitPendingWrite(std::move(reply_callback),
std::move(synchronous_done_callback));
}
void TestingPrefStore::SchedulePendingLossyWrites() {}
void TestingPrefStore::SetInitializationCompleted() {
NotifyInitializationCompleted();
}
void TestingPrefStore::NotifyPrefValueChanged(const std::string& key) {
for (Observer& observer : observers_)
observer.OnPrefValueChanged(key);
}
void TestingPrefStore::NotifyInitializationCompleted() {
DCHECK(!init_complete_);
init_complete_ = true;
if (read_success_ && read_error_ != PREF_READ_ERROR_NONE && error_delegate_)
error_delegate_->OnError(read_error_);
for (Observer& observer : observers_)
observer.OnInitializationCompleted(read_success_);
}
void TestingPrefStore::ReportValueChanged(const std::string& key,
uint32_t flags) {
const base::Value* value = nullptr;
if (prefs_.GetValue(key, &value))
CheckPrefIsSerializable(key, *value);
for (Observer& observer : observers_)
observer.OnPrefValueChanged(key);
}
void TestingPrefStore::SetString(const std::string& key,
const std::string& value) {
SetValue(key, base::Value(value), DEFAULT_PREF_WRITE_FLAGS);
}
void TestingPrefStore::SetInteger(const std::string& key, int value) {
SetValue(key, base::Value(value), DEFAULT_PREF_WRITE_FLAGS);
}
void TestingPrefStore::SetBoolean(const std::string& key, bool value) {
SetValue(key, base::Value(value), DEFAULT_PREF_WRITE_FLAGS);
}
bool TestingPrefStore::GetString(const std::string& key,
std::string* value) const {
const base::Value* stored_value;
if (!prefs_.GetValue(key, &stored_value) || !stored_value)
return false;
if (value && stored_value->is_string()) {
*value = stored_value->GetString();
return true;
}
return stored_value->is_string();
}
bool TestingPrefStore::GetInteger(const std::string& key, int* value) const {
const base::Value* stored_value;
if (!prefs_.GetValue(key, &stored_value) || !stored_value)
return false;
if (value && stored_value->is_int()) {
*value = stored_value->GetInt();
return true;
}
return stored_value->is_int();
}
bool TestingPrefStore::GetBoolean(const std::string& key, bool* value) const {
const base::Value* stored_value;
if (!prefs_.GetValue(key, &stored_value) || !stored_value)
return false;
if (value && stored_value->is_bool()) {
*value = stored_value->GetBool();
return true;
}
return stored_value->is_bool();
}
void TestingPrefStore::SetBlockAsyncRead(bool block_async_read) {
DCHECK(!init_complete_);
block_async_read_ = block_async_read;
if (pending_async_read_ && !block_async_read_)
NotifyInitializationCompleted();
}
void TestingPrefStore::WaitUntilValueChanges(std::string key) {
ChangedValueWaiter waiter(this, std::move(key));
waiter.Wait();
}
void TestingPrefStore::WaitForValue(std::string key,
base::Value expected_value) {
while (true) {
const base::Value* curr_value = nullptr;
if (GetValue(key, &curr_value) && *curr_value == expected_value) {
break;
}
WaitUntilValueChanges(key);
}
}
void TestingPrefStore::OnStoreDeletionFromDisk() {}
void TestingPrefStore::set_read_only(bool read_only) {
read_only_ = read_only;
}
void TestingPrefStore::set_read_success(bool read_success) {
DCHECK(!init_complete_);
read_success_ = read_success;
}
void TestingPrefStore::set_read_error(
PersistentPrefStore::PrefReadError read_error) {
DCHECK(!init_complete_);
read_error_ = read_error;
}
TestingPrefStore::~TestingPrefStore() {
for (auto& pref : prefs_)
CheckPrefIsSerializable(pref.first, pref.second);
}
void TestingPrefStore::CheckPrefIsSerializable(const std::string& key,
const base::Value& value) {
std::string json;
EXPECT_TRUE(base::JSONWriter::Write(value, &json))
<< "Pref \"" << key << "\" is not serializable as JSON.";
}
|