chore: Utilize app-runner for Desktop (#2569)

Author: bitsandfoxes

.github/workflows/ci.yml

@@ -98,8 +98,8 @@ jobs:
     with:
       unity-version: ${{ matrix.unity-version }}
 
-  # A Linux, docker-based build to prepare a game ("player") for some platforms. The tests run in `smoke-test-run`.
-  smoke-test-build:
+  # A Linux, docker-based build to prepare a WebGL player. The tests run in `smoke-test-run`.
+  smoke-test-build-webgl:
     name: Build ${{ matrix.platform }} ${{ matrix.unity-version }} Smoke Test
     if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
     needs: [smoke-test-create, create-unity-matrix]
@@ -108,15 +108,11 @@ jobs:
       fail-fast: false
       matrix:
         unity-version: ${{ fromJSON(needs.create-unity-matrix.outputs.unity-matrix).unity-version }}
-        platform: ["WebGL", "Linux"]
+        platform: ["WebGL"]
         include:
           - platform: WebGL
             check_symbols: true
             build_platform: WebGL
-          - platform: Linux
-            image-suffix: "-il2cpp"
-            check_symbols: true
-            build_platform: Linux            
     env:
       UNITY_PATH: docker exec unity unity-editor
     steps:
@@ -328,16 +324,16 @@ jobs:
         # Also make sure to match the versions available here:
         #  - https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md
 
-  smoke-test-run:
+  smoke-test-run-webgl:
     name: Run ${{ matrix.platform }} ${{ matrix.unity-version }} Smoke Test
     if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
-    needs: [smoke-test-build, create-unity-matrix]
+    needs: [smoke-test-build-webgl, create-unity-matrix]
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         unity-version: ${{ fromJSON(needs.create-unity-matrix.outputs.unity-matrix).unity-version }}
-        platform: ["WebGL", "Linux"]
+        platform: ["WebGL"]
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -352,133 +348,70 @@ jobs:
         run: tar -xvzf test-app-runtime.tar.gz
 
       - name: Run (WebGL)
-        if: ${{ matrix.platform == 'WebGL' }}
         timeout-minutes: 10
         run: |
           pip3 install --upgrade --user selenium urllib3 requests
           python3 scripts/smoke-test-webgl.py "samples/IntegrationTest/Build"
 
-      - name: Run Smoke Test (Linux)
-        if: ${{ matrix.platform == 'Linux' }}
-        run: ./test/Scripts.Integration.Test/run-smoke-test.ps1 -Smoke
-
-      - name: Run Crash Test (Linux)
-        if: ${{ matrix.platform == 'Linux' }}
-        run: ./test/Scripts.Integration.Test/run-smoke-test.ps1 -Crash
-
-  desktop-smoke-test:
-    name: Run ${{ matrix.os }} ${{ matrix.unity-version }} Smoke Test
+  smoke-test-build-linux:
+    name: Build Linux ${{ matrix.unity-version }} Integration Test
     if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
-    needs: [smoke-test-create, create-unity-matrix, build-unity-sdk]
-    runs-on: ${{ matrix.os }}-latest
+    needs: [smoke-test-create, create-unity-matrix]
+    secrets: inherit
     strategy:
       fail-fast: false
       matrix:
         unity-version: ${{ fromJSON(needs.create-unity-matrix.outputs.unity-matrix).unity-version }}
-        os: ["windows"]
-        include:
-          - os: windows
-            unity-modules: "windows-il2cpp"
-            unity-config-path: "C:/ProgramData/Unity/config/"
-        # os: ["windows", "macos"]
-        # include:
-          # - os: macos
-          #   unity-modules: mac-il2cpp
-          #   unity-config-path: /Library/Application Support/Unity/config/
-    steps:
-      - name: Checkout
-        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
-
-      - name: Load env
-        id: env
-        run: echo "unityVersion=$(./scripts/ci-env.ps1 "$env:UNITY_SCRIPT_ARG")" >> $env:GITHUB_OUTPUT
-        env:
-          UNITY_SCRIPT_ARG: unity${{ matrix.unity-version }}
-
-      - name: Setup Unity
-        uses: getsentry/setup-unity@3bdc8c022b6d30ecf2d21d12a564bfa55a54fa2e
-        with:
-          unity-version: ${{ steps.env.outputs.unityVersion }}
-          unity-modules: ${{ matrix.unity-modules }}
-
-      - name: Create Unity license config
-        run: |
-          New-Item -Path "$env:UNITY_CONFIG_PATH" -ItemType Directory
-          Set-Content -Path "$env:UNITY_CONFIG_PATH/services-config.json" -Value "$env:UNITY_LICENSE_SERVER_CONFIG"
-        env:
-          UNITY_CONFIG_PATH: ${{ matrix.unity-config-path }}
-          UNITY_LICENSE_SERVER_CONFIG: ${{ secrets.UNITY_LICENSE_SERVER_CONFIG }}
-
-      - name: Download IntegrationTest project
-        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
-        with:
-          name: smoke-test-${{ matrix.unity-version }}
-
-      - name: Extract project archive
-        run: tar -xvzf test-project.tar.gz
-
-      - name: Cache Unity Library
-        uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
-        with:
-          path: samples/IntegrationTest/Library
-          key: Library-IntegrationTest-${{ matrix.os }}-${{ matrix.unity-version }}-v1
-          restore-keys: |
-            Library-IntegrationTest-${{ matrix.os }}-${{ matrix.unity-version }}-
-            Library-IntegrationTest-${{ matrix.os }}-
-
-      - name: Restore cached build without Sentry
-        id: cache-build-nosentry
-        uses: actions/cache@v4
-        with:
-          path: samples/IntegrationTest/Build-NoSentry
-          key: build-nosentry-Windows-${{ matrix.unity-version }}
-
-      - name: Build without Sentry SDK
-        if: steps.cache-build-nosentry.outputs.cache-hit != 'true'
-        run: ./test/Scripts.Integration.Test/build-project.ps1 -UnityPath "$env:UNITY_PATH" -CheckSymbols:$false -BuildDirName "Build-NoSentry"
-
-      - name: Download UPM package
-        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
-        with:
-          name: package-release
-
-      - name: Extract UPM package
-        run: ./test/Scripts.Integration.Test/extract-package.ps1
-
-      - name: Add Sentry to the project
-        run: ./test/Scripts.Integration.Test/add-sentry.ps1 -UnityPath "$env:UNITY_PATH" -PackagePath "test-package-release"
-
-      - name: Configure Sentry
-        run: ./test/Scripts.Integration.Test/configure-sentry.ps1 -UnityPath "$env:UNITY_PATH" -CheckSymbols
-
-      - name: Build with Sentry SDK
-        run: ./test/Scripts.Integration.Test/build-project.ps1 -UnityPath "$env:UNITY_PATH" -CheckSymbols -UnityVersion "$env:UNITY_VERSION"
-        env:
-          UNITY_VERSION: ${{ matrix.unity-version }}
-
-      - name: Compare build sizes
-        run: ./test/Scripts.Integration.Test/measure-build-size.ps1 -Path1 "samples/IntegrationTest/Build-NoSentry" -Path2 "samples/IntegrationTest/Build" -Platform "Windows" -UnityVersion "$env:UNITY_VERSION"
-        env:
-          UNITY_VERSION: ${{ matrix.unity-version }}
+    uses: ./.github/workflows/smoke-test-build-linux.yml
+    with:
+      unity-version: ${{ matrix.unity-version }}
 
-      - name: Upload build size measurement
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
-        with:
-          name: build-size-Windows-${{ matrix.unity-version }}
-          path: build-size-measurements/*.json
-          retention-days: 1
+  smoke-test-build-windows:
+    name: Build Windows ${{ matrix.unity-version }} Integration Test
+    if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
+    needs: [smoke-test-create, create-unity-matrix]
+    secrets: inherit
+    strategy:
+      fail-fast: false
+      matrix:
+        unity-version: ${{ fromJSON(needs.create-unity-matrix.outputs.unity-matrix).unity-version }}
+    uses: ./.github/workflows/smoke-test-build-windows.yml
+    with:
+      unity-version: ${{ matrix.unity-version }}
 
-      - name: Run Smoke Test
-        run: ./test/Scripts.Integration.Test/run-smoke-test.ps1 -Smoke
+  smoke-test-run-linux:
+    name: Run Linux ${{ matrix.unity-version }} Integration Test
+    if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
+    needs: [smoke-test-build-linux, create-unity-matrix]
+    secrets: inherit
+    strategy:
+      fail-fast: false
+      matrix:
+        unity-version: ${{ fromJSON(needs.create-unity-matrix.outputs.unity-matrix).unity-version }}
+    uses: ./.github/workflows/smoke-test-run-desktop.yml
+    with:
+      unity-version: ${{ matrix.unity-version }}
+      platform: linux
 
-      - name: Run Crash Test
-        run: ./test/Scripts.Integration.Test/run-smoke-test.ps1 -Crash
+  smoke-test-run-windows:
+    name: Run Windows ${{ matrix.unity-version }} Integration Test
+    if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
+    needs: [smoke-test-build-windows, create-unity-matrix]
+    secrets: inherit
+    strategy:
+      fail-fast: false
+      matrix:
+        unity-version: ${{ fromJSON(needs.create-unity-matrix.outputs.unity-matrix).unity-version }}
+    uses: ./.github/workflows/smoke-test-run-desktop.yml
+    with:
+      unity-version: ${{ matrix.unity-version }}
+      platform: windows
 
   build-size-summary:
     name: Build Size
     runs-on: ubuntu-latest
     if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
-    needs: [smoke-test-build, smoke-test-build-android, smoke-test-compile-ios, desktop-smoke-test]
+    needs: [smoke-test-build-webgl, smoke-test-build-android, smoke-test-compile-ios, smoke-test-build-linux, smoke-test-build-windows]
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.github/workflows/smoke-test-build-android.yml

@@ -35,6 +35,7 @@ jobs:
         shell: bash
         env:
           UNITY_LICENSE_SERVER_CONFIG: ${{ secrets.UNITY_LICENSE_SERVER_CONFIG }}
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
 
       - name: Download IntegrationTest project
         uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4

.github/workflows/smoke-test-build-ios.yml

@@ -41,6 +41,7 @@ jobs:
         shell: bash
         env:
           UNITY_LICENSE_SERVER_CONFIG: ${{ secrets.UNITY_LICENSE_SERVER_CONFIG }}
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
 
       - name: Download IntegrationTest project
         uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4

.github/workflows/smoke-test-build-linux.yml

@@ -0,0 +1,145 @@
+name: "IntegrationTest: Build Linux"
+on:
+  workflow_call:
+    inputs:
+      unity-version:
+        required: true
+        type: string
+
+defaults:
+  run:
+    shell: pwsh
+
+jobs:
+  build:
+    name: Linux ${{ inputs.unity-version }}
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_ACTOR: ${{ github.actor }}
+      UNITY_PATH: docker exec unity unity-editor
+      UNITY_VERSION: ${{ inputs.unity-version }}
+      BUILD_PLATFORM: Linux
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
+
+      - name: Free Disk Space
+        uses: jlumbroso/free-disk-space@f68fdb76e2ea636224182cfb7377ff9a1708f9b8 # v1.3.0
+        with:
+          android: true
+          dotnet: false
+          haskell: true
+          large-packages: false
+          docker-images: false
+          swap-storage: true
+
+      - name: Log into Docker
+        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # pinned v3
+        with:
+          registry: ghcr.io
+          username: ${{ env.GITHUB_ACTOR }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Start the Unity docker container
+        run: ./scripts/ci-docker.sh "$UNITY_VERSION" "Linux-il2cpp" "$UNITY_LICENSE_SERVER_CONFIG"
+        shell: bash
+        env:
+          UNITY_LICENSE_SERVER_CONFIG: ${{ secrets.UNITY_LICENSE_SERVER_CONFIG }}
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+
+      - name: Download IntegrationTest project
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
+        with:
+          name: smoke-test-${{ env.UNITY_VERSION }}
+
+      - name: Extract project archive
+        run: tar -xvzf test-project.tar.gz
+
+      - name: Cache Unity Library
+        uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
+        with:
+          path: samples/IntegrationTest/Library
+          key: Library-IntegrationTest-linux-${{ env.UNITY_VERSION }}-v1
+          restore-keys: |
+            Library-IntegrationTest-linux-${{ env.UNITY_VERSION }}-
+            Library-IntegrationTest-linux-
+
+      - name: Restore cached build without Sentry
+        id: cache-build-nosentry
+        uses: actions/cache@v4
+        with:
+          path: samples/IntegrationTest/Build-NoSentry
+          key: build-nosentry-Linux-${{ inputs.unity-version }}
+
+      - name: Build without Sentry SDK
+        if: steps.cache-build-nosentry.outputs.cache-hit != 'true'
+        run: ./test/Scripts.Integration.Test/build-project.ps1 -UnityPath "$env:UNITY_PATH" -Platform Linux -CheckSymbols:$false -BuildDirName "Build-NoSentry"
+
+      - name: Download UPM package
+        uses: vaind/download-artifact@e7141b6a94ef28aa3d828b52830cfa1f406a1848 # v4-with-wait-timeout
+        with:
+          name: package-release
+          wait-timeout: 3600
+
+      - name: Extract UPM package
+        run: ./test/Scripts.Integration.Test/extract-package.ps1
+
+      - name: Add Sentry to the project
+        run: ./test/Scripts.Integration.Test/add-sentry.ps1 -UnityPath "$env:UNITY_PATH" -PackagePath "test-package-release"
+
+      - name: Configure Sentry
+        run: ./test/Scripts.Integration.Test/configure-sentry.ps1 -UnityPath "$env:UNITY_PATH" -Platform Linux -TestMode "integration"
+        env:
+          SENTRY_DSN: ${{ secrets.SENTRY_TEST_DSN }}
+
+      - name: Build with Sentry SDK
+        run: ./test/Scripts.Integration.Test/build-project.ps1 -UnityPath "$env:UNITY_PATH" -Platform Linux -CheckSymbols:$false -UnityVersion "$env:UNITY_VERSION"
+
+      - name: Compare build sizes
+        run: ./test/Scripts.Integration.Test/measure-build-size.ps1 -Path1 "samples/IntegrationTest/Build-NoSentry" -Path2 "samples/IntegrationTest/Build" -Platform Linux -UnityVersion "$env:UNITY_VERSION"
+
+      - name: Upload build size measurement
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: build-size-Linux-${{ env.UNITY_VERSION }}
+          path: build-size-measurements/*.json
+          retention-days: 1
+
+      # We create tar explicitly because upload-artifact is slow for many files.
+      - name: Create archive
+        run: |
+          Remove-Item -Recurse -Force samples/IntegrationTest/Build/*_BackUpThisFolder_ButDontShipItWithYourGame -ErrorAction SilentlyContinue
+          tar -cvzf test-app-desktop.tar.gz samples/IntegrationTest/Build
+
+      - name: Upload test app
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: testapp-desktop-compiled-${{ env.UNITY_VERSION }}-linux
+          if-no-files-found: error
+          path: test-app-desktop.tar.gz
+          retention-days: 14
+
+      - name: Docker diagnostics on failure
+        if: ${{ failure() }}
+        run: |
+          Write-Host "=== Docker container status ==="
+          docker ps -a --filter "name=^/unity$"
+
+          Write-Host "`n=== Working directory ==="
+          docker exec unity pwd
+
+          Write-Host "`n=== Unity log from container ==="
+          docker exec unity cat /sentry-unity/unity.log 2>&1 || echo "unity.log not found"
+        continue-on-error: true
+
+      - name: Upload IntegrationTest project on failure
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: failed-project-desktop-linux-${{ env.UNITY_VERSION }}
+          path: |
+            samples/IntegrationTest
+            unity.log
+            !samples/IntegrationTest/Build/*_BackUpThisFolder_ButDontShipItWithYourGame
+          retention-days: 14