blob: 548fe7313066468f2daa76c21500e0a2a40841bf [file] [log] [blame]
/*
* Copyright (C) 2015-2020 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#import "config.h"
#import "TestController.h"
#import "CrashReporterInfo.h"
#import "PlatformWebView.h"
#import "StringFunctions.h"
#import "TestInvocation.h"
#import "TestRunnerWKWebView.h"
#import "TestWebsiteDataStoreDelegate.h"
#import <Foundation/Foundation.h>
#import <Security/SecItem.h>
#import <WebKit/WKContextConfigurationRef.h>
#import <WebKit/WKContextPrivate.h>
#import <WebKit/WKPreferencesRefPrivate.h>
#import <WebKit/WKProcessPoolPrivate.h>
#import <WebKit/WKStringCF.h>
#import <WebKit/WKUserContentControllerPrivate.h>
#import <WebKit/WKWebView.h>
#import <WebKit/WKWebViewConfiguration.h>
#import <WebKit/WKWebViewConfigurationPrivate.h>
#import <WebKit/WKWebViewPrivate.h>
#import <WebKit/WKWebViewPrivateForTesting.h>
#import <WebKit/WKWebsiteDataRecordPrivate.h>
#import <WebKit/WKWebsiteDataStorePrivate.h>
#import <WebKit/WKWebsiteDataStoreRef.h>
#import <WebKit/_WKApplicationManifest.h>
#import <WebKit/_WKUserContentExtensionStore.h>
#import <WebKit/_WKUserContentExtensionStorePrivate.h>
#import <wtf/MainThread.h>
#import <wtf/spi/cocoa/SecuritySPI.h>
namespace WTR {
static WKWebViewConfiguration *globalWebViewConfiguration;
static TestWebsiteDataStoreDelegate *globalWebsiteDataStoreDelegateClient;
void initializeWebViewConfiguration(const char* libraryPath, WKStringRef injectedBundlePath, WKContextRef context, WKContextConfigurationRef contextConfiguration)
{
[globalWebViewConfiguration release];
globalWebViewConfiguration = [[WKWebViewConfiguration alloc] init];
globalWebViewConfiguration.processPool = (__bridge WKProcessPool *)context;
globalWebViewConfiguration.websiteDataStore = (__bridge WKWebsiteDataStore *)TestController::defaultWebsiteDataStore();
globalWebViewConfiguration._allowUniversalAccessFromFileURLs = YES;
globalWebViewConfiguration._allowTopNavigationToDataURLs = YES;
globalWebViewConfiguration._applePayEnabled = YES;
WKContextSetStorageAccessAPIEnabled(context, true);
[globalWebViewConfiguration.websiteDataStore _setResourceLoadStatisticsEnabled:YES];
[globalWebsiteDataStoreDelegateClient release];
globalWebsiteDataStoreDelegateClient = [[TestWebsiteDataStoreDelegate alloc] init];
[globalWebViewConfiguration.websiteDataStore set_delegate:globalWebsiteDataStoreDelegateClient];
#if PLATFORM(IOS_FAMILY)
globalWebViewConfiguration.allowsInlineMediaPlayback = YES;
globalWebViewConfiguration._inlineMediaPlaybackRequiresPlaysInlineAttribute = NO;
globalWebViewConfiguration._invisibleAutoplayNotPermitted = NO;
globalWebViewConfiguration._mediaDataLoadsAutomatically = YES;
globalWebViewConfiguration.requiresUserActionForMediaPlayback = NO;
#endif
globalWebViewConfiguration.mediaTypesRequiringUserActionForPlayback = WKAudiovisualMediaTypeNone;
#if USE(SYSTEM_PREVIEW)
globalWebViewConfiguration._systemPreviewEnabled = YES;
#endif
}
void TestController::cocoaPlatformInitialize()
{
const char* dumpRenderTreeTemp = libraryPathForTesting();
if (!dumpRenderTreeTemp)
return;
String resourceLoadStatisticsFolder = String(dumpRenderTreeTemp) + '/' + "ResourceLoadStatistics";
[[NSFileManager defaultManager] createDirectoryAtPath:resourceLoadStatisticsFolder withIntermediateDirectories:YES attributes:nil error: nil];
String fullBrowsingSessionResourceLog = resourceLoadStatisticsFolder + '/' + "full_browsing_session_resourceLog.plist";
NSDictionary *resourceLogPlist = [[NSDictionary alloc] initWithObjectsAndKeys: [NSNumber numberWithInt:1], @"version", nil];
if (![resourceLogPlist writeToFile:fullBrowsingSessionResourceLog atomically:YES])
WTFCrash();
[resourceLogPlist release];
}
WKContextRef TestController::platformContext()
{
return (__bridge WKContextRef)globalWebViewConfiguration.processPool;
}
WKPreferencesRef TestController::platformPreferences()
{
return (__bridge WKPreferencesRef)globalWebViewConfiguration.preferences;
}
void TestController::platformAddTestOptions(TestOptions& options) const
{
if ([[NSUserDefaults standardUserDefaults] boolForKey:@"EnableProcessSwapOnNavigation"])
options.contextOptions.enableProcessSwapOnNavigation = true;
if ([[NSUserDefaults standardUserDefaults] boolForKey:@"EnableProcessSwapOnWindowOpen"])
options.contextOptions.enableProcessSwapOnWindowOpen = true;
}
void TestController::platformCreateWebView(WKPageConfigurationRef, const TestOptions& options)
{
RetainPtr<WKWebViewConfiguration> copiedConfiguration = adoptNS([globalWebViewConfiguration copy]);
#if PLATFORM(IOS_FAMILY)
if (options.useDataDetection)
[copiedConfiguration setDataDetectorTypes:WKDataDetectorTypeAll];
if (options.ignoresViewportScaleLimits)
[copiedConfiguration setIgnoresViewportScaleLimits:YES];
if (options.useCharacterSelectionGranularity)
[copiedConfiguration setSelectionGranularity:WKSelectionGranularityCharacter];
#else
[copiedConfiguration _setServiceControlsEnabled:options.enableServiceControls];
#endif
if (options.enableAttachmentElement)
[copiedConfiguration _setAttachmentElementEnabled:YES];
if (options.enableColorFilter)
[copiedConfiguration _setColorFilterEnabled:YES];
if (options.enableEditableImages)
[copiedConfiguration _setEditableImagesEnabled:YES];
if (options.useEphemeralSession) {
auto ephemeralWebsiteDataStore = [WKWebsiteDataStore nonPersistentDataStore];
[ephemeralWebsiteDataStore _setResourceLoadStatisticsEnabled:YES];
[copiedConfiguration setWebsiteDataStore:ephemeralWebsiteDataStore];
}
[copiedConfiguration _setAllowTopNavigationToDataURLs:options.allowTopNavigationToDataURLs];
configureContentMode(copiedConfiguration.get(), options);
if (options.applicationManifest.length()) {
auto manifestPath = [NSString stringWithUTF8String:options.applicationManifest.c_str()];
NSString *text = [NSString stringWithContentsOfFile:manifestPath usedEncoding:nullptr error:nullptr];
[copiedConfiguration _setApplicationManifest:[_WKApplicationManifest applicationManifestFromJSON:text manifestURL:nil documentURL:nil]];
}
m_mainWebView = makeUnique<PlatformWebView>(copiedConfiguration.get(), options);
finishCreatingPlatformWebView(m_mainWebView.get(), options);
if (options.punchOutWhiteBackgroundsInDarkMode)
m_mainWebView->setDrawsBackground(false);
if (options.editable)
m_mainWebView->setEditable(true);
m_mainWebView->platformView().allowsLinkPreview = options.allowsLinkPreview;
}
PlatformWebView* TestController::platformCreateOtherPage(PlatformWebView* parentView, WKPageConfigurationRef, const TestOptions& options)
{
WKWebViewConfiguration *newConfiguration = [[globalWebViewConfiguration copy] autorelease];
newConfiguration._relatedWebView = static_cast<WKWebView*>(parentView->platformView());
if (newConfiguration._relatedWebView)
newConfiguration.websiteDataStore = newConfiguration._relatedWebView.configuration.websiteDataStore;
PlatformWebView* view = new PlatformWebView(newConfiguration, options);
finishCreatingPlatformWebView(view, options);
return view;
}
// Code that needs to run after TestController::m_mainWebView is initialized goes into this function.
void TestController::finishCreatingPlatformWebView(PlatformWebView* view, const TestOptions& options)
{
#if PLATFORM(MAC)
if (options.shouldShowWebView)
[view->platformWindow() orderFront:nil];
else
[view->platformWindow() orderBack:nil];
#endif
}
WKContextRef TestController::platformAdjustContext(WKContextRef context, WKContextConfigurationRef contextConfiguration)
{
initializeWebViewConfiguration(libraryPathForTesting(), injectedBundlePath(), context, contextConfiguration);
return (__bridge WKContextRef)globalWebViewConfiguration.processPool;
}
void TestController::platformRunUntil(bool& done, WTF::Seconds timeout)
{
NSDate *endDate = (timeout > 0_s) ? [NSDate dateWithTimeIntervalSinceNow:timeout.seconds()] : [NSDate distantFuture];
while (!done && [endDate compare:[NSDate date]] == NSOrderedDescending)
[[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:endDate];
}
static NSCalendar *swizzledCalendar()
{
NSCalendar *calendar = [NSCalendar calendarWithIdentifier:TestController::singleton().overriddenCalendarIdentifier()];
calendar.locale = [NSLocale localeWithLocaleIdentifier:TestController::singleton().overriddenCalendarLocaleIdentifier()];
return calendar;
}
NSString *TestController::overriddenCalendarIdentifier() const
{
return m_overriddenCalendarAndLocaleIdentifiers.first.get();
}
NSString *TestController::overriddenCalendarLocaleIdentifier() const
{
return m_overriddenCalendarAndLocaleIdentifiers.second.get();
}
void TestController::setDefaultCalendarType(NSString *identifier, NSString *localeIdentifier)
{
m_overriddenCalendarAndLocaleIdentifiers = { identifier, localeIdentifier };
if (!m_calendarSwizzler)
m_calendarSwizzler = makeUnique<ClassMethodSwizzler>([NSCalendar class], @selector(currentCalendar), reinterpret_cast<IMP>(swizzledCalendar));
}
void TestController::resetContentExtensions()
{
__block bool doneRemoving = false;
[[_WKUserContentExtensionStore defaultStore] removeContentExtensionForIdentifier:@"TestContentExtensions" completionHandler:^(NSError *error) {
doneRemoving = true;
}];
platformRunUntil(doneRemoving, noTimeout);
[[_WKUserContentExtensionStore defaultStore] _removeAllContentExtensions];
if (auto* webView = mainWebView()) {
TestRunnerWKWebView *platformView = webView->platformView();
[platformView.configuration.userContentController _removeAllUserContentFilters];
}
}
void TestController::setApplicationBundleIdentifier(const String& bundleIdentifier)
{
if (bundleIdentifier.isEmpty())
return;
[TestRunnerWKWebView _setApplicationBundleIdentifier:(NSString *)bundleIdentifier.createCFString().get()];
}
void TestController::clearApplicationBundleIdentifierTestingOverride()
{
[TestRunnerWKWebView _clearApplicationBundleIdentifierTestingOverride];
m_hasSetApplicationBundleIdentifier = false;
}
void TestController::cocoaResetStateToConsistentValues(const TestOptions& options)
{
m_calendarSwizzler = nullptr;
m_overriddenCalendarAndLocaleIdentifiers = { nil, nil };
if (auto* webView = mainWebView()) {
TestRunnerWKWebView *platformView = webView->platformView();
platformView._viewScale = 1;
platformView._minimumEffectiveDeviceWidth = 0;
[platformView _setContinuousSpellCheckingEnabledForTesting:options.shouldShowSpellCheckingDots];
[platformView resetInteractionCallbacks];
}
[globalWebsiteDataStoreDelegateClient setAllowRaisingQuota:YES];
}
void TestController::platformWillRunTest(const TestInvocation& testInvocation)
{
setCrashReportApplicationSpecificInformationToURL(testInvocation.url());
}
static NSString * const WebArchivePboardType = @"Apple Web Archive pasteboard type";
static NSString * const WebSubresourcesKey = @"WebSubresources";
static NSString * const WebSubframeArchivesKey = @"WebResourceMIMEType like 'image*'";
unsigned TestController::imageCountInGeneralPasteboard() const
{
#if PLATFORM(MAC)
NSData *data = [[NSPasteboard generalPasteboard] dataForType:WebArchivePboardType];
#elif PLATFORM(IOS_FAMILY)
NSData *data = [[UIPasteboard generalPasteboard] valueForPasteboardType:WebArchivePboardType];
#endif
if (!data)
return 0;
NSError *error = nil;
id webArchive = [NSPropertyListSerialization propertyListWithData:data options:NSPropertyListImmutable format:NULL error:&error];
if (error) {
NSLog(@"Encountered error while serializing Web Archive pasteboard data: %@", error);
return 0;
}
NSArray *subItems = [NSArray arrayWithArray:[webArchive objectForKey:WebSubresourcesKey]];
NSPredicate *predicate = [NSPredicate predicateWithFormat:WebSubframeArchivesKey];
NSArray *imagesArray = [subItems filteredArrayUsingPredicate:predicate];
if (!imagesArray)
return 0;
return imagesArray.count;
}
void TestController::removeAllSessionCredentials()
{
auto types = adoptNS([[NSSet alloc] initWithObjects:_WKWebsiteDataTypeCredentials, nil]);
[globalWebViewConfiguration.websiteDataStore removeDataOfTypes:types.get() modifiedSince:[NSDate distantPast] completionHandler:^() {
m_currentInvocation->didRemoveAllSessionCredentials();
}];
}
void TestController::getAllStorageAccessEntries()
{
auto* parentView = mainWebView();
if (!parentView)
return;
[globalWebViewConfiguration.websiteDataStore _getAllStorageAccessEntriesFor:parentView->platformView() completionHandler:^(NSArray<NSString *> *nsDomains) {
Vector<String> domains;
domains.reserveInitialCapacity(nsDomains.count);
for (NSString *domain : nsDomains)
domains.uncheckedAppend(domain);
m_currentInvocation->didReceiveAllStorageAccessEntries(domains);
}];
}
void TestController::loadedThirdPartyDomains()
{
auto* parentView = mainWebView();
if (!parentView)
return;
[globalWebViewConfiguration.websiteDataStore _loadedThirdPartyDomainsFor:parentView->platformView() completionHandler:^(NSArray<NSString *> *nsDomains) {
Vector<String> domains;
domains.reserveInitialCapacity(nsDomains.count);
for (NSString *domain : nsDomains)
domains.uncheckedAppend(domain);
m_currentInvocation->didReceiveLoadedThirdPartyDomains(WTFMove(domains));
}];
}
void TestController::clearLoadedThirdPartyDomains()
{
auto* parentView = mainWebView();
if (!parentView)
return;
[globalWebViewConfiguration.websiteDataStore _clearLoadedThirdPartyDomainsFor:parentView->platformView()];
}
void TestController::getWebViewCategory()
{
auto* parentView = mainWebView();
if (!parentView)
return;
[globalWebViewConfiguration.websiteDataStore _getWebViewCategoryFor:parentView->platformView() completionHandler:^(_WKWebViewCategory webViewCategory) {
String category;
switch (webViewCategory) {
case _WKWebViewCategoryAppBoundDomain:
category = "AppBoundDomain";
break;
case _WKWebViewCategoryHybridApp:
category = "HybridApp";
break;
case _WKWebViewCategoryInAppBrowser:
category = "InAppBrowser";
break;
case _WKWebViewCategoryWebBrowser:
category = "WebBrowser";
break;
}
m_currentInvocation->didReceiveWebViewCategory(category);
}];
}
void TestController::injectUserScript(WKStringRef script)
{
auto userScript = adoptNS([[WKUserScript alloc] initWithSource: toWTFString(script) injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:NO]);
[[globalWebViewConfiguration userContentController] addUserScript: userScript.get()];
}
void TestController::addTestKeyToKeychain(const String& privateKeyBase64, const String& attrLabel, const String& applicationTagBase64)
{
NSDictionary* options = @{
(id)kSecAttrKeyType: (id)kSecAttrKeyTypeECSECPrimeRandom,
(id)kSecAttrKeyClass: (id)kSecAttrKeyClassPrivate,
(id)kSecAttrKeySizeInBits: @256
};
CFErrorRef errorRef = nullptr;
auto key = adoptCF(SecKeyCreateWithData(
(__bridge CFDataRef)adoptNS([[NSData alloc] initWithBase64EncodedString:privateKeyBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get(),
(__bridge CFDictionaryRef)options,
&errorRef
));
ASSERT(!errorRef);
NSDictionary* addQuery = @{
(id)kSecValueRef: (id)key.get(),
(id)kSecClass: (id)kSecClassKey,
(id)kSecAttrLabel: attrLabel,
(id)kSecAttrApplicationTag: adoptNS([[NSData alloc] initWithBase64EncodedString:applicationTagBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get(),
(id)kSecAttrAccessible: (id)kSecAttrAccessibleAfterFirstUnlock,
#if HAVE(DATA_PROTECTION_KEYCHAIN)
(id)kSecUseDataProtectionKeychain: @YES
#else
(id)kSecAttrNoLegacy: @YES
#endif
};
OSStatus status = SecItemAdd((__bridge CFDictionaryRef)addQuery, NULL);
ASSERT_UNUSED(status, !status);
}
void TestController::cleanUpKeychain(const String& attrLabel, const String& applicationLabelBase64)
{
auto deleteQuery = adoptNS([[NSMutableDictionary alloc] init]);
[deleteQuery setObject:(id)kSecClassKey forKey:(id)kSecClass];
[deleteQuery setObject:attrLabel forKey:(id)kSecAttrLabel];
#if HAVE(DATA_PROTECTION_KEYCHAIN)
[deleteQuery setObject:@YES forKey:(id)kSecUseDataProtectionKeychain];
#else
[deleteQuery setObject:@YES forKey:(id)kSecAttrNoLegacy];
#endif
if (!!applicationLabelBase64)
[deleteQuery setObject:adoptNS([[NSData alloc] initWithBase64EncodedString:applicationLabelBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get() forKey:(id)kSecAttrApplicationLabel];
SecItemDelete((__bridge CFDictionaryRef)deleteQuery.get());
}
bool TestController::keyExistsInKeychain(const String& attrLabel, const String& applicationLabelBase64)
{
NSDictionary *query = @{
(id)kSecClass: (id)kSecClassKey,
(id)kSecAttrKeyClass: (id)kSecAttrKeyClassPrivate,
(id)kSecAttrLabel: attrLabel,
(id)kSecAttrApplicationLabel: adoptNS([[NSData alloc] initWithBase64EncodedString:applicationLabelBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get(),
#if HAVE(DATA_PROTECTION_KEYCHAIN)
(id)kSecUseDataProtectionKeychain: @YES
#else
(id)kSecAttrNoLegacy: @YES
#endif
};
OSStatus status = SecItemCopyMatching((__bridge CFDictionaryRef)query, NULL);
if (!status)
return true;
ASSERT(status == errSecItemNotFound);
return false;
}
void TestController::setAllowStorageQuotaIncrease(bool value)
{
[globalWebsiteDataStoreDelegateClient setAllowRaisingQuota: value];
}
void TestController::setAllowsAnySSLCertificate(bool allows)
{
m_allowsAnySSLCertificate = allows;
WKContextSetAllowsAnySSLCertificateForWebSocketTesting(platformContext(), allows);
[globalWebsiteDataStoreDelegateClient setAllowAnySSLCertificate: allows];
}
void TestController::installCustomMenuAction(const String& name, bool dismissesAutomatically)
{
#if PLATFORM(IOS_FAMILY)
auto* invocation = m_currentInvocation.get();
[m_mainWebView->platformView() installCustomMenuAction:name dismissesAutomatically:dismissesAutomatically callback:[invocation] {
if (TestController::singleton().isCurrentInvocation(invocation))
invocation->performCustomMenuAction();
}];
#else
UNUSED_PARAM(name);
UNUSED_PARAM(dismissesAutomatically);
#endif
}
void TestController::setAllowedMenuActions(const Vector<String>& actions)
{
#if PLATFORM(IOS_FAMILY)
auto actionNames = adoptNS([[NSMutableArray<NSString *> alloc] initWithCapacity:actions.size()]);
for (auto& action : actions)
[actionNames addObject:action];
[m_mainWebView->platformView() setAllowedMenuActions:actionNames.get()];
#else
UNUSED_PARAM(actions);
#endif
}
bool TestController::isDoingMediaCapture() const
{
return m_mainWebView->platformView()._mediaCaptureState != _WKMediaCaptureStateNone;
}
#if PLATFORM(IOS_FAMILY)
static WKContentMode contentMode(const TestOptions& options)
{
if (options.contentMode == "desktop"_s)
return WKContentModeDesktop;
if (options.contentMode == "mobile"_s)
return WKContentModeMobile;
return WKContentModeRecommended;
}
#endif // PLATFORM(IOS_FAMILY)
void TestController::configureContentMode(WKWebViewConfiguration *configuration, const TestOptions& options)
{
auto webpagePreferences = adoptNS([[WKWebpagePreferences alloc] init]);
#if PLATFORM(IOS_FAMILY)
[webpagePreferences setPreferredContentMode:contentMode(options)];
#else
UNUSED_PARAM(options);
#endif
configuration.defaultWebpagePreferences = webpagePreferences.get();
}
} // namespace WTR