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
|
// Copyright 2011 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stddef.h>
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "components/prefs/mock_pref_change_callback.h"
#include "components/prefs/pref_notifier_impl.h"
#include "components/prefs/pref_observer.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/pref_service.h"
#include "components/prefs/pref_value_store.h"
#include "components/prefs/testing_pref_service.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using testing::_;
using testing::Field;
using testing::Invoke;
using testing::Mock;
using testing::Truly;
namespace {
const char kChangedPref[] = "changed_pref";
const char kUnchangedPref[] = "unchanged_pref";
class MockPrefInitObserver {
public:
MOCK_METHOD1(OnInitializationCompleted, void(bool));
};
// This is an unmodified PrefNotifierImpl, except we make
// OnPreferenceChanged public for tests.
class TestingPrefNotifierImpl : public PrefNotifierImpl {
public:
explicit TestingPrefNotifierImpl(PrefService* service)
: PrefNotifierImpl(service) {
}
// Make public for tests.
using PrefNotifierImpl::OnPreferenceChanged;
};
// Mock PrefNotifier that allows tracking of observers and notifications.
class MockPrefNotifier : public PrefNotifierImpl {
public:
explicit MockPrefNotifier(PrefService* pref_service)
: PrefNotifierImpl(pref_service) {}
~MockPrefNotifier() override {}
MOCK_METHOD1(FireObservers, void(const std::string& path));
size_t CountObserver(const std::string& path, PrefObserver* obs) {
auto observer_iterator = pref_observers()->find(path);
if (observer_iterator == pref_observers()->end())
return false;
size_t count = 0;
for (auto& existing_obs : *observer_iterator->second) {
if (&existing_obs == obs)
count++;
}
return count;
}
// Make public for tests below.
using PrefNotifierImpl::OnPreferenceChanged;
using PrefNotifierImpl::OnInitializationCompleted;
};
class PrefObserverMock : public PrefObserver {
public:
PrefObserverMock() {}
virtual ~PrefObserverMock() {}
MOCK_METHOD2(OnPreferenceChanged, void(PrefService*, const std::string&));
};
// Test fixture class.
class PrefNotifierTest : public testing::Test {
protected:
void SetUp() override {
pref_service_.registry()->RegisterBooleanPref(kChangedPref, true);
pref_service_.registry()->RegisterBooleanPref(kUnchangedPref, true);
}
TestingPrefServiceSimple pref_service_;
PrefObserverMock obs1_;
PrefObserverMock obs2_;
};
TEST_F(PrefNotifierTest, OnPreferenceChanged) {
MockPrefNotifier notifier(&pref_service_);
EXPECT_CALL(notifier, FireObservers(kChangedPref)).Times(1);
notifier.OnPreferenceChanged(kChangedPref);
}
TEST_F(PrefNotifierTest, OnInitializationCompleted) {
MockPrefNotifier notifier(&pref_service_);
MockPrefInitObserver observer;
notifier.AddInitObserver(
base::BindOnce(&MockPrefInitObserver::OnInitializationCompleted,
base::Unretained(&observer)));
EXPECT_CALL(observer, OnInitializationCompleted(true));
notifier.OnInitializationCompleted(true);
}
TEST_F(PrefNotifierTest, AddAndRemovePrefObservers) {
const char pref_name[] = "homepage";
const char pref_name2[] = "proxy";
MockPrefNotifier notifier(&pref_service_);
notifier.AddPrefObserver(pref_name, &obs1_);
ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs1_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs1_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
// Re-adding the same observer for the same pref doesn't change anything.
// Skip this in debug mode, since it hits a DCHECK and death tests aren't
// thread-safe.
#if defined(NDEBUG) && !defined(DCHECK_ALWAYS_ON)
notifier.AddPrefObserver(pref_name, &obs1_);
ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs1_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs1_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
#endif
// Ensure that we can add the same observer to a different pref.
notifier.AddPrefObserver(pref_name2, &obs1_);
ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs1_));
ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
// Ensure that we can add another observer to the same pref.
notifier.AddPrefObserver(pref_name, &obs2_);
ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs1_));
ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs2_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
// Ensure that we can remove all observers, and that removing a non-existent
// observer is harmless.
notifier.RemovePrefObserver(pref_name, &obs1_);
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs1_));
ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs2_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
notifier.RemovePrefObserver(pref_name, &obs2_);
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs1_));
ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
notifier.RemovePrefObserver(pref_name, &obs1_);
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs1_));
ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
notifier.RemovePrefObserver(pref_name2, &obs1_);
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs1_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs1_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
}
TEST_F(PrefNotifierTest, FireObservers) {
TestingPrefNotifierImpl notifier(&pref_service_);
notifier.AddPrefObserver(kChangedPref, &obs1_);
notifier.AddPrefObserver(kUnchangedPref, &obs1_);
EXPECT_CALL(obs1_, OnPreferenceChanged(&pref_service_, kChangedPref));
EXPECT_CALL(obs2_, OnPreferenceChanged(_, _)).Times(0);
notifier.OnPreferenceChanged(kChangedPref);
Mock::VerifyAndClearExpectations(&obs1_);
Mock::VerifyAndClearExpectations(&obs2_);
notifier.AddPrefObserver(kChangedPref, &obs2_);
notifier.AddPrefObserver(kUnchangedPref, &obs2_);
EXPECT_CALL(obs1_, OnPreferenceChanged(&pref_service_, kChangedPref));
EXPECT_CALL(obs2_, OnPreferenceChanged(&pref_service_, kChangedPref));
notifier.OnPreferenceChanged(kChangedPref);
Mock::VerifyAndClearExpectations(&obs1_);
Mock::VerifyAndClearExpectations(&obs2_);
// Make sure removing an observer from one pref doesn't affect anything else.
notifier.RemovePrefObserver(kChangedPref, &obs1_);
EXPECT_CALL(obs1_, OnPreferenceChanged(_, _)).Times(0);
EXPECT_CALL(obs2_, OnPreferenceChanged(&pref_service_, kChangedPref));
notifier.OnPreferenceChanged(kChangedPref);
Mock::VerifyAndClearExpectations(&obs1_);
Mock::VerifyAndClearExpectations(&obs2_);
// Make sure removing an observer entirely doesn't affect anything else.
notifier.RemovePrefObserver(kUnchangedPref, &obs1_);
EXPECT_CALL(obs1_, OnPreferenceChanged(_, _)).Times(0);
EXPECT_CALL(obs2_, OnPreferenceChanged(&pref_service_, kChangedPref));
notifier.OnPreferenceChanged(kChangedPref);
Mock::VerifyAndClearExpectations(&obs1_);
Mock::VerifyAndClearExpectations(&obs2_);
notifier.RemovePrefObserver(kChangedPref, &obs2_);
notifier.RemovePrefObserver(kUnchangedPref, &obs2_);
}
} // namespace
|
