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
|
#!/usr/bin/env python
# ***** BEGIN LICENSE BLOCK *****
# 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/.
# ***** END LICENSE BLOCK *****
import copy
import os
import sys
# load modules from parent dir
sys.path.insert(1, os.path.dirname(os.path.dirname(sys.path[0])))
from mozharness.base.python import PreScriptAction
from mozharness.mozilla.structuredlog import StructuredOutputParser
from mozharness.mozilla.testing.codecoverage import (
CodeCoverageMixin,
code_coverage_config_options,
)
from mozharness.mozilla.testing.testbase import TestingMixin, testing_config_options
from mozharness.mozilla.vcstools import VCSToolsScript
# General command line arguments for Firefox ui tests
telemetry_tests_config_options = (
[
[
["--allow-software-gl-layers"],
{
"action": "store_true",
"dest": "allow_software_gl_layers",
"default": False,
"help": "Permits a software GL implementation (such as LLVMPipe) "
"to use the GL compositor.",
},
],
[
["--dry-run"],
{
"dest": "dry_run",
"default": False,
"help": "Only show what was going to be tested.",
},
],
[
["--disable-e10s"],
{
"dest": "e10s",
"action": "store_false",
"default": True,
"help": "Disable multi-process (e10s) mode when running tests.",
},
],
[
["--disable-fission"],
{
"dest": "disable_fission",
"action": "store_true",
"default": False,
"help": "Disable fission mode when running tests.",
},
],
[
["--setpref"],
{
"dest": "extra_prefs",
"action": "append",
"default": [],
"help": "Extra user prefs.",
},
],
[
["--symbols-path=SYMBOLS_PATH"],
{
"dest": "symbols_path",
"help": "absolute path to directory containing breakpad "
"symbols, or the url of a zip file containing symbols.",
},
],
[
["--tag=TAG"],
{
"dest": "tag",
"help": "Subset of tests to run (local, remote).",
},
],
]
+ copy.deepcopy(testing_config_options)
+ copy.deepcopy(code_coverage_config_options)
)
class TelemetryTests(TestingMixin, VCSToolsScript, CodeCoverageMixin):
def __init__(
self,
config_options=None,
all_actions=None,
default_actions=None,
*args,
**kwargs
):
config_options = config_options or telemetry_tests_config_options
actions = [
"clobber",
"download-and-extract",
"create-virtualenv",
"install",
"run-tests",
"uninstall",
]
super(TelemetryTests, self).__init__(
config_options=config_options,
all_actions=all_actions or actions,
default_actions=default_actions or actions,
*args,
**kwargs
)
# Code which runs in automation has to include the following properties
self.binary_path = self.config.get("binary_path")
self.installer_path = self.config.get("installer_path")
self.installer_url = self.config.get("installer_url")
self.test_packages_url = self.config.get("test_packages_url")
self.test_url = self.config.get("test_url")
self.disable_fission = self.config.get("disable_fission")
if not self.test_url and not self.test_packages_url:
self.fatal("You must use --test-url, or --test-packages-url")
@PreScriptAction("create-virtualenv")
def _pre_create_virtualenv(self, action):
abs_dirs = self.query_abs_dirs()
requirements = os.path.join(
abs_dirs["abs_test_install_dir"],
"config",
"telemetry_tests_requirements.txt",
)
self.register_virtualenv_module(requirements=[requirements])
def query_abs_dirs(self):
if self.abs_dirs:
return self.abs_dirs
abs_dirs = super(TelemetryTests, self).query_abs_dirs()
abs_test_install_dir = os.path.join(abs_dirs["abs_work_dir"], "tests")
dirs = {
"abs_test_install_dir": abs_test_install_dir,
"abs_telemetry_dir": os.path.join(
abs_test_install_dir, "telemetry", "marionette"
),
"abs_blob_upload_dir": os.path.join(
abs_dirs["abs_work_dir"], "blobber_upload_dir"
),
}
for key in dirs:
if key not in abs_dirs:
abs_dirs[key] = dirs[key]
self.abs_dirs = abs_dirs
return self.abs_dirs
def run_test(self, binary_path, env=None, marionette_port=2828):
"""All required steps for running the tests against an installer."""
dirs = self.query_abs_dirs()
# Import the harness to retrieve the location of the cli scripts
import telemetry_harness
cmd = [
self.query_python_path(),
os.path.join(os.path.dirname(telemetry_harness.__file__), self.cli_script),
"--binary",
binary_path,
"--address",
"localhost:{}".format(marionette_port),
# Resource files to serve via local webserver
"--server-root",
os.path.join(dirs["abs_telemetry_dir"], "harness", "www"),
# Use the work dir to get temporary data stored
"--workspace",
dirs["abs_work_dir"],
# logging options
"--gecko-log=-", # output from the gecko process redirected to stdout
"--log-raw=-", # structured log for output parser redirected to stdout
# additional reports helpful for Jenkins and inpection via Treeherder
"--log-html",
os.path.join(dirs["abs_blob_upload_dir"], "report.html"),
"--log-xunit",
os.path.join(dirs["abs_blob_upload_dir"], "report.xml"),
# Enable tracing output to log transmission protocol
"-vv",
]
# Symbols for crash reports
if self.symbols_path:
cmd.extend(["--symbols-path", self.symbols_path])
if self.disable_fission:
cmd.append("--disable-fission")
cmd.extend(["--setpref={}".format(p) for p in self.config["extra_prefs"]])
if not self.config["e10s"]:
cmd.append("--disable-e10s")
parser = StructuredOutputParser(
config=self.config, log_obj=self.log_obj, strict=False
)
# Add the default tests to run
tests = [
os.path.join(dirs["abs_telemetry_dir"], "tests", test)
for test in self.default_tests
]
cmd.extend(tests)
# Set further environment settings
env = env or self.query_env()
env.update({"MINIDUMP_SAVE_PATH": dirs["abs_blob_upload_dir"]})
if self.query_minidump_stackwalk():
env.update({"MINIDUMP_STACKWALK": self.minidump_stackwalk_path})
env["RUST_BACKTRACE"] = "1"
env["MOZ_IGNORE_NSS_SHUTDOWN_LEAKS"] = "1"
# Causes Firefox to crash when using non-local connections.
env["MOZ_DISABLE_NONLOCAL_CONNECTIONS"] = "1"
# If code coverage is enabled, set GCOV_PREFIX env variable
if self.config.get("code_coverage"):
env["GCOV_PREFIX"] = self.gcov_dir
return_code = self.run_command(
cmd,
cwd=dirs["abs_work_dir"],
output_timeout=1000,
output_parser=parser,
env=env,
)
tbpl_status, log_level, _ = parser.evaluate_parser(return_code)
self.record_status(tbpl_status, level=log_level)
return return_code
@PreScriptAction("run-tests")
def _pre_run_tests(self, action):
if not self.installer_path and not self.installer_url:
self.critical(
"Please specify an installer via --installer-path or --installer-url."
)
sys.exit(1)
def run_tests(self):
"""Run all the tests"""
return self.run_test(
binary_path=self.binary_path,
env=self.query_env(),
)
class TelemetryClientTests(TelemetryTests):
cli_script = "runtests.py"
default_tests = [
os.path.join("client", "manifest.toml"),
os.path.join("unit", "manifest.toml"),
]
if __name__ == "__main__":
myScript = TelemetryClientTests()
myScript.run_and_exit()
|
