• 배경
• 과정
• URLRequest to Response
• URLProtocol
• canInit
• canonicalRequest
• startLoading
• stopLoading
• XCTestCase에서 사용해보기
• 결과
• 참고 문서

배경

네트워킹을 테스트하긴 해야할 것 같은데.. 어떻게 하지...?

아..! 학습 스프린트 때 URLProtocol이란걸 언급하셨던 것 같은데..!?

과정

URLRequest to Response

앱은 실제로 네트워크 통신을 하기 위해 위 사진과 같은 과정을 거칩니다.

1. URLRequest를 생성하고
2. URLRequest를 이용해 URLSession Task를 만듭니다.
3. 서버와 데이터를 주고 받으면
4. 받은 데이터를 파싱해서 사용합니다.

저희는 이 중에서 3번 과정을 Mock 서버로 바꾸고 싶은거죠?

URLSession을 만들 때 필요한 URLSessionConfiguration은 URLProtocol들을 사용한다고 하는데요,

let configuration: URLSessionConfiguration = .ephemeral
configuration.protocolClasses?.insert(MockURLProtocol.self, at: .zero)

여기에 저희가 원하는 커스텀 Protocol을 넣는다면?

저희가 원하는 방식대로 URLSession을 사용할 수 있는겁니다!

이 URLProtocol이 네트워크 커넥션을 열고, Request를 생성하고, Response를 받아 처리하는 과정까지 모든 걸 원하는 방식대로 만들어줄 수 있기 때문에 Mocking에 유용한 것이죠.

근데 말로만 들어보면 테스팅이 아니라 일반적으로 사용할 때도 꽤 유용할 수 있겠다는 생각이 듭니다.

URLProtocol

어떤 놈인지는 알았지만 그래도 정의는 한 번 봐줘야겠죠? 공식문서 고고

프로토콜에 따라 URL 데이터를 불러오는 과정을 핸들링하는 추상 클래스

이름은 Protocol인데 정작 클래스네요..ㅎ

사용법은 URLProtocol을 상속받고, override 메서드를 네 가지 작성해주면 됩니다.

canInit

주어진 URLRequest에 URLProtocol을 적용할 지 여부를 결정합니다.

request 파라미터에 어떤 조건문을 걸어서 true나 false를 반환해주면 되는데...

대부분의 경우에는 그냥 true를 반환해주면 됩니다.

canonicalRequest

여기서는 사용할 URLRequest를 바꿔치기 할 수 있는데요..

마찬가지로 대부분의 경우 그냥 request를 그대로 반환해줍니다.

startLoading

실제로 요청을 처리하는 메서드입니다.

static var requestHandler: ((URLRequest) throws -> (HTTPURLResponse, Data))?

이런 requestHandler를 하나 만들어서

guard let handler = MockURLProtocol.requestHandler else {
	XCTFail("Received unexpected request with no handler set")
	return
}

do {
	let (response, data) = try handler(request)
	client?.urlProtocol(self, didReceive: response, cacheStoragePolicy: .notAllowed)
	client?.urlProtocol(self, didLoad: data)
	client?.urlProtocolDidFinishLoading(self)
} catch {
	client?.urlProtocol(self, didFailWithError: error)
}

이런식으로 사용해줍니다.

stopLoading

이 메서드는 Task가 취소되어야 할 때의 행동강령들을 적는 곳인데요,

MockURLProtocol의 경우에는 취소를 목적으로 하지는 않기 때문에 빈 칸으로 비워두었습니다.

XCTestCase에서 사용해보기

이렇게 MockURLProtocol을 생성했다면 사용할 준비가 끝난겁니다!

override func setUp() {
	URLProtocol.registerClass(MockURLProtocol.self)
	let configuration: URLSessionConfiguration = .ephemeral
	configuration.protocolClasses?.insert(MockURLProtocol.self, at: .zero)
	let session = URLSession(configuration: configuration)
	self.networking = MSNetworking(session: session)
}

setUp에서 앞서 봤던대로 URLSessionConfiguration에 MockURLProtocol을 넣어줍니다.

그리고 해당 Configuration으로 URLSession을 만들어서 사용해주면 됩니다!

각 Test Case마다 다른 Response를 테스트하겠죠?

MockURLProtocol.requestHandler = { _ **in**
	let response = HTTPURLResponse(url: URL(string: "https://api.codesquad.kr")!,
								   statusCode: 200,
								   httpVersion: nil,
								   headerFields: ["Content-Type": "application/json"])!
	return (response, data)
}

MockURLProtocol에 static으로 정의해두었던 requestHandler를 여기서 정의해주면 됩니다.

이렇게 원하는 response를 만들어서 반환을 해주면, MockURLProtocol의 startLoading 메서드에서 해당 핸들러로 주어진 응답을 고정적으로 내놓게 되는 것이죠.

결과

Repository단에서 Mock을 만들어서 반환하는 방법만 사용할 수 있는 줄 알았는데,

이렇게 네트워킹 자체를 Mocking할 수 있다는 점이 꽤 신기했습니다.

Response의 statusCode나 특별한 응답에 대한 테스트 케이스를 작성할 때 아주 유용하게 사용할 수 있을 것 같네요.

참고 문서

WWDC2018 - Testing Tips & Tricks