Fix mobile examples CI pipeline (#454)

* update Podfiles to use ios 13

* update prepare_model.sh to use new model download URL.

* update pipeline to use stages instead of jobs so they can be run individually

* remove job dependency

* get labelmap.txt

* use variables for agent pool specification

* remove mobile build related stuff, put podfile update into template

* fix podfile paths

* add python version parameter

* default to jdk 17

* remove explicit jdk version arg

* sync android python helper scripts with ORT version

* update run android emulator yaml

* add platform_helpers.py

* add step to install emulator

* add step to install platform tools

* use template for running android emulator

Author: edgchen1

ci_build/azure_pipelines/mobile-examples-pipeline.yml

@@ -3,15 +3,34 @@ parameters:
   type: stepList
 
 steps:
-- bash: |
+- script: |
+    if [[ ":$PATH:" == *":${ANDROID_SDK_ROOT}/emulator:"* ]]; then
+      echo "${ANDROID_SDK_ROOT}/emulator is in PATH"
+    else
+      ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --install "emulator"
+      echo "##vso[task.prependpath]${ANDROID_SDK_ROOT}/emulator"
+    fi
+  displayName: Check if emulator is installed and add to PATH
+
+- script: |
+    if [[ ":$PATH:" == *":${ANDROID_SDK_ROOT}/platform-tools:"* ]]; then
+        echo "${ANDROID_SDK_ROOT}/platform-tools is in PATH"
+    else
+        ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --install "platform-tools"
+        echo "##vso[task.prependpath]${ANDROID_SDK_ROOT}/platform-tools"
+    fi
+    ls -R ${ANDROID_SDK_ROOT}/platform-tools
+  displayName: Check if platform tools are installed and add to PATH
+
+- script: |
     set -e -x
 
     ORT_EXAMPLES_BUILD_ANDROID_EMULATOR_PID_FILE="$(Build.BinariesDirectory)/android_emulator.pid"
 
     python ./ci_build/python/run_android_emulator.py \
       --android-sdk-root "${ANDROID_SDK_ROOT}" \
-      --create-avd --system-image "system-images;android-30;default;x86_64" \
-      --start --emulator-extra-args="-partition-size 4096" \
+      --create-avd --system-image "system-images;android-31;default;x86_64" \
+      --start --emulator-extra-args="-partition-size 2047" \
       --emulator-pid-file "${ORT_EXAMPLES_BUILD_ANDROID_EMULATOR_PID_FILE}"
 
     set +x  # do not output next line or it may be parsed again with a trailing quote
@@ -20,7 +39,13 @@ steps:
 
 - ${{ parameters.steps }}
 
-- bash: |
+- script: |
+    set -e -x
+    python3 -m pip install psutil
+  displayName: Install psutil for emulator shutdown by run_android_emulator.py
+  condition: always()
+
+- script: |
     set -e -x
 
     if [[ -n "${ORT_EXAMPLES_BUILD_ANDROID_EMULATOR_PID_FILE-}" ]]; then

ci_build/azure_pipelines/templates/run-with-android-emulator-steps.yml

@@ -0,0 +1,24 @@
+parameters:
+- name: podfilePath
+  type: string
+- name: ortPodVersionSpecifier
+  type: string
+  default: ""
+- name: ortPodName
+  type: string
+  default: "onnxruntime-objc"
+
+steps:
+- bash: |
+    set -e
+
+    if [[ -z "${{ parameters.OrtPodVersionSpecifier }}" ]]; then
+      echo "Using original Podfile"
+      exit 0
+    fi
+
+    PODFILE="${{ parameters.PodfilePath }}"
+    ORT_POD_NAME="${{ parameters.OrtPodName }}"
+    sed -i "" -e "s/pod '${ORT_POD_NAME}'/pod '${ORT_POD_NAME}'$(OrtPodVersionSpecifier)/" "${PODFILE}"
+    cat "${PODFILE}"
+  displayName: "Update Podfile at ${{ parameters.PodfilePath }}"

ci_build/azure_pipelines/templates/update-podfile-step.yml

@@ -1,7 +1,7 @@
 parameters:
 - name: jdkVersion
   type: string
-  default: "11"
+  default: "17"
 
 steps:
 - task: JavaToolInstaller@0

ci_build/azure_pipelines/templates/use-jdk-step.yml

@@ -1,7 +1,12 @@
+parameters:
+- name: pythonVersion
+  type: string
+  default: "3.9"
+
 steps:
 - task: UsePythonVersion@0
   inputs:
-    versionSpec: '3.9'
+    versionSpec: "${{ parameters.pythonVersion }}"
     addToPath: true
     architecture: 'x64'
-  displayName: "Use Python 3.9"
+  displayName: "Use Python ${{ parameters.pythonVersion }}"

ci_build/azure_pipelines/templates/use-python-step.yml

@@ -7,48 +7,44 @@
 import shlex
 import sys
 
-from util.logger import get_logger
 import util.android as android
-
+from util.logger 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 start and stop (default), only start, or only "
-        "stop the 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("--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("--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(
-        "--android-sdk-root", required=True, help="Path to the Android SDK root.")
-    parser.add_argument(
-        "--system-image", default="system-images;android-29;google_apis;x86_64",
-        help="The Android system image package name.")
-    parser.add_argument(
-        "--avd-name", default="ort_android",
-        help="The Android virtual device name.")
+        "--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.")
+        "--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.")
+        "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:
-        # unspecified means start and stop
+    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:
@@ -84,10 +80,10 @@ def main():
         emulator_proc = android.start_emulator(**start_emulator_args)
 
         with open(args.emulator_pid_file, mode="w") as emulator_pid_file:
-            print("{}".format(emulator_proc.pid), file=emulator_pid_file)
+            print(f"{emulator_proc.pid}", file=emulator_pid_file)
 
     elif args.stop:
-        with open(args.emulator_pid_file, mode="r") as emulator_pid_file:
+        with open(args.emulator_pid_file) as emulator_pid_file:
             emulator_pid = int(emulator_pid_file.readline().strip())
 
         android.stop_emulator(emulator_pid)