Add Swift tests for Messaging (#9135)

Author: charlotteliang

FirebaseMessaging/Tests/IntegrationTests/FIRMessagingPubSubTest.swift

@@ -0,0 +1,76 @@
+/*
+ * 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.
+ */
+
+// macOS requests a user password when accessing the Keychain for the first time,
+// so the tests may fail. Disable integration tests on macOS so far.
+// TODO: Configure the tests to run on macOS without requesting the keychain password.
+#if !os(OSX)
+
+  import FirebaseCore
+  import FirebaseMessaging
+  import XCTest
+
+  class FIRMessagingPubSubTest: XCTestCase {
+    var app: FirebaseApp!
+    var messaging: Messaging!
+
+    override class func setUp() {
+      if FirebaseApp.app() == nil {
+        FirebaseApp.configure()
+      }
+    }
+
+    override func setUpWithError() throws {
+      messaging = try XCTUnwrap(Messaging.messaging())
+    }
+
+    override func tearDown() {
+      messaging = nil
+    }
+
+    func testSubscribeTopic() {
+      let expectation = self.expectation(description: "Successfully subscribe topic")
+      assertDefaultToken()
+
+      messaging.subscribe(toTopic: "cat_video") { error in
+        XCTAssertNil(error)
+        expectation.fulfill()
+      }
+      wait(for: [expectation], timeout: 5)
+    }
+
+    func testUnsubscribeTopic() {
+      let expectation = self.expectation(description: "Successfully unsubscribe topic")
+      assertDefaultToken()
+
+      messaging.unsubscribe(fromTopic: "cat_video") { error in
+        XCTAssertNil(error)
+        expectation.fulfill()
+      }
+      wait(for: [expectation], timeout: 5)
+    }
+
+    func assertDefaultToken() {
+      let expectation = self.expectation(description: "getToken")
+      messaging.token { token, error in
+        XCTAssertNil(error)
+        XCTAssertNotNil(token)
+        expectation.fulfill()
+      }
+      wait(for: [expectation], timeout: 5)
+    }
+  }
+#endif // !TARGET_OS_OSX

FirebaseMessaging/Tests/IntegrationTests/FIRMessagingTokenRefreshTests.swift

@@ -18,7 +18,6 @@
 // so the tests may fail. Disable integration tests on macOS so far.
 // TODO: Configure the tests to run on macOS without requesting the keychain password.
 #if !os(OSX)
-
   import FirebaseCore
   import FirebaseMessaging
   import XCTest
@@ -35,14 +34,16 @@
 
   class FIRMessagingTokenRefreshTests: XCTestCase {
     var app: FirebaseApp!
-    var messaging: Messaging?
+    var messaging: Messaging!
 
     override class func setUp() {
-      FirebaseApp.configure()
+      if FirebaseApp.app() == nil {
+        FirebaseApp.configure()
+      }
     }
 
-    override func setUp() {
-      messaging = Messaging.messaging()
+    override func setUpWithError() throws {
+      messaging = try XCTUnwrap(Messaging.messaging())
     }
 
     override func tearDown() {
@@ -59,12 +60,9 @@
         handler: nil)
 
       let testDelegate = fakeAppDelegate()
-      messaging?.delegate = testDelegate
+      messaging.delegate = testDelegate
       testDelegate.delegateIsCalled = false
 
-      guard let messaging = self.messaging else {
-        return
-      }
       messaging.deleteFCMToken(forSenderID: tokenAuthorizedEntity(), completion: { error in
         XCTAssertNil(error)
         XCTAssertTrue(testDelegate.delegateIsCalled)
@@ -85,10 +83,6 @@
       let testDelegate = fakeAppDelegate()
       messaging?.delegate = testDelegate
       testDelegate.delegateIsCalled = false
-
-      guard let messaging = self.messaging else {
-        return
-      }
       messaging.deleteToken { error in
         XCTAssertNil(error)
         XCTAssertTrue(testDelegate.delegateIsCalled)
@@ -97,12 +91,31 @@
       wait(for: [expectation, notificationExpectation], timeout: 5)
     }
 
+    func testDeleteDataWithTokenRefreshDelegatesAndNotifications() {
+      let expectation = self.expectation(description: "delegate method and notification are called")
+      assertDefaultToken()
+
+      let notificationExpectation = self.expectation(forNotification: NSNotification.Name
+        .MessagingRegistrationTokenRefreshed,
+        object: nil,
+        handler: nil)
+
+      let testDelegate = fakeAppDelegate()
+      messaging?.delegate = testDelegate
+      testDelegate.delegateIsCalled = false
+
+      messaging.deleteData { error in
+        XCTAssertNil(error)
+        XCTAssertTrue(testDelegate.delegateIsCalled)
+        expectation.fulfill()
+      }
+      wait(for: [expectation, notificationExpectation], timeout: 5)
+    }
+
     // pragma mark - Helpers
     func assertTokenWithAuthorizedEntity() {
       let expectation = self.expectation(description: "tokenWithAuthorizedEntity")
-      guard let messaging = self.messaging else {
-        return
-      }
+
       messaging.retrieveFCMToken(forSenderID: tokenAuthorizedEntity()) { token, error in
         XCTAssertNil(error)
         XCTAssertNotNil(token)
@@ -113,9 +126,7 @@
 
     func assertDefaultToken() {
       let expectation = self.expectation(description: "getToken")
-      guard let messaging = self.messaging else {
-        return
-      }
+
       messaging.token { token, error in
         XCTAssertNil(error)
         XCTAssertNotNil(token)

FirebaseMessaging/Tests/UnitTestsSwift/FIRMessagingAPITest.swift

@@ -0,0 +1,65 @@
+// 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.
+
+import Foundation
+
+import FirebaseCore
+import FirebaseMessaging
+import UserNotifications
+
+// This file is a build-only test for the public Messaging Swift APIs not
+// exercised in the integration tests.
+func apis() {
+  let messaging = Messaging.messaging()
+
+  if let _ = messaging.apnsToken {}
+
+  let apnsToken = Data()
+  messaging.setAPNSToken(apnsToken, type: .prod)
+
+  let topic = "cat_video"
+  messaging.subscribe(toTopic: topic)
+  messaging.unsubscribe(fromTopic: topic)
+
+  messaging.appDidReceiveMessage([:])
+
+  if #available(macOS 10.14, iOS 10.0, watchOS 3.0, tvOS 10.0, *) {
+    let serviceExtension = Messaging.serviceExtension()
+    let content = UNMutableNotificationContent()
+    serviceExtension.populateNotificationContent(content) { content in
+    }
+    serviceExtension.exportDeliveryMetricsToBigQuery(withMessageInfo: [:])
+  }
+}
+
+@available(iOS 15, tvOS 15, macOS 12, watchOS 8, *)
+func apiAsync() async throws {
+  let messaging = Messaging.messaging()
+  let topic = "cat_video"
+  #if compiler(>=5.5) && canImport(_Concurrency)
+    try await messaging.subscribe(toTopic: topic)
+
+    try await messaging.unsubscribe(fromTopic: topic)
+
+    try await messaging.token()
+
+    try await messaging.retrieveFCMToken(forSenderID: "fakeSenderID")
+
+    try await messaging.deleteToken()
+
+    try await messaging.deleteFCMToken(forSenderID: "fakeSenderID")
+
+    try await messaging.deleteData()
+  #endif
+}

SwiftDashboard.md

@@ -10,8 +10,8 @@ tasks for additional Swift improvements.
 |                       | AB  | An     | ApC    | ApD    | Aut    | Cor    | Crs    | DB     | Fst    | Fn     | IAM    | Ins    | Msg    | MLM    | Prf    | RC     |    Str |
 |   :---                | :--- | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: |
 | **Swift Library**     | ❌   |   ✔   | ❌     |❌     | ❌     | ❌     | ❌      |  ✔     |  ✔    | 1      |  ✔     | ❌    | ❌     | ✔      | ❌     | ❌    | ✔     |
-| **API Tests**         | ❌   |  ❌    |  ✔    |❌     | ❌     | ✔       | ❌     | 3      | 2     |  ✔     | 2      | ✔      | ❌     | 2      | ❌    |  ✔     | ✔    |
-| **async/await**       | ❌   |  n/a   |  ✔    |❌     | ❌     |  ✔      | ❌     | 3     | ❌     |  ✔     | ❌     | ❌    | ❌     | ❌    | ❌     |  ✔    | ✔    |
+| **API Tests**         | ❌   |  ❌    |  ✔    |❌     | ❌     | ✔       | ❌     | 3      | 2     |  ✔     | 2      | ✔      | 2     | 2      | ❌    |  ✔     | ✔    |
+| **async/await**       | ❌   |  n/a   |  ✔    |❌     | ❌     |  ✔      | ❌     | 3     | ❌     |  ✔     | ❌     | ❌    | ✔     | ❌    | ❌     |  ✔    | ✔    |
 | **Swift Errors**      |  ❌  |  ❌    | ❌    |❌     | 4      | ❌     | ❌     | ❌     | ❌    | ❌     | ❌     | ❌    | ❌     | ✔      | ❌     | ❌   | 5   |
 | **Codable**           | n/a  | n/a     | n/a   |n/a    | n/a     | n/a    |n/a     |  ✔     |  ✔     | 1      | n/a     | n/a   | ❌     | n/a    | n/a    |  ❌  |n/a   |
 | **SwiftUI Lifecycle** | n/a  |  ❌    | n/a    |❌     | ❌     | n/a    |n/a     | n/a    | n/a    | n/a     | n/a    | n/a   | ❌     | n/a    | n/a    | n/a   |n/a  |

scripts/build.sh

@@ -370,6 +370,12 @@ case "$product-$platform-$method" in
 
   Messaging-*-xcodebuild)
     pod_gen FirebaseMessaging.podspec --platforms=ios
+
+    # Add GoogleService-Info.plist to generated Test Wrapper App.
+    ruby ./scripts/update_xcode_target.rb gen/FirebaseMessaging/Pods/Pods.xcodeproj \
+      AppHost-FirebaseMessaging-Unit-Tests \
+      ../../../FirebaseMessaging/Tests/IntegrationTests/Resources/GoogleService-Info.plist
+
     RunXcodebuild \
       -workspace 'gen/FirebaseMessaging/FirebaseMessaging.xcworkspace' \
       -scheme "FirebaseMessaging-Unit-unit" \