sync_preferences_egtest.mm | Explore in Territory

// 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.

#import <XCTest/XCTest.h>

#import "base/ios/ios_util.h"
#import "base/strings/sys_string_conversions.h"
#import "base/test/ios/wait_util.h"
#import "base/time/time.h"
#import "components/sync/base/command_line_switches.h"
#import "components/sync/base/features.h"
#import "ios/chrome/browser/shared/model/prefs/pref_names.h"
#import "ios/chrome/browser/signin/model/fake_system_identity.h"
#import "ios/chrome/browser/ui/authentication/signin_earl_grey.h"
#import "ios/chrome/browser/ui/authentication/signin_earl_grey_ui_test_util.h"
#import "ios/chrome/test/earl_grey/chrome_earl_grey.h"
#import "ios/chrome/test/earl_grey/chrome_matchers.h"
#import "ios/chrome/test/earl_grey/chrome_test_case.h"
#import "ios/chrome/test/earl_grey/web_http_server_chrome_test_case.h"
#import "ios/testing/earl_grey/earl_grey_test.h"
#import "net/test/embedded_test_server/embedded_test_server.h"

namespace {

const char* kTestSyncablePref = prefs::kNetworkPredictionSetting;
const int kTestPrefValue1 = 1001;  // Some random value.
const int kTestPrefValue2 = 1002;  // Some random value.

// Constant for timeout while waiting for asynchronous sync operations.
constexpr base::TimeDelta kSyncOperationTimeout = base::Seconds(10);

// Waits for `entity_count` entities of PREFERENCE type on the fake server,
// and fails with a GREYAssert if the condition is not met, within a short
// period of time.
void WaitForEntitiesOnFakeServer(int entity_count) {
  GREYAssert(base::test::ios::WaitUntilConditionOrTimeout(
                 kSyncOperationTimeout,
                 ^{
                   return
                       [ChromeEarlGrey
                           numberOfSyncEntitiesWithType:syncer::PREFERENCES] ==
                       entity_count;
                 }),
             @"Expected %d entities for PREFERENCES.", entity_count);
}

// Waits for the active pref value to become `pref_value` and fails with a
// GREYAssert if the condition is not met, within a short period of time.
void WaitForPreferenceValue(int pref_value) {
  GREYAssertTrue(base::test::ios::WaitUntilConditionOrTimeout(
                     kSyncOperationTimeout,
                     ^{
                       return
                           [ChromeEarlGrey userIntegerPref:kTestSyncablePref] ==
                           pref_value;
                     }),
                 @"Expected preference to be present.");
}

}  // namespace

@interface SyncPreferencesTestCase : WebHttpServerChromeTestCase
@end

@implementation SyncPreferencesTestCase

- (AppLaunchConfiguration)appConfigurationForTestCase {
  AppLaunchConfiguration config = [super appConfigurationForTestCase];
  config.additional_args.push_back(std::string("--") +
                                   syncer::kSyncShortNudgeDelayForTest);
  config.features_enabled.push_back(syncer::kEnablePreferencesAccountStorage);
  return config;
}

- (void)setUp {
  [super setUp];

  GREYAssertTrue(self.testServer->Start(), @"Server did not start.");

  [ChromeEarlGrey clearFakeSyncServerData];
  WaitForEntitiesOnFakeServer(0);
}

- (void)tearDown {
  [ChromeEarlGrey clearUserPrefWithName:kTestSyncablePref];
  [ChromeEarlGrey clearFakeSyncServerData];

  WaitForEntitiesOnFakeServer(0);

  [super tearDown];
}

#pragma mark - SyncPreferencesTestCase Tests

// Tests that the local pref value is not uploaded to the account.
- (void)testLocalPrefNotUploadedToAccountOnSignIn {
  [ChromeEarlGrey setIntegerValue:kTestPrefValue1
                      forUserPref:kTestSyncablePref];

  // Sign in and sign out.
  FakeSystemIdentity* fakeIdentity = [FakeSystemIdentity fakeIdentity1];
  [SigninEarlGrey signinWithFakeIdentity:fakeIdentity];
  // No entity is committed to the server.
  WaitForEntitiesOnFakeServer(0);
  [SigninEarlGrey signOut];

  GREYAssertEqual([ChromeEarlGrey userIntegerPref:kTestSyncablePref],
                  kTestPrefValue1, @"Incorrect local pref value.");

  // Remove from local store.
  [ChromeEarlGrey clearUserPrefWithName:kTestSyncablePref];

  // Sign in again to validate the value is not set from the server.
  [SigninEarlGrey signinWithFakeIdentity:fakeIdentity];
  GREYAssertNotEqual([ChromeEarlGrey userIntegerPref:kTestSyncablePref],
                     kTestPrefValue1, @"Incorrect account pref value.");
}

// Tests that the account pref value is removed on signout and the local pref
// value takes effect.
- (void)testAccountPrefValueCleanedUpOnSignout {
  // Set a pref value of `kTestPrefValue2` in account.
  FakeSystemIdentity* fakeIdentity = [FakeSystemIdentity fakeIdentity1];
  [SigninEarlGrey signinWithFakeIdentity:fakeIdentity];
  [ChromeEarlGrey setIntegerValue:kTestPrefValue2
                      forUserPref:kTestSyncablePref];
  WaitForEntitiesOnFakeServer(1);
  [SigninEarlGrey signOut];

  // Reset local value to `kTestPrefValue1`.
  [ChromeEarlGrey setIntegerValue:kTestPrefValue1
                      forUserPref:kTestSyncablePref];

  // Local pref value is now `kTestPrefValue1` and the account value is
  // `kTestPrefValue2`.

  // Sign in and sync.
  [SigninEarlGrey signinWithFakeIdentity:fakeIdentity];
  WaitForPreferenceValue(kTestPrefValue2);

  // Sign out and validate that the active pref value is the local value.
  [SigninEarlGrey signOut];
  WaitForPreferenceValue(kTestPrefValue1);
}

@end
chromium/ios/chrome/browser/sync/model/prefs/sync_preferences_egtest.mm
