File: sync_handler_unittest.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (317 lines) | stat: -rw-r--r-- 12,263 bytes parent folder | download | duplicates (5)
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ui/webui/password_manager/sync_handler.h"

#include "base/memory/raw_ptr.h"
#include "base/test/bind.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/signin/identity_test_environment_profile_adaptor.h"
#include "chrome/browser/sync/sync_service_factory.h"
#include "chrome/test/base/chrome_render_view_host_test_harness.h"
#include "chrome/test/base/testing_browser_process.h"
#include "components/sync/base/data_type.h"
#include "components/sync/service/local_data_description.h"
#include "components/sync/service/sync_service_utils.h"
#include "components/sync/test/mock_sync_service.h"
#include "content/public/test/test_web_ui.h"

using syncer::MockSyncService;
using ::testing::Return;

namespace password_manager {

namespace {

const char kTestCallbackId[] = "test-callback-id";

std::unique_ptr<KeyedService> BuildMockSyncService(
    content::BrowserContext* context) {
  return std::make_unique<testing::NiceMock<syncer::MockSyncService>>();
}

std::unique_ptr<KeyedService> BuildNullSyncService(
    content::BrowserContext* context) {
  return nullptr;
}

bool CallbackReturnedSuccessfully(const content::TestWebUI::CallData& data) {
  return (data.function_name() == "cr.webUIResponse") &&
         data.arg1()->is_string() &&
         (data.arg1()->GetString() == kTestCallbackId) &&
         data.arg2()->is_bool() && data.arg2()->GetBool();
}

}  // namespace

class SyncHandlerTest : public ChromeRenderViewHostTestHarness {
 public:
  void SetUp() override {
    ChromeRenderViewHostTestHarness::SetUp();
    mock_sync_service_ = static_cast<syncer::MockSyncService*>(
        SyncServiceFactory::GetInstance()->SetTestingFactoryAndUse(
            profile(), base::BindRepeating(&BuildMockSyncService)));
    identity_test_env_adaptor_ =
        std::make_unique<IdentityTestEnvironmentProfileAdaptor>(profile());
    auto handler = std::make_unique<SyncHandler>(profile());
    handler_ = handler.get();
    web_ui_.AddMessageHandler(std::move(handler));
    static_cast<content::WebUIMessageHandler*>(handler_)
        ->AllowJavascriptForTesting();
    web_ui_.set_web_contents(web_contents());
  }

  void TearDown() override {
    static_cast<content::WebUIMessageHandler*>(handler_)->DisallowJavascript();
    mock_sync_service_ = nullptr;
    identity_test_env_adaptor_.reset();
    ChromeRenderViewHostTestHarness::TearDown();
  }

  TestingProfile::TestingFactories GetTestingFactories() const override {
    return IdentityTestEnvironmentProfileAdaptor::
        GetIdentityTestEnvironmentFactories();
  }

  AccountInfo CreateTestSyncAccount() {
    auto account_info = identity_test_env()->MakePrimaryAccountAvailable(
        "user@gmail.com", signin::ConsentLevel::kSync);
    ON_CALL(*sync_service(), HasSyncConsent).WillByDefault(Return(true));
    ON_CALL(*sync_service()->GetMockUserSettings(),
            IsInitialSyncFeatureSetupComplete())
        .WillByDefault(Return(true));
    ON_CALL(*sync_service(), GetAccountInfo)
        .WillByDefault(Return(account_info));
    return account_info;
  }

  void FireSyncStateChange() {
    static_cast<syncer::SyncServiceObserver*>(handler())->OnStateChanged(
        static_cast<syncer::SyncService*>(sync_service()));
  }

  void ExpectTrustedVaultBannerStateResponse(
      TrustedVaultBannerState expected_state) {
    auto& data = *web_ui_.call_data().back();
    ASSERT_TRUE(CallbackReturnedSuccessfully(data));
    EXPECT_EQ(static_cast<int>(expected_state), data.arg3()->GetInt());
  }

  std::vector<const base::Value*> GetAllFiredValuesForEventName(
      const std::string& event_name) {
    std::vector<const base::Value*> arguments;
    for (const std::unique_ptr<content::TestWebUI::CallData>& data :
         web_ui_.call_data()) {
      if (data->function_name() == "cr.webUIListenerCallback" &&
          data->arg1()->is_string() &&
          data->arg1()->GetString() == event_name) {
        arguments.push_back(data->arg2());
      }
    }
    return arguments;
  }

  void DestroySyncService() {
    static_cast<content::WebUIMessageHandler*>(handler_)->DisallowJavascript();
    mock_sync_service_ = nullptr;
    SyncServiceFactory::GetInstance()->SetTestingFactoryAndUse(
        profile(), base::BindRepeating(&BuildNullSyncService));
    static_cast<content::WebUIMessageHandler*>(handler_)
        ->AllowJavascriptForTesting();
  }

  signin::IdentityTestEnvironment* identity_test_env() {
    return identity_test_env_adaptor_->identity_test_env();
  }

  content::TestWebUI* web_ui() { return &web_ui_; }
  MockSyncService* sync_service() { return mock_sync_service_; }
  SyncHandler* handler() { return handler_; }

 private:
  content::TestWebUI web_ui_;
  std::unique_ptr<IdentityTestEnvironmentProfileAdaptor>
      identity_test_env_adaptor_;
  raw_ptr<MockSyncService> mock_sync_service_;
  raw_ptr<SyncHandler> handler_;
};

TEST_F(SyncHandlerTest, HandleTrustedVaultBannerStateNotShown) {
  // Paused sync should prevent showing trusted vault banner.
  ON_CALL(*sync_service(), GetTransportState())
      .WillByDefault(Return(syncer::SyncService::TransportState::PAUSED));

  base::Value::List args;
  args.Append(kTestCallbackId);
  web_ui()->ProcessWebUIMessage(GURL(), "GetSyncTrustedVaultBannerState",
                                std::move(args));
  ExpectTrustedVaultBannerStateResponse(TrustedVaultBannerState::kNotShown);
}

TEST_F(SyncHandlerTest, HandleTrustedVaultBannerStateOptedIn) {
  ON_CALL(*sync_service()->GetMockUserSettings(), GetPassphraseType())
      .WillByDefault(Return(syncer::PassphraseType::kTrustedVaultPassphrase));

  base::Value::List args;
  args.Append(kTestCallbackId);
  web_ui()->ProcessWebUIMessage(GURL(), "GetSyncTrustedVaultBannerState",
                                std::move(args));
  ExpectTrustedVaultBannerStateResponse(TrustedVaultBannerState::kOptedIn);
}

TEST_F(SyncHandlerTest, HandleTrustedVaultBannerStateOfferOptIn) {
  ON_CALL(*sync_service(), GetTransportState())
      .WillByDefault(Return(syncer::SyncService::TransportState::ACTIVE));
  ON_CALL(*sync_service(), GetActiveDataTypes())
      .WillByDefault(testing::Return(syncer::DataTypeSet({syncer::PASSWORDS})));
  ON_CALL(*sync_service()->GetMockUserSettings(), GetAllEncryptedDataTypes())
      .WillByDefault(testing::Return(syncer::DataTypeSet({syncer::PASSWORDS})));
  ON_CALL(*sync_service()->GetMockUserSettings(), GetPassphraseType())
      .WillByDefault(Return(syncer::PassphraseType::kKeystorePassphrase));
  ON_CALL(*sync_service()->GetMockUserSettings(), IsPassphraseRequired())
      .WillByDefault(Return(false));
  ASSERT_TRUE(syncer::ShouldOfferTrustedVaultOptIn(
      static_cast<syncer::SyncService*>(sync_service())));

  base::Value::List args;
  args.Append(kTestCallbackId);
  web_ui()->ProcessWebUIMessage(GURL(), "GetSyncTrustedVaultBannerState",
                                std::move(args));
  ExpectTrustedVaultBannerStateResponse(TrustedVaultBannerState::kOfferOptIn);
}

TEST_F(SyncHandlerTest, TrustedVaultBannerStateChange) {
  std::vector<const base::Value*> args =
      GetAllFiredValuesForEventName("trusted-vault-banner-state-changed");
  ASSERT_EQ(0U, args.size());

  // Ensure the state is propagated.
  ON_CALL(*sync_service(), GetTransportState())
      .WillByDefault(Return(syncer::SyncService::TransportState::PAUSED));
  FireSyncStateChange();
  args = GetAllFiredValuesForEventName("trusted-vault-banner-state-changed");
  ASSERT_EQ(1U, args.size());
  ASSERT_TRUE(args[0]->is_int());
  EXPECT_EQ(static_cast<int>(TrustedVaultBannerState::kNotShown),
            args[0]->GetInt());
}

TEST_F(SyncHandlerTest, GetSyncInfo) {
  CreateTestSyncAccount();

  base::Value::List args;
  args.Append(kTestCallbackId);
  web_ui()->ProcessWebUIMessage(GURL(), "GetSyncInfo", std::move(args));

  auto& data = *web_ui()->call_data().back();
  ASSERT_TRUE(CallbackReturnedSuccessfully(data));
  ASSERT_TRUE(data.arg3()->is_dict());
  // A syncing user should not be eligible for account storage.
  EXPECT_FALSE(*data.arg3()->GetDict().FindBool("isEligibleForAccountStorage"));
}

TEST_F(SyncHandlerTest, GetSyncInfoOnSyncStateChange) {
  CreateTestSyncAccount();

  FireSyncStateChange();
  std::vector<const base::Value*> state_update_args =
      GetAllFiredValuesForEventName("sync-info-changed");

  ASSERT_EQ(1U, state_update_args.size());
  ASSERT_TRUE(state_update_args[0]->is_dict());
  // A syncing user should not be eligible for account storage.
  EXPECT_FALSE(
      *state_update_args[0]->GetDict().FindBool("isEligibleForAccountStorage"));
}

TEST_F(SyncHandlerTest, AccountInfo) {
  base::Value::List args;
  args.Append(kTestCallbackId);
  web_ui()->ProcessWebUIMessage(GURL(), "GetAccountInfo", std::move(args));
  auto& data = *web_ui()->call_data().back();
  ASSERT_TRUE(CallbackReturnedSuccessfully(data));

  // Expect no accounts initially.
  base::Value::List expected_accounts;
  ASSERT_TRUE(data.arg3()->is_dict());
  EXPECT_EQ("", *data.arg3()->GetDict().FindString("email"));

  auto account_info = CreateTestSyncAccount();
  // Creating an account with IdentityTestEnvironment::MakeAccountAvailable
  // triggers identity manager observer before stored accounts info
  // can be retrieved.
  size_t num_account_change_updates =
      GetAllFiredValuesForEventName("stored-accounts-changed").size();

  // Verify that stored accounts are propagated to WebUI.
  static_cast<signin::IdentityManager::Observer*>(handler())
      ->OnExtendedAccountInfoUpdated(account_info);
  std::vector<const base::Value*> update_args =
      GetAllFiredValuesForEventName("stored-accounts-changed");
  ASSERT_EQ(num_account_change_updates + 1, update_args.size());
  ASSERT_TRUE(update_args[1]->is_dict());
  EXPECT_EQ(account_info.email, *update_args[1]->GetDict().FindString("email"));
}

TEST_F(SyncHandlerTest, NotEligibleForAccountStorageWhenSetupNotComplete) {
  CreateTestSyncAccount();
  ON_CALL(*sync_service()->GetMockUserSettings(),
          IsInitialSyncFeatureSetupComplete())
      .WillByDefault(Return(false));

  base::Value::List args;
  args.Append(kTestCallbackId);
  web_ui()->ProcessWebUIMessage(GURL(), "GetSyncInfo", std::move(args));

  auto& data = *web_ui()->call_data().back();
  ASSERT_TRUE(CallbackReturnedSuccessfully(data));
  ASSERT_TRUE(data.arg3()->is_dict());
  EXPECT_FALSE(*data.arg3()->GetDict().FindBool("isEligibleForAccountStorage"));
}

TEST_F(SyncHandlerTest, GetLocalPasswordCount) {
  CreateTestSyncAccount();
  int password_count = 10;
  // Make sure `SyncService::GetLocalDataDescriptions()` returns a list of
  // `password_count` (model content doesn't matter) for `syncer::PASSWORDS`.
  ON_CALL(*sync_service(), GetLocalDataDescriptions)
      .WillByDefault(
          [&password_count](
              syncer::DataTypeSet types,
              base::OnceCallback<void(
                  std::map<syncer::DataType, syncer::LocalDataDescription>)>
                  callback) {
            syncer::LocalDataDescription description;
            description.local_data_models =
                std::vector<syncer::LocalDataItemModel>(
                    password_count, syncer::LocalDataItemModel());
            std::move(callback).Run({{syncer::PASSWORDS, description}});
          });

  base::Value::List args;
  args.Append(kTestCallbackId);
  web_ui()->ProcessWebUIMessage(GURL(), "GetLocalPasswordCount",
                                std::move(args));

  auto& data = *web_ui()->call_data().back();
  ASSERT_TRUE(CallbackReturnedSuccessfully(data));
  ASSERT_TRUE(data.arg3()->is_int());
  EXPECT_EQ(data.arg3()->GetInt(), password_count);
}

TEST_F(SyncHandlerTest, GetLocalPasswordCountWithNoSyncService) {
  DestroySyncService();

  base::Value::List args;
  args.Append(kTestCallbackId);
  web_ui()->ProcessWebUIMessage(GURL(), "GetLocalPasswordCount",
                                std::move(args));

  auto& data = *web_ui()->call_data().back();
  ASSERT_TRUE(CallbackReturnedSuccessfully(data));
  ASSERT_TRUE(data.arg3()->is_int());
  EXPECT_EQ(data.arg3()->GetInt(), 0);
}

}  // namespace password_manager