05a4efbf90e5cce9dc404e841c700612278a60e5
[WebKit-https.git] / Tools / WebKitTestRunner / TestOptions.h
1 /*
2  * Copyright (C) 2015-2018 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 #pragma once
27
28 #include <wtf/HashMap.h>
29 #include <wtf/Vector.h>
30 #include <wtf/text/StringHash.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace WTR {
34
35 struct TestOptions {
36     bool useThreadedScrolling { false };
37     bool useAcceleratedDrawing { false };
38     bool useRemoteLayerTree { false };
39     bool shouldShowWebView { false };
40     bool useFlexibleViewport { false };
41     bool useFixedLayout { false };
42     bool isSVGTest { false };
43     bool useDataDetection { false };
44     bool useMockScrollbars { true };
45     bool needsSiteSpecificQuirks { false };
46     bool ignoresViewportScaleLimits { false };
47     bool useCharacterSelectionGranularity { false };
48     bool enableAttachmentElement { false };
49     bool enableIntersectionObserver { false };
50     bool enableMenuItemElement { false };
51     bool enableModernMediaControls { true };
52     bool enablePointerLock { false };
53     bool enableWebAuthentication { true };
54     bool enableWebAuthenticationLocalAuthenticator { true };
55     bool enableIsSecureContextAttribute { true };
56     bool enableInspectorAdditions { false };
57     bool shouldShowTouches { false };
58     bool dumpJSConsoleLogInStdErr { false };
59     bool allowCrossOriginSubresourcesToAskForCredentials { false };
60     bool enableProcessSwapOnNavigation { true };
61     bool enableProcessSwapOnWindowOpen { false };
62     bool enableColorFilter { false };
63     bool punchOutWhiteBackgroundsInDarkMode { false };
64     bool runSingly { false };
65     bool checkForWorldLeaks { false };
66     bool shouldIgnoreMetaViewport { false };
67     bool shouldShowSpellCheckingDots { false };
68     bool enableEditableImages { false };
69     bool editable { false };
70
71     float deviceScaleFactor { 1 };
72     Vector<String> overrideLanguages;
73     std::string applicationManifest;
74     std::string jscOptions;
75     HashMap<String, bool> experimentalFeatures;
76     HashMap<String, bool> internalDebugFeatures;
77
78     TestOptions(const std::string& pathOrURL);
79
80     // Add here options that can only be set upon PlatformWebView
81     // initialization and make sure it's up to date when adding new
82     // options to this struct. Otherwise, tests using those options
83     // might fail if WTR is reusing an existing PlatformWebView.
84     bool hasSameInitializationOptions(const TestOptions& options) const
85     {
86         if (useThreadedScrolling != options.useThreadedScrolling
87             || useAcceleratedDrawing != options.useAcceleratedDrawing
88             || overrideLanguages != options.overrideLanguages
89             || useMockScrollbars != options.useMockScrollbars
90             || needsSiteSpecificQuirks != options.needsSiteSpecificQuirks
91             || useCharacterSelectionGranularity != options.useCharacterSelectionGranularity
92             || enableAttachmentElement != options.enableAttachmentElement
93             || enableIntersectionObserver != options.enableIntersectionObserver
94             || enableMenuItemElement != options.enableMenuItemElement
95             || enableModernMediaControls != options.enableModernMediaControls
96             || enablePointerLock != options.enablePointerLock
97             || enableWebAuthentication != options.enableWebAuthentication
98             || enableWebAuthenticationLocalAuthenticator != options.enableWebAuthenticationLocalAuthenticator
99             || enableIsSecureContextAttribute != options.enableIsSecureContextAttribute
100             || enableInspectorAdditions != options.enableInspectorAdditions
101             || dumpJSConsoleLogInStdErr != options.dumpJSConsoleLogInStdErr
102             || applicationManifest != options.applicationManifest
103             || allowCrossOriginSubresourcesToAskForCredentials != options.allowCrossOriginSubresourcesToAskForCredentials
104             || enableProcessSwapOnNavigation != options.enableProcessSwapOnNavigation
105             || enableProcessSwapOnWindowOpen != options.enableProcessSwapOnWindowOpen
106             || enableColorFilter != options.enableColorFilter
107             || punchOutWhiteBackgroundsInDarkMode != options.punchOutWhiteBackgroundsInDarkMode
108             || jscOptions != options.jscOptions
109             || runSingly != options.runSingly
110             || checkForWorldLeaks != options.checkForWorldLeaks
111             || shouldShowSpellCheckingDots != options.shouldShowSpellCheckingDots
112             || shouldIgnoreMetaViewport != options.shouldIgnoreMetaViewport
113             || enableEditableImages != options.enableEditableImages
114             || editable != options.editable)
115             return false;
116
117         if (experimentalFeatures != options.experimentalFeatures)
118             return false;
119
120         if (internalDebugFeatures != options.internalDebugFeatures)
121             return false;
122
123         return true;
124     }
125     
126     bool shouldEnableProcessSwapOnNavigation() const
127     {
128         return enableProcessSwapOnNavigation || enableProcessSwapOnWindowOpen;
129     }
130 };
131
132 }