Add SPI for reloading without content blockers
[WebKit-https.git] / Tools / WebKitTestRunner / cocoa / TestControllerCocoa.mm
1 /*
2  * Copyright (C) 2015 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 "TestInvocation.h"
32 #import "TestRunnerWKWebView.h"
33 #import <Foundation/Foundation.h>
34 #import <WebKit/WKContextConfigurationRef.h>
35 #import <WebKit/WKPreferencesRefPrivate.h>
36 #import <WebKit/WKProcessPoolPrivate.h>
37 #import <WebKit/WKStringCF.h>
38 #import <WebKit/WKUserContentControllerPrivate.h>
39 #import <WebKit/WKWebView.h>
40 #import <WebKit/WKWebViewConfiguration.h>
41 #import <WebKit/WKWebViewConfigurationPrivate.h>
42 #import <WebKit/WKWebViewPrivate.h>
43 #import <WebKit/_WKProcessPoolConfiguration.h>
44 #import <WebKit/_WKUserContentExtensionStore.h>
45 #import <WebKit/_WKUserContentExtensionStorePrivate.h>
46 #import <wtf/MainThread.h>
47
48 namespace WTR {
49
50 static WKWebViewConfiguration *globalWebViewConfiguration;
51
52 void initializeWebViewConfiguration(const char* libraryPath, WKStringRef injectedBundlePath, WKContextRef context, WKContextConfigurationRef contextConfiguration)
53 {
54 #if WK_API_ENABLED
55     [globalWebViewConfiguration release];
56     globalWebViewConfiguration = [[WKWebViewConfiguration alloc] init];
57
58     globalWebViewConfiguration.processPool = WTF::adoptNS([[WKProcessPool alloc] _initWithConfiguration:(_WKProcessPoolConfiguration *)contextConfiguration]).get();
59     globalWebViewConfiguration.websiteDataStore = (WKWebsiteDataStore *)WKContextGetWebsiteDataStore(context);
60
61 #if TARGET_OS_IPHONE
62     globalWebViewConfiguration.allowsInlineMediaPlayback = YES;
63     globalWebViewConfiguration._inlineMediaPlaybackRequiresPlaysInlineAttribute = NO;
64     globalWebViewConfiguration._mediaDataLoadsAutomatically = YES;
65     globalWebViewConfiguration.requiresUserActionForMediaPlayback = NO;
66 #endif
67 #endif
68 }
69
70 WKPreferencesRef TestController::platformPreferences()
71 {
72 #if WK_API_ENABLED
73     return (WKPreferencesRef)globalWebViewConfiguration.preferences;
74 #else
75     return nullptr;
76 #endif
77 }
78
79 void TestController::platformCreateWebView(WKPageConfigurationRef, const TestOptions& options)
80 {
81     m_mainWebView = std::make_unique<PlatformWebView>(globalWebViewConfiguration, options);
82 }
83
84 PlatformWebView* TestController::platformCreateOtherPage(PlatformWebView* parentView, WKPageConfigurationRef, const TestOptions& options)
85 {
86 #if WK_API_ENABLED
87     WKWebViewConfiguration *newConfiguration = [[globalWebViewConfiguration copy] autorelease];
88     newConfiguration._relatedWebView = static_cast<WKWebView*>(parentView->platformView());
89     return new PlatformWebView(newConfiguration, options);
90 #else
91     return nullptr;
92 #endif
93 }
94
95 WKContextRef TestController::platformAdjustContext(WKContextRef context, WKContextConfigurationRef contextConfiguration)
96 {
97 #if WK_API_ENABLED
98     initializeWebViewConfiguration(libraryPathForTesting(), injectedBundlePath(), context, contextConfiguration);
99     return (WKContextRef)globalWebViewConfiguration.processPool;
100 #else
101     return nullptr;
102 #endif
103 }
104
105 void TestController::platformRunUntil(bool& done, double timeout)
106 {
107     NSDate *endDate = (timeout > 0) ? [NSDate dateWithTimeIntervalSinceNow:timeout] : [NSDate distantFuture];
108
109     while (!done && [endDate compare:[NSDate date]] == NSOrderedDescending)
110         [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:endDate];
111 }
112
113 void TestController::cocoaResetStateToConsistentValues()
114 {
115 #if WK_API_ENABLED
116     __block bool doneRemoving = false;
117     [[_WKUserContentExtensionStore defaultStore] removeContentExtensionForIdentifier:@"TestContentExtensions" completionHandler:^(NSError *error) {
118         doneRemoving = true;
119     }];
120     platformRunUntil(doneRemoving, 0);
121     [[_WKUserContentExtensionStore defaultStore] _removeAllContentExtensions];
122
123     if (PlatformWebView* webView = mainWebView())
124         [webView->platformView().configuration.userContentController _removeAllUserContentFilters];
125 #endif
126 }
127
128 void TestController::platformWillRunTest(const TestInvocation& testInvocation)
129 {
130     setCrashReportApplicationSpecificInformationToURL(testInvocation.url());
131 }
132
133 } // namespace WTR