1 // Copyright 2011 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "components/prefs/pref_notifier_impl.h"
6
7 #include <stddef.h>
8
9 #include "base/dcheck_is_on.h"
10 #include "base/functional/bind.h"
11 #include "base/functional/callback.h"
12 #include "components/prefs/mock_pref_change_callback.h"
13 #include "components/prefs/pref_observer.h"
14 #include "components/prefs/pref_registry_simple.h"
15 #include "components/prefs/pref_service.h"
16 #include "components/prefs/pref_value_store.h"
17 #include "components/prefs/testing_pref_service.h"
18 #include "testing/gmock/include/gmock/gmock.h"
19 #include "testing/gtest/include/gtest/gtest.h"
20
21 using testing::_;
22 using testing::Field;
23 using testing::Invoke;
24 using testing::Mock;
25 using testing::Truly;
26
27 namespace {
28
29 const char kChangedPref[] = "changed_pref";
30 const char kUnchangedPref[] = "unchanged_pref";
31
32 class MockPrefInitObserver {
33 public:
34 MOCK_METHOD1(OnInitializationCompleted, void(bool));
35 };
36
37 // This is an unmodified PrefNotifierImpl, except we make
38 // OnPreferenceChanged public for tests.
39 class TestingPrefNotifierImpl : public PrefNotifierImpl {
40 public:
TestingPrefNotifierImpl(PrefService * service)41 explicit TestingPrefNotifierImpl(PrefService* service)
42 : PrefNotifierImpl(service) {
43 }
44
45 // Make public for tests.
46 using PrefNotifierImpl::OnPreferenceChanged;
47 };
48
49 // Mock PrefNotifier that allows tracking of observers and notifications.
50 class MockPrefNotifier : public PrefNotifierImpl {
51 public:
MockPrefNotifier(PrefService * pref_service)52 explicit MockPrefNotifier(PrefService* pref_service)
53 : PrefNotifierImpl(pref_service) {}
54 ~MockPrefNotifier() override = default;
55
56 MOCK_METHOD(void, FireObservers, (std::string_view path), (override));
57
CountObserver(const std::string & path,PrefObserver * obs)58 size_t CountObserver(const std::string& path, PrefObserver* obs) {
59 auto observer_iterator = pref_observers()->find(path);
60 if (observer_iterator == pref_observers()->end())
61 return false;
62
63 size_t count = 0;
64 for (PrefObserver& existing_obs : observer_iterator->second) {
65 if (&existing_obs == obs)
66 count++;
67 }
68
69 return count;
70 }
71
72 // Make public for tests below.
73 using PrefNotifierImpl::OnPreferenceChanged;
74 using PrefNotifierImpl::OnInitializationCompleted;
75 };
76
77 class PrefObserverMock : public PrefObserver {
78 public:
79 MOCK_METHOD(void,
80 OnPreferenceChanged,
81 (PrefService*, std::string_view),
82 (override));
83 };
84
85 // Test fixture class.
86 class PrefNotifierTest : public testing::Test {
87 protected:
SetUp()88 void SetUp() override {
89 pref_service_.registry()->RegisterBooleanPref(kChangedPref, true);
90 pref_service_.registry()->RegisterBooleanPref(kUnchangedPref, true);
91 }
92
93 TestingPrefServiceSimple pref_service_;
94
95 PrefObserverMock obs1_;
96 PrefObserverMock obs2_;
97 };
98
TEST_F(PrefNotifierTest,OnPreferenceChanged)99 TEST_F(PrefNotifierTest, OnPreferenceChanged) {
100 MockPrefNotifier notifier(&pref_service_);
101 EXPECT_CALL(notifier, FireObservers(kChangedPref)).Times(1);
102 notifier.OnPreferenceChanged(kChangedPref);
103 }
104
TEST_F(PrefNotifierTest,OnInitializationCompleted)105 TEST_F(PrefNotifierTest, OnInitializationCompleted) {
106 MockPrefNotifier notifier(&pref_service_);
107 MockPrefInitObserver observer;
108 notifier.AddInitObserver(
109 base::BindOnce(&MockPrefInitObserver::OnInitializationCompleted,
110 base::Unretained(&observer)));
111 EXPECT_CALL(observer, OnInitializationCompleted(true));
112 notifier.OnInitializationCompleted(true);
113 }
114
TEST_F(PrefNotifierTest,AddAndRemovePrefObservers)115 TEST_F(PrefNotifierTest, AddAndRemovePrefObservers) {
116 const char pref_name[] = "homepage";
117 const char pref_name2[] = "proxy";
118
119 MockPrefNotifier notifier(&pref_service_);
120 notifier.AddPrefObserver(pref_name, &obs1_);
121 ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs1_));
122 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs1_));
123 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
124 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
125
126 // Re-adding the same observer for the same pref doesn't change anything.
127 // This hits a DUMP_WILL_BE_NOTREACHED() which is fatal in non-official
128 // builds.
129 #if defined(OFFICIAL_BUILD) && !DCHECK_IS_ON()
130 notifier.AddPrefObserver(pref_name, &obs1_);
131 ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs1_));
132 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs1_));
133 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
134 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
135 #endif
136
137 // Ensure that we can add the same observer to a different pref.
138 notifier.AddPrefObserver(pref_name2, &obs1_);
139 ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs1_));
140 ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
141 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
142 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
143
144 // Ensure that we can add another observer to the same pref.
145 notifier.AddPrefObserver(pref_name, &obs2_);
146 ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs1_));
147 ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
148 ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs2_));
149 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
150
151 // Ensure that we can remove all observers, and that removing a non-existent
152 // observer is harmless.
153 notifier.RemovePrefObserver(pref_name, &obs1_);
154 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs1_));
155 ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
156 ASSERT_EQ(1u, notifier.CountObserver(pref_name, &obs2_));
157 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
158
159 notifier.RemovePrefObserver(pref_name, &obs2_);
160 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs1_));
161 ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
162 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
163 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
164
165 notifier.RemovePrefObserver(pref_name, &obs1_);
166 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs1_));
167 ASSERT_EQ(1u, notifier.CountObserver(pref_name2, &obs1_));
168 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
169 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
170
171 notifier.RemovePrefObserver(pref_name2, &obs1_);
172 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs1_));
173 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs1_));
174 ASSERT_EQ(0u, notifier.CountObserver(pref_name, &obs2_));
175 ASSERT_EQ(0u, notifier.CountObserver(pref_name2, &obs2_));
176 }
177
TEST_F(PrefNotifierTest,FireObservers)178 TEST_F(PrefNotifierTest, FireObservers) {
179 TestingPrefNotifierImpl notifier(&pref_service_);
180 notifier.AddPrefObserver(kChangedPref, &obs1_);
181 notifier.AddPrefObserver(kUnchangedPref, &obs1_);
182
183 EXPECT_CALL(obs1_, OnPreferenceChanged(&pref_service_, kChangedPref));
184 EXPECT_CALL(obs2_, OnPreferenceChanged(_, _)).Times(0);
185 notifier.OnPreferenceChanged(kChangedPref);
186 Mock::VerifyAndClearExpectations(&obs1_);
187 Mock::VerifyAndClearExpectations(&obs2_);
188
189 notifier.AddPrefObserver(kChangedPref, &obs2_);
190 notifier.AddPrefObserver(kUnchangedPref, &obs2_);
191
192 EXPECT_CALL(obs1_, OnPreferenceChanged(&pref_service_, kChangedPref));
193 EXPECT_CALL(obs2_, OnPreferenceChanged(&pref_service_, kChangedPref));
194 notifier.OnPreferenceChanged(kChangedPref);
195 Mock::VerifyAndClearExpectations(&obs1_);
196 Mock::VerifyAndClearExpectations(&obs2_);
197
198 // Make sure removing an observer from one pref doesn't affect anything else.
199 notifier.RemovePrefObserver(kChangedPref, &obs1_);
200
201 EXPECT_CALL(obs1_, OnPreferenceChanged(_, _)).Times(0);
202 EXPECT_CALL(obs2_, OnPreferenceChanged(&pref_service_, kChangedPref));
203 notifier.OnPreferenceChanged(kChangedPref);
204 Mock::VerifyAndClearExpectations(&obs1_);
205 Mock::VerifyAndClearExpectations(&obs2_);
206
207 // Make sure removing an observer entirely doesn't affect anything else.
208 notifier.RemovePrefObserver(kUnchangedPref, &obs1_);
209
210 EXPECT_CALL(obs1_, OnPreferenceChanged(_, _)).Times(0);
211 EXPECT_CALL(obs2_, OnPreferenceChanged(&pref_service_, kChangedPref));
212 notifier.OnPreferenceChanged(kChangedPref);
213 Mock::VerifyAndClearExpectations(&obs1_);
214 Mock::VerifyAndClearExpectations(&obs2_);
215
216 notifier.RemovePrefObserver(kChangedPref, &obs2_);
217 notifier.RemovePrefObserver(kUnchangedPref, &obs2_);
218 }
219
220 } // namespace
221