File: scoped_user_pref_update_unittest.cc

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (140 lines) | stat: -rw-r--r-- 5,232 bytes parent folder | download | duplicates (6)
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
// Copyright 2013 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/mock_pref_change_callback.h"
#include "components/prefs/pref_change_registrar.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/scoped_user_pref_update.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::Mock;

class ScopedUserPrefUpdateTest : public testing::Test {
 public:
  ScopedUserPrefUpdateTest()
      : dict_observer_(&prefs_), list_observer_(&prefs_) {}
  ~ScopedUserPrefUpdateTest() override = default;

 protected:
  void SetUp() override {
    prefs_.registry()->RegisterDictionaryPref(kDictPref);
    prefs_.registry()->RegisterListPref(kListPref);
    registrar_.Init(&prefs_);
    registrar_.Add(kDictPref, dict_observer_.GetCallback());
    registrar_.Add(kListPref, list_observer_.GetCallback());
  }

  static const char kDictPref[];
  static const char kListPref[];
  static const char kKey[];
  static const char kValue[];

  TestingPrefServiceSimple prefs_;
  MockPrefChangeCallback dict_observer_;
  MockPrefChangeCallback list_observer_;
  PrefChangeRegistrar registrar_;
};

const char ScopedUserPrefUpdateTest::kDictPref[] = "dict_pref_name";
const char ScopedUserPrefUpdateTest::kListPref[] = "list_pref_name";
const char ScopedUserPrefUpdateTest::kKey[] = "key";
const char ScopedUserPrefUpdateTest::kValue[] = "value";

TEST_F(ScopedUserPrefUpdateTest, ScopedDictPrefUpdateRegularUse) {
  // Dictionary that will be expected to be set at the end.
  base::Value expected_dictionary(base::Value::Type::DICT);
  expected_dictionary.GetDict().Set(kKey, kValue);

  {
    EXPECT_CALL(dict_observer_, OnPreferenceChanged(_)).Times(0);
    ScopedDictPrefUpdate update(&prefs_, kDictPref);
    update->Set(kKey, kValue);

    // The dictionary was created for us but the creation should have happened
    // silently without notifications.
    Mock::VerifyAndClearExpectations(&dict_observer_);

    // Modifications happen online and are instantly visible, though.
    EXPECT_EQ(expected_dictionary, prefs_.GetDict(kDictPref));

    // Now we are leaving the scope of the update so we should be notified.
    dict_observer_.Expect(kDictPref, &expected_dictionary);
  }
  Mock::VerifyAndClearExpectations(&dict_observer_);

  EXPECT_EQ(expected_dictionary, prefs_.GetDict(kDictPref));
}

TEST_F(ScopedUserPrefUpdateTest, ScopedDictPrefUpdateNeverTouchAnything) {
  const base::Value::Dict& old_value = prefs_.GetDict(kDictPref);
  EXPECT_CALL(dict_observer_, OnPreferenceChanged(_)).Times(0);
  { ScopedDictPrefUpdate update(&prefs_, kDictPref); }
  const base::Value::Dict& new_value = prefs_.GetDict(kDictPref);
  EXPECT_EQ(old_value, new_value);
  Mock::VerifyAndClearExpectations(&dict_observer_);
}

TEST_F(ScopedUserPrefUpdateTest, ScopedDictPrefUpdateWithDefaults) {
  auto defaults =
      base::Value::Dict().Set("firstkey", "value").Set("secondkey", "value");

  std::string pref_name = "mypref";
  prefs_.registry()->RegisterDictionaryPref(pref_name, std::move(defaults));
  EXPECT_EQ(2u, prefs_.GetDict(pref_name).size());

  ScopedDictPrefUpdate update(&prefs_, pref_name);
  update->Set("thirdkey", "value");
  EXPECT_EQ(3u, prefs_.GetDict(pref_name).size());
}

TEST_F(ScopedUserPrefUpdateTest, ScopedListPrefUpdateRegularUse) {
  // List that will be expected to be set at the end.
  base::Value expected_list(base::Value::Type::LIST);
  expected_list.GetList().Append(kValue);

  {
    EXPECT_CALL(list_observer_, OnPreferenceChanged(_)).Times(0);
    ScopedListPrefUpdate update(&prefs_, kListPref);
    update->Append(kValue);

    // The list was created for us but the creation should have happened
    // silently without notifications.
    Mock::VerifyAndClearExpectations(&list_observer_);

    // Modifications happen online and are instantly visible, though.
    EXPECT_EQ(expected_list, prefs_.GetList(kListPref));

    // Now we are leaving the scope of the update so we should be notified.
    list_observer_.Expect(kListPref, &expected_list);
  }
  Mock::VerifyAndClearExpectations(&list_observer_);

  EXPECT_EQ(expected_list.GetList(), prefs_.GetList(kListPref));
}

TEST_F(ScopedUserPrefUpdateTest, ScopedListPrefUpdateNeverTouchAnything) {
  const base::Value::List& old_value = prefs_.GetList(kListPref);
  EXPECT_CALL(dict_observer_, OnPreferenceChanged(_)).Times(0);
  { ScopedListPrefUpdate update(&prefs_, kListPref); }
  const base::Value::List& new_value = prefs_.GetList(kListPref);
  EXPECT_EQ(old_value, new_value);
  Mock::VerifyAndClearExpectations(&dict_observer_);
}

TEST_F(ScopedUserPrefUpdateTest, ScopedListPrefUpdateWithDefaults) {
  base::Value::List defaults;
  defaults.Append("firstvalue");
  defaults.Append("secondvalue");

  std::string pref_name = "mypref";
  prefs_.registry()->RegisterListPref(pref_name, std::move(defaults));
  EXPECT_EQ(2u, prefs_.GetList(pref_name).size());

  ScopedListPrefUpdate update(&prefs_, pref_name);
  update->Append("thirdvalue");
  EXPECT_EQ(3u, prefs_.GetList(pref_name).size());
}