1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
import errno
import os
import shutil
import tempfile
import pytest
GVE = "org.mozilla.geckoview_example"
def run(
logger,
path,
webdriver_binary,
webdriver_port,
webdriver_ws_port,
browser_binary=None,
device_serial=None,
package_name=None,
environ=None,
bugs=None,
debug=False,
interventions=None,
shims=None,
config=None,
headless=False,
addon=None,
do2fa=False,
log_level="INFO",
failure_screenshots_dir=None,
no_failure_screenshots=None,
platform_override=None,
):
""""""
old_environ = os.environ.copy()
try:
with TemporaryDirectory() as cache:
if environ:
os.environ.update(environ)
config_plugin = WDConfig()
result_recorder = ResultRecorder(logger)
args = [
"--strict", # turn warnings into errors
"-vv", # show each individual subtest and full failure logs
"--capture",
"no", # enable stdout/stderr from tests
"--basetemp",
cache, # temporary directory
"--showlocals", # display contents of variables in local scope
"-p",
"no:mozlog", # use the WPT result recorder
"--disable-warnings",
"-rfEs",
"-p",
"no:cacheprovider", # disable state preservation across invocations
"-o=console_output_style=classic", # disable test progress bar
"--browser",
"firefox",
"--webdriver-binary",
webdriver_binary,
"--webdriver-port",
webdriver_port,
"--webdriver-ws-port",
webdriver_ws_port,
"--webdriver-log-level",
log_level,
"--capture=no",
"--show-capture=no",
]
if debug:
args.append("--pdb")
if headless:
args.append("--headless")
if browser_binary:
args.append("--browser-binary")
args.append(browser_binary)
if device_serial:
args.append("--device-serial")
args.append(device_serial)
if package_name:
args.append("--package-name")
args.append(package_name)
if addon:
args.append("--addon")
args.append(addon)
if do2fa:
args.append("--do2fa")
if config:
args.append("--config")
args.append(config)
if failure_screenshots_dir:
args.append("--failure-screenshots-dir")
args.append(failure_screenshots_dir)
if platform_override:
args.append("--platform-override")
args.append(platform_override)
if no_failure_screenshots:
args.append("--no-failure-screenshots")
if interventions is not None and shims is not None:
raise ValueError(
"Must provide only one of interventions or shims argument"
)
elif interventions is None and shims is None:
raise ValueError(
"Must provide either an interventions or shims argument"
)
name = "webcompat-interventions"
if interventions == "enabled":
args.extend(["-m", "with_interventions"])
elif interventions == "disabled":
args.extend(["-m", "without_interventions"])
elif interventions is not None:
raise ValueError(f"Invalid value for interventions {interventions}")
if shims == "enabled":
args.extend(["-m", "with_shims"])
name = "smartblock-shims"
elif shims == "disabled":
args.extend(["-m", "without_shims"])
name = "smartblock-shims"
elif shims is not None:
raise ValueError(f"Invalid value for shims {shims}")
else:
name = "smartblock-shims"
if bugs is not None:
args.extend(["-k", " or ".join(bugs)])
args.append(path)
try:
logger.suite_start([], name=name)
pytest.main(args, plugins=[config_plugin, result_recorder])
except Exception as e:
logger.critical(str(e))
finally:
logger.suite_end()
finally:
os.environ = old_environ
class WDConfig:
def pytest_addoption(self, parser):
parser.addoption(
"--browser-binary", action="store", help="Path to browser binary"
)
parser.addoption(
"--webdriver-binary", action="store", help="Path to webdriver binary"
)
parser.addoption(
"--webdriver-port",
action="store",
default="4444",
help="Port on which to run WebDriver",
)
parser.addoption(
"--webdriver-ws-port",
action="store",
default="9222",
help="Port on which to run WebDriver BiDi websocket",
)
parser.addoption(
"--webdriver-log-level",
action="store",
default="INFO",
help="Log level to use for WebDriver",
)
parser.addoption(
"--browser", action="store", choices=["firefox"], help="Name of the browser"
)
parser.addoption(
"--do2fa",
action="store_true",
default=False,
help="Do two-factor auth live in supporting tests",
)
parser.addoption(
"--failure-screenshots-dir",
action="store",
help="Path to save failure screenshots",
)
parser.addoption(
"--no-failure-screenshots",
action="store_true",
default=False,
help="Do not save screenshots on failure",
)
parser.addoption(
"--config",
action="store",
help="Path to JSON file containing logins and other settings",
)
parser.addoption(
"--addon",
action="store",
help="Path to the webcompat addon XPI to use",
)
parser.addoption(
"--device-serial",
action="store",
help="Emulator device serial number",
)
parser.addoption(
"--package-name",
action="store",
default=GVE,
help="Android package to run/connect to",
)
parser.addoption(
"--headless", action="store_true", help="Run browser in headless mode"
)
parser.addoption(
"--platform-override",
action="store",
choices=["android", "linux", "mac", "windows"],
help="Override key navigator properties to match the given platform and/or use responsive design mode to mimic the given platform",
)
class ResultRecorder:
def __init__(self, logger):
self.logger = logger
def pytest_runtest_logreport(self, report):
if report.passed and report.when == "call":
self.record_pass(report)
elif report.failed:
if report.when != "call":
self.record_error(report)
else:
self.record_fail(report)
elif report.skipped:
self.record_skip(report)
def record_pass(self, report):
self.record(report.nodeid, "PASS")
def record_fail(self, report):
# pytest outputs the stacktrace followed by an error message prefixed
# with "E ", e.g.
#
# def test_example():
# > assert "fuu" in "foobar"
# > E AssertionError: assert 'fuu' in 'foobar'
message = ""
for line in report.longreprtext.splitlines():
if line.startswith("E "):
message = line[1:].strip()
break
self.record(report.nodeid, "FAIL", message=message, stack=report.longrepr)
def record_error(self, report):
# error in setup/teardown
if report.when != "call":
message = f"{report.when} error"
self.record(report.nodeid, "ERROR", message, report.longrepr)
def record_skip(self, report):
self.record(report.nodeid, "SKIP")
def record(self, test, status, message=None, stack=None):
if stack is not None:
stack = str(stack)
self.logger.test_start(test)
self.logger.test_end(
test=test, status=status, expected="PASS", message=message, stack=stack
)
class TemporaryDirectory:
def __enter__(self):
self.path = tempfile.mkdtemp(prefix="pytest-")
return self.path
def __exit__(self, *args):
try:
shutil.rmtree(self.path)
except OSError as e:
# no such file or directory
if e.errno != errno.ENOENT:
raise
|
