Build and execute tvOS Testapps on custom trigger (#559)

Add the ability for CI to execute tvOS builds and vet them with integeration tests on Apple TV simulators.
They will not execute as part of the nightly until we include tvOS as a shippable target (ie when we add it to the nightly packaged builds).

Author: DellaBitta

.github/workflows/build_starter.yml

@@ -200,6 +200,18 @@ jobs:
       unity_platform_name: iOS
       additional_cmake_flags: ${{ needs.check_and_prepare.outputs.additional_cmake_flags }}
 
+  build_tvos:
+    name: build-tvos-unity${{ needs.check_and_prepare.outputs.unity_version }}-CPP${{ needs.check_and_prepare.outputs.firebase_cpp_sdk_version }}
+    uses: ./.github/workflows/build_tvos.yml
+    needs: [check_and_prepare, decide_build_branch]
+    if: always() && contains(needs.check_and_prepare.outputs.platform, 'tvOS')
+    with:
+      unity_version: ${{needs.check_and_prepare.outputs.unity_version }}
+      firebase_cpp_sdk_version: ${{ needs.check_and_prepare.outputs.firebase_cpp_sdk_version }}
+      unity_branch: ${{ needs.decide_build_branch.outputs.build_branch }}
+      apis: ${{ needs.check_and_prepare.outputs.apis }}
+      unity_platform_name: 'tvOS,iOS'
+
   build_linux:
     name: build-linux-unity${{ needs.check_and_prepare.outputs.unity_version }}-CPP${{ needs.check_and_prepare.outputs.firebase_cpp_sdk_version }}
     uses: ./.github/workflows/build_linux.yml

.github/workflows/integration_tests.yml

@@ -248,35 +248,24 @@ jobs:
           name: build_and_test_results
           path: build-results-${{ steps.matrix_info.outputs.info }}*
           retention-days: ${{ env.artifactRetentionDays }}
-      - name: Upload build logs artifact
+      - name: Upload Mobile integration tests artifact
         uses: actions/upload-artifact@v3
-        if: ${{ !cancelled() }}
-        with:
-          name: testapps-build-logs-${{ steps.matrix_info.outputs.info }}
-          path: testapps-${{ steps.matrix_info.outputs.info }}/build-logs
-          retention-days: ${{ env.artifactRetentionDays }}
-      - name: Upload Android integration tests artifact
-        uses: actions/upload-artifact@v3
-        if: ${{ contains(matrix.platform, 'Android') && !cancelled() }}
+        if: ${{ contains('Android,iOS,tvOS', matrix.platform) && !cancelled() }}
         with:
-          name: testapps-Android-${{ steps.matrix_info.outputs.artifact_suffix }}
-          path: testapps-${{ steps.matrix_info.outputs.info }}/Android
+          name: testapps-${{ matrix.platform }}-${{ steps.matrix_info.outputs.artifact_suffix }}
+          path: testapps-${{ steps.matrix_info.outputs.info }}
           retention-days: ${{ env.artifactRetentionDays }}
-      - name: Delete Android integration tests artifact
-        if: ${{ contains(matrix.platform, 'Android') && !cancelled() }}
+      - name: Delete Mobile integration tests artifact
+        if: ${{ contains('Android,iOS,tvOS', matrix.platform) && !cancelled() }}
         shell: bash
-        run: rm -rf testapps-${{ steps.matrix_info.outputs.info }}/Android || true
-      - name: Upload iOS integration tests artifact
+        run: rm -rf testapps-${{ steps.matrix_info.outputs.info }} || true
+      - name: Upload Desktop build logs artifact  # Mobile build logs are uploaded with integration tests artifact
         uses: actions/upload-artifact@v3
-        if: ${{ contains(matrix.platform, 'iOS') && !cancelled() }}
+        if: ${{ !contains('Android,iOS,tvOS', matrix.platform) && !cancelled() }}
         with:
-          name: testapps-iOS-${{ steps.matrix_info.outputs.artifact_suffix }}
-          path: testapps-${{ steps.matrix_info.outputs.info }}/iOS
+          name: testapps-build-logs-${{ steps.matrix_info.outputs.info }}
+          path: testapps-${{ steps.matrix_info.outputs.info }}/build-logs
           retention-days: ${{ env.artifactRetentionDays }}
-      - name: Delete iOS integration tests artifact
-        if: ${{ contains(matrix.platform, 'iOS') && !cancelled() }}
-        shell: bash
-        run: rm -rf testapps-${{ steps.matrix_info.outputs.info }}/iOS || true
       - name: Upload Linux integration tests artifact
         uses: actions/upload-artifact@v3
         if: ${{ contains(matrix.platform, 'Linux') && !cancelled() }}
@@ -492,10 +481,11 @@ jobs:
           python scripts/gha/read_ftl_test_result.py --test_result '${{ steps.ftl_test.outputs.test_summary }}' \
             --output_path testapps/test-results-"${{ steps.matrix_info.outputs.info }}".log
       - name: Run Mobile integration tests on virtual device locally
-        timeout-minutes: 60
+        timeout-minutes: 120
         if: ${{ matrix.device_type == 'virtual' && !cancelled() }}
         run: |
           python scripts/gha/test_simulator.py --testapp_dir testapps \
+            --tvos_device "${{ matrix.test_device }}" \
             --ios_device "${{ matrix.test_device }}" \
             --android_device "${{ matrix.test_device }}" \
             --logfile_name ""${{ steps.matrix_info.outputs.info }}"" \

scripts/build_scripts/build_zips.py

@@ -193,6 +193,11 @@ def get_targets_args(targets):
     support_targets = TVOS_SUPPORT_TARGETS
     if not targets:
       targets = TVOS_SUPPORT_TARGETS
+    else:
+      if 'dynamic_links' in targets:
+        logging.warning("Dynamic Links is not supported on tvOS. " +
+          "Removing it from the api build list.")
+        targets.remove('dynamic_links')
 
   if targets:
     # check if all the entries are valid

scripts/gha/build_testapps.py

@@ -620,7 +620,10 @@ def perform_in_editor_tests(dir_helper, retry_on_license_check=True):
 
 def run_xcodebuild(dir_helper, ios_config, device_type, target_os):
   """Uses xcode project generated by Unity to build an iOS or tvOS binary."""
-  build_output_dir = os.path.join(dir_helper.output_dir, "ios_output_"+device_type)
+  if target_os == _TVOS:
+    build_output_dir = os.path.join(dir_helper.output_dir, "tvos_output_"+device_type)
+  else:
+    build_output_dir = os.path.join(dir_helper.output_dir, "ios_output_"+device_type)
   _run(
       xcodebuild.get_args_for_build(
           path=dir_helper.xcode_path,
@@ -668,6 +671,8 @@ def _collect_integration_tests(config, testapps, root_output_dir, output_dir, ar
   android_testapp_extension = ".apk"
   ios_testapp_dir = "ios_output_" + _DEVICE_REAL
   ios_simualtor_testapp_dir = "ios_output_" + _DEVICE_VIRTUAL
+  tvos_testapp_dir = "tvos_output_" + _DEVICE_REAL
+  tvos_simulator_testapp_dir = "tvos_output_" + _DEVICE_VIRTUAL
   ios_testapp_extension = ".ipa"
   ios_simualtor_testapp_extension = ".app"
   windows_testapp_dir = "WindowsTestapp" 
@@ -676,6 +681,7 @@ def _collect_integration_tests(config, testapps, root_output_dir, output_dir, ar
 
   android_testapp_paths = []
   ios_testapp_paths = []
+  tvos_testapp_paths = []
   windows_testapp_paths = []
   macos_testapp_paths = []
   linux_testapp_paths = []
@@ -689,11 +695,15 @@ def _collect_integration_tests(config, testapps, root_output_dir, output_dir, ar
         linux_testapp_paths.append(os.path.join(file_dir, directory))
       elif ios_simualtor_testapp_dir in file_dir and directory.endswith(ios_simualtor_testapp_extension):
         ios_testapp_paths.append(os.path.join(file_dir, directory))
+      elif tvos_simulator_testapp_dir in file_dir and directory.endswith(ios_simualtor_testapp_extension):
+        tvos_testapp_paths.append(os.path.join(file_dir, directory))
     for file_name in file_names:
       if file_name.endswith(android_testapp_extension):
         android_testapp_paths.append(os.path.join(file_dir, file_name))
       elif ios_testapp_dir in file_dir and file_name.endswith(ios_testapp_extension):
         ios_testapp_paths.append(os.path.join(file_dir, file_name))
+      elif tvos_testapp_dir in file_dir and file_name.endswith(ios_testapp_extension):
+        tvos_testapp_paths.append(os.path.join(file_dir, file_name))
 
   artifact_path = os.path.join(root_output_dir, testapps_artifact_dir)
   logging.info("Collecting artifacts to: %s", artifact_path)
@@ -704,6 +714,7 @@ def _collect_integration_tests(config, testapps, root_output_dir, output_dir, ar
 
   _collect_integration_tests_platform(config, testapps, artifact_path, android_testapp_paths, _ANDROID)
   _collect_integration_tests_platform(config, testapps, artifact_path, ios_testapp_paths, _IOS)
+  _collect_integration_tests_platform(config, testapps, artifact_path, tvos_testapp_paths, _TVOS)
   _collect_integration_tests_platform(config, testapps, artifact_path, windows_testapp_paths, _WINDOWS)
   _collect_integration_tests_platform(config, testapps, artifact_path, macos_testapp_paths, _MACOS)
   _collect_integration_tests_platform(config, testapps, artifact_path, linux_testapp_paths, _LINUX)
@@ -715,12 +726,13 @@ def _collect_integration_tests_platform(config, testapps, artifact_path, testapp
     return
 
   for testapp in testapps:
-    os.makedirs(os.path.join(artifact_path, platform ,testapp))
+    os.makedirs(os.path.join(artifact_path, platform, testapp))
+
   for path in testapp_paths:
     for testapp in testapps:
       if config.get_api(testapp).full_name in path:
         if os.path.isfile(path):
-          shutil.move(path, os.path.join(artifact_path, platform ,testapp))
+          shutil.move(path, os.path.join(artifact_path, platform, testapp))
         else:
           shutil.move(path, os.path.join(artifact_path, platform ,testapp, os.path.basename(path)), copy_function = shutil.copytree)
         break

scripts/gha/integration_testing/automated_testapp/ftl_testapp_files/IOSPluginWrapper.cs renamed to scripts/gha/integration_testing/automated_testapp/ftl_testapp_files/ApplePluginWrapper.cs

@@ -20,9 +20,9 @@
 
 namespace Firebase.TestLab {
   /// <summary>
-  /// Provides access to the native iOS plugin for Game Loops.
+  /// Provides access to the native iOS/tvOS plugin for Game Loops.
   /// </summary>
-  internal sealed class IOSPluginWrapper {
+  internal sealed class ApplePluginWrapper {
     public static int GetScenario() {
       // Not yet hooked up to a native plugin. Return 1 for now, so that we treat the testapps
       // as always running on Game Loops. This is 'harmless', since this assumption currently

scripts/gha/integration_testing/automated_testapp/ftl_testapp_files/IOSTestLabManager.cs renamed to scripts/gha/integration_testing/automated_testapp/ftl_testapp_files/AppleTestLabManager.cs

@@ -17,21 +17,24 @@
 using UnityEngine;
 
 namespace Firebase.TestLab {
-  internal sealed class IOSTestLabManager : TestLabManager {
+  internal sealed class AppleTestLabManager : TestLabManager {
 
     public override int ScenarioNumber { get { return scenario; } }
 
     readonly int scenario;
     readonly StreamWriter logWriter;
 
-    private IOSTestLabManager(int scenario, StreamWriter logWriter) {
+    private AppleTestLabManager(int scenario, StreamWriter logWriter) {
       this.scenario = scenario;
       this.logWriter = logWriter;
     }
 
     protected override void OnFinishTest() {
       logWriter.Close();
-      Application.OpenURL("firebase-game-loop-complete://");
+      if (Application.platform == RuntimePlatform.IPhonePlayer) {
+        // OpenURL function doesn't exist on tvOS
+        Application.OpenURL("firebase-game-loop-complete://");
+      } 
     }
 
     public override void LogToResults(string s) {
@@ -40,21 +43,28 @@ public override void LogToResults(string s) {
     }
 
     /// <summary>
-    /// Attempts to create a TestLabManager for an iOS build. If running with Game Loops,
+    /// Attempts to create a TestLabManager for an iOS/tvOS build. If running with Game Loops,
     /// and all necessary information is found in the custom url, this will return a functional
-    /// IOSTestLabManager. If not running with Game Loops, this will return a dummy.
+    /// AppleTestLabManager. If not running with Game Loops, this will return a dummy.
     /// </summary>
     public static TestLabManager Create() {
-      int scenario = IOSPluginWrapper.GetScenario();
+      int scenario = ApplePluginWrapper.GetScenario();
       if (scenario == -1) {  // Not using Game Loops: return dummy.
         return new DummyTestLabManager();
       }
-      string logDir = Application.persistentDataPath + "/GameLoopResults";
+      string logDir = "";
+      if (Application.platform == RuntimePlatform.IPhonePlayer) {
+        logDir = Application.persistentDataPath + "/GameLoopResults";
+      } else if (Application.platform == RuntimePlatform.tvOS) {
+        // persistentDataPath doesn't exist on tvOS
+        // files under temporaryCachePath may be cleared at anytime
+        logDir = Application.temporaryCachePath + "/GameLoopResults";
+      }
       string logPath = string.Format("{0}/Results{1}.json", logDir, scenario);
       Directory.CreateDirectory(logDir);
       // Logs will be appended, so we need to clear the file first.
       File.Delete(logPath);
-      return new IOSTestLabManager(scenario, File.AppendText(logPath));
+      return new AppleTestLabManager(scenario, File.AppendText(logPath));
     }
   }
 }

scripts/gha/integration_testing/automated_testapp/ftl_testapp_files/Firebase.TestLabManager.csproj

@@ -38,8 +38,8 @@
     <Compile Include="AndroidTestLabManager.cs" />
     <Compile Include="DesktopTestLabManager.cs" />
     <Compile Include="DummyTestLabManager.cs" />
-    <Compile Include="IOSPluginWrapper.cs" />
-    <Compile Include="IOSTestLabManager.cs" />
+    <Compile Include="ApplePluginWrapper.cs" />
+    <Compile Include="AppleTestLabManager.cs" />
     <Compile Include="LibcWrapper.cs" />
     <Compile Include="TestLabManager.cs" />
   </ItemGroup>

scripts/gha/integration_testing/automated_testapp/ftl_testapp_files/TestLabManager.cs

@@ -58,15 +58,20 @@ public void NotifyHarnessTestIsComplete() {
     public static TestLabManager Instantiate() {
       if (Application.platform == RuntimePlatform.Android) {
         return AndroidTestLabManager.Create();
-      } else if (Application.platform == RuntimePlatform.IPhonePlayer) {
-        return IOSTestLabManager.Create();
+      } else if (IsApplePlatform(Application.platform)) {
+        return AppleTestLabManager.Create();
       } else if (IsDesktopPlatform(Application.platform)) {
         return DesktopTestLabManager.Create();
       } else {
         return new DummyTestLabManager();
       }
     }
 
+    static bool IsApplePlatform(RuntimePlatform platform) {
+      return platform == RuntimePlatform.IPhonePlayer
+        || platform == RuntimePlatform.tvOS;
+    }
+
     static bool IsDesktopPlatform(RuntimePlatform platform) {
       return platform == RuntimePlatform.OSXPlayer
         || platform == RuntimePlatform.WindowsPlayer

scripts/gha/integration_testing/gameloop_apple/gameloop.xcodeproj/project.pbxproj

@@ -404,7 +404,7 @@
 				SWIFT_EMIT_LOC_STRINGS = YES;
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = 3;
-				TVOS_DEPLOYMENT_TARGET = 10.1;
+				TVOS_DEPLOYMENT_TARGET = 12.0;
 			};
 			name = Debug;
 		};
@@ -431,7 +431,7 @@
 				SWIFT_EMIT_LOC_STRINGS = YES;
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = 3;
-				TVOS_DEPLOYMENT_TARGET = 10.1;
+				TVOS_DEPLOYMENT_TARGET = 12.0;
 			};
 			name = Release;
 		};
@@ -454,7 +454,7 @@
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = 3;
 				TEST_TARGET_NAME = gameloop_tvos;
-				TVOS_DEPLOYMENT_TARGET = 10.1;
+				TVOS_DEPLOYMENT_TARGET = 12.0;
 			};
 			name = Debug;
 		};
@@ -477,7 +477,7 @@
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = 3;
 				TEST_TARGET_NAME = gameloop_tvos;
-				TVOS_DEPLOYMENT_TARGET = 10.1;
+				TVOS_DEPLOYMENT_TARGET = 12.0;
 			};
 			name = Release;
 		};

scripts/gha/integration_testing/xcodebuild.py

@@ -13,23 +13,19 @@
 # limitations under the License.
 
 """Helper module for working with xcode projects.
-
 The tool xcodebuild provides support to build xcode projects from the command
 line. The motivation was to simplify usage of xcodebuild, since it was
 non-trivial to figure out which flags were needed to get it working in a CI
 environment. The options required by the methods in this module were found to
 work both locally and on CI, with both the Unity and C++ projects.
-
 get_args_for_build() doesn't perform operations with xcodebuild directly,
 instead returning arg sequences. These sequences can be passed to e.g.
 subprocess.run to execute the operations.
-
 get_args_for_build() supports both device and simulator builds. For simulator
 builds, it suffices to use get_args_for_build() to create a .app that can be
 used with simulators. For unsigned device builds, generate .app via
 get_args_for_build() step and then use generate_unsigned_ipa() to package
 the .app to .ipa.
-
 """
 
 import os
@@ -38,7 +34,6 @@
 
 def get_args_for_build(path, scheme, output_dir, ios_sdk, target_os, configuration):
   """Constructs subprocess args for an unsigned xcode build.
-
   Args:
     path (str): Full path to the project or workspace to build. Must end in
         either .xcodeproj or .xcworkspace.
@@ -48,10 +43,8 @@ def get_args_for_build(path, scheme, output_dir, ios_sdk, target_os, configurati
     ios_sdk (str): Where this build will be run: "device" or "simulator".
     target_os (str): one of "iOS" or "tvOS".
     configuration (str): Value for the -configuration flag.
-
   Returns:
     Sequence of strings, corresponding to valid args for a subprocess call.
-
   """
   args = [
       "xcodebuild",
@@ -102,7 +95,6 @@ def _get_ios_env_from_target(ios_sdk, target_os):
 
 def generate_unsigned_ipa(output_dir, configuration):
   """Creates an unsigned .ipa from an existing .app.
-
   Args:
     output_dir (str): Same value as get_args_for_build. The generated unsigned
       .ipa will be placed within the subdirectory "<configuration>-iphoneos".