[GL] Testing with the Android emulator on CI

Author: Gordon-F

.cargo/config

@@ -0,0 +1,8 @@
+[target.x86_64-linux-android]
+rustflags = [
+    "-C", "link-arg=-lc++_static",
+    "-C", "link-arg=-lc++abi",
+    "-C", "link-arg=-lEGL",
+    "-C", "link-arg=-lGLESv3",
+    "-C", "link-arg=-llog",
+]

.github/workflows/CI.yml

@@ -3,105 +3,35 @@ name: CI
 on:
   push:
     branches-ignore: [staging.tmp]
+    paths:
+    #- 'examples/quad_android/**'
+    #- '!examples/quad_android/**.md'
+    #- 'src/backend/gl/**'
+    #- '!src/backend/gl/**.md'
   pull_request:
     branches-ignore: [staging.tmp]
-
+    paths:
+    #- 'examples/quad_android/**'
+    #- '!examples/quad_android/**.md'
+    #- 'src/backend/gl/**'
+    #- '!src/backend/gl/**.md'
 jobs:
-  ios_build:
-    name: iOS Stable
-    runs-on: macos-10.15
-    env:
-      TARGET: aarch64-apple-ios
-    steps:
-      - uses: actions/checkout@v2
-      - name: Prepare Rust
-        run: rustup target add ${{ env.TARGET }}
-      - run: cargo check --manifest-path src/backend/metal/Cargo.toml --target ${{ env.TARGET }}
-
-  android_build:
-    name: Android Stable
-    runs-on: ubuntu-18.04
-    env:
-      TARGET: aarch64-linux-android
-    steps:
-      - uses: actions/checkout@v2
-      - run: echo "$ANDROID_HOME/ndk-bundle/toolchains/llvm/prebuilt/linux-x86_64/bin" >> $GITHUB_PATH
-      - name: Prepare Rust
-        run: rustup target add ${{ env.TARGET }}
-      - run: cargo check --manifest-path src/backend/vulkan/Cargo.toml --target ${{ env.TARGET }}
-      - run: cargo check --manifest-path src/backend/gl/Cargo.toml --target ${{ env.TARGET }}
-
-  webgl_build:
-    name: Web Assembly
-    runs-on: ubuntu-18.04
-    steps:
-      - uses: actions/checkout@v2
-      - run: rustup target add wasm32-unknown-unknown
-      - run: cargo build --manifest-path examples/Cargo.toml --features gl --target wasm32-unknown-unknown --bin quad
-
-  check-advisories:
-    name: Advisory Check
-    runs-on: ubuntu-18.04
-    steps:
-      - uses: actions/checkout@v2
-      - uses: EmbarkStudios/cargo-deny-action@v1
+  test:
+      runs-on: macos-10.15
+      steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: run tests
+        uses: reactivecircus/android-emulator-runner@v2
         with:
-          command: check advisories
-
-  check-dependencies:
-    name: Dependency Check
-    runs-on: ubuntu-18.04
-    steps:
-      - uses: actions/checkout@v2
-      - uses: EmbarkStudios/cargo-deny-action@v1
-        with:
-          command: check bans licenses sources
-
-  build:
-    name: ${{ matrix.name }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        name:
-          [
-            MacOS Stable,
-            MacOS Nightly,
-            Ubuntu Stable,
-            Ubuntu Nightly,
-            Windows Stable,
-            Windows Nightly,
-          ]
-        include:
-          - os: macos-10.15
-            name: MacOS Stable
-            channel: stable
-          - os: macos-10.15
-            name: MacOS Nightly
-            channel: nightly
-          - os: ubuntu-18.04
-            name: Ubuntu Stable
-            channel: stable
-          - os: ubuntu-18.04
-            name: Ubuntu Nightly
-            channel: nightly
-          - os: windows-2019
-            name: Windows Stable
-            channel: stable
-          - os: windows-2019
-            name: Windows Nightly
-            channel: nightly
-    steps:
-      - uses: actions/checkout@v2
-      - if: matrix.channel == 'nightly'
-        name: Install latest nightly
-        uses: actions-rs/toolchain@v1
+          api-level: 29
+          arch: x86_64
+          profile: Nexus 6
+          script: sh ./.github/workflows/android_test.sh
+      - uses: actions/upload-artifact@master
+        if: ${{ always() }}
         with:
-          toolchain: nightly
-          override: true
-      - if: matrix.os == 'windows-2019'
-        name: Install make
-        run: choco install make
-      #- if: matrix.channel == 'stable'
-      #  run: rustup component add clippy
-      - run: make all
+          name: screenshot
+          path: |
+            ~/screenshot.png
+            ~/logcat.log

.github/workflows/android_test.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+set -ex
+
+rustup target install x86_64-linux-android
+cargo install cargo-apk
+cargo apk run --package quad_android --target x86_64-linux-android
+
+sleep 30s
+
+adb shell /system/bin/screencap -p /sdcard/screenshot.png
+adb pull /sdcard/screenshot.png ~/screenshot.png
+adb logcat *:S RustStdoutStderr:V -d > ~/logcat.log
+
+if grep -e 'thread.*panicked at' ~/logcat.log;
+then
+    exit 1
+else
+    exit 0
+fi

Cargo.toml

@@ -13,6 +13,7 @@ members = [
     "src/hal",
     "src/warden",
     "examples",
+    "examples/quad_android",
 ]
 
 [patch."https://github.com/gfx-rs/naga"]

examples/quad_android/Cargo.toml

@@ -0,0 +1,37 @@
+[package]
+name = "quad_android"
+version = "0.1.0"
+publish = false
+workspace = "../.."
+edition = "2018"
+
+[lib]
+crate-type = ["cdylib"]
+
+[features]
+default = ["gl"]
+gl = ["gfx-backend-gl"]
+
+[target.'cfg(target_os = "android")'.dependencies]
+android_logger = "0.9"
+image = "0.23.12"
+log = "0.4"
+hal = { path = "../../src/hal", version = "0.6", package = "gfx-hal" }
+auxil = { path = "../../src/auxil/auxil", version = "0.5", package = "gfx-auxil" }
+gfx-backend-empty = { path = "../../src/backend/empty", version = "0.6" }
+winit = "0.23"
+ndk-glue = "0.2"
+
+[target.'cfg(target_os = "android")'.dependencies.gfx-backend-gl]
+path = "../../src/backend/gl"
+optional = true
+
+[package.metadata.android]
+package_name = "com.rust.game"
+label = "GfxQuad"
+# Vulkan supports on devices running Android API level 24 or higher.
+target_sdk_version = 29
+min_sdk_version = 29
+fullscreen = true
+opengles_version = [3, 0]
+orientation = "sensorLandscape"

examples/quad_android/README.md

@@ -0,0 +1,5 @@
+# Quad
+
+The following image is an output of `cargo run --bin quad --features=gl`:
+
+![screenshot](screenshot.png "Quad")

examples/quad_android/data/index.html

@@ -0,0 +1,18 @@
+<html>
+  <head>
+    <meta content="text/html;charset=utf-8" http-equiv="Content-Type"/>
+  </head>
+  <body>
+    <script src="./spirv_cross_wrapper_glsl.js"></script>
+    <script type="module">
+      import init from './quad.js';
+      window.addEventListener("load", () => {
+        const module = window.sc_internal_wrapper().then(module => {
+          window.sc_internal = module;
+          init('./quad_bg.wasm');
+        });
+      });
+    </script>
+  </body>
+</html>
+

examples/quad_android/data/logo.png

@@ -0,0 +1,12 @@
+#version 450
+#extension GL_ARB_separate_shader_objects : enable
+
+layout(location = 0) in vec2 v_uv;
+layout(location = 0) out vec4 target0;
+
+layout(set = 0, binding = 0) uniform texture2D u_texture;
+layout(set = 0, binding = 1) uniform sampler u_sampler;
+
+void main() {
+    target0 = texture(sampler2D(u_texture, u_sampler), v_uv);
+}

examples/quad_android/data/quad.frag

@@ -0,0 +1,18 @@
+#version 450
+#extension GL_ARB_separate_shader_objects : enable
+
+// see colour-uniform example for the case where this is a push constant
+const float scale = 1.2f;
+
+layout(location = 0) in vec2 a_pos;
+layout(location = 1) in vec2 a_uv;
+layout(location = 0) out vec2 v_uv;
+
+out gl_PerVertex {
+    vec4 gl_Position;
+};
+
+void main() {
+    v_uv = a_uv;
+    gl_Position = vec4(scale * a_pos, 0.0, 1.0);
+}