DumpRenderTree should report unknown options
[WebKit-https.git] / Tools / DumpRenderTree / TestOptions.cpp
1 /*
2  * Copyright (C) 2016-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 #include "config.h"
27 #include "TestOptions.h"
28
29 #include <fstream>
30
31 static bool parseBooleanTestHeaderValue(const std::string& value)
32 {
33     if (value == "true")
34         return true;
35     if (value == "false")
36         return false;
37
38     LOG_ERROR("Found unexpected value '%s' for boolean option. Expected 'true' or 'false'.", value.c_str());
39     return false;
40 }
41
42 TestOptions::TestOptions(const std::string& pathOrURL, const std::string& absolutePath)
43 {
44     const auto& path = absolutePath.empty() ? pathOrURL : absolutePath;
45     if (path.empty())
46         return;
47
48     std::string options;
49     std::ifstream testFile(path.data());
50     if (!testFile.good())
51         return;
52     getline(testFile, options);
53     std::string beginString("webkit-test-runner [ ");
54     std::string endString(" ]");
55     size_t beginLocation = options.find(beginString);
56     if (beginLocation == std::string::npos)
57         return;
58     size_t endLocation = options.find(endString, beginLocation);
59     if (endLocation == std::string::npos) {
60         LOG_ERROR("Could not find end of test header in %s", path.c_str());
61         return;
62     }
63     std::string pairString = options.substr(beginLocation + beginString.size(), endLocation - (beginLocation + beginString.size()));
64     size_t pairStart = 0;
65     while (pairStart < pairString.size()) {
66         size_t pairEnd = pairString.find(" ", pairStart);
67         if (pairEnd == std::string::npos)
68             pairEnd = pairString.size();
69         size_t equalsLocation = pairString.find("=", pairStart);
70         if (equalsLocation == std::string::npos) {
71             LOG_ERROR("Malformed option in test header (could not find '=' character) in %s", path.c_str());
72             break;
73         }
74         auto key = pairString.substr(pairStart, equalsLocation - pairStart);
75         auto value = pairString.substr(equalsLocation + 1, pairEnd - (equalsLocation + 1));
76         if (key == "enableAttachmentElement")
77             enableAttachmentElement = parseBooleanTestHeaderValue(value);
78         else if (key == "useAcceleratedDrawing")
79             useAcceleratedDrawing = parseBooleanTestHeaderValue(value);
80         else if (key == "enableIntersectionObserver")
81             enableIntersectionObserver = parseBooleanTestHeaderValue(value);
82         else if (key == "enableMenuItemElement")
83             enableMenuItemElement = parseBooleanTestHeaderValue(value);
84         else if (key == "enableModernMediaControls")
85             enableModernMediaControls = parseBooleanTestHeaderValue(value);
86         else if (key == "enablePointerLock")
87             enablePointerLock = parseBooleanTestHeaderValue(value);
88         else if (key == "enableDragDestinationActionLoad")
89             enableDragDestinationActionLoad = parseBooleanTestHeaderValue(value);
90         else if (key == "layerBackedWebView")
91             layerBackedWebView = parseBooleanTestHeaderValue(value);
92         else if (key == "enableIsSecureContextAttribute")
93             enableIsSecureContextAttribute = parseBooleanTestHeaderValue(value);
94         else if (key == "enableInspectorAdditions")
95             enableInspectorAdditions = parseBooleanTestHeaderValue(value);
96         else if (key == "dumpJSConsoleLogInStdErr")
97             dumpJSConsoleLogInStdErr = parseBooleanTestHeaderValue(value);
98         else if (key == "allowCrossOriginSubresourcesToAskForCredentials")
99             allowCrossOriginSubresourcesToAskForCredentials = parseBooleanTestHeaderValue(value);
100         else if (key == "experimental:WebAnimationsCSSIntegrationEnabled")
101             enableWebAnimationsCSSIntegration = parseBooleanTestHeaderValue(value);
102         else if (key == "internal:selectionAcrossShadowBoundariesEnabled")
103             enableSelectionAcrossShadowBoundaries = parseBooleanTestHeaderValue(value);
104         else if (key == "enableColorFilter")
105             enableColorFilter = parseBooleanTestHeaderValue(value);
106         else if (key == "jscOptions")
107             jscOptions = value;
108         else if (key == "experimental:WebGPUEnabled")
109             enableWebGPU = parseBooleanTestHeaderValue(value);
110         else if (key == "internal:CSSLogicalEnabled")
111             enableCSSLogical = parseBooleanTestHeaderValue(value);
112         else if (key == "internal:AdClickAttributionEnabled")
113             adClickAttributionEnabled = parseBooleanTestHeaderValue(value);
114         else if (key == "applicationManifest")
115             applicationManifest = value;
116         else if (key == "experimental:CSSCustomPropertiesAndValuesEnabled")
117             enableCSSCustomPropertiesAndValues = parseBooleanTestHeaderValue(value);
118         else if (key == "useFlexibleViewport")
119             useFlexibleViewport = parseBooleanTestHeaderValue(value);
120         else if (key == "useThreadedScrolling")
121             useThreadedScrolling  = parseBooleanTestHeaderValue(value);
122         else if (key == "experimental:DarkModeCSSEnabled")
123             enableDarkModeCSS = parseBooleanTestHeaderValue(value);
124         else if (key == "experimental:CSSTypedOMEnabled")
125             enableCSSTypedOM = parseBooleanTestHeaderValue(value);
126         else if (key == "punchOutWhiteBackgrounds")
127             punchOutWhiteBackgrounds = parseBooleanTestHeaderValue(value);
128         else if (key == "enableEditableImages")
129             enableEditableImages = parseBooleanTestHeaderValue(value);
130         else if (key == "useCharacterSelectionGranularity")
131             useCharacterSelectionGranularity = parseBooleanTestHeaderValue(value);
132         else if (key == "spellCheckingDots")
133             spellCheckingDots = parseBooleanTestHeaderValue(value);
134         else if (key == "experimental:CSSPaintingAPIEnabled")
135             enableCSSPaintingAPI = parseBooleanTestHeaderValue(value);
136         else if (key == "experimental:PointerEventsEnabled")
137             enablePointerEvents = parseBooleanTestHeaderValue(value);
138         else if (key =="useMockScrollbars")
139             useMockScrollbars = parseBooleanTestHeaderValue(value);
140         else if (key =="ignoresViewportScaleLimits")
141             ignoresViewportScaleLimits = parseBooleanTestHeaderValue(value);
142         else if (key =="shouldIgnoreMetaViewport")
143             shouldIgnoreMetaViewport = parseBooleanTestHeaderValue(value);
144         else if (key =="enableProcessSwapOnNavigation")
145             enableProcessSwapOnNavigation = parseBooleanTestHeaderValue(value);
146         else if (key =="runSingly")
147             runSingly = parseBooleanTestHeaderValue(value);
148         else if (key =="internal:WebAPIStatisticsEnabled")
149             enableWebAPIStatistics = parseBooleanTestHeaderValue(value);
150         else if (key =="internal:SourceBufferChangeTypeEnabled")
151             enableSourceBufferChangeType = parseBooleanTestHeaderValue(value);
152         else if (key =="needsSiteSpecificQuirks")
153             needsSiteSpecificQuirks = parseBooleanTestHeaderValue(value);
154         else if (key =="modernMediaControls")
155             modernMediaControls = parseBooleanTestHeaderValue(value);
156         else if (key == "experimental:WebGL2Enabled")
157             enableWebGL2 = parseBooleanTestHeaderValue(value);
158         else
159             RELEASE_ASSERT_NOT_REACHED();
160         pairStart = pairEnd + 1;
161     }
162 }
163
164 bool TestOptions::webViewIsCompatibleWithOptions(const TestOptions& other) const
165 {
166     return other.layerBackedWebView == layerBackedWebView
167         && other.jscOptions == jscOptions
168         && other.enableWebAnimationsCSSIntegration == enableWebAnimationsCSSIntegration;
169 }