Allow WebKit clients to specify a minimum effective width for layout.
[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 #else
175     m_mainWebView = std::make_unique<PlatformWebView>(globalWebViewConfiguration, options);
176 #endif
177 }
178
179 PlatformWebView* TestController::platformCreateOtherPage(PlatformWebView* parentView, WKPageConfigurationRef, const TestOptions& options)
180 {
181 #if WK_API_ENABLED
182     WKWebViewConfiguration *newConfiguration = [[globalWebViewConfiguration copy] autorelease];
183     newConfiguration._relatedWebView = static_cast<WKWebView*>(parentView->platformView());
184     return new PlatformWebView(newConfiguration, options);
185 #else
186     return nullptr;
187 #endif
188 }
189
190 WKContextRef TestController::platformAdjustContext(WKContextRef context, WKContextConfigurationRef contextConfiguration)
191 {
192 #if WK_API_ENABLED
193     initializeWebViewConfiguration(libraryPathForTesting(), injectedBundlePath(), context, contextConfiguration);
194     return (__bridge WKContextRef)globalWebViewConfiguration.processPool;
195 #else
196     return nullptr;
197 #endif
198 }
199
200 void TestController::platformRunUntil(bool& done, WTF::Seconds timeout)
201 {
202     NSDate *endDate = (timeout > 0_s) ? [NSDate dateWithTimeIntervalSinceNow:timeout.seconds()] : [NSDate distantFuture];
203
204     while (!done && [endDate compare:[NSDate date]] == NSOrderedDescending)
205         [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:endDate];
206 }
207
208 ClassMethodSwizzler::ClassMethodSwizzler(Class cls, SEL originalSelector, IMP implementation)
209     : m_method(class_getClassMethod(objc_getMetaClass(NSStringFromClass(cls).UTF8String), originalSelector))
210     , m_originalImplementation(method_setImplementation(m_method, implementation))
211 {
212 }
213
214 ClassMethodSwizzler::~ClassMethodSwizzler()
215 {
216     method_setImplementation(m_method, m_originalImplementation);
217 }
218     
219 static NSCalendar *swizzledCalendar()
220 {
221     return [NSCalendar calendarWithIdentifier:TestController::singleton().getOverriddenCalendarIdentifier().get()];
222 }
223     
224 RetainPtr<NSString> TestController::getOverriddenCalendarIdentifier() const
225 {
226     return m_overriddenCalendarIdentifier;
227 }
228
229 void TestController::setDefaultCalendarType(NSString *identifier)
230 {
231     m_overriddenCalendarIdentifier = identifier;
232     if (!m_calendarSwizzler)
233         m_calendarSwizzler = std::make_unique<ClassMethodSwizzler>([NSCalendar class], @selector(currentCalendar), reinterpret_cast<IMP>(swizzledCalendar));
234 }
235     
236 void TestController::cocoaResetStateToConsistentValues(const TestOptions& options)
237 {
238 #if WK_API_ENABLED
239     __block bool doneRemoving = false;
240     [[_WKUserContentExtensionStore defaultStore] removeContentExtensionForIdentifier:@"TestContentExtensions" completionHandler:^(NSError *error) {
241         doneRemoving = true;
242     }];
243     platformRunUntil(doneRemoving, noTimeout);
244     [[_WKUserContentExtensionStore defaultStore] _removeAllContentExtensions];
245
246
247     m_calendarSwizzler = nullptr;
248     m_overriddenCalendarIdentifier = nil;
249     
250     if (auto* webView = mainWebView()) {
251         TestRunnerWKWebView *platformView = webView->platformView();
252         [platformView.configuration.userContentController _removeAllUserContentFilters];
253         platformView._viewScale = 1;
254         platformView._minimumEffectiveDeviceWidth = 0;
255
256         // Toggle on before the test, and toggle off after the test.
257         if (options.shouldShowSpellCheckingDots)
258             [platformView toggleContinuousSpellChecking:nil];
259     }
260 #endif
261 }
262
263 void TestController::platformWillRunTest(const TestInvocation& testInvocation)
264 {
265     setCrashReportApplicationSpecificInformationToURL(testInvocation.url());
266 }
267
268 static NSString * const WebArchivePboardType = @"Apple Web Archive pasteboard type";
269 static NSString * const WebSubresourcesKey = @"WebSubresources";
270 static NSString * const WebSubframeArchivesKey = @"WebResourceMIMEType like 'image*'";
271
272 unsigned TestController::imageCountInGeneralPasteboard() const
273 {
274 #if PLATFORM(MAC)
275     NSData *data = [[NSPasteboard generalPasteboard] dataForType:WebArchivePboardType];
276 #elif PLATFORM(IOS_FAMILY)
277     NSData *data = [[UIPasteboard generalPasteboard] valueForPasteboardType:WebArchivePboardType];
278 #endif
279     if (!data)
280         return 0;
281     
282     NSError *error = nil;
283     id webArchive = [NSPropertyListSerialization propertyListWithData:data options:NSPropertyListImmutable format:NULL error:&error];
284     if (error) {
285         NSLog(@"Encountered error while serializing Web Archive pasteboard data: %@", error);
286         return 0;
287     }
288     
289     NSArray *subItems = [NSArray arrayWithArray:[webArchive objectForKey:WebSubresourcesKey]];
290     NSPredicate *predicate = [NSPredicate predicateWithFormat:WebSubframeArchivesKey];
291     NSArray *imagesArray = [subItems filteredArrayUsingPredicate:predicate];
292     
293     if (!imagesArray)
294         return 0;
295     
296     return imagesArray.count;
297 }
298
299 void TestController::removeAllSessionCredentials()
300 {
301 #if WK_API_ENABLED
302     auto types = adoptNS([[NSSet alloc] initWithObjects:_WKWebsiteDataTypeCredentials, nil]);
303     [globalWebViewConfiguration.websiteDataStore removeDataOfTypes:types.get() modifiedSince:[NSDate distantPast] completionHandler:^() {
304         m_currentInvocation->didRemoveAllSessionCredentials();
305     }];
306 #endif
307 }
308
309 void TestController::getAllStorageAccessEntries()
310 {
311 #if WK_API_ENABLED
312     auto* parentView = mainWebView();
313     if (!parentView)
314         return;
315
316     [globalWebViewConfiguration.websiteDataStore _getAllStorageAccessEntriesFor:parentView->platformView() completionHandler:^(NSArray<NSString *> *nsDomains) {
317         Vector<String> domains;
318         domains.reserveInitialCapacity(nsDomains.count);
319         for (NSString *domain : nsDomains)
320             domains.uncheckedAppend(domain);
321         m_currentInvocation->didReceiveAllStorageAccessEntries(domains);
322     }];
323 #endif
324 }
325
326 void TestController::injectUserScript(WKStringRef script)
327 {
328 #if WK_API_ENABLED
329     auto userScript = adoptNS([[WKUserScript alloc] initWithSource: toWTFString(script) injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:NO]);
330
331     [[globalWebViewConfiguration userContentController] addUserScript: userScript.get()];
332 #endif
333 }
334
335 void TestController::addTestKeyToKeychain(const String& privateKeyBase64, const String& attrLabel, const String& applicationTagBase64)
336 {
337     // FIXME(182772)
338 #if PLATFORM(IOS_FAMILY)
339     NSDictionary* options = @{
340         (id)kSecAttrKeyType: (id)kSecAttrKeyTypeECSECPrimeRandom,
341         (id)kSecAttrKeyClass: (id)kSecAttrKeyClassPrivate,
342         (id)kSecAttrKeySizeInBits: @256
343     };
344     CFErrorRef errorRef = nullptr;
345     auto key = adoptCF(SecKeyCreateWithData(
346         (__bridge CFDataRef)adoptNS([[NSData alloc] initWithBase64EncodedString:privateKeyBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get(),
347         (__bridge CFDictionaryRef)options,
348         &errorRef
349     ));
350     ASSERT(!errorRef);
351
352     NSDictionary* addQuery = @{
353         (id)kSecValueRef: (id)key.get(),
354         (id)kSecClass: (id)kSecClassKey,
355         (id)kSecAttrLabel: attrLabel,
356         (id)kSecAttrApplicationTag: adoptNS([[NSData alloc] initWithBase64EncodedString:applicationTagBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get()
357     };
358     OSStatus status = SecItemAdd((__bridge CFDictionaryRef)addQuery, NULL);
359     ASSERT_UNUSED(status, !status);
360 #endif
361 }
362
363 void TestController::cleanUpKeychain(const String& attrLabel)
364 {
365     // FIXME(182772)
366 #if PLATFORM(IOS_FAMILY)
367     NSDictionary* deleteQuery = @{
368         (id)kSecClass: (id)kSecClassKey,
369         (id)kSecAttrLabel: attrLabel
370     };
371     SecItemDelete((__bridge CFDictionaryRef)deleteQuery);
372 #endif
373 }
374
375 bool TestController::keyExistsInKeychain(const String& attrLabel, const String& applicationTagBase64)
376 {
377     // FIXME(182772)
378 #if PLATFORM(IOS_FAMILY)
379     NSDictionary *query = @{
380         (id)kSecClass: (id)kSecClassKey,
381         (id)kSecAttrKeyClass: (id)kSecAttrKeyClassPrivate,
382         (id)kSecAttrLabel: attrLabel,
383         (id)kSecAttrApplicationTag: adoptNS([[NSData alloc] initWithBase64EncodedString:applicationTagBase64 options:NSDataBase64DecodingIgnoreUnknownCharacters]).get(),
384     };
385     OSStatus status = SecItemCopyMatching((__bridge CFDictionaryRef)query, NULL);
386     if (!status)
387         return true;
388     ASSERT(status == errSecItemNotFound);
389 #endif
390     return false;
391 }
392
393 } // namespace WTR