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 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
|
// Copyright 2012 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/sync/sync_ui_util.h"
#include <set>
#include <string>
#include <utility>
#include "base/test/task_environment.h"
#include "build/build_config.h"
#include "chrome/grit/branded_strings.h"
#include "chrome/grit/generated_resources.h"
#include "components/signin/public/identity_manager/identity_test_environment.h"
#include "components/sync/engine/sync_engine.h"
#include "components/sync/test/test_sync_service.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#if BUILDFLAG(IS_CHROMEOS)
#include "ash/constants/ash_features.h"
#include "base/test/scoped_feature_list.h"
#endif
namespace {
MATCHER_P5(SyncStatusLabelsMatch,
message_type,
status_label_string_id,
button_string_id,
secondary_button_string_id,
action_type,
"") {
if (arg.message_type != message_type) {
*result_listener << "Wrong message type";
return false;
}
if (arg.status_label_string_id != status_label_string_id) {
*result_listener << "Wrong status label";
return false;
}
if (arg.button_string_id != button_string_id) {
*result_listener << "Wrong button string";
return false;
}
if (arg.secondary_button_string_id != secondary_button_string_id) {
*result_listener << "Wrong button string";
return false;
}
if (arg.action_type != action_type) {
*result_listener << "Wrong action type";
return false;
}
return true;
}
// A number of distinct states of the SyncService can be generated for tests.
enum DistinctState {
STATUS_CASE_SETUP_IN_PROGRESS,
STATUS_CASE_SETUP_ERROR,
STATUS_CASE_AUTH_ERROR,
STATUS_CASE_PROTOCOL_ERROR,
STATUS_CASE_CONFIRM_SYNC_SETTINGS,
STATUS_CASE_PASSPHRASE_ERROR,
STATUS_CASE_TRUSTED_VAULT_KEYS_ERROR,
STATUS_CASE_TRUSTED_VAULT_RECOVERABILITY_ERROR,
STATUS_CASE_SYNCED,
STATUS_CASE_SYNC_DISABLED_BY_POLICY,
#if BUILDFLAG(IS_CHROMEOS)
STATUS_CASE_SYNC_RESET_FROM_DASHBOARD,
#endif // BUILDFLAG(IS_CHROMEOS)
NUMBER_OF_STATUS_CASES
};
const char kTestUser[] = "test_user@test.com";
// Sets up a TestSyncService to emulate one of a number of distinct cases in
// order to perform tests on the generated messages. Returns the expected value
// GetSyncStatusLabels should return.
// TODO(mastiz): Split the cases below to separate tests.
SyncStatusLabels SetUpDistinctCase(
syncer::TestSyncService* service,
signin::IdentityTestEnvironment* test_environment,
DistinctState case_number) {
AccountInfo account = test_environment->MakePrimaryAccountAvailable(
kTestUser, signin::ConsentLevel::kSync);
service->SetSignedIn(signin::ConsentLevel::kSync, account);
switch (case_number) {
case STATUS_CASE_SETUP_IN_PROGRESS: {
service->SetInitialSyncFeatureSetupComplete(false);
service->SetSetupInProgress();
return {SyncStatusMessageType::kPreSynced, IDS_SYNC_SETUP_IN_PROGRESS,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
case STATUS_CASE_SETUP_ERROR: {
service->SetInitialSyncFeatureSetupComplete(false);
service->SetHasUnrecoverableError(true);
return {SyncStatusMessageType::kSyncError,
#if !BUILDFLAG(IS_CHROMEOS)
IDS_SYNC_STATUS_UNRECOVERABLE_ERROR,
#else
IDS_SYNC_STATUS_UNRECOVERABLE_ERROR_NEEDS_SIGNOUT,
#endif
IDS_SYNC_RELOGIN_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kReauthenticate};
}
case STATUS_CASE_AUTH_ERROR: {
test_environment->SetRefreshTokenForPrimaryAccount();
test_environment->UpdatePersistentErrorOfRefreshTokenForAccount(
account.account_id,
GoogleServiceAuthError(GoogleServiceAuthError::State::SERVICE_ERROR));
service->SetPersistentAuthError();
return {SyncStatusMessageType::kSyncError, IDS_SYNC_RELOGIN_ERROR,
IDS_SYNC_RELOGIN_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kReauthenticate};
}
case STATUS_CASE_PROTOCOL_ERROR: {
syncer::SyncStatus status;
status.sync_protocol_error = {.action = syncer::UPGRADE_CLIENT};
service->SetDetailedSyncStatus(/*engine_available=*/false, status);
return {SyncStatusMessageType::kSyncError, IDS_SYNC_UPGRADE_CLIENT,
IDS_SYNC_UPGRADE_CLIENT_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kUpgradeClient};
}
case STATUS_CASE_CONFIRM_SYNC_SETTINGS: {
service->SetInitialSyncFeatureSetupComplete(false);
return {
SyncStatusMessageType::kSyncError, IDS_SYNC_SETTINGS_NOT_CONFIRMED,
IDS_SYNC_ERROR_USER_MENU_CONFIRM_SYNC_SETTINGS_BUTTON,
IDS_SYNC_EMPTY_STRING, SyncStatusActionType::kConfirmSyncSettings};
}
case STATUS_CASE_PASSPHRASE_ERROR: {
service->SetPassphraseRequired();
return {SyncStatusMessageType::kSyncError, IDS_SYNC_STATUS_NEEDS_PASSWORD,
IDS_SYNC_STATUS_NEEDS_PASSWORD_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kEnterPassphrase};
}
case STATUS_CASE_TRUSTED_VAULT_KEYS_ERROR:
service->SetTrustedVaultKeyRequired(true);
return {SyncStatusMessageType::kPasswordsOnlySyncError,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_STATUS_NEEDS_KEYS_BUTTON,
IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kRetrieveTrustedVaultKeys};
case STATUS_CASE_TRUSTED_VAULT_RECOVERABILITY_ERROR:
service->SetTrustedVaultRecoverabilityDegraded(true);
return {SyncStatusMessageType::kSynced, IDS_SYNC_ACCOUNT_SYNCING,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
case STATUS_CASE_SYNCED: {
return {SyncStatusMessageType::kSynced, IDS_SYNC_ACCOUNT_SYNCING,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
case STATUS_CASE_SYNC_DISABLED_BY_POLICY: {
service->SetAllowedByEnterprisePolicy(false);
return {SyncStatusMessageType::kSynced,
IDS_SIGNED_IN_WITH_SYNC_DISABLED_BY_POLICY, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING, SyncStatusActionType::kNoAction};
}
#if BUILDFLAG(IS_CHROMEOS)
case STATUS_CASE_SYNC_RESET_FROM_DASHBOARD: {
service->GetUserSettings()->SetSyncFeatureDisabledViaDashboard();
return {SyncStatusMessageType::kSyncError,
IDS_SIGNED_IN_WITH_SYNC_STOPPED_VIA_DASHBOARD,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
#endif // BUILDFLAG(IS_CHROMEOS)
case NUMBER_OF_STATUS_CASES:
NOTREACHED();
}
return {SyncStatusMessageType::kPreSynced, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
// This test ensures that each distinctive SyncService status will return a
// proper status and link messages from GetSyncStatusLabels().
TEST(SyncUIUtilTest, DistinctCasesReportProperMessages) {
base::test::TaskEnvironment task_environment;
for (int index = 0; index != NUMBER_OF_STATUS_CASES; index++) {
SCOPED_TRACE(testing::Message() << "Testing case " << index);
syncer::TestSyncService service;
signin::IdentityTestEnvironment environment;
SyncStatusLabels expected_labels = SetUpDistinctCase(
&service, &environment, static_cast<DistinctState>(index));
EXPECT_THAT(
GetSyncStatusLabels(&service, environment.identity_manager(),
/*is_user_clear_primary_account_allowed=*/true),
SyncStatusLabelsMatch(expected_labels.message_type,
expected_labels.status_label_string_id,
expected_labels.button_string_id,
expected_labels.secondary_button_string_id,
expected_labels.action_type));
}
}
TEST(SyncUIUtilTest, UnrecoverableErrorWithActionableProtocolError) {
base::test::TaskEnvironment task_environment;
syncer::TestSyncService service;
signin::IdentityTestEnvironment environment;
environment.SetPrimaryAccount(kTestUser, signin::ConsentLevel::kSync);
service.SetInitialSyncFeatureSetupComplete(true);
service.SetHasUnrecoverableError(true);
// First time action is not set. We should get unrecoverable error.
service.SetDetailedSyncStatus(true, syncer::SyncStatus());
// Expect the generic unrecoverable error action which is to reauthenticate.
int unrecoverable_error =
#if !BUILDFLAG(IS_CHROMEOS)
IDS_SYNC_STATUS_UNRECOVERABLE_ERROR;
#else
IDS_SYNC_STATUS_UNRECOVERABLE_ERROR_NEEDS_SIGNOUT;
#endif
EXPECT_THAT(
GetSyncStatusLabels(&service, environment.identity_manager(),
/*is_user_clear_primary_account_allowed=*/true),
SyncStatusLabelsMatch(SyncStatusMessageType::kSyncError,
unrecoverable_error, IDS_SYNC_RELOGIN_BUTTON,
IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kReauthenticate));
// This time set action to SyncStatusActionType::kUpgradeClient.
syncer::SyncStatus status;
status.sync_protocol_error.action = syncer::UPGRADE_CLIENT;
service.SetDetailedSyncStatus(true, status);
EXPECT_THAT(
GetSyncStatusLabels(&service, environment.identity_manager(),
/*is_user_clear_primary_account_allowed=*/true),
SyncStatusLabelsMatch(
SyncStatusMessageType::kSyncError, IDS_SYNC_UPGRADE_CLIENT,
IDS_SYNC_UPGRADE_CLIENT_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kUpgradeClient));
}
TEST(SyncUIUtilTest, ActionableProtocolErrorWithPassiveMessage) {
base::test::TaskEnvironment task_environment;
syncer::TestSyncService service;
signin::IdentityTestEnvironment environment;
environment.SetPrimaryAccount(kTestUser, signin::ConsentLevel::kSync);
service.SetInitialSyncFeatureSetupComplete(true);
service.SetHasUnrecoverableError(true);
// Set action to SyncStatusActionType::kUpgradeClient.
syncer::SyncStatus status;
status.sync_protocol_error.action = syncer::UPGRADE_CLIENT;
service.SetDetailedSyncStatus(true, status);
// Expect a 'client upgrade' call to action.
EXPECT_THAT(
GetSyncStatusLabels(&service, environment.identity_manager(),
/*is_user_clear_primary_account_allowed=*/true),
SyncStatusLabelsMatch(
SyncStatusMessageType::kSyncError, IDS_SYNC_UPGRADE_CLIENT,
IDS_SYNC_UPGRADE_CLIENT_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kUpgradeClient));
}
TEST(SyncUIUtilTest, SyncSettingsConfirmationNeededTest) {
base::test::TaskEnvironment task_environment;
syncer::TestSyncService service;
signin::IdentityTestEnvironment environment;
environment.SetPrimaryAccount(kTestUser, signin::ConsentLevel::kSync);
service.SetInitialSyncFeatureSetupComplete(false);
ASSERT_TRUE(ShouldRequestSyncConfirmation(&service));
EXPECT_THAT(
GetSyncStatusLabels(&service, environment.identity_manager(),
/*is_user_clear_primary_account_allowed=*/true),
SyncStatusLabelsMatch(
SyncStatusMessageType::kSyncError, IDS_SYNC_SETTINGS_NOT_CONFIRMED,
IDS_SYNC_ERROR_USER_MENU_CONFIRM_SYNC_SETTINGS_BUTTON,
IDS_SYNC_EMPTY_STRING, SyncStatusActionType::kConfirmSyncSettings));
}
// Errors in non-sync accounts should be ignored.
TEST(SyncUIUtilTest, IgnoreSyncErrorForNonSyncAccount) {
base::test::TaskEnvironment task_environment;
syncer::TestSyncService service;
signin::IdentityTestEnvironment environment;
const AccountInfo primary_account_info =
environment.MakePrimaryAccountAvailable(kTestUser,
signin::ConsentLevel::kSync);
service.SetSignedIn(signin::ConsentLevel::kSync, primary_account_info);
// Setup a secondary account.
const AccountInfo secondary_account_info =
environment.MakeAccountAvailable("secondary-user@example.com");
// Verify that we do not have any existing errors.
ASSERT_THAT(
GetSyncStatusLabels(&service, environment.identity_manager(),
/*is_user_clear_primary_account_allowed=*/true),
SyncStatusLabelsMatch(SyncStatusMessageType::kSynced,
IDS_SYNC_ACCOUNT_SYNCING, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction));
// Add an error to the secondary account.
environment.UpdatePersistentErrorOfRefreshTokenForAccount(
secondary_account_info.account_id,
GoogleServiceAuthError(
GoogleServiceAuthError::State::INVALID_GAIA_CREDENTIALS));
// Verify that we do not see any sign-in errors.
EXPECT_THAT(
GetSyncStatusLabels(&service, environment.identity_manager(),
/*is_user_clear_primary_account_allowed=*/true),
SyncStatusLabelsMatch(SyncStatusMessageType::kSynced,
IDS_SYNC_ACCOUNT_SYNCING, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction));
}
TEST(SyncUIUtilTest, ShouldShowSyncPassphraseError) {
syncer::TestSyncService service;
service.SetInitialSyncFeatureSetupComplete(true);
service.SetPassphraseRequired();
EXPECT_TRUE(ShouldShowSyncPassphraseError(&service));
}
TEST(SyncUIUtilTest, ShouldShowSyncPassphraseError_SyncDisabled) {
syncer::TestSyncService service;
service.SetInitialSyncFeatureSetupComplete(false);
service.SetPassphraseRequired();
EXPECT_FALSE(ShouldShowSyncPassphraseError(&service));
}
TEST(SyncUIUtilTest, ShouldShowSyncPassphraseError_NotUsingPassphrase) {
syncer::TestSyncService service;
service.SetInitialSyncFeatureSetupComplete(true);
EXPECT_FALSE(ShouldShowSyncPassphraseError(&service));
}
} // namespace
|