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
|
// 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/overlay_user_pref_store.h"
#include <memory>
#include "base/test/task_environment.h"
#include "base/values.h"
#include "components/prefs/persistent_pref_store_unittest.h"
#include "components/prefs/pref_store_observer_mock.h"
#include "components/prefs/testing_pref_store.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::testing::Mock;
using ::testing::StrEq;
namespace base {
namespace {
const char kBrowserWindowPlacement[] = "browser.window_placement";
const char kShowBookmarkBar[] = "bookmark_bar.show_on_all_tabs";
const char kSharedKey[] = "sync_promo.show_on_first_run_allowed";
const char* const regular_key = kBrowserWindowPlacement;
const char* const persistent_key = kShowBookmarkBar;
const char* const shared_key = kSharedKey;
} // namespace
class OverlayUserPrefStoreTest : public testing::Test {
protected:
OverlayUserPrefStoreTest()
: underlay_(new TestingPrefStore()),
overlay_(new OverlayUserPrefStore(underlay_.get())) {
overlay_->RegisterPersistentPref(persistent_key);
overlay_->RegisterPersistentPref(shared_key);
}
~OverlayUserPrefStoreTest() override {}
base::test::TaskEnvironment task_environment_;
scoped_refptr<TestingPrefStore> underlay_;
scoped_refptr<OverlayUserPrefStore> overlay_;
};
TEST_F(OverlayUserPrefStoreTest, Observer) {
PrefStoreObserverMock obs;
overlay_->AddObserver(&obs);
// Check that underlay first value is reported.
underlay_->SetValue(regular_key, Value(42),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
obs.VerifyAndResetChangedKey(regular_key);
// Check that underlay overwriting is reported.
underlay_->SetValue(regular_key, Value(43),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
obs.VerifyAndResetChangedKey(regular_key);
// Check that overwriting change in overlay is reported.
overlay_->SetValue(regular_key, Value(44),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
obs.VerifyAndResetChangedKey(regular_key);
// Check that hidden underlay change is not reported.
underlay_->SetValue(regular_key, Value(45),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
EXPECT_TRUE(obs.changed_keys.empty());
// Check that overlay remove is reported.
overlay_->RemoveValue(regular_key,
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
obs.VerifyAndResetChangedKey(regular_key);
// Check that underlay remove is reported.
underlay_->RemoveValue(regular_key,
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
obs.VerifyAndResetChangedKey(regular_key);
// Check respecting of silence.
overlay_->SetValueSilently(regular_key, Value(46),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
EXPECT_TRUE(obs.changed_keys.empty());
overlay_->RemoveObserver(&obs);
// Check successful unsubscription.
underlay_->SetValue(regular_key, Value(47),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
overlay_->SetValue(regular_key, Value(48),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
EXPECT_TRUE(obs.changed_keys.empty());
}
TEST_F(OverlayUserPrefStoreTest, GetAndSet) {
const Value* value = nullptr;
EXPECT_FALSE(overlay_->GetValue(regular_key, &value));
EXPECT_FALSE(underlay_->GetValue(regular_key, &value));
underlay_->SetValue(regular_key, Value(42),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
// Value shines through:
EXPECT_TRUE(overlay_->GetValue(regular_key, &value));
EXPECT_EQ(base::Value(42), *value);
EXPECT_TRUE(underlay_->GetValue(regular_key, &value));
EXPECT_EQ(base::Value(42), *value);
overlay_->SetValue(regular_key, Value(43),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
EXPECT_TRUE(overlay_->GetValue(regular_key, &value));
EXPECT_EQ(base::Value(43), *value);
EXPECT_TRUE(underlay_->GetValue(regular_key, &value));
EXPECT_EQ(base::Value(42), *value);
overlay_->RemoveValue(regular_key,
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
// Value shines through:
EXPECT_TRUE(overlay_->GetValue(regular_key, &value));
EXPECT_EQ(base::Value(42), *value);
EXPECT_TRUE(underlay_->GetValue(regular_key, &value));
EXPECT_EQ(base::Value(42), *value);
}
// Check that GetMutableValue does not return the dictionary of the underlay.
TEST_F(OverlayUserPrefStoreTest, ModifyDictionaries) {
underlay_->SetValue(regular_key, base::Value(base::Value::Dict()),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
Value* modify = nullptr;
EXPECT_TRUE(overlay_->GetMutableValue(regular_key, &modify));
ASSERT_TRUE(modify);
ASSERT_TRUE(modify->is_dict());
modify->GetDict().SetByDottedPath(regular_key, 42);
Value* original_in_underlay = nullptr;
EXPECT_TRUE(underlay_->GetMutableValue(regular_key, &original_in_underlay));
ASSERT_TRUE(original_in_underlay);
ASSERT_TRUE(original_in_underlay->is_dict());
EXPECT_TRUE(original_in_underlay->GetDict().empty());
Value* modified = nullptr;
EXPECT_TRUE(overlay_->GetMutableValue(regular_key, &modified));
ASSERT_TRUE(modified);
ASSERT_TRUE(modified->is_dict());
EXPECT_EQ(*modify, *modified);
}
// Here we consider a global preference that is not overlayed.
TEST_F(OverlayUserPrefStoreTest, GlobalPref) {
PrefStoreObserverMock obs;
overlay_->AddObserver(&obs);
const Value* value = nullptr;
// Check that underlay first value is reported.
underlay_->SetValue(persistent_key, Value(42),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
obs.VerifyAndResetChangedKey(persistent_key);
// Check that underlay overwriting is reported.
underlay_->SetValue(persistent_key, Value(43),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
obs.VerifyAndResetChangedKey(persistent_key);
// Check that we get this value from the overlay
EXPECT_TRUE(overlay_->GetValue(persistent_key, &value));
EXPECT_EQ(base::Value(43), *value);
// Check that overwriting change in overlay is reported.
overlay_->SetValue(persistent_key, Value(44),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
obs.VerifyAndResetChangedKey(persistent_key);
// Check that we get this value from the overlay and the underlay.
EXPECT_TRUE(overlay_->GetValue(persistent_key, &value));
EXPECT_EQ(base::Value(44), *value);
EXPECT_TRUE(underlay_->GetValue(persistent_key, &value));
EXPECT_EQ(base::Value(44), *value);
// Check that overlay remove is reported.
overlay_->RemoveValue(persistent_key,
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
obs.VerifyAndResetChangedKey(persistent_key);
// Check that value was removed from overlay and underlay
EXPECT_FALSE(overlay_->GetValue(persistent_key, &value));
EXPECT_FALSE(underlay_->GetValue(persistent_key, &value));
// Check respecting of silence.
overlay_->SetValueSilently(persistent_key, Value(46),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
EXPECT_TRUE(obs.changed_keys.empty());
overlay_->RemoveObserver(&obs);
// Check successful unsubscription.
underlay_->SetValue(persistent_key, Value(47),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
overlay_->SetValue(persistent_key, Value(48),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
EXPECT_TRUE(obs.changed_keys.empty());
}
TEST_F(OverlayUserPrefStoreTest, GetValues) {
// To check merge behavior, create underlay and overlay so each has a key the
// other doesn't have and they have one key in common.
underlay_->SetValue(persistent_key, Value(42),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
overlay_->SetValue(regular_key, Value(43),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
underlay_->SetValue(shared_key, Value(42),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
overlay_->SetValue(shared_key, Value(43),
WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS);
auto values = overlay_->GetValues();
// Check that an overlay preference is returned.
const Value* value = values.FindByDottedPath(persistent_key);
ASSERT_TRUE(value);
EXPECT_EQ(base::Value(42), *value);
// Check that an underlay preference is returned.
value = values.FindByDottedPath(regular_key);
ASSERT_TRUE(value);
EXPECT_EQ(base::Value(43), *value);
// Check that the overlay is preferred.
value = values.FindByDottedPath(shared_key);
ASSERT_TRUE(value);
EXPECT_EQ(base::Value(43), *value);
}
TEST_F(OverlayUserPrefStoreTest, CommitPendingWriteWithCallback) {
TestCommitPendingWriteWithCallback(overlay_.get(), &task_environment_);
}
} // namespace base
|