Install Unity on GHA with a different tool (#532)

a-maurice · web-flow · commit a6c5bad6faf2 · 2022-11-14T14:32:36.000-08:00
* Add Unity install fallback logic

* Update unity_installer.py

* Try downloading the installer differently

* Update action.yml

* Update action.yml

* Download the installer a different way

* More attempts

* Update build_windows.yml

* Update build_windows.yml

* Update build_windows.yml

* Update build_windows.yml

* Update build_windows.yml

* Update build_windows.yml

* Update build_windows.yml

* Update build_windows.yml

* Update build_windows.yml

* Update build_windows.yml

* Update build_windows.yml

* Use setup unity for all builds

* Update integration test installer method

* Update integration_tests.yml

* Update integration_tests.yml

* Update integration_tests.yml

* Update integration_tests.yml

* Update integration_tests.yml

* Update integration_tests.yml

* Update integration_tests.yml

* Update scripts

* Fix timeout settings
diff --git a/.github/workflows/build_android.yml b/.github/workflows/build_android.yml
@@ -101,13 +101,13 @@ jobs:
         shell: bash
         run: |
           pip install -r scripts/gha/requirements.txt
-      
-      - id: unity_setup
-        uses: ./gha/unity
+
+      - name: Setup Unity
+        uses: kuler90/setup-unity@v1
         timeout-minutes: 30
         with:
-          version: ${{ inputs.unity_version }}
-          platforms: ${{ inputs.unity_platform_name }}
+          unity-version: 2020.3.34f1
+          unity-modules: android
 
       - name: Display Swig Version
         shell: bash
diff --git a/.github/workflows/build_ios.yml b/.github/workflows/build_ios.yml
@@ -81,12 +81,12 @@ jobs:
         run: |
           pip install -r scripts/gha/requirements.txt
       
-      - id: unity_setup
-        uses: ./gha/unity
+      - name: Setup Unity
+        uses: kuler90/setup-unity@v1
         timeout-minutes: 30
         with:
-          version: ${{ inputs.unity_version }}
-          platforms: ${{ inputs.unity_platform_name }}
+          unity-version: 2020.3.34f1
+          unity-modules: ios
 
       - name: Build SDK (iOS)
         timeout-minutes: 90
diff --git a/.github/workflows/build_linux.yml b/.github/workflows/build_linux.yml
@@ -83,12 +83,11 @@ jobs:
         run: |
           sudo apt install openssl
 
-      - id: unity_setup
-        uses: ./gha/unity
+      - name: Setup Unity
+        uses: kuler90/setup-unity@v1
         timeout-minutes: 30
         with:
-          version: ${{ inputs.unity_version }}
-          platforms: ${{ inputs.unity_platform_name }}
+          unity-version: 2020.3.40f1
 
       - name: Setup Swig Env
         shell: bash
diff --git a/.github/workflows/build_macos.yml b/.github/workflows/build_macos.yml
@@ -97,12 +97,13 @@ jobs:
           # brew won't overwrite MacOS system default OpenSSL, so force it here.
           echo "OPENSSL_ROOT_DIR=$(brew --prefix openssl --installed)" >> $GITHUB_ENV
 
-      - id: unity_setup
-        uses: ./gha/unity
+      - name: Setup Unity
+        uses: kuler90/setup-unity@v1
         timeout-minutes: 30
         with:
-          version: ${{ inputs.unity_version }}
-          platforms: ${{ inputs.unity_platform_name }}
+          unity-version: 2020.3.34f1
+          # Include iOS for the editor tools
+          unity-modules: ios
 
       - name: Setup Swig Env
         shell: bash
diff --git a/.github/workflows/build_tvos.yml b/.github/workflows/build_tvos.yml
@@ -108,12 +108,12 @@ jobs:
         run: |
           pod repo add cocoapods https://github.com/CocoaPods/Specs.git
 
-      - id: unity_setup
-        uses: ./gha/unity
+      - name: Setup Unity
+        uses: kuler90/setup-unity@v1
         timeout-minutes: 30
         with:
-          version: ${{ inputs.unity_version }}
-          platforms: ${{ inputs.unity_platform_name }}
+          unity-version: 2020.3.34f1
+          unity-modules: appletv
 
       - name: Build SDK (tvOS)
         timeout-minutes: 90
diff --git a/.github/workflows/build_windows.yml b/.github/workflows/build_windows.yml
@@ -89,12 +89,11 @@ jobs:
         run: |
           choco install openssl -r
 
-      - id: unity_setup
-        uses: ./gha/unity
+      - name: Setup Unity
+        uses: kuler90/setup-unity@v1
         timeout-minutes: 30
         with:
-          version: ${{ inputs.unity_version }}
-          platforms: ${{ inputs.unity_platform_name }}
+          unity-version: 2020.3.34f1
 
       - name: Setup Swig Env
         shell: bash
diff --git a/.github/workflows/integration_tests.yml b/.github/workflows/integration_tests.yml
@@ -184,15 +184,72 @@ jobs:
       - name: setup Xcode version
         if: runner.os == 'macOS'
         run: sudo xcode-select -s /Applications/Xcode_${{ env.xcodeVersion }}.app/Contents/Developer
-      - id: unity_setup
-        uses: ./gha/unity
+
+      - name: Setup Unity (Android)
+        if: ${{ contains(matrix.platform, 'Android') }}
+        uses: kuler90/setup-unity@v1
+        timeout-minutes: 30
+        with:
+          unity-version: 2020.3.34f1
+          unity-modules: android
+      # Because of a bug, include iOS for the editor tools
+      - name: Setup Unity (Android, Part 2)
+        if: ${{ contains(matrix.platform, 'Android') }}
+        uses: kuler90/setup-unity@v1
+        timeout-minutes: 30
+        with:
+          unity-version: 2020.3.34f1
+          unity-modules: ios
+
+      - name: Setup Unity (iOS)
+        if: ${{ contains(matrix.platform, 'iOS') }}
+        uses: kuler90/setup-unity@v1
+        timeout-minutes: 30
+        with:
+          unity-version: 2020.3.34f1
+          unity-modules: ios
+
+      - name: Setup Unity (Desktop Windows)
+        if: ${{ !contains(matrix.platform, 'Android') && !contains(matrix.platform, 'iOS') && runner.os != 'macOS' }}
+        uses: kuler90/setup-unity@v1
+        timeout-minutes: 30
+        with:
+          unity-version: 2020.3.34f1
+          unity-modules: mac-mono
+      - name: Setup Unity (Desktop Windows Part 2)
+        if: ${{ !contains(matrix.platform, 'Android') && !contains(matrix.platform, 'iOS') && runner.os != 'macOS' }}
+        uses: kuler90/setup-unity@v1
+        timeout-minutes: 30
+        with:
+          unity-version: 2020.3.34f1
+          unity-modules: linux-mono
+
+      - name: Setup Unity (Desktop macOS)
+        if: ${{ !contains(matrix.platform, 'Android') && !contains(matrix.platform, 'iOS') && runner.os == 'macOS' }}
+        uses: kuler90/setup-unity@v1
+        timeout-minutes: 30
+        with:
+          unity-version: 2020.3.34f1
+          unity-modules: windows-mono
+      - name: Setup Unity (Desktop macOS Part 2)
+        if: ${{ !contains(matrix.platform, 'Android') && !contains(matrix.platform, 'iOS') && runner.os == 'macOS' }}
+        uses: kuler90/setup-unity@v1
         timeout-minutes: 30
         with:
-          version: ${{ matrix.unity_version }}
-          platforms: ${{ matrix.platform }}
-          username: ${{ secrets.UNITY_USERNAME }}
-          password: ${{ secrets.UNITY_PASSWORD }}
-          serial_ids: ${{ secrets.SERIAL_ID }}
+          unity-version: 2020.3.34f1
+          unity-modules: linux-mono
+
+      - name: Activate Unity license
+        shell: bash
+        run: |
+          python gha/unity/unity_installer.py --activate_license \
+            --version 2020  \
+            --username "${{ secrets.UNITY_USERNAME }}" \
+            --password "${{ secrets.UNITY_PASSWORD }}" \
+            --serial_ids "${{ secrets.SERIAL_ID }}" \
+            --logfile "testapps/activate_license.log"
+          cat testapps/activate_license.log
+
       - name: Prepare for integration tests
         timeout-minutes: 10
         shell: bash
@@ -218,21 +275,28 @@ jobs:
           fi
           python scripts/gha/build_testapps.py \
             --t ${{ needs.check_and_prepare.outputs.apis }} \
-            --u "${{ steps.unity_setup.outputs.unity_version }}" \
+            --u 2020.3.34f1 \
             --p "${{ matrix.platform }}" \
             --ios_sdk "${{ matrix.ios_sdk }}" \
             --plugin_dir ~/Downloads/firebase_unity_sdk \
             --output_directory "${{ github.workspace }}" \
             --artifact_name "${{ steps.matrix_info.outputs.info }}" \
             --force_latest_runtime \
             --ci
+
       - name: Return Unity license
-        # Always returns true, even when job failed or canceled. But will not run when a critical failure prevents the task from running. 
         if: always()
-        uses: ./gha/unity
+        uses: nick-invision/retry@v2
         with:
-          version: ${{ matrix.unity_version }}
-          release_license: "true"
+          timeout_minutes: 5
+          max_attempts: 2
+          shell: bash
+          command: |
+            python gha/unity/unity_installer.py --release_license \
+              --version 2020 \
+              --logfile "testapps/release_license.log"
+            cat testapps/release_license.log
+
       - name: Prepare results summary artifact
         if: ${{ !cancelled() }}
         shell: bash
@@ -358,14 +422,23 @@ jobs:
         shell: bash
         run: |
           pip install -r scripts/gha/requirements.txt
-      - id: unity_setup
-        uses: ./gha/unity
+      - name: Setup Unity
+        uses: kuler90/setup-unity@v1
         timeout-minutes: 30
         with:
-          version: ${{ matrix.unity_version }}
-          username: ${{ secrets.UNITY_USERNAME }}
-          password: ${{ secrets.UNITY_PASSWORD }}
-          serial_ids: ${{ secrets.SERIAL_ID }}
+          unity-version: 2020.3.34f1
+          # Install ios for the editor tools
+          unity-modules: ios
+      - name: Activate Unity license
+        shell: bash
+        run: |
+          python gha/unity/unity_installer.py --activate_license \
+            --version 2020  \
+            --username "${{ secrets.UNITY_USERNAME }}" \
+            --password "${{ secrets.UNITY_PASSWORD }}" \
+            --serial_ids "${{ secrets.SERIAL_ID }}" \
+            --logfile "testapps/activate_license.log"
+          cat testapps/activate_license.log
       - name: Prepare for integration tests
         timeout-minutes: 10
         shell: bash
@@ -389,20 +462,25 @@ jobs:
           fi
           python scripts/gha/build_testapps.py \
             --t ${{ needs.check_and_prepare.outputs.apis }} \
-            --u ${{ steps.unity_setup.outputs.unity_version }} \
+            --u 2020.3.34f1 \
             --p Playmode \
             --plugin_dir ~/Downloads/firebase_unity_sdk \
             --output_directory "${{ github.workspace }}" \
             --artifact_name "${{ steps.matrix_info.outputs.info }}" \
             --force_latest_runtime \
             --ci
       - name: Return Unity license
-        # Always returns true, even when job failed or canceled. But will not run when a critical failure prevents the task from running. 
         if: always()
-        uses: ./gha/unity
+        uses: nick-invision/retry@v2
         with:
-          version: ${{ matrix.unity_version }}
-          release_license: "true"
+          timeout_minutes: 5
+          max_attempts: 2
+          shell: bash
+          command: |
+            python gha/unity/unity_installer.py --release_license \
+              --version 2020 \
+              --logfile "testapps/release_license.log"
+            cat testapps/release_license.log
       - name: Prepare results summary artifact
         if: ${{ !cancelled() }}
         shell: bash
diff --git a/gha/unity/action.yml b/gha/unity/action.yml
@@ -62,6 +62,13 @@ runs:
         echo "LANG=en_US.UTF-8" >> $GITHUB_ENV
         echo "U3D_PASSWORD=" >> $GITHUB_ENV
         echo "U3D_SKIP_UPDATE_CHECK=1" >> $GITHUB_ENV
+    - name: Download Unity Fallback
+      if: inputs.release_license == '' && startsWith(matrix.os, 'windows')
+      shell: bash
+      run: |
+        mkdir -p ~/Downloads
+        curl -L https://download.unity3d.com/download_unity/9a4c9c70452b/Windows64EditorInstaller/UnitySetup64.exe -o ~/Downloads/UnityInstaller.exe
+        ls -l ~/Downloads/
     - id: unity_installation
       name: Install Unity
       if: inputs.release_license == ''
diff --git a/gha/unity/unity_installer.py b/gha/unity/unity_installer.py
@@ -72,6 +72,7 @@
 
 """
 
+import os
 import platform
 import shutil
 import subprocess
@@ -84,7 +85,7 @@
 _CMD_TIMEOUT = 900
 _MAX_ATTEMPTS = 3
 
-_DEFALUT = "Default"
+_DEFAULT = "Default"
 _ANDROID = "Android"
 _IOS = "iOS"
 _TVOS = "tvOS"
@@ -199,7 +200,7 @@ def install_unity(unity_version, platforms):
   # for platforms other than the running OS, or embedded Android SDK/NDK.
   os = get_os()
   unity_full_version = UNITY_SETTINGS[unity_version][os]["version"]
-  package_list = UNITY_SETTINGS[unity_version][os]["packages"][_DEFALUT]
+  package_list = UNITY_SETTINGS[unity_version][os]["packages"][_DEFAULT]
   if platforms:
     for p in platforms:
       if UNITY_SETTINGS[unity_version][os]["packages"][p]:
@@ -226,7 +227,7 @@ def install_unity(unity_version, platforms):
     else:
       break
     attempt_num += 1
-  
+
   logging.info("Finished installing Unity.")
 
   unity_path = get_unity_path(unity_version)
@@ -313,9 +314,17 @@ def get_unity_executable(version):
   # https://github.com/DragonBox/u3d
   full_version = UNITY_SETTINGS[version][get_os()]["version"]
   if platform.system() == "Windows":
-    return "C:/Program Files/Unity_%s/editor/unity.exe" % full_version
+    unity_path = "C:/Program Files/Unity_%s/editor/unity.exe" % full_version
+    if os.path.exists(unity_path):
+      return unity_path
+    else:
+      return "C:/Program Files/Unity/Hub/Editor/2020.3.34f1/Editor/Unity.exe"
   elif platform.system() == "Darwin":
-    return "/Applications/Unity_%s/Unity.app/Contents/MacOS/Unity" % full_version
+    unity_path = "/Applications/Unity_%s/Unity.app/Contents/MacOS/Unity" % full_version
+    if os.path.exists(unity_path):
+      return unity_path
+    else:
+      return "/Applications/Unity/Hub/Editor/2020.3.34f1/Unity.app/Contents/MacOS/Unity"
   else:
     # /opt/unity-editor-%s/Editor/Unity is the path for Linux expected by U3D,
     # but Linux is not yet supported.
