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
|
# 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 re
import statistics
import time
from datetime import datetime, timedelta
import mozdevice
from .android import AndroidDevice
DATETIME_FORMAT = "%Y.%m.%d"
PAGE_START_MOZ = re.compile("GeckoSession: handleMessage GeckoView:PageStart uri=")
PROD_FENIX = "fenix"
PROD_FOCUS = "focus"
PROD_GVEX = "geckoview_example"
PROD_CHRM = "chrome-m"
MOZILLA_PRODUCTS = [PROD_FENIX, PROD_FOCUS, PROD_GVEX]
KEY_NAME = "name"
KEY_PRODUCT = "product"
KEY_DATETIME = "date"
KEY_COMMIT = "commit"
KEY_ARCHITECTURE = "architecture"
KEY_TEST_NAME = "test_name"
MEASUREMENT_DATA = ["mean", "median", "standard_deviation"]
OLD_VERSION_FOCUS_PAGE_START_LINE_COUNT = 3
NEW_VERSION_FOCUS_PAGE_START_LINE_COUNT = 2
STDOUT_LINE_COUNT = 2
TEST_COLD_MAIN_FF = "cold_main_first_frame"
TEST_COLD_MAIN_RESTORE = "cold_main_session_restore"
TEST_COLD_VIEW_FF = "cold_view_first_frame"
TEST_COLD_VIEW_NAV_START = "cold_view_nav_start"
TEST_URI = "https://example.com"
BASE_URL_DICT = {
PROD_FENIX: (
"https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/"
"gecko.v2.mozilla-central.pushdate.{date}.latest.mobile.fenix-nightly"
"/artifacts/public%2Fbuild%2Ftarget.{architecture}.apk"
),
PROD_FENIX
+ "-pre-mono-repo": (
"https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/"
"mobile.v3.firefox-android.apks.fenix-nightly.{date}.latest.{architecture}/artifacts/"
"public%2Fbuild%2Ftarget.{architecture}.apk"
),
PROD_FENIX
+ "-latest": (
"https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/"
"gecko.v2.mozilla-central.latest.mobile.fenix-nightly/artifacts/"
"public%2Fbuild%2Ftarget.{architecture}.apk"
),
PROD_FOCUS: (
"https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/"
"gecko.v2.mozilla-central.pushdate.{date}.latest.mobile.focus-nightly"
"/artifacts/public%2Fbuild%2Ftarget.{architecture}.apk"
),
PROD_FOCUS
+ "-pre-mono-repo": (
"https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/"
"mobile.v3.firefox-android.apks.focus-nightly.{date}.latest.{architecture}"
"/artifacts/public%2Fbuild%2Ftarget.{architecture}.apk"
),
PROD_FOCUS
+ "-latest": (
"https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/"
"gecko.v2.mozilla-central.latest.mobile.focus-nightly/artifacts/"
"public%2Fbuild%2Ftarget.{architecture}.apk"
),
PROD_GVEX: (
"https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/"
"gecko.v2.mozilla-central.pushdate.{date}.latest.mobile.android-"
"{architecture}-debug/artifacts/public%2Fbuild%2Fgeckoview_example.apk"
),
PROD_GVEX
+ "-latest": (
"https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/"
"gecko.v2.mozilla-central.shippable.latest.mobile.android-"
"{architecture}-opt/artifacts/public/build/geckoview_example.apk"
),
}
PROD_TO_CHANNEL_TO_PKGID = {
PROD_FENIX: {
"nightly": "org.mozilla.fenix",
"beta": "org.mozilla.firefox.beta",
"release": "org.mozilla.firefox",
"debug": "org.mozilla.fenix.debug",
},
PROD_FOCUS: {
"nightly": "org.mozilla.focus.nightly",
"beta": "org.mozilla.focus.beta", # only present since post-fenix update.
"release": "org.mozilla.focus",
"debug": "org.mozilla.focus.debug",
},
PROD_GVEX: {
"nightly": "org.mozilla.geckoview_example",
},
PROD_CHRM: {
"release": "com.android.chrome",
},
}
TEST_LIST = [
"cold_main_first_frame",
"cold_view_nav_start",
"cold_view_first_frame",
"cold_main_session_restore",
]
# "cold_view_first_frame", "cold_main_session_restore" are 2 disabled tests(broken)
class AndroidStartUpDownloadError(Exception):
"""Failure downloading Firefox Nightly APK"""
pass
class AndroidStartUpInstallError(Exception):
"""Failure installing Firefox on the android device"""
pass
class AndroidStartUpUnknownTestError(Exception):
"""
Test name provided is not one avaiable to test, this is either because
the test is currently not being tested or a typo in the spelling
"""
pass
class AndroidStartUpMatchingError(Exception):
"""
We expected a certain number of matches but did not get them
"""
pass
class AndroidStartUpData:
def open_data(self, data):
return {
"name": "AndroidStartUp",
"subtest": data["name"],
"data": [
{"file": "android_startup", "value": value, "xaxis": xaxis}
for xaxis, value in enumerate(data["values"])
],
"shouldAlert": True,
}
def transform(self, data):
return data
merge = transform
class AndroidStartUp(AndroidDevice):
name = "AndroidStartUp"
activated = False
arguments = {
"test-name": {
"type": str,
"default": "",
"help": "This is the startup android test that will be run on the a51",
},
"apk_metadata": {
"type": str,
"default": "",
"help": "This is the startup android test that will be run on the a51",
},
"product": {
"type": str,
"default": "",
"help": "This is the startup android test that will be run on the a51",
},
"release-channel": {
"type": str,
"default": "",
"help": "This is the startup android test that will be run on the a51",
},
}
def __init__(self, env, mach_cmd):
super(AndroidStartUp, self).__init__(env, mach_cmd)
self.android_activity = None
self.capture_logcat = self.capture_file = self.app_name = None
self.device = mozdevice.ADBDevice(use_root=False)
def run(self, metadata):
options = metadata.script["options"]
self.test_name = self.get_arg("test-name")
self.apk_metadata = self.get_arg("apk-metadata")
self.product = self.get_arg("product")
self.release_channel = self.get_arg("release_channel")
self.single_date = options["test_parameters"]["single_date"]
self.date_range = options["test_parameters"]["date_range"]
self.startup_cache = options["test_parameters"]["startup_cache"]
self.test_cycles = options["test_parameters"]["test_cycles"]
self.package_id = PROD_TO_CHANNEL_TO_PKGID[self.product][self.release_channel]
self.proc_start = re.compile(
rf"ActivityManager: Start proc \d+:{self.package_id}/"
)
apk_metadata = self.apk_metadata
self.get_measurements(apk_metadata, metadata)
# Cleanup
self.device.shell(f"rm {apk_metadata[KEY_NAME]}")
return metadata
def get_measurements(self, apk_metadata, metadata):
measurements = self.run_performance_analysis(apk_metadata)
self.add_to_metadata(measurements, metadata)
def get_date_array_for_range(self, start, end):
startdate = datetime.strptime(start, DATETIME_FORMAT)
enddate = datetime.strptime(end, DATETIME_FORMAT)
delta_dates = (enddate - startdate).days + 1
return [
(startdate + timedelta(days=i)).strftime("%Y.%m.%d")
for i in range(delta_dates)
]
def add_to_metadata(self, measurements, metadata):
if measurements is not None:
for key, value in measurements.items():
metadata.add_result(
{
"name": f"AndroidStartup:{self.product}",
"framework": {"name": "mozperftest"},
"transformer": "mozperftest.system.android_startup:AndroidStartUpData",
"shouldAlert": True,
"results": [
{
"values": [value],
"name": key,
"shouldAlert": True,
}
],
}
)
def run_performance_analysis(self, apk_metadata):
# Installing the application on the device and getting ready to run the tests
install_path = apk_metadata[KEY_NAME]
self.apk_name = apk_metadata[KEY_NAME].split(".")[0]
if self.custom_apk_exists():
install_path = self.custom_apk_path
if self.product in MOZILLA_PRODUCTS:
self.device.uninstall_app(self.package_id)
self.info(f"Installing {install_path}...")
app_name = self.device.install_app(install_path)
if self.device.is_app_installed(app_name):
self.info(f"Successfully installed {app_name}")
else:
raise AndroidStartUpInstallError("The android app was not installed")
return self.run_tests()
def run_tests(self):
measurements = {}
# Iterate through the tests in the test list
self.info(f"Running {self.test_name} on {self.apk_name}...")
self.skip_onboarding(self.test_name)
time.sleep(self.get_warmup_delay_seconds())
test_measurements = []
for i in range(self.test_cycles):
start_cmd_args = self.get_start_cmd(self.test_name)
self.info(start_cmd_args)
self.device.stop_application(self.package_id)
time.sleep(1)
self.info(f"iteration {i + 1}")
self.device.shell("logcat -c")
process = self.device.shell_output(start_cmd_args).splitlines()
test_measurements.append(self.get_measurement(self.test_name, process))
self.info(f"{self.test_name}: {str(test_measurements)}")
measurements[f"{self.test_name}.{MEASUREMENT_DATA[0]}"] = statistics.mean(
test_measurements
)
self.info(f"Mean: {statistics.mean(test_measurements)}")
measurements[f"{self.test_name}.{MEASUREMENT_DATA[1]}"] = statistics.median(
test_measurements
)
self.info(f"Median: {statistics.median(test_measurements)}")
if self.test_cycles > 1:
measurements[f"{self.test_name}.{MEASUREMENT_DATA[2]}"] = statistics.stdev(
test_measurements
)
self.info(f"Standard Deviation: {statistics.stdev(test_measurements)}")
return measurements
def get_measurement(self, test_name, stdout):
if test_name in [TEST_COLD_MAIN_FF, TEST_COLD_VIEW_FF]:
return self.get_measurement_from_am_start_log(stdout)
elif (
test_name in [TEST_COLD_VIEW_NAV_START, TEST_COLD_MAIN_RESTORE]
and self.product in MOZILLA_PRODUCTS
):
# We must sleep until the Navigation::Start event occurs. If we don't
# the script will fail. This can take up to 14s on the G5
time.sleep(17)
proc = self.device.shell_output("logcat -d")
return self.get_measurement_from_nav_start_logcat(proc)
else:
raise Exception(
"invalid test settings selected, please double check that "
"the test name is valid and that the test is supported for "
"the browser you are testing"
)
def get_measurement_from_am_start_log(self, stdout):
total_time_prefix = "TotalTime: "
matching_lines = [line for line in stdout if line.startswith(total_time_prefix)]
if len(matching_lines) != 1:
raise AndroidStartUpMatchingError(
f"Each run should only have 1 {total_time_prefix}."
f"However, this run unexpectedly had {matching_lines} matching lines"
)
duration = int(matching_lines[0][len(total_time_prefix) :])
return duration
def get_measurement_from_nav_start_logcat(self, process_output):
def __line_to_datetime(line):
date_str = " ".join(line.split(" ")[:2]) # e.g. "05-18 14:32:47.366"
# strptime needs microseconds. logcat outputs millis so we append zeroes
date_str_with_micros = date_str + "000"
return datetime.strptime(date_str_with_micros, "%m-%d %H:%M:%S.%f")
def __get_proc_start_datetime():
# This regex may not work on older versions of Android: we don't care
# yet because supporting older versions isn't in our requirements.
proc_start_lines = [line for line in lines if self.proc_start.search(line)]
if len(proc_start_lines) != 1:
raise AndroidStartUpMatchingError(
f"Expected to match 1 process start string but matched {len(proc_start_lines)}"
)
return __line_to_datetime(proc_start_lines[0])
def __get_page_start_datetime():
page_start_lines = [line for line in lines if PAGE_START_MOZ.search(line)]
page_start_line_count = len(page_start_lines)
page_start_assert_msg = "found len=" + str(page_start_line_count)
# In focus versions <= v8.8.2, it logs 3 PageStart lines and these include actual uris.
# We need to handle our assertion differently due to the different line count. In focus
# versions >= v8.8.3, this measurement is broken because the logcat were removed.
is_old_version_of_focus = (
"about:blank" in page_start_lines[0] and self.product == PROD_FOCUS
)
if is_old_version_of_focus:
assert (
page_start_line_count
== OLD_VERSION_FOCUS_PAGE_START_LINE_COUNT # should be 3
), page_start_assert_msg # Lines: about:blank, target URL, target URL.
else:
assert (
page_start_line_count
== NEW_VERSION_FOCUS_PAGE_START_LINE_COUNT # Should be 2
), page_start_assert_msg # Lines: about:blank, target URL.
return __line_to_datetime(
page_start_lines[1]
) # 2nd PageStart is for target URL.
lines = process_output.split("\n")
elapsed_seconds = (
__get_page_start_datetime() - __get_proc_start_datetime()
).total_seconds()
elapsed_millis = round(elapsed_seconds * 1000)
return elapsed_millis
def get_warmup_delay_seconds(self):
"""
We've been told the start up cache is populated ~60s after first start up. As such,
we should measure start up with the start up cache populated. If the
args say we shouldn't wait, we only wait a short duration ~= visual completeness.
"""
return 60 if self.startup_cache else 5
def get_start_cmd(self, test_name):
intent_action_prefix = "android.intent.action.{}"
if test_name in [TEST_COLD_MAIN_FF, TEST_COLD_MAIN_RESTORE]:
intent = (
f"-a {intent_action_prefix.format('MAIN')} "
f"-c android.intent.category.LAUNCHER"
)
elif test_name in [TEST_COLD_VIEW_FF, TEST_COLD_VIEW_NAV_START]:
intent = f"-a {intent_action_prefix.format('VIEW')} -d {TEST_URI}"
else:
raise AndroidStartUpUnknownTestError(
"Unknown test provided please double check the test name and spelling"
)
# You can't launch an app without an pkg_id/activity pair
component_name = self.get_component_name_for_intent(intent)
cmd = f"am start-activity -W -n {component_name} {intent} "
# If focus skip onboarding: it is not stateful so must be sent for every cold start intent
if self.product == PROD_FOCUS:
cmd += "--ez performancetest true"
return cmd
def get_component_name_for_intent(self, intent):
resolve_component_args = (
f"cmd package resolve-activity --brief {intent} {self.package_id}"
)
result_output = self.device.shell_output(resolve_component_args)
stdout = result_output.splitlines()
if len(stdout) != STDOUT_LINE_COUNT: # Should be 2
raise AndroidStartUpMatchingError(f"expected 2 lines. Got: {stdout}")
return stdout[1]
def skip_onboarding(self, test_name):
"""
We skip onboarding for focus in measure_start_up.py because it's stateful
and needs to be called for every cold start intent.
Onboarding only visibly gets in the way of our MAIN test results.
"""
if self.product == PROD_FOCUS or test_name not in {
TEST_COLD_MAIN_FF,
TEST_COLD_MAIN_RESTORE,
}:
return
if self.product == MOZILLA_PRODUCTS:
# This sets mutable state so we only need to pass this flag once, before we start the test
self.device.shell(
f"am start-activity -W -a android.intent.action.MAIN --ez "
f"performancetest true -n{self.package_id}/org.mozilla.fenix.App"
)
time.sleep(4) # ensure skip onboarding call has time to propagate.
|