单元测试 iOS 10 通知

Question

在我的应用程序中，我希望断言通知已以正确的格式添加。我通常会通过依赖注入来做到这一点，但我想不出一种方法来测试新的UNUserNotificationCenter API。

我开始创建一个模拟对象来捕获通知请求：

import Foundation
import UserNotifications

class NotificationCenterMock: UNUserNotificationCenter {
    var request: UNNotificationRequest? = nil
    override func add(_ request: UNNotificationRequest, withCompletionHandler completionHandler: ((Error?) -> Void)? = nil) {
        self.request = request
    }
}

但是，UNUserNotificationCenter 没有可访问的初始化程序，我无法实例化模拟。

我什至不确定是否可以通过添加通知请求并获取当前通知来进行测试，因为测试需要请求模拟器的权限，这会导致测试停止。目前我已经将通知逻辑重构为一个包装器，因此我至少可以在整个应用程序中模拟它并手动测试。

我有比手动测试更好的选择吗？

Answer 1

您可以使用UNUserNotificationCenter，然后在返回的settings 上使用setValue

UNUserNotificationCenter.current().getNotificationSettings(completionHandler: { settings in
    let status: UNAuthorizationStatus = .authorized
    settings.setValue(status.rawValue, forKey: "authorizationStatus")
    completionHandler(settings)
})

Answer 2

虽然测试UNUserNotificationCenter 是否被调用而不是测试它是否实际工作（Apple 应该测试它）很可能是正确的，但您不需要任何权限来安排然后检查预定通知。只有在实际显示通知时才需要权限（而且您绝对不会在单元测试中对其进行测试）。

在我的单元测试中，我调用真正的UNUserNotificationCenter 实现，然后检查预定的通知 (UNUserNotificationCenter.current().getPendingNotificationRequests)，所有这些都无需任何权限即可工作，并且测试运行得非常快。这种方法比已经提出的方法快得多（从这个意义上说，您需要编写更少的代码来进行测试）。

Answer 3

您可以为您正在使用的方法创建一个协议，并在 UNUserNotificationCenter 上进行扩展以符合它。 该协议将充当原始 UNUserNotificationCenter 实现和您的模拟对象之间的“桥梁”，以替换其方法实现。

这是我在操场上编写的示例代码，运行良好：

/* UNUserNotificationCenterProtocol.swift */

// This protocol allows you to use UNUserNotificationCenter, and replace the implementation of its 
// methods in you test classes.
protocol UNUserNotificationCenterProtocol: class {
  // Declare only the methods that you'll be using.
  func add(_ request: UNNotificationRequest,
           withCompletionHandler completionHandler: ((Error?) -> Void)?)
}

// The mock class that you'll be using for your test classes. Replace the method contents with your mock
// objects.
class MockNotificationCenter: UNUserNotificationCenterProtocol {

  var addRequestExpectation: XCTestExpectation?

  func add(_ request: UNNotificationRequest,
           withCompletionHandler completionHandler: ((Error?) -> Void)?) {
    // Do anything you want here for your tests, fulfill the expectation to pass the test.
    addRequestExpectation?.fulfill()
    print("Mock center log")
    completionHandler?(nil)
  }
}

// Must extend UNUserNotificationCenter to conform to this protocol in order to use it in your class.
extension UNUserNotificationCenter: UNUserNotificationCenterProtocol {
// I'm only adding this implementation to show a log message in this example. In order to use the original implementation, don't add it here.
  func add(_ request: UNNotificationRequest, withCompletionHandler completionHandler: ((Error?) -> Void)?) {
    print("Notification center log")
    completionHandler?(nil)
  }
}

/* ExampleClass.swift */

class ExampleClass {

  // Even though the type is UNUserNotificationCenterProtocol, it will take UNUserNotificationCenter type
  // because of the extension above.
  var notificationCenter: UNUserNotificationCenterProtocol = UNUserNotificationCenter.current()

  func doSomething() {
    // Create a request.
    let content = UNNotificationContent()
    let request = UNNotificationRequest(identifier: "Request",
                                           content: content,
                                           trigger: nil)
    notificationCenter.add(request) { (error: Error?) in
      // completion handler code
    }
  }
}

let exampleClass = ExampleClass()
exampleClass.doSomething() // This should log "Notification center log"

EDITED:
/* TestClass.Swift (unit test class) */

class TestClass {
  // Class being tested 
  var exampleClass: ExampleClass!    
  // Create your mock class.
  var mockNotificationCenter = MockNotificationCenter()

  func setUp() {
     super.setUp()
     exampleClass = ExampleClass()
     exampleClass.notificationCenter = mockNotificationCenter 
  }

  func testDoSomething() {
    mockNotificationCenter.addRequestExpectation = expectation(description: "Add request should've been called")
    exampleClass.doSomething()
    waitForExpectations(timeout: 1)
  }
}
// Once you run the test, the expectation will be called and "Mock Center Log" will be printed

请记住，每次使用新方法时，都必须将其添加到协议中，否则编译器会报错。

希望这会有所帮助！