AppCheck Swift API build tests (#8331)

* Initial AppAttest API build tests

* AppCheck Swift API build tests

* Fix CI

* Test @available(swift 5.5)

* Review

* Explicit availability checks

FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheckProvider.h

@@ -30,7 +30,6 @@ NS_SWIFT_NAME(AppCheckProvider)
 /// or an error.
 - (void)getTokenWithCompletion:
     (void (^)(FIRAppCheckToken *_Nullable token, NSError *_Nullable error))handler
-
     NS_SWIFT_NAME(getToken(completion:));
 
 @end

FirebaseAppCheck/Tests/Unit/Swift/AppCheckAPITests.swift

@@ -0,0 +1,200 @@
+//
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+// MARK: This file is used to evaluate the experience of using Firebase APIs in Swift.
+
+import Foundation
+
+import FirebaseCore
+import FirebaseAppCheck
+
+final class AppCheckAPITests: NSObject {
+  func usage() {
+    // MARK: - AppAttestProvider
+
+    #if TARGET_OS_IOS
+      if #available(iOS 14.0, *) {
+        if let app = FirebaseApp.app(), let provider = AppAttestProvider(app: app) {
+          provider.getToken { token, error in
+            // ...
+          }
+        }
+      }
+    #endif // TARGET_OS_IOS
+
+    // MARK: - AppCheck
+
+    // `AppCheckTokenDidChange` & associated notification keys
+    _ = NotificationCenter.default
+      .addObserver(
+        forName: .AppCheckTokenDidChange,
+        object: nil,
+        queue: .main
+      ) { notification in
+        _ = notification.userInfo?[AppCheckTokenNotificationKey]
+        _ = notification.userInfo?[AppCheckAppNameNotificationKey]
+      }
+
+    // Retrieving an AppCheck instance
+    _ = AppCheck.appCheck()
+
+    if let app = FirebaseApp.app() {
+      _ = AppCheck.appCheck(app: app)
+    }
+
+    // Get token
+    AppCheck.appCheck().token(forcingRefresh: false) { token, error in
+      if let _ /* error */ = error {
+        // ...
+      } else if let _ /* token */ = token {
+        // ...
+      }
+    }
+
+    // Get token (async/await)
+    #if swift(>=5.5)
+      if #available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *) {
+        // async/await is a Swift 5.5+ feature available on iOS 15+
+        async {
+          do {
+            try await AppCheck.appCheck().token(forcingRefresh: false)
+          } catch {
+            // ...
+          }
+        }
+      }
+    #endif // swift(>=5.5)
+
+    // Set `AppCheckProviderFactory`
+    AppCheck.setAppCheckProviderFactory(self)
+
+    // Get & Set `isTokenAutoRefreshEnabled`
+    _ = AppCheck.appCheck().isTokenAutoRefreshEnabled
+    AppCheck.appCheck().isTokenAutoRefreshEnabled = false
+
+    // MARK: - `AppCheckDebugProvider`
+
+    // `AppCheckDebugProvider` initializer
+    if let app = FirebaseApp.app(), let debugProvider = AppCheckDebugProvider(app: app) {
+      // Get token
+      debugProvider.getToken { token, error in
+        if let _ /* error */ = error {
+          // ...
+        } else if let _ /* token */ = token {
+          // ...
+        }
+      }
+
+      // Get token (async/await)
+      #if swift(>=5.5)
+        if #available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *) {
+          // async/await is a Swift 5.5+ feature available on iOS 15+
+          async {
+            do {
+              _ = try await debugProvider.getToken()
+            } catch {
+              // ...
+            }
+          }
+        }
+      #endif // swift(>=5.5)
+
+      _ = debugProvider.localDebugToken()
+      _ = debugProvider.currentDebugToken()
+    }
+
+    // MARK: - AppCheckToken
+
+    let token = AppCheckToken(token: "token", expirationDate: Date.distantFuture)
+    _ = token.token
+    _ = token.expirationDate
+
+    // MARK: - AppCheckErrors
+
+    AppCheck.appCheck().token(forcingRefresh: false) { _, error in
+      if let error = error {
+        switch error {
+        case AppCheckErrorCode.unknown:
+          break
+        case AppCheckErrorCode.serverUnreachable:
+          break
+        case AppCheckErrorCode.invalidConfiguration:
+          break
+        case AppCheckErrorCode.keychain:
+          break
+        case AppCheckErrorCode.unsupported:
+          break
+        default:
+          break
+        }
+      }
+      // ...
+    }
+
+    // MARK: - AppCheckProvider
+
+    // A protocol implemented by:
+    // - `AppAttestDebugProvider`
+    // - `AppCheckDebugProvider`
+    // - `DeviceCheckProvider`
+
+    // MARK: - AppCheckProviderFactory
+
+    // A protocol implemented by:
+    // - `AppCheckDebugProvider`
+    // - `DeviceCheckProvider`
+
+    // MARK: - DeviceCheckProvider
+
+    // `DeviceCheckProvider` initializer
+    if let app = FirebaseApp.app(), let deviceCheckProvider = DeviceCheckProvider(app: app) {
+      // Get token
+      deviceCheckProvider.getToken { token, error in
+        if let _ /* error */ = error {
+          // ...
+        } else if let _ /* token */ = token {
+          // ...
+        }
+      }
+
+      // Get token (async/await)
+      #if swift(>=5.5)
+        if #available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *) {
+          // async/await is a Swift 5.5+ feature available on iOS 15+
+          async {
+            do {
+              _ = try await deviceCheckProvider.getToken()
+            } catch {
+              // ...
+            }
+          }
+        }
+      #endif // swift(>=5.5)
+    }
+  }
+}
+
+class DummyAppCheckProvider: NSObject, AppCheckProvider {
+  func getToken(completion handler: @escaping (AppCheckToken?, Error?) -> Void) {
+    handler(AppCheckToken(token: "token", expirationDate: .distantFuture), nil)
+  }
+}
+
+extension AppCheckAPITests: AppCheckProviderFactory {
+  func createProvider(with app: FirebaseApp) -> AppCheckProvider? {
+    return DummyAppCheckProvider()
+  }
+}

FirebaseAppCheck/Tests/Unit/Swift/AppCheckTests.swift

@@ -1,52 +0,0 @@
-/*
- * Copyright 2020 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import XCTest
-
-import FirebaseCore
-import FirebaseAppCheck
-
-class AppCheckTests: XCTestCase {
-  func usageExample() {
-    AppCheck.setAppCheckProviderFactory(self)
-    FirebaseApp.configure()
-
-    let firebaseOptions = FirebaseOptions(contentsOfFile: "path")!
-    FirebaseApp.configure(name: "AppName", options: firebaseOptions)
-
-    AppCheck.appCheck().token(forcingRefresh: true) { token, error in
-      // ...
-    }
-  }
-
-  #if swift(>=5.5)
-    func asyncGetTokenUsageExample() async throws {
-      _ = try await AppCheck.appCheck().token(forcingRefresh: true)
-    }
-  #endif // swift(>=5.5)
-}
-
-class DummyAppCheckProvider: NSObject, AppCheckProvider {
-  func getToken(completion handler: @escaping (AppCheckToken?, Error?) -> Void) {
-    handler(AppCheckToken(token: "token", expirationDate: .distantFuture), nil)
-  }
-}
-
-extension AppCheckTests: AppCheckProviderFactory {
-  func createProvider(with app: FirebaseApp) -> AppCheckProvider? {
-    return DummyAppCheckProvider()
-  }
-}