// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#import <UIKit/UIKit.h>
#import <XCTest/XCTest.h>
#import <map>
#import <memory>
#import "base/apple/foundation_util.h"
#import "base/strings/stringprintf.h"
#import "base/strings/sys_string_conversions.h"
#import "build/branding_buildflags.h"
#import "components/browsing_data/core/browsing_data_utils.h"
#import "components/browsing_data/core/pref_names.h"
#import "components/strings/grit/components_strings.h"
#import "ios/chrome/browser/shared/public/features/features.h"
#import "ios/chrome/browser/shared/ui/elements/activity_overlay_egtest_util.h"
#import "ios/chrome/browser/signin/model/test_constants.h"
#import "ios/chrome/browser/ui/authentication/signin/signin_constants.h"
#import "ios/chrome/browser/ui/authentication/signin_matchers.h"
#import "ios/chrome/browser/ui/settings/settings_app_interface.h"
#import "ios/chrome/grit/ios_branded_strings.h"
#import "ios/chrome/grit/ios_strings.h"
#import "ios/chrome/test/earl_grey/chrome_actions_app_interface.h"
#import "ios/chrome/test/earl_grey/chrome_earl_grey.h"
#import "ios/chrome/test/earl_grey/chrome_earl_grey_ui.h"
#import "ios/chrome/test/earl_grey/chrome_matchers.h"
#import "ios/chrome/test/earl_grey/chrome_test_case.h"
#import "ios/testing/earl_grey/earl_grey_test.h"
#import "net/test/embedded_test_server/embedded_test_server.h"
#import "ui/base/l10n/l10n_util.h"
#import "url/gurl.h"
using chrome_test_util::ButtonWithAccessibilityLabelId;
using chrome_test_util::ClearBrowsingDataButton;
using chrome_test_util::ClearBrowsingDataView;
using chrome_test_util::ClearBrowsingHistoryButton;
using chrome_test_util::ClearCacheButton;
using chrome_test_util::ClearCookiesButton;
using chrome_test_util::ClearSavedPasswordsButton;
using chrome_test_util::SettingsCollectionView;
using chrome_test_util::SettingsDoneButton;
using chrome_test_util::SettingsMenuBackButton;
using chrome_test_util::SettingsMenuPrivacyButton;
using chrome_test_util::SettingsSignInRowMatcher;
namespace {
NSString* const kCookieName = @"name";
NSString* const kCookieValue = @"value";
enum MetricsServiceType {
kMetrics,
kCrashpad,
};
// Matcher for the Clear Browsing Data cell on the Privacy screen.
id<GREYMatcher> ClearBrowsingDataCell() {
return ButtonWithAccessibilityLabelId(IDS_IOS_CLEAR_BROWSING_DATA_TITLE);
}
} // namespace
// Settings tests for Chrome.
@interface SettingsTestCase : ChromeTestCase
@end
@implementation SettingsTestCase
- (void)tearDown {
// It is possible for a test to fail with a menu visible, which can cause
// future tests to fail.
// Check if a sub-menu is still displayed. If so, close it.
NSError* error = nil;
[[EarlGrey selectElementWithMatcher:SettingsMenuBackButton()]
assertWithMatcher:grey_notNil()
error:&error];
if (!error) {
[[EarlGrey selectElementWithMatcher:SettingsMenuBackButton()]
performAction:grey_tap()];
}
// Check if the Settings menu is displayed. If so, close it.
error = nil;
[[EarlGrey selectElementWithMatcher:SettingsDoneButton()]
assertWithMatcher:grey_notNil()
error:&error];
if (!error) {
[[EarlGrey selectElementWithMatcher:SettingsDoneButton()]
performAction:grey_tap()];
}
// Shutdown network process after tests run to avoid hanging from
// clearing browsing history.
[ChromeEarlGrey killWebKitNetworkProcess];
[super tearDown];
}
// Performs the steps to clear browsing data. Must be called on the
// Clear Browsing Data settings screen, after having selected the data types
// scheduled for removal.
- (void)clearBrowsingData {
[ChromeEarlGreyUI tapClearBrowsingDataMenuButton:ClearBrowsingDataButton()];
[[EarlGrey selectElementWithMatcher:chrome_test_util::
ConfirmClearBrowsingDataButton()]
performAction:grey_tap()];
[ChromeEarlGreyUI waitForAppToIdle];
WaitForActivityOverlayToDisappear();
// Before returning, make sure that the top of the Clear Browsing Data
// settings screen is visible to match the state at the start of the method.
// TODO(crbug.com/40631911): On iOS 13 the settings menu appears as a card
// that can be dismissed with a downward swipe. This make it difficult to use
// a gesture to return to the top of the Clear Browsing Data screen, so scroll
// programatically instead. Remove this custom action if we switch back to a
// fullscreen presentation.
[[EarlGrey selectElementWithMatcher:ClearBrowsingDataView()]
performAction:[ChromeActionsAppInterface scrollToTop]];
}
// From the NTP, clears the cookies and site data via the UI.
- (void)clearCookiesAndSiteData {
[ChromeEarlGreyUI openSettingsMenu];
[ChromeEarlGreyUI tapSettingsMenuButton:SettingsMenuPrivacyButton()];
[ChromeEarlGreyUI tapPrivacyMenuButton:ClearBrowsingDataCell()];
// "Browsing history", "Cookies, Site Data" and "Cached Images and Files"
// are the default checked options when the prefs are registered. Uncheck
// "Browsing history" and "Cached Images and Files".
// Prefs are reset to default at the end of each test.
[[EarlGrey selectElementWithMatcher:ClearBrowsingHistoryButton()]
performAction:grey_tap()];
[[EarlGrey selectElementWithMatcher:ClearCacheButton()]
performAction:grey_tap()];
[self clearBrowsingData];
[[EarlGrey selectElementWithMatcher:SettingsDoneButton()]
performAction:grey_tap()];
}
// From the NTP, clears the saved passwords via the UI.
- (void)clearPasswords {
[ChromeEarlGreyUI openSettingsMenu];
[ChromeEarlGreyUI tapSettingsMenuButton:SettingsMenuPrivacyButton()];
[ChromeEarlGreyUI tapPrivacyMenuButton:ClearBrowsingDataCell()];
// "Browsing history", "Cookies, Site Data" and "Cached Images and Files"
// are the default checked options when the prefs are registered. Unckeck all
// of them and check "Passwords".
[[EarlGrey selectElementWithMatcher:ClearBrowsingHistoryButton()]
performAction:grey_tap()];
[[EarlGrey selectElementWithMatcher:ClearCookiesButton()]
performAction:grey_tap()];
[[EarlGrey selectElementWithMatcher:ClearCacheButton()]
performAction:grey_tap()];
[[EarlGrey selectElementWithMatcher:ClearSavedPasswordsButton()]
performAction:grey_tap()];
[self clearBrowsingData];
// Re-tap all the previously tapped cells, so that the default state of the
// checkmarks is preserved.
[[EarlGrey selectElementWithMatcher:ClearBrowsingHistoryButton()]
performAction:grey_tap()];
[[EarlGrey selectElementWithMatcher:ClearCookiesButton()]
performAction:grey_tap()];
[[EarlGrey selectElementWithMatcher:ClearCacheButton()]
performAction:grey_tap()];
[[EarlGrey selectElementWithMatcher:ClearSavedPasswordsButton()]
performAction:grey_tap()];
[[EarlGrey selectElementWithMatcher:SettingsDoneButton()]
performAction:grey_tap()];
}
// Checks for a given service that it is both recording and uploading, where
// appropriate.
- (void)assertMetricsServiceEnabled:(MetricsServiceType)serviceType {
switch (serviceType) {
case kMetrics:
GREYAssertTrue([SettingsAppInterface isMetricsRecordingEnabled],
@"Metrics recording should be enabled.");
GREYAssertTrue([SettingsAppInterface isMetricsReportingEnabled],
@"Metrics reporting should be enabled.");
break;
case kCrashpad:
GREYAssertTrue([SettingsAppInterface isCrashpadEnabled],
@"Crashpad should be enabled.");
GREYAssertTrue([SettingsAppInterface isCrashpadReportingEnabled],
@"Crashpad reporting should be enabled.");
break;
}
}
// Checks for a given service that it is completely disabled.
- (void)assertMetricsServiceDisabled:(MetricsServiceType)serviceType {
switch (serviceType) {
case kMetrics: {
GREYAssertFalse([SettingsAppInterface isMetricsRecordingEnabled],
@"Metrics recording should be disabled.");
GREYAssertFalse([SettingsAppInterface isMetricsReportingEnabled],
@"Metrics reporting should be disabled.");
break;
}
case kCrashpad: {
// Crashpad is always enabled.
GREYAssertTrue([SettingsAppInterface isCrashpadEnabled],
@"Crashpad should be enabled.");
break;
}
}
}
// Checks for a given service that it is recording, but not uploading anything.
// Used to test that the wifi-only preference is honored when the device is
// using a cellular network.
- (void)assertMetricsServiceEnabledButNotUploading:
(MetricsServiceType)serviceType {
switch (serviceType) {
case kMetrics: {
GREYAssertTrue([SettingsAppInterface isMetricsRecordingEnabled],
@"Metrics recording should be enabled.");
GREYAssertFalse([SettingsAppInterface isMetricsReportingEnabled],
@"Metrics reporting should be disabled.");
break;
}
case kCrashpad: {
GREYAssertTrue([SettingsAppInterface isCrashpadEnabled],
@"Crashpad should be enabled.");
GREYAssertFalse([SettingsAppInterface isCrashpadReportingEnabled],
@"Crashpad reporting should be disabled.");
break;
}
}
}
- (void)assertsMetricsPrefsForService:(MetricsServiceType)serviceType {
// kMetricsReportingEnabled OFF
// - Services do not record data and do not upload data.
[SettingsAppInterface setMetricsReportingEnabled:NO];
// Service should be completely disabled.
// I.e. no recording of data, and no uploading of what's been recorded.
[self assertMetricsServiceDisabled:serviceType];
// kMetricsReportingEnabled ON
// - Services record data and upload data.
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
// Official builds allow recording and uploading of data, honoring the
// metrics prefs. Development builds should never record or upload data.
[SettingsAppInterface setMetricsReportingEnabled:YES];
// Service should be enabled.
[self assertMetricsServiceEnabled:serviceType];
#else
// Development build. Do not allow any recording or uploading of data.
[SettingsAppInterface setMetricsReportingEnabled:YES];
// Service should remain disabled.
[self assertMetricsServiceDisabled:serviceType];
#endif
}
#pragma mark Tests
// Tests that clearing the cookies through the UI does clear all of them. Use a
// local server to navigate to a page that sets then tests a cookie, and then
// clears the cookie and tests it is not set.
- (void)testClearCookies {
// Set pref to the last hour.
[ChromeEarlGrey
setIntegerValue:static_cast<int>(browsing_data::TimePeriod::LAST_HOUR)
forUserPref:browsing_data::prefs::kDeleteTimePeriod];
GREYAssertTrue(self.testServer->Start(), @"Server did not start.");
// Load `kUrl` and check that cookie is not set.
[ChromeEarlGrey loadURL:self.testServer->GetURL("/echo")];
[ChromeEarlGrey waitForWebStateContainingText:"Echo"];
NSDictionary* cookies = [ChromeEarlGrey cookies];
GREYAssertEqual(0U, cookies.count, @"No cookie should be found.");
// Visit "/set-cookie" to set a cookie and then load another page to check
// that it is still set.
std::string setCookiePath = base::StringPrintf(
"/set-cookie?%s=%s", base::SysNSStringToUTF8(kCookieName).c_str(),
base::SysNSStringToUTF8(kCookieValue).c_str());
[ChromeEarlGrey loadURL:self.testServer->GetURL(setCookiePath)];
[ChromeEarlGrey waitForPageToFinishLoading];
[ChromeEarlGrey loadURL:self.testServer->GetURL("/echo")];
[ChromeEarlGrey waitForWebStateContainingText:"Echo"];
cookies = [ChromeEarlGrey cookies];
GREYAssertEqualObjects(kCookieValue, cookies[kCookieName],
@"Failed to set cookie.");
GREYAssertEqual(1U, cookies.count, @"Only one cookie should be found.");
// Restore the Clear Browsing Data checkmarks prefs to their default state
// in Teardown.
[self setTearDownHandler:^{
[SettingsAppInterface restoreClearBrowsingDataCheckmarksToDefault];
}];
// Clear all cookies.
[self clearCookiesAndSiteData];
// Reload and test that there are no cookies left.
[ChromeEarlGrey loadURL:self.testServer->GetURL("/echo")];
[ChromeEarlGrey waitForPageToFinishLoading];
cookies = [ChromeEarlGrey cookies];
GREYAssertEqual(0U, cookies.count, @"No cookie should be found.");
[ChromeEarlGrey closeAllTabs];
}
// Verifies that metrics reporting works properly under possible settings of the
// preference kMetricsReportingEnabled.
- (void)testMetricsReporting {
[self assertsMetricsPrefsForService:kMetrics];
}
// Verifies that crashpad reporting works properly under possible settings of
// the preference `kMetricsReportingEnabled`.
// NOTE: crashpad only allows uploading for non-first-launch runs.
- (void)testCrashpadReporting {
[self assertsMetricsPrefsForService:kCrashpad];
}
// Verifies that the Settings UI registers keyboard commands when presented, but
// not when it itself presents something.
- (void)testSettingsKeyboardCommands {
[ChromeEarlGreyUI openSettingsMenu];
[[EarlGrey selectElementWithMatcher:SettingsCollectionView()]
assertWithMatcher:grey_notNil()];
// Verify that the Settings register keyboard commands.
GREYAssertTrue([SettingsAppInterface settingsRegisteredKeyboardCommands],
@"Settings should register key commands when presented.");
// Present the Sign-in UI.
id<GREYMatcher> matcher =
grey_allOf(SettingsSignInRowMatcher(), grey_sufficientlyVisible(), nil);
[[EarlGrey selectElementWithMatcher:matcher] performAction:grey_tap()];
// Wait for UI to finish loading the Sign-in screen.
[ChromeEarlGreyUI waitForAppToIdle];
// Verify that the Settings register keyboard commands.
GREYAssertFalse([SettingsAppInterface settingsRegisteredKeyboardCommands],
@"Settings should not register key commands when presented.");
// Cancel the sign-in operation.
[[EarlGrey selectElementWithMatcher:grey_accessibilityID(
kFakeAuthCancelButtonIdentifier)]
performAction:grey_tap()];
// Wait for UI to finish closing the Sign-in screen.
[ChromeEarlGreyUI waitForAppToIdle];
// Verify that the Settings register keyboard commands.
GREYAssertTrue([SettingsAppInterface settingsRegisteredKeyboardCommands],
@"Settings should register key commands when presented.");
}
@end
Codebase Browser
chromium