11b0e3ae34fbbe7e1ba9e1721a4d118d33026796
[WebKit-https.git] / Tools / WebKitTestRunner / cocoa / TestControllerCocoa.mm
1 /*
2  * Copyright (C) 2015-2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import "config.h"
27 #import "TestController.h"
28
29 #import "CrashReporterInfo.h"
30 #import "PlatformWebView.h"
31 #import "StringFunctions.h"
32 #import "TestInvocation.h"
33 #import "TestRunnerWKWebView.h"
34 #import <Foundation/Foundation.h>
35 #import <Security/SecItem.h>
36 #import <WebKit/WKContextConfigurationRef.h>
37 #import <WebKit/WKCookieManager.h>
38 #import <WebKit/WKPreferencesRefPrivate.h>
39 #import <WebKit/WKProcessPoolPrivate.h>
40 #import <WebKit/WKStringCF.h>
41 #import <WebKit/WKUserContentControllerPrivate.h>
42 #import <WebKit/WKWebView.h>
43 #import <WebKit/WKWebViewConfiguration.h>
44 #import <WebKit/WKWebViewConfigurationPrivate.h>
45 #import <WebKit/WKWebViewPrivate.h>
46 #import <WebKit/WKWebsiteDataRecordPrivate.h>
47 #import <WebKit/WKWebsiteDataStorePrivate.h>
48 #import <WebKit/WKWebsiteDataStoreRef.h>
49 #import <WebKit/_WKApplicationManifest.h>
50 #import <WebKit/_WKUserContentExtensionStore.h>
51 #import <WebKit/_WKUserContentExtensionStorePrivate.h>
52 #import <wtf/MainThread.h>
53
54 namespace WTR {
55
56 static WKWebViewConfiguration *globalWebViewConfiguration;
57
58 void initializeWebViewConfiguration(const char* libraryPath, WKStringRef injectedBundlePath, WKContextRef context, WKContextConfigurationRef contextConfiguration)
59 {
60 #if WK_API_ENABLED
61     [globalWebViewConfiguration release];
62     globalWebViewConfiguration = [[WKWebViewConfiguration alloc] init];
63
64     globalWebViewConfiguration.processPool = (__bridge WKProcessPool *)context;
65     globalWebViewConfiguration.websiteDataStore = (__bridge WKWebsiteDataStore *)WKContextGetWebsiteDataStore(context);
66     globalWebViewConfiguration._allowUniversalAccessFromFileURLs = YES;
67     globalWebViewConfiguration._applePayEnabled = YES;
68
69     WKCookieManagerSetStorageAccessAPIEnabled(WKContextGetCookieManager(context), true);
70
71     WKWebsiteDataStore* poolWebsiteDataStore = (__bridge WKWebsiteDataStore *)WKContextGetWebsiteDataStore((__bridge WKContextRef)globalWebViewConfiguration.processPool);
72     if (libraryPath) {
73         String cacheStorageDirectory = String(libraryPath) + '/' + "CacheStorage";
74         [poolWebsiteDataStore _setCacheStorageDirectory: cacheStorageDirectory];
75
76         String serviceWorkerRegistrationDirectory = String(libraryPath) + '/' + "ServiceWorkers";
77         [poolWebsiteDataStore _setServiceWorkerRegistrationDirectory: serviceWorkerRegistrationDirectory];
78     }
79
80     [globalWebViewConfiguration.websiteDataStore _setResourceLoadStatisticsEnabled:YES];
81     [globalWebViewConfiguration.websiteDataStore _resourceLoadStatisticsSetShouldSubmitTelemetry:NO];
82
83 #if PLATFORM(IOS_FAMILY)
84     globalWebViewConfiguration.allowsInlineMediaPlayback = YES;
85     globalWebViewConfiguration._inlineMediaPlaybackRequiresPlaysInlineAttribute = NO;
86     globalWebViewConfiguration._invisibleAutoplayNotPermitted = NO;
87     globalWebViewConfiguration._mediaDataLoadsAutomatically = YES;
88     globalWebViewConfiguration.requiresUserActionForMediaPlayback = NO;
89 #endif
90     globalWebViewConfiguration.mediaTypesRequiringUserActionForPlayback = WKAudiovisualMediaTypeNone;
91 #endif
92
93 #if USE(SYSTEM_PREVIEW)
94     globalWebViewConfiguration._systemPreviewEnabled = YES;
95 #endif
96 }
97
98 void TestController::cocoaPlatformInitialize()
99 {
100     const char* dumpRenderTreeTemp = libraryPathForTesting();
101     if (!dumpRenderTreeTemp)
102         return;
103
104     String resourceLoadStatisticsFolder = String(dumpRenderTreeTemp) + '/' + "ResourceLoadStatistics";
105     [[NSFileManager defaultManager] createDirectoryAtPath:resourceLoadStatisticsFolder withIntermediateDirectories:YES attributes:nil error: nil];
106     String fullBrowsingSessionResourceLog = resourceLoadStatisticsFolder + '/' + "full_browsing_session_resourceLog.plist";
107     NSDictionary *resourceLogPlist = [[NSDictionary alloc] initWithObjectsAndKeys: [NSNumber numberWithInt:1], @"version", nil];
108     if (![resourceLogPlist writeToFile:fullBrowsingSessionResourceLog atomically:YES])
109         WTFCrash();
110     [resourceLogPlist release];
111 }
112
113 WKContextRef TestController::platformContext()
114 {
115 #if WK_API_ENABLED
116     return (__bridge WKContextRef)globalWebViewConfiguration.processPool;
117 #else
118     return nullptr;
119 #endif
120 }
121
122 WKPreferencesRef TestController::platformPreferences()
123 {
124 #if WK_API_ENABLED
125     return (__bridge WKPreferencesRef)globalWebViewConfiguration.preferences;
126 #else
127     return nullptr;
128 #endif
129 }
130
131 void TestController::platformAddTestOptions(TestOptions& options) const
132 {
133     if ([[NSUserDefaults standardUserDefaults] boolForKey:@"EnableProcessSwapOnNavigation"])
134         options.enableProcessSwapOnNavigation = true;
135     if ([[NSUserDefaults standardUserDefaults] boolForKey:@"EnableProcessSwapOnWindowOpen"])
136         options.enableProcessSwapOnWindowOpen = true;
137 }
138
139 void TestController::platformCreateWebView(WKPageConfigurationRef, const TestOptions& options)
140 {
141 #if WK_API_ENABLED
142     RetainPtr<WKWebViewConfiguration> copiedConfiguration = adoptNS([globalWebViewConfiguration copy]);
143
144 #if PLATFORM(IOS_FAMILY)
145     if (options.useDataDetection)
146         [copiedConfiguration setDataDetectorTypes:WKDataDetectorTypeAll];
147     if (options.ignoresViewportScaleLimits)
148         [copiedConfiguration setIgnoresViewportScaleLimits:YES];
149     if (options.useCharacterSelectionGranularity)
150         [copiedConfiguration setSelectionGranularity:WKSelectionGranularityCharacter];
151     if (options.useCharacterSelectionGranularity)
152         [copiedConfiguration setSelectionGranularity:WKSelectionGranularityCharacter];
153 #endif
154
155     if (options.enableAttachmentElement)
156         [copiedConfiguration _setAttachmentElementEnabled:YES];
157
158     if (options.enableColorFilter)
159         [copiedConfiguration _setColorFilterEnabled:YES];
160
161     if (options.enableEditableImages)
162         [copiedConfiguration _setEditableImagesEnabled:YES];
163
164     if (options.applicationManifest.length()) {
165         auto manifestPath = [NSString stringWithUTF8String:options.applicationManifest.c_str()];
166         NSString *text = [NSString stringWithContentsOfFile:manifestPath usedEncoding:nullptr error:nullptr];
167         [copiedConfiguration _setApplicationManifest:[_WKApplicationManifest applicationManifestFromJSON:text manifestURL:nil documentURL:nil]];
168     }
169
170     m_mainWebView = std::make_unique<PlatformWebView>(copiedConfiguration.get(), options);
171
172     if (options.punchOutWhiteBackgroundsInDarkMode)
173         m_mainWebView->setDrawsBackground(false);
174
175     if (options.editable)
176         m_mainWebView->setEditable(true);
177 #else
178     m_mainWebView = std::make_unique<PlatformWebView>(globalWebViewConfiguration, options);
179 #endif
180 }
181
182 PlatformWebView* TestController::platformCreateOtherPage(PlatformWebView* parentView, WKPageConfigurationRef, const TestOptions& options)
183 {
184 #if WK_API_ENABLED
185     WKWebViewConfiguration *newConfiguration = [[globalWebViewConfiguration copy] autorelease];
186     newConfiguration._relatedWebView = static_cast<WKWebView*>(parentView->platformView());
187     return new PlatformWebView(newConfiguration, options);
188 #else
189     return nullptr;
190 #endif
191 }
192
193 WKContextRef TestController::platformAdjustContext(WKContextRef context, WKContextConfigurationRef contextConfiguration)
194 {
195 #if WK_API_ENABLED
196     initializeWebViewConfiguration(libraryPathForTesting(), injectedBundlePath(), context, contextConfiguration);
197     return (__bridge WKContextRef)globalWebViewConfiguration.processPool;
198 #else
199     return nullptr;
200 #endif
201 }
202
203 void TestController::platformRunUntil(bool& done, WTF::Seconds timeout)
204 {
205     NSDate *endDate = (timeout > 0_s) ? [NSDate dateWithTimeIntervalSinceNow:timeout.seconds()] : [NSDate distantFuture];
206
207     while (!done && [endDate compare:[NSDate date]] == NSOrderedDescending)
208         [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:endDate];
209 }
210
211 static NSCalendar *swizzledCalendar()
212 {
213     return [NSCalendar calendarWithIdentifier:TestController::singleton().getOverriddenCalendarIdentifier().get()];
214 }
215     
216 RetainPtr<NSString> TestController::getOverriddenCalendarIdentifier() const
217 {
218     return m_overriddenCalendarIdentifier;
219 }
220
221 void TestController::setDefaultCalendarType(NSString *identifier)
222 {
223     m_overriddenCalendarIdentifier = identifier;
224     if (!m_calendarSwizzler)
225         m_calendarSwizzler = std::make_unique<ClassMethodSwizzler>([NSCalendar class], @selector(currentCalendar), reinterpret_cast<IMP>(swizzledCalendar));
226 }
227     
228 void TestController::cocoaResetStateToConsistentValues(const TestOptions& options)
229 {
230 #if WK_API_ENABLED
231     __block bool doneRemoving = false;
232     [[_WKUserContentExtensionStore defaultStore] removeContentExtensionForIdentifier:@"TestContentExtensions" completionHandler:^(NSError *error) {
233         doneRemoving = true;
234     }];
235     platformRunUntil(doneRemoving, noTimeout);
236     [[_WKUserContentExtensionStore defaultStore] _removeAllContentExtensions];
237
238
239     m_calendarSwizzler = nullptr;
240     m_overriddenCalendarIdentifier = nil;
241     
242     if (auto* webView = mainWebView()) {
243         TestRunnerWKWebView *platformView = webView->platformView();
244         [platformView.configuration.userContentController _removeAllUserContentFilters];
245         platformView._viewScale = 1;
246         platformView._minimumEffectiveDeviceWidth = 0;
247
248         // Toggle on before the test, and toggle off after the test.
249         if (options.shouldShowSpellCheckingDots)
250             [platformView toggleContinuousSpellChecking:nil];
251     }
252 #endif
253 }
254
255 void TestController::platformWillRunTest(const TestInvocation& testInvocation)
256 {
257     setCrashReportApplicationSpecificInformationToURL(testInvocation.url());
258 }
259
260 static NSString * const WebArchivePboardType = @"Apple Web Archive pasteboard type";
261 static NSString * const WebSubresourcesKey = @"WebSubresources";
262 static NSString * const WebSubframeArchivesKey = @"WebResourceMIMEType like 'image*'";
263
264 unsigned TestController::imageCountInGeneralPasteboard() const
265 {
266 #if PLATFORM(MAC)
267     NSData *data = [[NSPasteboard generalPasteboard] dataForType:WebArchivePboardType];
268 #elif PLATFORM(IOS_FAMILY)
269     NSData *data = [[UIPasteboard generalPasteboard] valueForPasteboardType:WebArchivePboardType];
270 #endif
271     if (!data)
272         return 0;
273     
274     NSError *error = nil;
275     id webArchive = [NSPropertyListSerialization propertyListWithData:data options:NSPropertyListImmutable format:NULL error:&error];
276     if (error) {
277         NSLog(@"Encountered error while serializing Web Archive pasteboard data: %@", error);
278         return 0;
279     }
280     
281     NSArray *subItems = [NSArray arrayWithArray:[webArchive objectForKey:WebSubresourcesKey]];
282     NSPredicate *predicate = [NSPredicate predicateWithFormat:WebSubframeArchivesKey];
283     NSArray *imagesArray = [subItems filteredArrayUsingPredicate:predicate];
284     
285     if (!imagesArray)
286         return 0;
287     
288     return imagesArray.count;
289 }
290
291 void TestController::removeAllSessionCredentials()
292 {
293 #if WK_API_ENABLED
294     auto types = adoptNS([[NSSet alloc] initWithObjects:_WKWebsiteDataTypeCredentials, nil]);
295     [globalWebViewConfiguration.websiteDataStore removeDataOfTypes:types.get() modifiedSince:[NSDate distantPast] completionHandler:^() {
296         m_currentInvocation->didRemoveAllSessionCredentials();
297     }];
298 #endif
299 }
300
301 void TestController::getAllStorageAccessEntries()
302 {
303 #if WK_API_ENABLED
304     auto* parentView = mainWebView();
305     if (!parentView)
306         return;
307
308     [globalWebViewConfiguration.websiteDataStore _getAllStorageAccessEntriesFor:parentView->platformView() completionHandler:^(NSArray<NSString *> *nsDomains) {
309         Vector<String> domains;
310         domains.reserveInitialCapacity(nsDomains.count);
311         for (NSString *domain : nsDomains)
312             domains.uncheckedAppend(domain);
313         m_currentInvocation->didReceiveAllStorageAccessEntries(domains);
314     }];
315 #endif
316 }
317
318 void TestController::injectUserScript(WKStringRef script)
319 {
320 #if WK_API_ENABLED
321     auto userScript = adoptNS([[WKUserScript alloc] initWithSource: toWTFString(script) injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:NO]);
322
323     [[globalWebViewConfiguration userContentController] addUserScript: userScript.get()];
324 #endif
325 }
326
327 void TestController::addTestKeyToKeychain(const String& privateKeyBase64, const String& attrLabel, const String& applicationTagBase64)
328 {
329     // FIXME(182772)
330 #if PLATFORM(IOS_FAMILY)
331     NSDictionary* options = @{
332         (id)kSecAttrKeyType: (id)kSecAttrKeyTypeECSECPrimeRandom,
333         (id)kSecAttrKeyClass: (id)kSecAttrKeyClassPrivate,
334         (id)kSecAttrKeySizeInBits: @256
335     };
336     CFErrorRef errorRef = nullptr;
337     auto key = adoptCF(SecKeyCreateWithData(
338         (__bridge CFDataRef)adoptNS([[NSData alloc] initWithBase64EncodedString:privateKeyBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get(),
339         (__bridge CFDictionaryRef)options,
340         &errorRef
341     ));
342     ASSERT(!errorRef);
343
344     NSDictionary* addQuery = @{
345         (id)kSecValueRef: (id)key.get(),
346         (id)kSecClass: (id)kSecClassKey,
347         (id)kSecAttrLabel: attrLabel,
348         (id)kSecAttrApplicationTag: adoptNS([[NSData alloc] initWithBase64EncodedString:applicationTagBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get()
349     };
350     OSStatus status = SecItemAdd((__bridge CFDictionaryRef)addQuery, NULL);
351     ASSERT_UNUSED(status, !status);
352 #endif
353 }
354
355 void TestController::cleanUpKeychain(const String& attrLabel)
356 {
357     // FIXME(182772)
358 #if PLATFORM(IOS_FAMILY)
359     NSDictionary* deleteQuery = @{
360         (id)kSecClass: (id)kSecClassKey,
361         (id)kSecAttrLabel: attrLabel
362     };
363     SecItemDelete((__bridge CFDictionaryRef)deleteQuery);
364 #endif
365 }
366
367 bool TestController::keyExistsInKeychain(const String& attrLabel, const String& applicationTagBase64)
368 {
369     // FIXME(182772)
370 #if PLATFORM(IOS_FAMILY)
371     NSDictionary *query = @{
372         (id)kSecClass: (id)kSecClassKey,
373         (id)kSecAttrKeyClass: (id)kSecAttrKeyClassPrivate,
374         (id)kSecAttrLabel: attrLabel,
375         (id)kSecAttrApplicationTag: adoptNS([[NSData alloc] initWithBase64EncodedString:applicationTagBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get(),
376     };
377     OSStatus status = SecItemCopyMatching((__bridge CFDictionaryRef)query, NULL);
378     if (!status)
379         return true;
380     ASSERT(status == errSecItemNotFound);
381 #endif
382     return false;
383 }
384
385 } // namespace WTR