Restore Catalyst unit testing in CI (#7185)

paulb777 · web-flow · commit 451a6c24c299 · 2020-12-17T07:45:13.000-08:00
diff --git a/.github/workflows/abtesting.yml b/.github/workflows/abtesting.yml
@@ -68,8 +68,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
-      run: scripts/test_catalyst.sh FirebaseABTesting build FirebaseABTesting-Unit-unit
+      run: scripts/test_catalyst.sh FirebaseABTesting test FirebaseABTesting-Unit-unit
 
   quickstart:
     # Don't run on private repo unless it is a PR.
diff --git a/.github/workflows/appdistribution.yml b/.github/workflows/appdistribution.yml
@@ -43,6 +43,18 @@ jobs:
     - name: iOS Unit Tests
       run: scripts/third_party/travis/retry.sh ./scripts/build.sh AppDistributionUnit iOS spm
 
+  catalyst:
+    # Don't run on private repo unless it is a PR.
+    if: (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || github.event_name == 'pull_request'
+
+    runs-on: macOS-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Bundler
+      run: scripts/setup_bundler.sh
+    - name: Setup project and Build for Catalyst
+      run: scripts/test_catalyst.sh FirebaseAppDistribution test FirebaseAppDistribution-Unit-unit
+
   appdistribution-cron-only:
     if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
 
diff --git a/.github/workflows/auth.yml b/.github/workflows/auth.yml
@@ -87,7 +87,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      # Only build the unit tests on Catalyst
+      # Only build the unit tests on Catalyst. Their keychain reliance causes several failures.
       run: scripts/test_catalyst.sh FirebaseAuth build FirebaseAuth-Unit-unit
 
   quickstart:
diff --git a/.github/workflows/core-diagnostics.yml b/.github/workflows/core-diagnostics.yml
@@ -52,7 +52,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build Catalyst
-      run: scripts/test_catalyst.sh FirebaseCoreDiagnostics build
+      run: scripts/test_catalyst.sh FirebaseCoreDiagnostics test FirebaseCoreDiagnostics-Unit-unit
 
   corediagnostics-cron-only:
     # Don't run on private repo.
diff --git a/.github/workflows/core.yml b/.github/workflows/core.yml
@@ -67,7 +67,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build Catalyst
-      run: scripts/test_catalyst.sh FirebaseCore build
+      run: scripts/test_catalyst.sh FirebaseCore test FirebaseCore-Unit-unit
 
   core-cron-only:
     # Don't run on private repo.
diff --git a/.github/workflows/crashlytics.yml b/.github/workflows/crashlytics.yml
@@ -71,7 +71,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      run: scripts/test_catalyst.sh FirebaseCrashlytics build FirebaseCrashlytics-Unit-unit
+      run: scripts/test_catalyst.sh FirebaseCrashlytics test FirebaseCrashlytics-Unit-unit
 
   quickstart:
     # Don't run on private repo unless it is a PR.
diff --git a/.github/workflows/database.yml b/.github/workflows/database.yml
@@ -78,8 +78,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
-      run: scripts/test_catalyst.sh FirebaseDatabase build FirebaseDatabase-Unit-unit
+      run: scripts/test_catalyst.sh FirebaseDatabase test FirebaseDatabase-Unit-unit
 
 # Restore when FirebaseUI works with Firebase 7 (#6646)
   quickstart:
diff --git a/.github/workflows/datatransport.yml b/.github/workflows/datatransport.yml
@@ -37,7 +37,6 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Test Catalyst
-      # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
       run: scripts/third_party/travis/retry.sh scripts/test_catalyst.sh GoogleDataTransport build
 
   watchos-testapp:
diff --git a/.github/workflows/functions.yml b/.github/workflows/functions.yml
@@ -68,8 +68,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
-      run: scripts/test_catalyst.sh FirebaseFunctions build FirebaseFunctions-Unit-unit
+      run: scripts/test_catalyst.sh FirebaseFunctions test FirebaseFunctions-Unit-unit
 
 # Restore when FirebaseUI works with Firebase 7 (#6646)
   quickstart:
diff --git a/.github/workflows/google-utilities-components.yml b/.github/workflows/google-utilities-components.yml
@@ -38,8 +38,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
-      run: scripts/test_catalyst.sh GoogleUtilitiesComponents build GoogleUtilitiesComponents-Unit-unit
+      run: scripts/test_catalyst.sh GoogleUtilitiesComponents test GoogleUtilitiesComponents-Unit-unit
 
   utilities-cron-only:
     # Don't run on private repo.
diff --git a/.github/workflows/google-utilities.yml b/.github/workflows/google-utilities.yml
@@ -64,8 +64,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
-      run: scripts/test_catalyst.sh GoogleUtilities build GoogleUtilities-Unit-unit
+      run: scripts/test_catalyst.sh GoogleUtilities test GoogleUtilities-Unit-unit
 
   utilities-cron-only:
     # Don't run on private repo.
diff --git a/.github/workflows/installations.yml b/.github/workflows/installations.yml
@@ -68,19 +68,14 @@ jobs:
     - name: Unit Tests
       run: scripts/third_party/travis/retry.sh ./scripts/build.sh FirebaseInstallations ${{ matrix.target }} spmbuildonly
 
-  # TODO - Catalyst is disabled because `pod gen` does not have a way to get some dependent pods
-  # from a local path and the Installations podspec requires that FirebaseInstanceID.podspec not be
-  # the local version.
-  #
-  # catalyst:
-  #   runs-on: macOS-latest
-  #   steps:
-  #   - uses: actions/checkout@v2
-  #   - name: Setup Bundler
-  #     run: scripts/setup_bundler.sh
-  #   - name: Setup project and Build for Catalyst
-  #     # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
-  #     run: scripts/test_catalyst.sh FirebaseInstallations build FirebaseInstallations-Unit-unit
+  catalyst:
+    runs-on: macOS-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Bundler
+      run: scripts/setup_bundler.sh
+    - name: Setup project and Build for Catalyst
+      run: scripts/test_catalyst.sh FirebaseInstallations test FirebaseInstallations-Unit-unit
 
   quickstart:
     # Don't run on private repo unless it is a PR.
diff --git a/.github/workflows/instanceid.yml b/.github/workflows/instanceid.yml
@@ -48,8 +48,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
-      run: scripts/test_catalyst.sh FirebaseInstanceID build FirebaseInstanceID-Unit-unit
+      run: scripts/test_catalyst.sh FirebaseInstanceID test FirebaseInstanceID-Unit-unit
 
   instanceid-cron-only:
     # Don't run on private repo.
diff --git a/.github/workflows/messaging.yml b/.github/workflows/messaging.yml
@@ -91,7 +91,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build Catalyst
-      run: scripts/test_catalyst.sh FirebaseMessaging build
+      run: scripts/test_catalyst.sh FirebaseMessaging test FirebaseMessaging-Unit-unit
 
   quickstart:
     # Don't run on private repo unless it is a PR.
diff --git a/.github/workflows/remoteconfig.yml b/.github/workflows/remoteconfig.yml
@@ -96,8 +96,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
-      run: scripts/test_catalyst.sh FirebaseRemoteConfig build FirebaseRemoteConfig-Unit-unit
+      run: scripts/test_catalyst.sh FirebaseRemoteConfig test FirebaseRemoteConfig-Unit-unit
 
   quickstart:
     # Don't run on private repo unless it is a PR.
diff --git a/.github/workflows/segmentation.yml b/.github/workflows/segmentation.yml
@@ -38,7 +38,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      run: scripts/test_catalyst.sh FirebaseSegmentation build FirebaseSegmentation-Unit-unit
+      run: scripts/test_catalyst.sh FirebaseSegmentation test FirebaseSegmentation-Unit-unit
 
   segmentation-cron-only:
     # Don't run on private repo.
diff --git a/.github/workflows/storage.yml b/.github/workflows/storage.yml
@@ -83,8 +83,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Setup project and Build for Catalyst
-      # Only build the unit tests on Catalyst. Test stopped working when GHA moved to Xcode 11.4.1.
-      run: scripts/test_catalyst.sh FirebaseStorage build FirebaseStorage-Unit-unit
+      run: scripts/test_catalyst.sh FirebaseStorage test FirebaseStorage-Unit-unit
 
   quickstart:
     # Don't run on private repo unless it is a PR.
diff --git a/Example/InstanceID/Tests/FIRInstanceIDAuthKeyChainTest.m b/Example/InstanceID/Tests/FIRInstanceIDAuthKeyChainTest.m
@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+#import <TargetConditionals.h>
+#if !TARGET_OS_MACCATALYST
+// Skip keychain tests on Catalyst.
+
 #import <XCTest/XCTest.h>
 
 #import <OCMock/OCMock.h>
@@ -408,3 +412,5 @@ - (NSData *)tokenDataWithAuthorizedEntity:(NSString *)authorizedEntity
 #pragma clang diagnostic pop
 }
 @end
+
+#endif  // TARGET_OS_MACCATALYST
diff --git a/FirebaseCoreDiagnostics.podspec b/FirebaseCoreDiagnostics.podspec
@@ -19,10 +19,16 @@ non-Cocoapod integration. This library also respects the Firebase global data co
   }
 
   s.social_media_url = 'https://twitter.com/Firebase'
-  s.ios.deployment_target = '9.0'
-  s.osx.deployment_target = '10.12'
-  s.tvos.deployment_target = '10.0'
-  s.watchos.deployment_target = '6.0'
+
+  ios_deployment_target = '9.0'
+  osx_deployment_target = '10.12'
+  tvos_deployment_target = '10.0'
+  watchos_deployment_target = '6.0'
+
+  s.ios.deployment_target = ios_deployment_target
+  s.osx.deployment_target = osx_deployment_target
+  s.tvos.deployment_target = tvos_deployment_target
+  s.watchos.deployment_target = watchos_deployment_target
 
   s.cocoapods_version = '>= 1.4.0'
   s.prefix_header_file = false
@@ -57,8 +63,11 @@ non-Cocoapod integration. This library also respects the Firebase global data co
   s.dependency 'nanopb', '~> 2.30907.0'
 
   s.test_spec 'unit' do |unit_tests|
-    unit_tests.platforms = {:ios => '8.0', :osx => '10.11', :tvos => '10.0'}
-    unit_tests.platforms = {:ios => '8.0', :osx => '10.11', :tvos => '10.0'}
+    unit_tests.platforms = {
+      :ios => ios_deployment_target,
+      :osx => osx_deployment_target,
+      :tvos => tvos_deployment_target
+    }
     unit_tests.dependency 'GoogleUtilities/UserDefaults', '~> 7.0'
     unit_tests.dependency 'OCMock'
     unit_tests.source_files = [
diff --git a/GoogleUtilities/Tests/Unit/Environment/GULKeychainStorageTests.m b/GoogleUtilities/Tests/Unit/Environment/GULKeychainStorageTests.m
@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+#import <TargetConditionals.h>
+#if !TARGET_OS_MACCATALYST
+// Skip keychain tests on Catalyst.
+
 #import <XCTest/XCTest.h>
 
 #import "FBLPromise+Testing.h"
@@ -199,3 +203,5 @@ - (void)assertRemoveObjectForKey:(NSString *)key {
 }
 
 @end
+
+#endif  // TARGET_OS_MACCATALYST
diff --git a/GoogleUtilities/Tests/Unit/Network/GULNetworkTest.m b/GoogleUtilities/Tests/Unit/Network/GULNetworkTest.m
@@ -17,6 +17,9 @@
 #import <XCTest/XCTest.h>
 #import "OCMock.h"
 
+#if !TARGET_OS_MACCATALYST
+// These tests are flaky on Catalyst. One of the tests typically fails.
+
 #import "GoogleUtilities/NSData+zlib/Public/GoogleUtilities/GULNSData+zlib.h"
 #import "GoogleUtilities/Network/Public/GoogleUtilities/GULNetwork.h"
 #import "GoogleUtilities/Reachability/Public/GoogleUtilities/GULReachabilityChecker.h"
@@ -1008,3 +1011,5 @@ - (void)reachabilityDidChange {
 }
 
 @end
+
+#endif  // TARGET_OS_MACCATALYST
diff --git a/GoogleUtilities/Tests/Unit/Swizzler/GULAppDelegateSwizzlerTest.m b/GoogleUtilities/Tests/Unit/Swizzler/GULAppDelegateSwizzlerTest.m
@@ -1055,7 +1055,7 @@ - (void)testApplicationDidReceiveRemoteNotificationIsInvokedOnInterceptors {
 }
 #pragma clang diagnostic pop
 
-#if TARGET_OS_IOS || TARGET_OS_TV
+#if (TARGET_OS_IOS || TARGET_OS_TV) && !TARGET_OS_MACCATALYST
 - (void)testApplicationDidReceiveRemoteNotificationWithCompletionIsInvokedOnInterceptors {
   NSDictionary *notification = @{};
   GULApplication *application = [GULApplication sharedApplication];
@@ -1092,7 +1092,7 @@ - (void)testApplicationDidReceiveRemoteNotificationWithCompletionIsInvokedOnInte
 - (void)verifyCompletionCalledForObserverResult:(UIBackgroundFetchResult)observerResult1
                           anotherObserverResult:(UIBackgroundFetchResult)observerResult2
                                  swizzledResult:(UIBackgroundFetchResult)swizzledResult
-                                 expecredResult:(UIBackgroundFetchResult)expectedResult {
+                                 expectedResult:(UIBackgroundFetchResult)expectedResult {
   NSDictionary *notification = @{};
   GULApplication *application = [GULApplication sharedApplication];
 
@@ -1150,45 +1150,45 @@ - (void)testApplicationDidReceiveRemoteNotificationWithCompletionCompletionIsCal
   [self verifyCompletionCalledForObserverResult:UIBackgroundFetchResultNoData
                           anotherObserverResult:UIBackgroundFetchResultNoData
                                  swizzledResult:UIBackgroundFetchResultNoData
-                                 expecredResult:UIBackgroundFetchResultNoData];
+                                 expectedResult:UIBackgroundFetchResultNoData];
 }
 
 - (void)
     testApplicationDidReceiveRemoteNotificationWithCompletionCompletionIsCalledOnce_HandleFailedState {
   [self verifyCompletionCalledForObserverResult:UIBackgroundFetchResultFailed
                           anotherObserverResult:UIBackgroundFetchResultFailed
                                  swizzledResult:UIBackgroundFetchResultFailed
-                                 expecredResult:UIBackgroundFetchResultFailed];
+                                 expectedResult:UIBackgroundFetchResultFailed];
 }
 
 - (void)testApplicationDidReceiveRemoteNotificationWithCompletionCompletionIsCalledOnce_NoData {
   [self verifyCompletionCalledForObserverResult:UIBackgroundFetchResultNoData
                           anotherObserverResult:UIBackgroundFetchResultFailed
                                  swizzledResult:UIBackgroundFetchResultFailed
-                                 expecredResult:UIBackgroundFetchResultNoData];
+                                 expectedResult:UIBackgroundFetchResultNoData];
 }
 - (void)
     testApplicationDidReceiveRemoteNotificationWithCompletionCompletionIsCalledOnce_HandleNewDataState_OthersFailed {
   [self verifyCompletionCalledForObserverResult:UIBackgroundFetchResultNewData
                           anotherObserverResult:UIBackgroundFetchResultFailed
                                  swizzledResult:UIBackgroundFetchResultFailed
-                                 expecredResult:UIBackgroundFetchResultNewData];
+                                 expectedResult:UIBackgroundFetchResultNewData];
 }
 
 - (void)
     testApplicationDidReceiveRemoteNotificationWithCompletionCompletionIsCalledOnce_HandleNewDataState_OthersNoData {
   [self verifyCompletionCalledForObserverResult:UIBackgroundFetchResultNewData
                           anotherObserverResult:UIBackgroundFetchResultNoData
                                  swizzledResult:UIBackgroundFetchResultNoData
-                                 expecredResult:UIBackgroundFetchResultNewData];
+                                 expectedResult:UIBackgroundFetchResultNewData];
 }
 
 - (void)
     testApplicationDidReceiveRemoteNotificationWithCompletionCompletionIsCalledOnce_HandleNewDataState_OthersNoDataFailed {
   [self verifyCompletionCalledForObserverResult:UIBackgroundFetchResultNewData
                           anotherObserverResult:UIBackgroundFetchResultNoData
                                  swizzledResult:UIBackgroundFetchResultFailed
-                                 expecredResult:UIBackgroundFetchResultNewData];
+                                 expectedResult:UIBackgroundFetchResultNewData];
 }
 
 - (void)testApplicationDidReceiveRemoteNotificationWithCompletionImplementationIsNotAdded {
diff --git a/GoogleUtilities/Tests/Unit/Swizzler/GULObjectSwizzlerTest.m b/GoogleUtilities/Tests/Unit/Swizzler/GULObjectSwizzlerTest.m
@@ -354,6 +354,9 @@ - (void)testRespondsToSelectorWorksEvenIfSwizzledProxyISASwizzledBySomeoneElse {
   objc_disposeClassPair(generatedClass);
 }
 
+#if !TARGET_OS_MACCATALYST
+// Test fails on Catalyst due to an interaction with GULSceneDelegateSwizzlerTests.
+
 - (void)testSwizzlerDoesntDisposeGeneratedClassWhenObjectIsISASwizzledBySomeoneElse {
   Class generatedClass = nil;
   __weak GULObjectSwizzler *weakSwizzler;
@@ -403,6 +406,7 @@ - (void)testSwizzlerDoesntDisposeGeneratedClassWhenObjectIsISASwizzledBySomeoneE
   // Clean up.
   objc_disposeClassPair(generatedClass);
 }
+#endif
 
 // The test is disabled because in the case of success it should crash with SIGABRT, so it is not
 // suitable for CI.
diff --git a/GoogleUtilities/Tests/Unit/Swizzler/GULSceneDelegateSwizzlerTest.m b/GoogleUtilities/Tests/Unit/Swizzler/GULSceneDelegateSwizzlerTest.m
@@ -144,6 +144,9 @@ - (void)testSceneOpenURLContextsIsInvokedOnInterceptors {
   }
 }
 
+#if !TARGET_OS_MACCATALYST
+// Test fails on Catalyst.
+
 - (void)testNotificationCenterRegister {
   if (@available(iOS 13, tvOS 13, *)) {
     [GULSceneDelegateSwizzler proxyOriginalSceneDelegate];
@@ -157,6 +160,7 @@ - (void)testNotificationCenterRegister {
     [self waitForExpectations:@[ expectation ] timeout:1];
   }
 }
+#endif
 
 #pragma mark - Tests to test that Plist flag is honored
 
diff --git a/GoogleUtilities/Tests/Unit/UserDefaults/GULUserDefaultsTests.m b/GoogleUtilities/Tests/Unit/UserDefaults/GULUserDefaultsTests.m
@@ -493,6 +493,9 @@ - (void)testNewUserDefaultsWithNSUserDefaultsFile {
   [self removePreferenceFileWithSuiteName:suiteName];
 }
 
+#if !TARGET_OS_MACCATALYST
+// Disable Catalyst flakes.
+
 #pragma mark - Thread-safety test
 
 - (void)testNewUserDefaultsThreadSafeAddingObjects {
@@ -708,6 +711,7 @@ - (void)testBothUserDefaultsRemovingSomeObjects {
   }
   [self removePreferenceFileWithSuiteName:suiteName];
 }
+#endif  // TARGET_OS_MACCATALYST
 
 #pragma mark - Thread methods
 
diff --git a/scripts/test_catalyst.sh b/scripts/test_catalyst.sh
