-
Notifications
You must be signed in to change notification settings - Fork 99
/
launchers.py
494 lines (415 loc) · 15.9 KB
/
launchers.py
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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
"""
Define the launcher classes, responsible of running the tested applications.
"""
from __future__ import absolute_import, print_function
import json
import os
import stat
import sys
import time
import zipfile
from abc import ABCMeta, abstractmethod
from subprocess import call
from threading import Thread
import mozinfo
import mozinstall
import mozversion
from mozdevice import ADBDeviceFactory, ADBError, ADBHost
from mozfile import remove
from mozlog.structured import get_default_logger, get_proxy_logger
from mozprofile import Profile, ThunderbirdProfile
from mozrunner import Runner
from mozregression.class_registry import ClassRegistry
from mozregression.errors import LauncherError, LauncherNotRunnable
from mozregression.tempdir import safe_mkdtemp
LOG = get_proxy_logger("Test Runner")
class Launcher(metaclass=ABCMeta):
"""
Handle the logic of downloading a build file, installing and
running an application.
"""
profile_class = Profile
@classmethod
def check_is_runnable(cls):
"""
Check that the launcher can be created and can run on the system.
:raises: :class:`LauncherNotRunnable`.
"""
pass
def __init__(self, dest, **kwargs):
self._running = False
self._stopping = False
try:
self._install(dest)
except Exception as e:
msg = "Unable to install {} (error: {})".format(dest, e)
LOG.error(msg)
raise LauncherError(msg).with_traceback(sys.exc_info()[2])
def start(self, **kwargs):
"""
Start the application.
"""
if not self._running:
try:
self._start(**kwargs)
except Exception as e:
msg = "Unable to start the application (error: {})".format(e)
LOG.error(msg)
raise LauncherError(msg).with_traceback(sys.exc_info()[2])
self._running = True
def wait(self):
"""
Wait for the application to be finished and return the error code
when available.
"""
if self._running:
return_code = self._wait()
self.stop()
return return_code
def stop(self):
"""
Stop the application.
"""
if self._running:
self._stopping = True
try:
self._stop()
except Exception as e:
msg = "Unable to stop the application (error: {})".format(e)
LOG.error(msg)
raise LauncherError(msg).with_traceback(sys.exc_info()[2])
self._running = False
self._stopping = False
def get_app_info(self):
"""
Return information about the application.
"""
raise NotImplementedError
def cleanup(self):
self.stop()
def __enter__(self):
return self
def __exit__(self, *exc):
self.cleanup()
@abstractmethod
def _install(self, dest):
raise NotImplementedError
@abstractmethod
def _start(self, **kwargs):
raise NotImplementedError
@abstractmethod
def _wait(self):
raise NotImplementedError
@abstractmethod
def _stop(self):
raise NotImplementedError
def _create_profile(self, profile=None, addons=(), preferences=None):
if isinstance(profile, Profile):
return profile
else:
return self.create_profile(profile=profile, addons=addons, preferences=preferences)
@classmethod
def create_profile(cls, profile=None, addons=(), preferences=None, clone=True):
if profile:
if not os.path.exists(profile):
LOG.warning("Creating directory '%s' to put the profile in there" % profile)
os.makedirs(profile)
# since the user gave an empty dir for the profile,
# let's keep it on the disk in any case.
clone = False
if clone:
# mozprofile makes some changes in the profile that can not
# be undone. Let's clone the profile to not have side effect
# on existing profile.
# see https://bugzilla.mozilla.org/show_bug.cgi?id=999009
profile = cls.profile_class.clone(profile, addons=addons, preferences=preferences)
else:
profile = cls.profile_class(profile, addons=addons, preferences=preferences)
elif len(addons):
profile = cls.profile_class(addons=addons, preferences=preferences)
else:
profile = cls.profile_class(preferences=preferences)
return profile
def safe_get_version(**kwargs):
# some really old firefox builds are not supported by mozversion
# and let's be paranoid and handle any error (but report them!)
try:
return mozversion.get_version(**kwargs)
except mozversion.VersionError as exc:
LOG.warning("Unable to get app version: %s" % exc)
return {}
class MozRunnerLauncher(Launcher):
tempdir = None
runner = None
app_name = "undefined"
binary = None
def _install(self, dest):
self.tempdir = safe_mkdtemp()
try:
self.binary = mozinstall.get_binary(
mozinstall.install(src=dest, dest=self.tempdir), self.app_name
)
except Exception:
remove(self.tempdir)
raise
def _disableUpdateByPolicy(self):
updatePolicy = {"policies": {"DisableAppUpdate": True}}
installdir = os.path.dirname(self.binary)
if mozinfo.os == "mac":
# macOS has the following filestructure:
# binary at:
# PackageName.app/Contents/MacOS/firefox
# we need policies.json in:
# PackageName.app/Contents/Resources/distribution
installdir = os.path.normpath(os.path.join(installdir, "..", "Resources"))
os.mkdir(os.path.join(installdir, "distribution"))
policyFile = os.path.join(installdir, "distribution", "policies.json")
with open(policyFile, "w") as fp:
json.dump(updatePolicy, fp, indent=2)
def _start(
self,
profile=None,
addons=(),
cmdargs=(),
preferences=None,
adb_profile_dir=None,
):
profile = self._create_profile(profile=profile, addons=addons, preferences=preferences)
LOG.info("Launching %s" % self.binary)
self.runner = Runner(binary=self.binary, cmdargs=cmdargs, profile=profile)
def _on_exit():
# if we are stopping the process do not log anything.
if not self._stopping:
# mozprocess (behind mozrunner) fire 'onFinish'
# a bit early - let's ensure the process is finished.
# we have to call wait() directly on the subprocess
# instance of the ProcessHandler, else on windows
# None is returned...
# TODO: search that bug and fix that in mozprocess or
# mozrunner. (likely mozproces)
try:
exitcode = self.runner.process_handler.proc.wait()
except Exception:
print()
LOG.error(
"Error while waiting process, consider filing a bug.",
exc_info=True,
)
return
if exitcode != 0:
# first print a blank line, to be sure we don't
# write on an already printed line without EOL.
print()
LOG.warning("Process exited with code %s" % exitcode)
# we don't need stdin, and GUI will not work in Windowed mode if set
# see: https://stackoverflow.com/a/40108817
# also, don't stream to stdout: https://bugzilla.mozilla.org/show_bug.cgi?id=1653349
devnull = open(os.devnull, "wb")
self.runner.process_args = {
"processOutputLine": [get_default_logger("process").info],
"stdin": devnull,
"stream": None,
"onFinish": _on_exit,
}
self.runner.start()
def _wait(self):
return self.runner.wait()
def _stop(self):
if mozinfo.os == "win" and self.app_name == "firefox":
# for some reason, stopping the runner may hang on windows. For
# example restart the browser in safe mode, it will hang for a
# couple of minutes. As a workaround, we call that in a thread and
# wait a bit for the completion. If the stop() can't complete we
# forgot about that thread.
thread = Thread(target=self.runner.stop)
thread.daemon = True
thread.start()
thread.join(0.7)
else:
self.runner.stop()
# release the runner since it holds a profile reference
del self.runner
def cleanup(self):
try:
Launcher.cleanup(self)
finally:
# always remove tempdir
if self.tempdir is not None:
remove(self.tempdir)
def get_app_info(self):
return safe_get_version(binary=self.binary)
REGISTRY = ClassRegistry("app_name")
def create_launcher(buildinfo):
"""
Create and returns an instance launcher for the given buildinfo.
"""
return REGISTRY.get(buildinfo.app_name)(buildinfo.build_file, task_id=buildinfo.task_id)
class FirefoxRegressionProfile(Profile):
"""
Specialized Profile subclass for Firefox / Fennec
Some preferences may only apply to one or the other
"""
preferences = {
# Don't automatically update the application (only works on older
# versions of Firefox)
"app.update.enabled": False,
# On newer versions of Firefox (where disabling automatic updates
# is impossible, at least don't update automatically)
"app.update.auto": False,
# Don't automatically download the update (this pref is specific to
# some versions of Fennec)
"app.update.autodownload": "disabled",
# Don't restore the last open set of tabs
# if the browser has crashed
"browser.sessionstore.resume_from_crash": False,
# Don't check for the default web browser during startup
"browser.shell.checkDefaultBrowser": False,
# Don't warn on exit when multiple tabs are open
"browser.tabs.warnOnClose": False,
# Don't warn when exiting the browser
"browser.warnOnQuit": False,
# Don't send Firefox health reports to the production
# server
"datareporting.healthreport.uploadEnabled": False,
"datareporting.healthreport.documentServerURI": "http://%(server)s/healthreport/",
# Don't show tab with privacy notice on every launch
"datareporting.policy.dataSubmissionPolicyBypassNotification": True,
# Don't report telemetry information
"toolkit.telemetry.enabled": False,
# Allow sideloading extensions
"extensions.autoDisableScopes": 0,
# Disable what's new page
"browser.startup.homepage_override.mstone": "ignore",
}
@REGISTRY.register("firefox")
class FirefoxLauncher(MozRunnerLauncher):
profile_class = FirefoxRegressionProfile
def _install(self, dest):
super(FirefoxLauncher, self)._install(dest)
self._disableUpdateByPolicy()
class ThunderbirdRegressionProfile(ThunderbirdProfile):
"""
Specialized Profile subclass for Thunderbird
"""
preferences = {
# Don't automatically update the application
"app.update.enabled": False,
"app.update.auto": False,
}
@REGISTRY.register("thunderbird")
class ThunderbirdLauncher(MozRunnerLauncher):
profile_class = ThunderbirdRegressionProfile
class AndroidLauncher(Launcher):
app_info = None
adb = None
package_name = None
profile_class = FirefoxRegressionProfile
remote_profile = None
@abstractmethod
def _get_package_name(self):
raise NotImplementedError
@abstractmethod
def _launch(self):
raise NotImplementedError
@classmethod
def check_is_runnable(cls):
try:
devices = ADBHost().devices()
except ADBError as adb_error:
raise LauncherNotRunnable(str(adb_error))
if not devices:
raise LauncherNotRunnable(
"No android device connected." " Connect a device and try again."
)
def _install(self, dest):
# get info now, as dest may be removed
self.app_info = safe_get_version(binary=dest)
self.package_name = self.app_info.get("package_name", self._get_package_name())
self.adb = ADBDeviceFactory()
try:
self.adb.uninstall_app(self.package_name)
except ADBError as msg:
LOG.warning(
"Failed to uninstall %s (%s)\nThis is normal if it is the"
" first time the application is installed." % (self.package_name, msg)
)
self.adb.run_as_package = self.adb.install_app(dest)
def _start(
self,
profile=None,
addons=(),
cmdargs=(),
preferences=None,
adb_profile_dir=None,
):
# for now we don't handle addons on the profile for fennec
profile = self._create_profile(profile=profile, preferences=preferences)
# send the profile on the device
if not adb_profile_dir:
adb_profile_dir = self.adb.test_root
self.remote_profile = "/".join([adb_profile_dir, os.path.basename(profile.profile)])
if self.adb.exists(self.remote_profile):
self.adb.rm(self.remote_profile, recursive=True)
LOG.debug("Pushing profile to device (%s -> %s)" % (profile.profile, self.remote_profile))
self.adb.push(profile.profile, self.remote_profile)
self._launch()
def _wait(self):
while self.adb.process_exist(self.package_name):
time.sleep(0.1)
def _stop(self):
self.adb.stop_application(self.package_name)
if self.adb.exists(self.remote_profile):
self.adb.rm(self.remote_profile, recursive=True)
def get_app_info(self):
return self.app_info
@REGISTRY.register("fennec")
class FennecLauncher(AndroidLauncher):
def _get_package_name(self):
return "org.mozilla.fennec"
def _launch(self):
LOG.debug("Launching fennec")
self.adb.launch_fennec(self.package_name, extra_args=["-profile", self.remote_profile])
@REGISTRY.register("gve")
class GeckoViewExampleLauncher(AndroidLauncher):
def _get_package_name(self):
return "org.mozilla.geckoview_example"
def _launch(self):
LOG.debug("Launching geckoview_example")
self.adb.launch_activity(
self.package_name,
activity_name="GeckoViewActivity",
extra_args=["-profile", self.remote_profile],
e10s=True,
)
@REGISTRY.register("jsshell")
class JsShellLauncher(Launcher):
temp_dir = None
def _install(self, dest):
self.tempdir = safe_mkdtemp()
try:
with zipfile.ZipFile(dest, "r") as z:
z.extractall(self.tempdir)
self.binary = os.path.join(self.tempdir, "js" if mozinfo.os != "win" else "js.exe")
# set the file executable
os.chmod(self.binary, os.stat(self.binary).st_mode | stat.S_IEXEC)
except Exception:
remove(self.tempdir)
raise
def _start(self, **kwargs):
LOG.info("Launching %s" % self.binary)
res = call([self.binary], cwd=self.tempdir)
if res != 0:
LOG.warning("jsshell exited with code %d." % res)
def _wait(self):
pass
def _stop(self, **kwargs):
pass
def get_app_info(self):
return {}
def cleanup(self):
try:
Launcher.cleanup(self)
finally:
# always remove tempdir
if self.tempdir is not None:
remove(self.tempdir)