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