onnxruntime/tools/python/run_android_emulator.py
Scott McKay ae211999dd
Attempt to make the usage of the Android emulator in CIs more robust (#17903)
### Description
<!-- Describe your changes. -->
Android emulator usage updates:
- Change approach to detecting boot has completed
- use `-delay-adb` and a simple command (`ls`) with `wait-for-device` as
the first step
    - this ensures enough startup has occurred for adb to be responsive
- use secondary loop on the python side to check for sys.boot_completed
to be set
- doing the check on the python side provides more feedback and seems to
work well
- make the 'stop' logic more precise by using psutil
- add internal timeout of 20 mins for emulator startup
  - waiting for the CI jobs overall timeout is way too long
- value is hardcoded for now (most CIs startup in under 10 mins) but
could be made configurable if needed

CI updates:
- add template for using the Android emulator
  - update CIs to use template
- reorder React Native CI
- minimize the time the Android emulator or iOS simulator is running by
moving some build steps around
  - don't run both at the same time
- unnecessary and potentially adds significant memory pressure to the
machine
- fix QNN Android emulator CI as much as possible
- now everything works apart from running onnx_test_runner with the QNN
EP

### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- If it fixes an open issue, please link to the issue here. -->
Fix inconsistent detection of the emulator boot completing.

---------

Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
2023-10-15 08:42:36 +10:00

93 lines
3.2 KiB
Python
Executable file

#!/usr/bin/env python3
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
import argparse
import contextlib
import shlex
import sys
import util.android as android
from util import get_logger
log = get_logger("run_android_emulator")
def parse_args():
parser = argparse.ArgumentParser(
description="Manages the running of an Android emulator. "
"Supported modes are to create an AVD, and start or stop the emulator. "
"The default is to start the emulator and wait for a keypress to stop it (start and stop)."
)
parser.add_argument("--create-avd", action="store_true", help="Whether to create the Android virtual device.")
parser.add_argument("--start", action="store_true", help="Start the emulator.")
parser.add_argument("--stop", action="store_true", help="Stop the emulator.")
parser.add_argument("--android-sdk-root", required=True, help="Path to the Android SDK root.")
parser.add_argument(
"--system-image",
default="system-images;android-31;default;x86_64",
help="The Android system image package name.",
)
parser.add_argument("--avd-name", default="ort_android", help="The Android virtual device name.")
parser.add_argument(
"--emulator-extra-args", default="", help="A string of extra arguments to pass to the Android emulator."
)
parser.add_argument(
"--emulator-pid-file",
help="Output/input file containing the PID of the emulator process. "
"This is only required if exactly one of --start or --stop is given.",
)
args = parser.parse_args()
if not args.start and not args.stop and not args.create_avd:
# unspecified means start and stop if not creating the AVD
args.start = args.stop = True
if args.start != args.stop and args.emulator_pid_file is None:
raise ValueError("PID file must be specified if only starting or stopping.")
return args
def main():
args = parse_args()
sdk_tool_paths = android.get_sdk_tool_paths(args.android_sdk_root)
start_emulator_args = {
"sdk_tool_paths": sdk_tool_paths,
"avd_name": args.avd_name,
"extra_args": shlex.split(args.emulator_extra_args),
}
if args.create_avd:
android.create_virtual_device(sdk_tool_paths, args.system_image, args.avd_name)
if args.start and args.stop:
with contextlib.ExitStack() as context_stack:
emulator_proc = android.start_emulator(**start_emulator_args)
context_stack.enter_context(emulator_proc)
context_stack.callback(android.stop_emulator, emulator_proc)
log.info("Press Enter to close.")
sys.stdin.readline()
elif args.start:
emulator_proc = android.start_emulator(**start_emulator_args)
with open(args.emulator_pid_file, mode="w") as emulator_pid_file:
print(f"{emulator_proc.pid}", file=emulator_pid_file)
elif args.stop:
with open(args.emulator_pid_file) as emulator_pid_file:
emulator_pid = int(emulator_pid_file.readline().strip())
android.stop_emulator(emulator_pid)
if __name__ == "__main__":
sys.exit(main())