6bc46870b654f00e05210ba4b4927a819cdb4171
[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 <WebKit/WKContextConfigurationRef.h>
36 #import <WebKit/WKCookieManager.h>
37 #import <WebKit/WKPreferencesRefPrivate.h>
38 #import <WebKit/WKProcessPoolPrivate.h>
39 #import <WebKit/WKStringCF.h>
40 #import <WebKit/WKUserContentControllerPrivate.h>
41 #import <WebKit/WKWebView.h>
42 #import <WebKit/WKWebViewConfiguration.h>
43 #import <WebKit/WKWebViewConfigurationPrivate.h>
44 #import <WebKit/WKWebViewPrivate.h>
45 #import <WebKit/WKWebsiteDataRecordPrivate.h>
46 #import <WebKit/WKWebsiteDataStorePrivate.h>
47 #import <WebKit/WKWebsiteDataStoreRef.h>
48 #import <WebKit/_WKApplicationManifest.h>
49 #import <WebKit/_WKProcessPoolConfiguration.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 #if (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101300) || PLATFORM(IOS)
70     WKCookieManagerSetCookieStoragePartitioningEnabled(WKContextGetCookieManager(context), true);
71     WKCookieManagerSetStorageAccessAPIEnabled(WKContextGetCookieManager(context), true);
72 #endif
73
74     WKWebsiteDataStore* poolWebsiteDataStore = (__bridge WKWebsiteDataStore *)WKContextGetWebsiteDataStore((__bridge WKContextRef)globalWebViewConfiguration.processPool);
75     [poolWebsiteDataStore _setCacheStoragePerOriginQuota: 400 * 1024];
76     if (libraryPath) {
77         String cacheStorageDirectory = String(libraryPath) + '/' + "CacheStorage";
78         [poolWebsiteDataStore _setCacheStorageDirectory: cacheStorageDirectory];
79
80         String serviceWorkerRegistrationDirectory = String(libraryPath) + '/' + "ServiceWorkers";
81         [poolWebsiteDataStore _setServiceWorkerRegistrationDirectory: serviceWorkerRegistrationDirectory];
82     }
83
84     [globalWebViewConfiguration.websiteDataStore _setResourceLoadStatisticsEnabled:YES];
85     [globalWebViewConfiguration.websiteDataStore _resourceLoadStatisticsSetShouldSubmitTelemetry:NO];
86
87 #if PLATFORM(IOS)
88     globalWebViewConfiguration.allowsInlineMediaPlayback = YES;
89     globalWebViewConfiguration._inlineMediaPlaybackRequiresPlaysInlineAttribute = NO;
90     globalWebViewConfiguration._invisibleAutoplayNotPermitted = NO;
91     globalWebViewConfiguration._mediaDataLoadsAutomatically = YES;
92     globalWebViewConfiguration.requiresUserActionForMediaPlayback = NO;
93 #endif
94     globalWebViewConfiguration.mediaTypesRequiringUserActionForPlayback = WKAudiovisualMediaTypeNone;
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::platformCreateWebView(WKPageConfigurationRef, const TestOptions& options)
132 {
133 #if WK_API_ENABLED
134     RetainPtr<WKWebViewConfiguration> copiedConfiguration = adoptNS([globalWebViewConfiguration copy]);
135
136 #if PLATFORM(IOS)
137     if (options.useDataDetection)
138         [copiedConfiguration setDataDetectorTypes:WKDataDetectorTypeAll];
139     if (options.ignoresViewportScaleLimits)
140         [copiedConfiguration setIgnoresViewportScaleLimits:YES];
141     if (options.useCharacterSelectionGranularity)
142         [copiedConfiguration setSelectionGranularity:WKSelectionGranularityCharacter];
143     if (options.useCharacterSelectionGranularity)
144         [copiedConfiguration setSelectionGranularity:WKSelectionGranularityCharacter];
145 #endif
146
147     if (options.enableAttachmentElement)
148         [copiedConfiguration _setAttachmentElementEnabled: YES];
149
150     if (options.enableColorFilter)
151         [copiedConfiguration _setColorFilterEnabled: YES];
152
153     if (options.applicationManifest.length()) {
154         auto manifestPath = [NSString stringWithUTF8String:options.applicationManifest.c_str()];
155         NSString *text = [NSString stringWithContentsOfFile:manifestPath usedEncoding:nullptr error:nullptr];
156         [copiedConfiguration _setApplicationManifest:[_WKApplicationManifest applicationManifestFromJSON:text manifestURL:nil documentURL:nil]];
157     }
158
159     m_mainWebView = std::make_unique<PlatformWebView>(copiedConfiguration.get(), options);
160 #else
161     m_mainWebView = std::make_unique<PlatformWebView>(globalWebViewConfiguration, options);
162 #endif
163 }
164
165 PlatformWebView* TestController::platformCreateOtherPage(PlatformWebView* parentView, WKPageConfigurationRef, const TestOptions& options)
166 {
167 #if WK_API_ENABLED
168     WKWebViewConfiguration *newConfiguration = [[globalWebViewConfiguration copy] autorelease];
169     newConfiguration._relatedWebView = static_cast<WKWebView*>(parentView->platformView());
170     return new PlatformWebView(newConfiguration, options);
171 #else
172     return nullptr;
173 #endif
174 }
175
176 WKContextRef TestController::platformAdjustContext(WKContextRef context, WKContextConfigurationRef contextConfiguration)
177 {
178 #if WK_API_ENABLED
179     initializeWebViewConfiguration(libraryPathForTesting(), injectedBundlePath(), context, contextConfiguration);
180     return (__bridge WKContextRef)globalWebViewConfiguration.processPool;
181 #else
182     return nullptr;
183 #endif
184 }
185
186 void TestController::platformRunUntil(bool& done, double timeout)
187 {
188     NSDate *endDate = (timeout > 0) ? [NSDate dateWithTimeIntervalSinceNow:timeout] : [NSDate distantFuture];
189
190     while (!done && [endDate compare:[NSDate date]] == NSOrderedDescending)
191         [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:endDate];
192 }
193
194 void TestController::cocoaResetStateToConsistentValues()
195 {
196 #if WK_API_ENABLED
197     __block bool doneRemoving = false;
198     [[_WKUserContentExtensionStore defaultStore] removeContentExtensionForIdentifier:@"TestContentExtensions" completionHandler:^(NSError *error) {
199         doneRemoving = true;
200     }];
201     platformRunUntil(doneRemoving, noTimeout);
202     [[_WKUserContentExtensionStore defaultStore] _removeAllContentExtensions];
203
204     if (PlatformWebView* webView = mainWebView())
205         [webView->platformView().configuration.userContentController _removeAllUserContentFilters];
206 #endif
207 }
208
209 void TestController::platformWillRunTest(const TestInvocation& testInvocation)
210 {
211     setCrashReportApplicationSpecificInformationToURL(testInvocation.url());
212 }
213
214 static NSString * const WebArchivePboardType = @"Apple Web Archive pasteboard type";
215 static NSString * const WebSubresourcesKey = @"WebSubresources";
216 static NSString * const WebSubframeArchivesKey = @"WebResourceMIMEType like 'image*'";
217
218 unsigned TestController::imageCountInGeneralPasteboard() const
219 {
220 #if PLATFORM(MAC)
221     NSData *data = [[NSPasteboard generalPasteboard] dataForType:WebArchivePboardType];
222 #elif PLATFORM(IOS)
223     NSData *data = [[UIPasteboard generalPasteboard] valueForPasteboardType:WebArchivePboardType];
224 #endif
225     if (!data)
226         return 0;
227     
228     NSError *error = nil;
229     id webArchive = [NSPropertyListSerialization propertyListWithData:data options:NSPropertyListImmutable format:NULL error:&error];
230     if (error) {
231         NSLog(@"Encountered error while serializing Web Archive pasteboard data: %@", error);
232         return 0;
233     }
234     
235     NSArray *subItems = [NSArray arrayWithArray:[webArchive objectForKey:WebSubresourcesKey]];
236     NSPredicate *predicate = [NSPredicate predicateWithFormat:WebSubframeArchivesKey];
237     NSArray *imagesArray = [subItems filteredArrayUsingPredicate:predicate];
238     
239     if (!imagesArray)
240         return 0;
241     
242     return imagesArray.count;
243 }
244
245 void TestController::removeAllSessionCredentials()
246 {
247 #if WK_API_ENABLED
248     auto types = adoptNS([[NSSet alloc] initWithObjects:_WKWebsiteDataTypeCredentials, nil]);
249     [globalWebViewConfiguration.websiteDataStore removeDataOfTypes:types.get() modifiedSince:[NSDate distantPast] completionHandler:^() {
250         m_currentInvocation->didRemoveAllSessionCredentials();
251     }];
252 #endif
253 }
254
255 void TestController::getAllStorageAccessEntries()
256 {
257 #if WK_API_ENABLED
258     [globalWebViewConfiguration.websiteDataStore _getAllStorageAccessEntries:^(NSArray<NSString *> *nsDomains) {
259         Vector<String> domains;
260         domains.reserveInitialCapacity(nsDomains.count);
261         for (NSString *domain : nsDomains)
262             domains.uncheckedAppend(domain);
263         m_currentInvocation->didReceiveAllStorageAccessEntries(domains);
264     }];
265 #endif
266 }
267
268 } // namespace WTR