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
|
// Copyright 2010 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/pref_change_registrar.h"
#include <memory>
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "components/prefs/pref_observer.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/testing_pref_service.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using testing::Mock;
using testing::Eq;
namespace base {
namespace {
const char kHomePage[] = "homepage";
const char kHomePageIsNewTabPage[] = "homepage_is_newtabpage";
const char kApplicationLocale[] = "intl.app_locale";
// A mock provider that allows us to capture pref observer changes.
class MockPrefService : public TestingPrefServiceSimple {
public:
MockPrefService() {}
~MockPrefService() override {}
MOCK_METHOD2(AddPrefObserver, void(const std::string&, PrefObserver*));
MOCK_METHOD2(RemovePrefObserver, void(const std::string&, PrefObserver*));
};
// Due to overloads, base::DoNothing() cannot be passed directly to
// PrefChangeRegistrar::Add() as it is convertible to all callbacks.
base::RepeatingClosure DoNothingClosure() {
return base::DoNothing();
}
} // namespace
class PrefChangeRegistrarTest : public testing::Test {
public:
PrefChangeRegistrarTest() {}
~PrefChangeRegistrarTest() override {}
protected:
void SetUp() override;
MockPrefService* service() const { return service_.get(); }
private:
std::unique_ptr<MockPrefService> service_;
};
void PrefChangeRegistrarTest::SetUp() {
service_ = std::make_unique<MockPrefService>();
}
TEST_F(PrefChangeRegistrarTest, AddAndRemove) {
PrefChangeRegistrar registrar;
registrar.Init(service());
// Test adding.
EXPECT_CALL(*service(),
AddPrefObserver(Eq(std::string("test.pref.1")), ®istrar));
EXPECT_CALL(*service(),
AddPrefObserver(Eq(std::string("test.pref.2")), ®istrar));
registrar.Add("test.pref.1", DoNothingClosure());
registrar.Add("test.pref.2", DoNothingClosure());
EXPECT_FALSE(registrar.IsEmpty());
// Test removing.
Mock::VerifyAndClearExpectations(service());
EXPECT_CALL(*service(),
RemovePrefObserver(Eq(std::string("test.pref.1")), ®istrar));
EXPECT_CALL(*service(),
RemovePrefObserver(Eq(std::string("test.pref.2")), ®istrar));
registrar.Remove("test.pref.1");
registrar.Remove("test.pref.2");
EXPECT_TRUE(registrar.IsEmpty());
// Explicitly check the expectations now to make sure that the Removes
// worked (rather than the registrar destructor doing the work).
Mock::VerifyAndClearExpectations(service());
}
TEST_F(PrefChangeRegistrarTest, AutoRemove) {
PrefChangeRegistrar registrar;
registrar.Init(service());
// Setup of auto-remove.
EXPECT_CALL(*service(),
AddPrefObserver(Eq(std::string("test.pref.1")), ®istrar));
registrar.Add("test.pref.1", DoNothingClosure());
Mock::VerifyAndClearExpectations(service());
EXPECT_FALSE(registrar.IsEmpty());
// Test auto-removing.
EXPECT_CALL(*service(),
RemovePrefObserver(Eq(std::string("test.pref.1")), ®istrar));
}
TEST_F(PrefChangeRegistrarTest, RemoveAll) {
PrefChangeRegistrar registrar;
registrar.Init(service());
EXPECT_CALL(*service(),
AddPrefObserver(Eq(std::string("test.pref.1")), ®istrar));
EXPECT_CALL(*service(),
AddPrefObserver(Eq(std::string("test.pref.2")), ®istrar));
registrar.Add("test.pref.1", DoNothingClosure());
registrar.Add("test.pref.2", DoNothingClosure());
Mock::VerifyAndClearExpectations(service());
EXPECT_CALL(*service(),
RemovePrefObserver(Eq(std::string("test.pref.1")), ®istrar));
EXPECT_CALL(*service(),
RemovePrefObserver(Eq(std::string("test.pref.2")), ®istrar));
registrar.RemoveAll();
EXPECT_TRUE(registrar.IsEmpty());
// Explicitly check the expectations now to make sure that the RemoveAll
// worked (rather than the registrar destructor doing the work).
Mock::VerifyAndClearExpectations(service());
}
class ObserveSetOfPreferencesTest : public testing::Test {
public:
void SetUp() override {
pref_service_ = std::make_unique<TestingPrefServiceSimple>();
PrefRegistrySimple* registry = pref_service_->registry();
registry->RegisterStringPref(kHomePage, "http://google.com");
registry->RegisterBooleanPref(kHomePageIsNewTabPage, false);
registry->RegisterStringPref(kApplicationLocale, std::string());
}
PrefChangeRegistrar* CreatePrefChangeRegistrar() {
PrefChangeRegistrar* pref_set = new PrefChangeRegistrar();
pref_set->Init(pref_service_.get());
pref_set->Add(kHomePage, DoNothingClosure());
pref_set->Add(kHomePageIsNewTabPage, DoNothingClosure());
return pref_set;
}
MOCK_METHOD1(OnPreferenceChanged, void(const std::string&));
std::unique_ptr<TestingPrefServiceSimple> pref_service_;
};
TEST_F(ObserveSetOfPreferencesTest, IsObserved) {
std::unique_ptr<PrefChangeRegistrar> pref_set(CreatePrefChangeRegistrar());
EXPECT_TRUE(pref_set->IsObserved(kHomePage));
EXPECT_TRUE(pref_set->IsObserved(kHomePageIsNewTabPage));
EXPECT_FALSE(pref_set->IsObserved(kApplicationLocale));
}
TEST_F(ObserveSetOfPreferencesTest, Observe) {
using testing::_;
using testing::Mock;
PrefChangeRegistrar pref_set;
PrefChangeRegistrar::NamedChangeCallback callback =
base::BindRepeating(&ObserveSetOfPreferencesTest::OnPreferenceChanged,
base::Unretained(this));
pref_set.Init(pref_service_.get());
pref_set.Add(kHomePage, callback);
pref_set.Add(kHomePageIsNewTabPage, callback);
EXPECT_CALL(*this, OnPreferenceChanged(kHomePage));
pref_service_->SetUserPref(kHomePage,
std::make_unique<Value>("http://crbug.com"));
Mock::VerifyAndClearExpectations(this);
EXPECT_CALL(*this, OnPreferenceChanged(kHomePageIsNewTabPage));
pref_service_->SetUserPref(kHomePageIsNewTabPage,
std::make_unique<Value>(true));
Mock::VerifyAndClearExpectations(this);
EXPECT_CALL(*this, OnPreferenceChanged(_)).Times(0);
pref_service_->SetUserPref(kApplicationLocale,
std::make_unique<Value>("en_US.utf8"));
Mock::VerifyAndClearExpectations(this);
}
} // namespace base
|