[iOS/Swift] 비동기(async) 테스트

참고 사이트 및 출처

원문 Kodeco의 iOS Unit Testing and UI Testing Tutorial을 번역한 yoonbumatae의 글을 정리한 포스팅입니다. 더 자세한 내용을 참고하시려면 아래 두 링크를 참고하세요!

https://www.kodeco.com/21020457-ios-unit-testing-and-ui-testing-tutorial

iOS Unit Testing and UI Testing Tutorial

http://yoonbumtae.com/?p=4020 

Swift(스위프트): iOS 단위 테스트(Unit test) 및 UI 테스트 튜토리얼 - BGSMM

 

Intro

• 유닛 테스트는 안정적으로 진행되어야 하며 테스트 동안 request가 일어날 경우 예상치 못한 이유로 테스트가 영향을 받을 수 있음

Tutorial

• 가장 많이 사용되는 방법은 URLSession을 확장하고 프로토콜을 생성해서 URLSession이 채택하도록 한다. 그러면 기존에 URLSession을 사용하면서 URLSession과 같은 모양의 Mock 역활을 하는 함수를 만들 수 있다.

typealias DataTaskCompletionHandler = (Data?, URLResponse?, Error?) -> Void

(해당 코드는 구 raywenderlich 현 kodeco에서 참고 했습니다. 자세한 내용은 해당 포스팅 상단에 있습니다)

 

• typealias로 정의한 DataTaskCompletionHandler는 URLSession의 dataTask의 클로져 반환값과 동일한 형태. 정의 해줘도 되고 안해줘도 됨. (아래 처럼 코드가 좀더 깔끔함)

protocol URLSessionProtocol {
  func dataTask(
    with url: URL,
    completionHandler: @escaping DataTaskCompletionHandler
  ) -> URLSessionDataTask
}

• URLSession의 dataTask 함수와 동일한 형태의 protocol을 정의해 줌

extension URLSession: URLSessionProtocol { }

var urlSession: URLSessionProtocol = URLSession.shared

• URLSession이 URLSessionProtocol을 채택하면 URLSession은 기존에 dataTask를 사용할 수 있음
• 테스트할 객체의 URLSession을 설정할 때 타입을 URLSessionProtocol 타입으로 지정하면 기존의 URLSession을 사용하면서도  URLSession 처럼 행동하는 테스트용 가짜 URLSession을 주입할 수 있음

class URLSessionStub: URLSessionProtocol {
  private let stubbedData: Data?
  private let stubbedResponse: URLResponse?
  private let stubbedError: Error?

  public init(data: Data? = nil, response: URLResponse? = nil, error: Error? = nil) {
    self.stubbedData = data
    self.stubbedResponse = response
    self.stubbedError = error
  }

  public func dataTask(
    with url: URL,
    completionHandler: @escaping DataTaskCompletionHandler
  ) -> URLSessionDataTask {
    URLSessionDataTaskStub(
      stubbedData: stubbedData,
      stubbedResponse: stubbedResponse,
      stubbedError: stubbedError,
      completionHandler: completionHandler
    )
  }
}

• URLSessionStub은 URLSession과 같은 역활을 하지만 실제 request는 하지 않는 객체
• UnitTest에서 URLSession을 주입하지 않고 URLSessionStub을 주입해서 사용

UnitTest

  func testStartNewRoundUsesRandomValueFromApiRequest() {
    // given
    // 1
    let stubbedData = "[1]".data(using: .utf8)
    let urlString = "http://www.randomnumberapi.com/api/v1.0/random?min=0&max=100&count=1"
    let url = URL(string: urlString)!
    let stubbedResponse = HTTPURLResponse(
      url: url,
      statusCode: 200,
      httpVersion: nil,
      headerFields: nil)
    let urlSessionStub = URLSessionStub(
      data: stubbedData,
      response: stubbedResponse,
      error: nil)
    sut.urlSession = urlSessionStub
    let promise = expectation(description: "Completion handler invoked")

    // when
    sut.startNewRound {
      // then
      // 2
      XCTAssertEqual(self.sut.targetValue, 1)
      promise.fulfill()
    }
    wait(for: [promise], timeout: 5)
  }

(해당 코드는 구 raywenderlich 현 kodeco에서 참고 했습니다. 자세한 내용은 해당 포스팅 상단에 있습니다)

 

    let stubbedData = "[1]".data(using: .utf8)
    let urlString = "http://www.randomnumberapi.com/api/v1.0/random?min=0&max=100&count=1"

• urlString는 url의 파라미터에서 보낸 값 대로 최소 0, 최대 100의 한 개의 랜덤 숫자를 어레이에 담아 보내 줌
• stubbedData에 전달하는 스트링 값이 stub 데이터로, 테스트 케이스의 예상한 동작을 위해 필요한 값. 이를 Data로 바꾸어 주는데, 이 값을 테스트 결과 값과 비교하게 되고 실제 request는 일어나지 않음

    let urlSessionStub = URLSessionStub(
      data: stubbedData,
      response: stubbedResponse,
      error: nil)
    sut.urlSession = urlSessionStub

class BullsEyeGame {
	.. 생략
  var urlSession: URLSessionProtocol = URLSession.shared
  	.. 생략
}

• URLSessionStub은 URLSessionProtocol을 채택하고 있기 때문에 테스트할 클래스인 BullsEyeGame의 urlSession으로 주입해 줄 수 있음

    let promise = expectation(description: "Completion handler invoked")
    wait(for: [promise], timeout: 5)

• expectation을 사용해서 비동기 테스트 할 수 있음. 비동기 작업이 완료될 때 수행할 수 있는 XCTestExpectation 인스턴스를 생성함
• 5초 동안 테스트 실행이 끝날 때까지 기다림
• fulfill()을 호출해서 테스트가 끝났음을 알릴 수 있음

    sut.startNewRound {
      // then
      // 2
      XCTAssertEqual(self.sut.targetValue, 1)
      promise.fulfill()
    }

• 테스트 코드를 실행해서 나온 값과 예상한 값이 같다고 정의 한 뒤 fulfill을 통해 비동기 테스트를 끝냄