123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350 |
- // Copyright (c) 2011 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- #include "components/prefs/pref_member.h"
- #include <memory>
- #include "base/bind.h"
- #include "base/location.h"
- #include "base/memory/raw_ptr.h"
- #include "base/synchronization/waitable_event.h"
- #include "base/task/sequenced_task_runner.h"
- #include "base/task/thread_pool.h"
- #include "base/test/task_environment.h"
- #include "components/prefs/pref_registry_simple.h"
- #include "components/prefs/testing_pref_service.h"
- #include "testing/gtest/include/gtest/gtest.h"
- namespace {
- const char kBoolPref[] = "bool";
- const char kIntPref[] = "int";
- const char kDoublePref[] = "double";
- const char kStringPref[] = "string";
- const char kStringListPref[] = "string_list";
- void RegisterTestPrefs(PrefRegistrySimple* registry) {
- registry->RegisterBooleanPref(kBoolPref, false);
- registry->RegisterIntegerPref(kIntPref, 0);
- registry->RegisterDoublePref(kDoublePref, 0.0);
- registry->RegisterStringPref(kStringPref, "default");
- registry->RegisterListPref(kStringListPref);
- }
- class GetPrefValueHelper
- : public base::RefCountedThreadSafe<GetPrefValueHelper> {
- public:
- GetPrefValueHelper()
- : value_(false),
- task_runner_(base::ThreadPool::CreateSequencedTaskRunner({})) {}
- void Init(const std::string& pref_name, PrefService* prefs) {
- pref_.Init(pref_name, prefs);
- pref_.MoveToSequence(task_runner_);
- }
- void Destroy() {
- pref_.Destroy();
- }
- void FetchValue() {
- base::WaitableEvent event(base::WaitableEvent::ResetPolicy::MANUAL,
- base::WaitableEvent::InitialState::NOT_SIGNALED);
- ASSERT_TRUE(task_runner_->PostTask(
- FROM_HERE,
- base::BindOnce(&GetPrefValueHelper::GetPrefValue, this, &event)));
- event.Wait();
- }
- bool value() { return value_; }
- private:
- friend class base::RefCountedThreadSafe<GetPrefValueHelper>;
- ~GetPrefValueHelper() {}
- void GetPrefValue(base::WaitableEvent* event) {
- value_ = pref_.GetValue();
- event->Signal();
- }
- BooleanPrefMember pref_;
- bool value_;
- // The sequence |pref_| runs on.
- scoped_refptr<base::SequencedTaskRunner> task_runner_;
- };
- class PrefMemberTestClass {
- public:
- explicit PrefMemberTestClass(PrefService* prefs)
- : observe_cnt_(0), prefs_(prefs) {
- str_.Init(kStringPref, prefs,
- base::BindRepeating(&PrefMemberTestClass::OnPreferenceChanged,
- base::Unretained(this)));
- }
- void OnPreferenceChanged(const std::string& pref_name) {
- EXPECT_EQ(pref_name, kStringPref);
- EXPECT_EQ(str_.GetValue(), prefs_->GetString(kStringPref));
- EXPECT_EQ(str_.IsDefaultValue(),
- prefs_->FindPreference(kStringPref)->IsDefaultValue());
- ++observe_cnt_;
- }
- StringPrefMember str_;
- int observe_cnt_;
- private:
- raw_ptr<PrefService> prefs_;
- };
- } // anonymous namespace
- class PrefMemberTest : public testing::Test {
- base::test::TaskEnvironment task_environment_;
- };
- TEST_F(PrefMemberTest, BasicGetAndSet) {
- TestingPrefServiceSimple prefs;
- RegisterTestPrefs(prefs.registry());
- // Test bool
- BooleanPrefMember boolean;
- boolean.Init(kBoolPref, &prefs);
- // Check the defaults
- EXPECT_FALSE(prefs.GetBoolean(kBoolPref));
- EXPECT_FALSE(boolean.GetValue());
- EXPECT_FALSE(*boolean);
- EXPECT_TRUE(boolean.IsDefaultValue());
- // Try changing through the member variable.
- boolean.SetValue(true);
- EXPECT_TRUE(boolean.GetValue());
- EXPECT_TRUE(prefs.GetBoolean(kBoolPref));
- EXPECT_TRUE(*boolean);
- EXPECT_FALSE(boolean.IsDefaultValue());
- // Try changing back through the pref.
- prefs.SetBoolean(kBoolPref, false);
- EXPECT_FALSE(prefs.GetBoolean(kBoolPref));
- EXPECT_FALSE(boolean.GetValue());
- EXPECT_FALSE(*boolean);
- EXPECT_FALSE(boolean.IsDefaultValue());
- // Test int
- IntegerPrefMember integer;
- integer.Init(kIntPref, &prefs);
- // Check the defaults
- EXPECT_EQ(0, prefs.GetInteger(kIntPref));
- EXPECT_EQ(0, integer.GetValue());
- EXPECT_EQ(0, *integer);
- EXPECT_TRUE(integer.IsDefaultValue());
- // Try changing through the member variable.
- integer.SetValue(5);
- EXPECT_EQ(5, integer.GetValue());
- EXPECT_EQ(5, prefs.GetInteger(kIntPref));
- EXPECT_EQ(5, *integer);
- EXPECT_FALSE(integer.IsDefaultValue());
- // Try changing back through the pref.
- prefs.SetInteger(kIntPref, 2);
- EXPECT_EQ(2, prefs.GetInteger(kIntPref));
- EXPECT_EQ(2, integer.GetValue());
- EXPECT_EQ(2, *integer);
- EXPECT_FALSE(integer.IsDefaultValue());
- // Test double
- DoublePrefMember double_member;
- double_member.Init(kDoublePref, &prefs);
- // Check the defaults
- EXPECT_EQ(0.0, prefs.GetDouble(kDoublePref));
- EXPECT_EQ(0.0, double_member.GetValue());
- EXPECT_EQ(0.0, *double_member);
- EXPECT_TRUE(double_member.IsDefaultValue());
- // Try changing through the member variable.
- double_member.SetValue(1.0);
- EXPECT_EQ(1.0, double_member.GetValue());
- EXPECT_EQ(1.0, prefs.GetDouble(kDoublePref));
- EXPECT_EQ(1.0, *double_member);
- EXPECT_FALSE(double_member.IsDefaultValue());
- // Try changing back through the pref.
- prefs.SetDouble(kDoublePref, 3.0);
- EXPECT_EQ(3.0, prefs.GetDouble(kDoublePref));
- EXPECT_EQ(3.0, double_member.GetValue());
- EXPECT_EQ(3.0, *double_member);
- EXPECT_FALSE(double_member.IsDefaultValue());
- // Test string
- StringPrefMember string;
- string.Init(kStringPref, &prefs);
- // Check the defaults
- EXPECT_EQ("default", prefs.GetString(kStringPref));
- EXPECT_EQ("default", string.GetValue());
- EXPECT_EQ("default", *string);
- EXPECT_TRUE(string.IsDefaultValue());
- // Try changing through the member variable.
- string.SetValue("foo");
- EXPECT_EQ("foo", string.GetValue());
- EXPECT_EQ("foo", prefs.GetString(kStringPref));
- EXPECT_EQ("foo", *string);
- EXPECT_FALSE(string.IsDefaultValue());
- // Try changing back through the pref.
- prefs.SetString(kStringPref, "bar");
- EXPECT_EQ("bar", prefs.GetString(kStringPref));
- EXPECT_EQ("bar", string.GetValue());
- EXPECT_EQ("bar", *string);
- EXPECT_FALSE(string.IsDefaultValue());
- // Test string list
- base::Value::List expected_list;
- std::vector<std::string> expected_vector;
- StringListPrefMember string_list;
- string_list.Init(kStringListPref, &prefs);
- // Check the defaults
- EXPECT_EQ(expected_list, prefs.GetValueList(kStringListPref));
- EXPECT_EQ(expected_vector, string_list.GetValue());
- EXPECT_EQ(expected_vector, *string_list);
- EXPECT_TRUE(string_list.IsDefaultValue());
- // Try changing through the pref member.
- expected_list.Append("foo");
- expected_vector.push_back("foo");
- string_list.SetValue(expected_vector);
- EXPECT_EQ(expected_list, prefs.GetValueList(kStringListPref));
- EXPECT_EQ(expected_vector, string_list.GetValue());
- EXPECT_EQ(expected_vector, *string_list);
- EXPECT_FALSE(string_list.IsDefaultValue());
- // Try adding through the pref.
- expected_list.Append("bar");
- expected_vector.push_back("bar");
- prefs.SetList(kStringListPref, expected_list.Clone());
- EXPECT_EQ(expected_list, prefs.GetValueList(kStringListPref));
- EXPECT_EQ(expected_vector, string_list.GetValue());
- EXPECT_EQ(expected_vector, *string_list);
- EXPECT_FALSE(string_list.IsDefaultValue());
- // Try removing through the pref.
- expected_list.erase(expected_list.begin());
- expected_vector.erase(expected_vector.begin());
- prefs.SetList(kStringListPref, expected_list.Clone());
- EXPECT_EQ(expected_list, prefs.GetValueList(kStringListPref));
- EXPECT_EQ(expected_vector, string_list.GetValue());
- EXPECT_EQ(expected_vector, *string_list);
- EXPECT_FALSE(string_list.IsDefaultValue());
- }
- TEST_F(PrefMemberTest, InvalidList) {
- // Set the vector to an initial good value.
- std::vector<std::string> expected_vector;
- expected_vector.push_back("foo");
- // Try to add a valid list first.
- base::Value list(base::Value::Type::LIST);
- list.Append("foo");
- std::vector<std::string> vector;
- EXPECT_TRUE(subtle::PrefMemberVectorStringUpdate(list, &vector));
- EXPECT_EQ(expected_vector, vector);
- // Now try to add an invalid list. |vector| should not be changed.
- list.Append(0);
- EXPECT_FALSE(subtle::PrefMemberVectorStringUpdate(list, &vector));
- EXPECT_EQ(expected_vector, vector);
- }
- TEST_F(PrefMemberTest, TwoPrefs) {
- // Make sure two DoublePrefMembers stay in sync.
- TestingPrefServiceSimple prefs;
- RegisterTestPrefs(prefs.registry());
- DoublePrefMember pref1;
- pref1.Init(kDoublePref, &prefs);
- DoublePrefMember pref2;
- pref2.Init(kDoublePref, &prefs);
- pref1.SetValue(2.3);
- EXPECT_EQ(2.3, *pref2);
- pref2.SetValue(3.5);
- EXPECT_EQ(3.5, *pref1);
- prefs.SetDouble(kDoublePref, 4.2);
- EXPECT_EQ(4.2, *pref1);
- EXPECT_EQ(4.2, *pref2);
- }
- TEST_F(PrefMemberTest, Observer) {
- TestingPrefServiceSimple prefs;
- RegisterTestPrefs(prefs.registry());
- PrefMemberTestClass test_obj(&prefs);
- EXPECT_EQ("default", *test_obj.str_);
- EXPECT_TRUE(test_obj.str_.IsDefaultValue());
- // Changing the pref from the default value to an explicitly-set version of
- // the same value fires the observer. The caller may be sensitive to
- // IsDefaultValue().
- prefs.SetString(kStringPref, "default");
- EXPECT_EQ("default", *test_obj.str_);
- EXPECT_EQ(1, test_obj.observe_cnt_);
- EXPECT_FALSE(test_obj.str_.IsDefaultValue());
- // Calling SetValue should not fire the observer.
- test_obj.str_.SetValue("hello");
- EXPECT_EQ(1, test_obj.observe_cnt_);
- EXPECT_EQ("hello", prefs.GetString(kStringPref));
- // Changing the pref does fire the observer.
- prefs.SetString(kStringPref, "world");
- EXPECT_EQ(2, test_obj.observe_cnt_);
- EXPECT_EQ("world", *(test_obj.str_));
- // Not changing the value should not fire the observer.
- prefs.SetString(kStringPref, "world");
- EXPECT_EQ(2, test_obj.observe_cnt_);
- EXPECT_EQ("world", *(test_obj.str_));
- prefs.SetString(kStringPref, "hello");
- EXPECT_EQ(3, test_obj.observe_cnt_);
- EXPECT_EQ("hello", prefs.GetString(kStringPref));
- }
- TEST_F(PrefMemberTest, NoInit) {
- // Make sure not calling Init on a PrefMember doesn't cause problems.
- IntegerPrefMember pref;
- }
- TEST_F(PrefMemberTest, MoveToSequence) {
- TestingPrefServiceSimple prefs;
- scoped_refptr<GetPrefValueHelper> helper(new GetPrefValueHelper());
- RegisterTestPrefs(prefs.registry());
- helper->Init(kBoolPref, &prefs);
- helper->FetchValue();
- EXPECT_FALSE(helper->value());
- prefs.SetBoolean(kBoolPref, true);
- helper->FetchValue();
- EXPECT_TRUE(helper->value());
- helper->Destroy();
- helper->FetchValue();
- EXPECT_TRUE(helper->value());
- }
|