[AISW-143208] build_and_test.py can run Android tests on local device (microsoft#181)

Author: jeffkilpatrick

qcom/build_and_test.py

@@ -22,9 +22,11 @@
     task,
 )
 from ep_build.task import (
+    CompositeTask,
     ExtractArchiveTask,
     ListTasksTask,
     NoOpTask,
+    PyTestTask,
 )
 from ep_build.tasks.build import (
     BuildEpLinuxTask,
@@ -37,6 +39,7 @@
     REPO_ROOT,
     is_host_arm64,
     is_host_linux,
+    is_host_mac,
     is_host_windows,
 )
 
@@ -153,7 +156,7 @@ def to_dot(highlight: list[str] | None = None) -> str:
     @task
     @depends(["build_ort_android"])
     def archive_ort_android(self, plan: Plan) -> str:
-        if is_host_linux():
+        if is_host_linux() or is_host_mac():
             return plan.add_step(
                 BuildEpLinuxTask(
                     "Archiving ONNX Runtime for Android",
@@ -234,7 +237,7 @@ def build(self, plan: Plan) -> str:
     @task
     @depends(["create_venv"])
     def build_ort_android(self, plan: Plan) -> str:
-        if is_host_linux():
+        if is_host_linux() or is_host_mac():
             return plan.add_step(
                 BuildEpLinuxTask(
                     "Building ONNX Runtime for Android",
@@ -392,6 +395,37 @@ def test_ort_linux(self, plan: Plan) -> str:
             )
         )
 
+    @task
+    @depends(["archive_ort_android"])
+    def test_ort_local_android(self, plan: Plan) -> str:
+        env = dict(os.environ)
+        test_root = REPO_ROOT / "build" / "qdc_test_root"
+        env["QDC_TEST_ROOT"] = str(test_root)
+
+        # This is a pretty slow way to do this, but it's easy to implement
+        # and essentially free to maintain. If you find yourself using this
+        # often enough that your life would be better if we didn't roundtrip
+        # through a zip file, please open a Jira and we'll invest more here.
+        return plan.add_step(
+            CompositeTask(
+                group_name=None,
+                tasks=[
+                    ExtractArchiveTask(
+                        "Extracting ONNX Runtime for Android",
+                        REPO_ROOT / "build" / "onnxruntime-tests-android.zip",
+                        test_root,
+                    ),
+                    PyTestTask(
+                        "Testing ONNX Runtime for Android with a local device",
+                        self.__venv_path,
+                        ["tests"],
+                        env=env,
+                        cwd=REPO_ROOT / "qcom" / "scripts" / "linux" / "appium",
+                    ),
+                ],
+            )
+        )
+
     @task
     @depends(["archive_ort_android"])
     def test_ort_qdc_android(self, plan: Plan) -> str:

qcom/ep_build/task.py

@@ -291,3 +291,16 @@ def run_task(self) -> None:
             self.true_task.run()
         else:
             self.false_task.run()
+
+
+class PyTestTask(RunExecutablesWithVenvTask):
+    def __init__(
+        self,
+        group_name: str | None,
+        venv: Path | None,
+        files_or_dirs: list[str],
+        env: Mapping[str, str] | None = None,
+        cwd: Path | None = None,
+    ):
+        cmd = [["pytest", *files_or_dirs]]
+        super().__init__(group_name, venv, cmd, env, cwd)

qcom/packages.yml

@@ -17,6 +17,11 @@ ccache_linux:
   url: https://github.com/ccache/ccache/releases/download/v{version}/ccache-{version}-linux-x86_64.tar.xz
   sha256: 7766991b91b3a5a177ab33fa043fe09e72c68586d5a86d20a563a05b74f119c0
   content_root: ccache-{version}-linux-x86_64
+ccache_macos:
+  version: 4.11.3
+  url: https://github.com/ccache/ccache/releases/download/v{version}/ccache-{version}-darwin.tar.gz
+  sha256: 6f187a79fc57864d900aff28f9c3f93d020ed7a849be2f2ead6799959ccf30b0
+  content_root: ccache-{version}-darwin
 ccache_windows_x86_64:
   version: 4.11.3
   url: https://github.com/ccache/ccache/releases/download/v{version}/ccache-{version}-windows-x86_64.zip
@@ -28,6 +33,12 @@ cmake_linux:
   sha256: 14e15d0b445dbeac686acc13fe13b3135e8307f69ccf4c5c91403996ce5aa2d4
   content_root: cmake-{version}-linux-x86_64
   bindir: bin
+cmake_macos:
+  version: 3.31.7
+  url: https://github.com/Kitware/CMake/releases/download/v{version}/cmake-{version}-macos-universal.tar.gz
+  sha256: 1cb11aa2edae8551bb0f22807c6f5246bd0eb60ae9fa1474781eb4095d299aca
+  content_root: cmake-{version}-macos-universal/CMake.app/Contents
+  bindir: bin
 cmake_windows_x86_64:
   version: 3.31.7
   url: https://github.com/Kitware/CMake/releases/download/v{version}/cmake-{version}-windows-x86_64.zip
@@ -41,6 +52,13 @@ java_linux:
   sha256: 9c2f7c39e0d5b296ce50e563740694b2ebfe4a620415d1b2b848ba47bebceb47
   content_root: jdk-{version}
   bindir: bin
+java_macos:
+  major_version: 21
+  version: 21.0.5
+  url: https://download.oracle.com/java/{major_version}/archive/jdk-{version}_macos-aarch64_bin.tar.gz
+  sha256: 13cb8d754069fc76a2ff6eee96273cc1a96cb47ecf3afa7820407635c386dd37
+  content_root: jdk-{version}.jdk/Contents/Home
+  bindir: bin
 java_windows_x86_64:
   major_version: 21
   version: 21.0.5
@@ -52,6 +70,10 @@ ninja_linux:
   version: 1.12.1
   url: https://github.com/ninja-build/ninja/releases/download/v{version}/ninja-linux.zip
   sha256: 6f98805688d19672bd699fbbfa2c2cf0fc054ac3df1f0e6a47664d963d530255
+ninja_macos:
+  version: 1.12.1
+  url: https://github.com/ninja-build/ninja/releases/download/v{version}/ninja-mac.zip
+  sha256: 89a287444b5b3e98f88a945afa50ce937b8ffd1dcc59c555ad9b1baf855298c9
 ninja_windows_x86_64:
   version: 1.12.1
   url: https://github.com/ninja-build/ninja/releases/download/v{version}/ninja-win.zip

qcom/scripts/linux/appium/tests/test_ort.py

@@ -64,5 +64,5 @@ def __get_test_cmd(test_cmd: list[str]) -> str:
             f"echo -=-=-=-=-=-=-=-=-=-=- >> {ORT_TEST_RESULTS_DEVICE_LOG} && "
             f"echo Running test: {test_str} >> {ORT_TEST_RESULTS_DEVICE_LOG} && "
             f"env ADSP_LIBRARY_PATH={QNN_ADSP_LIBRARY_PATH} LD_LIBRARY_PATH={QNN_LD_LIBRARY_PATH} "
-            f"{test_str} >> {ORT_TEST_RESULTS_DEVICE_LOG} 2>&1"
+            f"{test_str} 2>&1 | tee -a {ORT_TEST_RESULTS_DEVICE_LOG}"
         )

qcom/scripts/linux/tools.sh

@@ -20,28 +20,42 @@ function clean_tools_dir() {
 function get_android_ndk_root() {
     python \
         "${REPO_ROOT}/qcom/scripts/all/install_ndk.py" \
-        "--cli-tools-root=$(get_package_contentdir android_commandlinetools_linux)"
+        "--cli-tools-root=$(get_package_contentdir android_commandlinetools_$(get_host_platform))"
 }
 
 #
 # Get the Android SDK root (ANDROID_HOME)
 #
 function get_android_sdk_root() {
-    realpath $(get_package_contentdir android_commandlinetools_linux)/..
+    realpath $(get_package_contentdir android_commandlinetools_$(get_host_platform))/..
 }
 
 #
 # Get the directory containing ccache, installing it if necessary.
 #
 function get_ccache_bindir() {
-    get_package_bindir ccache_linux
+    get_package_bindir ccache_$(get_host_platform)
 }
 
 #
 # Get the directory containing CMake binaries, installing them if necessary.
 #
 function get_cmake_bindir() {
-    get_package_bindir cmake_linux
+    get_package_bindir cmake_$(get_host_platform)
+}
+
+function get_host_platform() {
+    case `uname` in
+        Darwin)
+            echo "macos"
+            ;;
+        Linux)
+            echo "linux"
+            ;;
+        *)
+            die "Unknown host platform"
+            ;;
+    esac
 }
 
 #
@@ -51,15 +65,15 @@ function get_java_bindir() {
   if [ -n "${JAVA_HOME:-}" ]; then
     log_debug "JAVA_HOME found at ${JAVA_HOME}"
   else
-    get_package_bindir java_linux
+    get_package_bindir java_$(get_host_platform)
   fi
 }
 
 #
 # Get the directory containing ninja, installing it if necessary.
 #
 function get_ninja_bindir() {
-    get_package_bindir ninja_linux
+    get_package_bindir ninja_$(get_host_platform)
 }
 
 function get_package_bindir() {