SessionManagerTests.swift 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866
  1. //
  2. // SessionManagerTests.swift
  3. //
  4. // Copyright (c) 2014 Alamofire Software Foundation (http://alamofire.org/)
  5. //
  6. // Permission is hereby granted, free of charge, to any person obtaining a copy
  7. // of this software and associated documentation files (the "Software"), to deal
  8. // in the Software without restriction, including without limitation the rights
  9. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. // copies of the Software, and to permit persons to whom the Software is
  11. // furnished to do so, subject to the following conditions:
  12. //
  13. // The above copyright notice and this permission notice shall be included in
  14. // all copies or substantial portions of the Software.
  15. //
  16. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22. // THE SOFTWARE.
  23. //
  24. @testable import Alamofire
  25. import Foundation
  26. import XCTest
  27. class SessionManagerTestCase: BaseTestCase {
  28. // MARK: Helper Types
  29. private class HTTPMethodAdapter: RequestAdapter {
  30. let method: HTTPMethod
  31. let throwsError: Bool
  32. init(method: HTTPMethod, throwsError: Bool = false) {
  33. self.method = method
  34. self.throwsError = throwsError
  35. }
  36. func adapt(_ urlRequest: URLRequest) throws -> URLRequest {
  37. guard !throwsError else { throw AFError.invalidURL(url: "") }
  38. var urlRequest = urlRequest
  39. urlRequest.httpMethod = method.rawValue
  40. return urlRequest
  41. }
  42. }
  43. private class RequestHandler: RequestAdapter, RequestRetrier {
  44. var adaptedCount = 0
  45. var retryCount = 0
  46. var retryErrors: [Error] = []
  47. var shouldApplyAuthorizationHeader = false
  48. var throwsErrorOnSecondAdapt = false
  49. func adapt(_ urlRequest: URLRequest) throws -> URLRequest {
  50. if throwsErrorOnSecondAdapt && adaptedCount == 1 {
  51. throwsErrorOnSecondAdapt = false
  52. throw AFError.invalidURL(url: "")
  53. }
  54. var urlRequest = urlRequest
  55. adaptedCount += 1
  56. if shouldApplyAuthorizationHeader && adaptedCount > 1 {
  57. if let header = Request.authorizationHeader(user: "user", password: "password") {
  58. urlRequest.setValue(header.value, forHTTPHeaderField: header.key)
  59. }
  60. }
  61. return urlRequest
  62. }
  63. func should(_ manager: SessionManager, retry request: Request, with error: Error, completion: @escaping RequestRetryCompletion) {
  64. retryCount += 1
  65. retryErrors.append(error)
  66. if retryCount < 2 {
  67. completion(true, 0.0)
  68. } else {
  69. completion(false, 0.0)
  70. }
  71. }
  72. }
  73. private class UploadHandler: RequestAdapter, RequestRetrier {
  74. var adaptedCount = 0
  75. var retryCount = 0
  76. var retryErrors: [Error] = []
  77. func adapt(_ urlRequest: URLRequest) throws -> URLRequest {
  78. adaptedCount += 1
  79. if adaptedCount == 1 { throw AFError.invalidURL(url: "") }
  80. return urlRequest
  81. }
  82. func should(_ manager: SessionManager, retry request: Request, with error: Error, completion: @escaping RequestRetryCompletion) {
  83. retryCount += 1
  84. retryErrors.append(error)
  85. completion(true, 0.0)
  86. }
  87. }
  88. // MARK: Tests - Initialization
  89. func testInitializerWithDefaultArguments() {
  90. // Given, When
  91. let manager = SessionManager()
  92. // Then
  93. XCTAssertNotNil(manager.session.delegate, "session delegate should not be nil")
  94. XCTAssertTrue(manager.delegate === manager.session.delegate, "manager delegate should equal session delegate")
  95. XCTAssertNil(manager.session.serverTrustPolicyManager, "session server trust policy manager should be nil")
  96. }
  97. func testInitializerWithSpecifiedArguments() {
  98. // Given
  99. let configuration = URLSessionConfiguration.default
  100. let delegate = SessionDelegate()
  101. let serverTrustPolicyManager = ServerTrustPolicyManager(policies: [:])
  102. // When
  103. let manager = SessionManager(
  104. configuration: configuration,
  105. delegate: delegate,
  106. serverTrustPolicyManager: serverTrustPolicyManager
  107. )
  108. // Then
  109. XCTAssertNotNil(manager.session.delegate, "session delegate should not be nil")
  110. XCTAssertTrue(manager.delegate === manager.session.delegate, "manager delegate should equal session delegate")
  111. XCTAssertNotNil(manager.session.serverTrustPolicyManager, "session server trust policy manager should not be nil")
  112. }
  113. func testThatFailableInitializerSucceedsWithDefaultArguments() {
  114. // Given
  115. let delegate = SessionDelegate()
  116. let session: URLSession = {
  117. let configuration = URLSessionConfiguration.default
  118. return URLSession(configuration: configuration, delegate: delegate, delegateQueue: nil)
  119. }()
  120. // When
  121. let manager = SessionManager(session: session, delegate: delegate)
  122. // Then
  123. if let manager = manager {
  124. XCTAssertTrue(manager.delegate === manager.session.delegate, "manager delegate should equal session delegate")
  125. XCTAssertNil(manager.session.serverTrustPolicyManager, "session server trust policy manager should be nil")
  126. } else {
  127. XCTFail("manager should not be nil")
  128. }
  129. }
  130. func testThatFailableInitializerSucceedsWithSpecifiedArguments() {
  131. // Given
  132. let delegate = SessionDelegate()
  133. let session: URLSession = {
  134. let configuration = URLSessionConfiguration.default
  135. return URLSession(configuration: configuration, delegate: delegate, delegateQueue: nil)
  136. }()
  137. let serverTrustPolicyManager = ServerTrustPolicyManager(policies: [:])
  138. // When
  139. let manager = SessionManager(session: session, delegate: delegate, serverTrustPolicyManager: serverTrustPolicyManager)
  140. // Then
  141. if let manager = manager {
  142. XCTAssertTrue(manager.delegate === manager.session.delegate, "manager delegate should equal session delegate")
  143. XCTAssertNotNil(manager.session.serverTrustPolicyManager, "session server trust policy manager should not be nil")
  144. } else {
  145. XCTFail("manager should not be nil")
  146. }
  147. }
  148. func testThatFailableInitializerFailsWithWhenDelegateDoesNotEqualSessionDelegate() {
  149. // Given
  150. let delegate = SessionDelegate()
  151. let session: URLSession = {
  152. let configuration = URLSessionConfiguration.default
  153. return URLSession(configuration: configuration, delegate: SessionDelegate(), delegateQueue: nil)
  154. }()
  155. // When
  156. let manager = SessionManager(session: session, delegate: delegate)
  157. // Then
  158. XCTAssertNil(manager, "manager should be nil")
  159. }
  160. func testThatFailableInitializerFailsWhenSessionDelegateIsNil() {
  161. // Given
  162. let delegate = SessionDelegate()
  163. let session: URLSession = {
  164. let configuration = URLSessionConfiguration.default
  165. return URLSession(configuration: configuration, delegate: nil, delegateQueue: nil)
  166. }()
  167. // When
  168. let manager = SessionManager(session: session, delegate: delegate)
  169. // Then
  170. XCTAssertNil(manager, "manager should be nil")
  171. }
  172. // MARK: Tests - Default HTTP Headers
  173. func testDefaultUserAgentHeader() {
  174. // Given, When
  175. let userAgent = SessionManager.defaultHTTPHeaders["User-Agent"]
  176. // Then
  177. let osNameVersion: String = {
  178. let version = ProcessInfo.processInfo.operatingSystemVersion
  179. let versionString = "\(version.majorVersion).\(version.minorVersion).\(version.patchVersion)"
  180. let osName: String = {
  181. #if os(iOS)
  182. return "iOS"
  183. #elseif os(watchOS)
  184. return "watchOS"
  185. #elseif os(tvOS)
  186. return "tvOS"
  187. #elseif os(macOS)
  188. return "OS X"
  189. #elseif os(Linux)
  190. return "Linux"
  191. #else
  192. return "Unknown"
  193. #endif
  194. }()
  195. return "\(osName) \(versionString)"
  196. }()
  197. let alamofireVersion: String = {
  198. guard
  199. let afInfo = Bundle(for: SessionManager.self).infoDictionary,
  200. let build = afInfo["CFBundleShortVersionString"]
  201. else { return "Unknown" }
  202. return "Alamofire/\(build)"
  203. }()
  204. XCTAssertTrue(userAgent?.contains(alamofireVersion) == true)
  205. XCTAssertTrue(userAgent?.contains(osNameVersion) == true)
  206. XCTAssertTrue(userAgent?.contains("Unknown/Unknown") == true)
  207. // let expectedUserAgent = "Unknown/Unknown (Unknown; build:Unknown; \(osNameVersion)) \(alamofireVersion)"
  208. // XCTAssertEqual(userAgent, expectedUserAgent)
  209. }
  210. // MARK: Tests - Start Requests Immediately
  211. func testSetStartRequestsImmediatelyToFalseAndResumeRequest() {
  212. // Given
  213. let manager = SessionManager()
  214. manager.startRequestsImmediately = false
  215. let url = URL(string: "https://httpbin.org/get")!
  216. let urlRequest = URLRequest(url: url)
  217. let expectation = self.expectation(description: "\(url)")
  218. var response: HTTPURLResponse?
  219. // When
  220. manager.request(urlRequest)
  221. .response { resp in
  222. response = resp.response
  223. expectation.fulfill()
  224. }
  225. .resume()
  226. waitForExpectations(timeout: timeout, handler: nil)
  227. // Then
  228. XCTAssertNotNil(response, "response should not be nil")
  229. XCTAssertTrue(response?.statusCode == 200, "response status code should be 200")
  230. }
  231. // MARK: Tests - Deinitialization
  232. func testReleasingManagerWithPendingRequestDeinitializesSuccessfully() {
  233. // Given
  234. var manager: SessionManager? = SessionManager()
  235. manager?.startRequestsImmediately = false
  236. let url = URL(string: "https://httpbin.org/get")!
  237. let urlRequest = URLRequest(url: url)
  238. // When
  239. let request = manager?.request(urlRequest)
  240. manager = nil
  241. // Then
  242. XCTAssertTrue(request?.task?.state == .suspended, "request task state should be '.Suspended'")
  243. XCTAssertNil(manager, "manager should be nil")
  244. }
  245. func testReleasingManagerWithPendingCanceledRequestDeinitializesSuccessfully() {
  246. // Given
  247. var manager: SessionManager? = SessionManager()
  248. manager!.startRequestsImmediately = false
  249. let url = URL(string: "https://httpbin.org/get")!
  250. let urlRequest = URLRequest(url: url)
  251. // When
  252. let request = manager!.request(urlRequest)
  253. request.cancel()
  254. manager = nil
  255. // Then
  256. let state = request.task?.state
  257. XCTAssertTrue(state == .canceling || state == .completed, "state should be .Canceling or .Completed")
  258. XCTAssertNil(manager, "manager should be nil")
  259. }
  260. // MARK: Tests - Bad Requests
  261. func testThatDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
  262. // Given
  263. let sessionManager = SessionManager()
  264. let expectation = self.expectation(description: "Request should fail with error")
  265. var response: DefaultDataResponse?
  266. // When
  267. sessionManager.request("https://httpbin.org/get/äëïöü").response { resp in
  268. response = resp
  269. expectation.fulfill()
  270. }
  271. waitForExpectations(timeout: timeout, handler: nil)
  272. // Then
  273. XCTAssertNil(response?.request)
  274. XCTAssertNil(response?.response)
  275. XCTAssertNotNil(response?.data)
  276. XCTAssertEqual(response?.data?.count, 0)
  277. XCTAssertNotNil(response?.error)
  278. if let error = response?.error as? AFError {
  279. XCTAssertTrue(error.isInvalidURLError)
  280. XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
  281. } else {
  282. XCTFail("error should not be nil")
  283. }
  284. }
  285. func testThatDownloadRequestWithInvalidURLStringThrowsResponseHandlerError() {
  286. // Given
  287. let sessionManager = SessionManager()
  288. let expectation = self.expectation(description: "Download should fail with error")
  289. var response: DefaultDownloadResponse?
  290. // When
  291. sessionManager.download("https://httpbin.org/get/äëïöü").response { resp in
  292. response = resp
  293. expectation.fulfill()
  294. }
  295. waitForExpectations(timeout: timeout, handler: nil)
  296. // Then
  297. XCTAssertNil(response?.request)
  298. XCTAssertNil(response?.response)
  299. XCTAssertNil(response?.temporaryURL)
  300. XCTAssertNil(response?.destinationURL)
  301. XCTAssertNil(response?.resumeData)
  302. XCTAssertNotNil(response?.error)
  303. if let error = response?.error as? AFError {
  304. XCTAssertTrue(error.isInvalidURLError)
  305. XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
  306. } else {
  307. XCTFail("error should not be nil")
  308. }
  309. }
  310. func testThatUploadDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
  311. // Given
  312. let sessionManager = SessionManager()
  313. let expectation = self.expectation(description: "Upload should fail with error")
  314. var response: DefaultDataResponse?
  315. // When
  316. sessionManager.upload(Data(), to: "https://httpbin.org/get/äëïöü").response { resp in
  317. response = resp
  318. expectation.fulfill()
  319. }
  320. waitForExpectations(timeout: timeout, handler: nil)
  321. // Then
  322. XCTAssertNil(response?.request)
  323. XCTAssertNil(response?.response)
  324. XCTAssertNotNil(response?.data)
  325. XCTAssertEqual(response?.data?.count, 0)
  326. XCTAssertNotNil(response?.error)
  327. if let error = response?.error as? AFError {
  328. XCTAssertTrue(error.isInvalidURLError)
  329. XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
  330. } else {
  331. XCTFail("error should not be nil")
  332. }
  333. }
  334. func testThatUploadFileRequestWithInvalidURLStringThrowsResponseHandlerError() {
  335. // Given
  336. let sessionManager = SessionManager()
  337. let expectation = self.expectation(description: "Upload should fail with error")
  338. var response: DefaultDataResponse?
  339. // When
  340. sessionManager.upload(URL(fileURLWithPath: "/invalid"), to: "https://httpbin.org/get/äëïöü").response { resp in
  341. response = resp
  342. expectation.fulfill()
  343. }
  344. waitForExpectations(timeout: timeout, handler: nil)
  345. // Then
  346. XCTAssertNil(response?.request)
  347. XCTAssertNil(response?.response)
  348. XCTAssertNotNil(response?.data)
  349. XCTAssertEqual(response?.data?.count, 0)
  350. XCTAssertNotNil(response?.error)
  351. if let error = response?.error as? AFError {
  352. XCTAssertTrue(error.isInvalidURLError)
  353. XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
  354. } else {
  355. XCTFail("error should not be nil")
  356. }
  357. }
  358. func testThatUploadStreamRequestWithInvalidURLStringThrowsResponseHandlerError() {
  359. // Given
  360. let sessionManager = SessionManager()
  361. let expectation = self.expectation(description: "Upload should fail with error")
  362. var response: DefaultDataResponse?
  363. // When
  364. sessionManager.upload(InputStream(data: Data()), to: "https://httpbin.org/get/äëïöü").response { resp in
  365. response = resp
  366. expectation.fulfill()
  367. }
  368. waitForExpectations(timeout: timeout, handler: nil)
  369. // Then
  370. XCTAssertNil(response?.request)
  371. XCTAssertNil(response?.response)
  372. XCTAssertNotNil(response?.data)
  373. XCTAssertEqual(response?.data?.count, 0)
  374. XCTAssertNotNil(response?.error)
  375. if let error = response?.error as? AFError {
  376. XCTAssertTrue(error.isInvalidURLError)
  377. XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
  378. } else {
  379. XCTFail("error should not be nil")
  380. }
  381. }
  382. // MARK: Tests - Request Adapter
  383. func testThatSessionManagerCallsRequestAdapterWhenCreatingDataRequest() {
  384. // Given
  385. let adapter = HTTPMethodAdapter(method: .post)
  386. let sessionManager = SessionManager()
  387. sessionManager.adapter = adapter
  388. sessionManager.startRequestsImmediately = false
  389. // When
  390. let request = sessionManager.request("https://httpbin.org/get")
  391. // Then
  392. XCTAssertEqual(request.task?.originalRequest?.httpMethod, adapter.method.rawValue)
  393. }
  394. func testThatSessionManagerCallsRequestAdapterWhenCreatingDownloadRequest() {
  395. // Given
  396. let adapter = HTTPMethodAdapter(method: .post)
  397. let sessionManager = SessionManager()
  398. sessionManager.adapter = adapter
  399. sessionManager.startRequestsImmediately = false
  400. // When
  401. let destination = DownloadRequest.suggestedDownloadDestination()
  402. let request = sessionManager.download("https://httpbin.org/get", to: destination)
  403. // Then
  404. XCTAssertEqual(request.task?.originalRequest?.httpMethod, adapter.method.rawValue)
  405. }
  406. func testThatSessionManagerCallsRequestAdapterWhenCreatingUploadRequestWithData() {
  407. // Given
  408. let adapter = HTTPMethodAdapter(method: .get)
  409. let sessionManager = SessionManager()
  410. sessionManager.adapter = adapter
  411. sessionManager.startRequestsImmediately = false
  412. // When
  413. let request = sessionManager.upload("data".data(using: .utf8)!, to: "https://httpbin.org/post")
  414. // Then
  415. XCTAssertEqual(request.task?.originalRequest?.httpMethod, adapter.method.rawValue)
  416. }
  417. func testThatSessionManagerCallsRequestAdapterWhenCreatingUploadRequestWithFile() {
  418. // Given
  419. let adapter = HTTPMethodAdapter(method: .get)
  420. let sessionManager = SessionManager()
  421. sessionManager.adapter = adapter
  422. sessionManager.startRequestsImmediately = false
  423. // When
  424. let fileURL = URL(fileURLWithPath: "/path/to/some/file.txt")
  425. let request = sessionManager.upload(fileURL, to: "https://httpbin.org/post")
  426. // Then
  427. XCTAssertEqual(request.task?.originalRequest?.httpMethod, adapter.method.rawValue)
  428. }
  429. func testThatSessionManagerCallsRequestAdapterWhenCreatingUploadRequestWithInputStream() {
  430. // Given
  431. let adapter = HTTPMethodAdapter(method: .get)
  432. let sessionManager = SessionManager()
  433. sessionManager.adapter = adapter
  434. sessionManager.startRequestsImmediately = false
  435. // When
  436. let inputStream = InputStream(data: "data".data(using: .utf8)!)
  437. let request = sessionManager.upload(inputStream, to: "https://httpbin.org/post")
  438. // Then
  439. XCTAssertEqual(request.task?.originalRequest?.httpMethod, adapter.method.rawValue)
  440. }
  441. func testThatRequestAdapterErrorThrowsResponseHandlerError() {
  442. // Given
  443. let adapter = HTTPMethodAdapter(method: .post, throwsError: true)
  444. let sessionManager = SessionManager()
  445. sessionManager.adapter = adapter
  446. sessionManager.startRequestsImmediately = false
  447. // When
  448. let request = sessionManager.request("https://httpbin.org/get")
  449. // Then
  450. if let error = request.delegate.error as? AFError {
  451. XCTAssertTrue(error.isInvalidURLError)
  452. XCTAssertEqual(error.urlConvertible as? String, "")
  453. } else {
  454. XCTFail("error should not be nil")
  455. }
  456. }
  457. // MARK: Tests - Request Retrier
  458. func testThatSessionManagerCallsRequestRetrierWhenRequestEncountersError() {
  459. // Given
  460. let handler = RequestHandler()
  461. let sessionManager = SessionManager()
  462. sessionManager.adapter = handler
  463. sessionManager.retrier = handler
  464. let expectation = self.expectation(description: "request should eventually fail")
  465. var response: DataResponse<Any>?
  466. // When
  467. let request = sessionManager.request("https://httpbin.org/basic-auth/user/password")
  468. .validate()
  469. .responseJSON { jsonResponse in
  470. response = jsonResponse
  471. expectation.fulfill()
  472. }
  473. waitForExpectations(timeout: timeout, handler: nil)
  474. // Then
  475. XCTAssertEqual(handler.adaptedCount, 2)
  476. XCTAssertEqual(handler.retryCount, 2)
  477. XCTAssertEqual(request.retryCount, 1)
  478. XCTAssertEqual(response?.result.isSuccess, false)
  479. XCTAssertTrue(sessionManager.delegate.requests.isEmpty)
  480. }
  481. func testThatSessionManagerCallsRequestRetrierWhenRequestInitiallyEncountersAdaptError() {
  482. // Given
  483. let handler = RequestHandler()
  484. handler.adaptedCount = 1
  485. handler.throwsErrorOnSecondAdapt = true
  486. handler.shouldApplyAuthorizationHeader = true
  487. let sessionManager = SessionManager()
  488. sessionManager.adapter = handler
  489. sessionManager.retrier = handler
  490. let expectation = self.expectation(description: "request should eventually fail")
  491. var response: DataResponse<Any>?
  492. // When
  493. sessionManager.request("https://httpbin.org/basic-auth/user/password")
  494. .validate()
  495. .responseJSON { jsonResponse in
  496. response = jsonResponse
  497. expectation.fulfill()
  498. }
  499. waitForExpectations(timeout: timeout, handler: nil)
  500. // Then
  501. XCTAssertEqual(handler.adaptedCount, 2)
  502. XCTAssertEqual(handler.retryCount, 1)
  503. XCTAssertEqual(response?.result.isSuccess, true)
  504. XCTAssertTrue(sessionManager.delegate.requests.isEmpty)
  505. handler.retryErrors.forEach { XCTAssertFalse($0 is AdaptError) }
  506. }
  507. func testThatSessionManagerCallsRequestRetrierWhenDownloadInitiallyEncountersAdaptError() {
  508. // Given
  509. let handler = RequestHandler()
  510. handler.adaptedCount = 1
  511. handler.throwsErrorOnSecondAdapt = true
  512. handler.shouldApplyAuthorizationHeader = true
  513. let sessionManager = SessionManager()
  514. sessionManager.adapter = handler
  515. sessionManager.retrier = handler
  516. let expectation = self.expectation(description: "request should eventually fail")
  517. var response: DownloadResponse<Any>?
  518. let destination: DownloadRequest.DownloadFileDestination = { _, _ in
  519. let fileURL = self.testDirectoryURL.appendingPathComponent("test-output.json")
  520. return (fileURL, [.removePreviousFile])
  521. }
  522. // When
  523. sessionManager.download("https://httpbin.org/basic-auth/user/password", to: destination)
  524. .validate()
  525. .responseJSON { jsonResponse in
  526. response = jsonResponse
  527. expectation.fulfill()
  528. }
  529. waitForExpectations(timeout: timeout, handler: nil)
  530. // Then
  531. XCTAssertEqual(handler.adaptedCount, 2)
  532. XCTAssertEqual(handler.retryCount, 1)
  533. XCTAssertEqual(response?.result.isSuccess, true)
  534. XCTAssertTrue(sessionManager.delegate.requests.isEmpty)
  535. handler.retryErrors.forEach { XCTAssertFalse($0 is AdaptError) }
  536. }
  537. func testThatSessionManagerCallsRequestRetrierWhenUploadInitiallyEncountersAdaptError() {
  538. // Given
  539. let handler = UploadHandler()
  540. let sessionManager = SessionManager()
  541. sessionManager.adapter = handler
  542. sessionManager.retrier = handler
  543. let expectation = self.expectation(description: "request should eventually fail")
  544. var response: DataResponse<Any>?
  545. let uploadData = "upload data".data(using: .utf8, allowLossyConversion: false)!
  546. // When
  547. sessionManager.upload(uploadData, to: "https://httpbin.org/post")
  548. .validate()
  549. .responseJSON { jsonResponse in
  550. response = jsonResponse
  551. expectation.fulfill()
  552. }
  553. waitForExpectations(timeout: timeout, handler: nil)
  554. // Then
  555. XCTAssertEqual(handler.adaptedCount, 2)
  556. XCTAssertEqual(handler.retryCount, 1)
  557. XCTAssertEqual(response?.result.isSuccess, true)
  558. XCTAssertTrue(sessionManager.delegate.requests.isEmpty)
  559. handler.retryErrors.forEach { XCTAssertFalse($0 is AdaptError) }
  560. }
  561. func testThatSessionManagerCallsAdapterWhenRequestIsRetried() {
  562. // Given
  563. let handler = RequestHandler()
  564. handler.shouldApplyAuthorizationHeader = true
  565. let sessionManager = SessionManager()
  566. sessionManager.adapter = handler
  567. sessionManager.retrier = handler
  568. let expectation = self.expectation(description: "request should eventually fail")
  569. var response: DataResponse<Any>?
  570. // When
  571. let request = sessionManager.request("https://httpbin.org/basic-auth/user/password")
  572. .validate()
  573. .responseJSON { jsonResponse in
  574. response = jsonResponse
  575. expectation.fulfill()
  576. }
  577. waitForExpectations(timeout: timeout, handler: nil)
  578. // Then
  579. XCTAssertEqual(handler.adaptedCount, 2)
  580. XCTAssertEqual(handler.retryCount, 1)
  581. XCTAssertEqual(request.retryCount, 1)
  582. XCTAssertEqual(response?.result.isSuccess, true)
  583. XCTAssertTrue(sessionManager.delegate.requests.isEmpty)
  584. }
  585. func testThatRequestAdapterErrorThrowsResponseHandlerErrorWhenRequestIsRetried() {
  586. // Given
  587. let handler = RequestHandler()
  588. handler.throwsErrorOnSecondAdapt = true
  589. let sessionManager = SessionManager()
  590. sessionManager.adapter = handler
  591. sessionManager.retrier = handler
  592. let expectation = self.expectation(description: "request should eventually fail")
  593. var response: DataResponse<Any>?
  594. // When
  595. let request = sessionManager.request("https://httpbin.org/basic-auth/user/password")
  596. .validate()
  597. .responseJSON { jsonResponse in
  598. response = jsonResponse
  599. expectation.fulfill()
  600. }
  601. waitForExpectations(timeout: timeout, handler: nil)
  602. // Then
  603. XCTAssertEqual(handler.adaptedCount, 1)
  604. XCTAssertEqual(handler.retryCount, 1)
  605. XCTAssertEqual(request.retryCount, 0)
  606. XCTAssertEqual(response?.result.isSuccess, false)
  607. XCTAssertTrue(sessionManager.delegate.requests.isEmpty)
  608. if let error = response?.result.error as? AFError {
  609. XCTAssertTrue(error.isInvalidURLError)
  610. XCTAssertEqual(error.urlConvertible as? String, "")
  611. } else {
  612. XCTFail("error should not be nil")
  613. }
  614. }
  615. }
  616. // MARK: -
  617. class SessionManagerConfigurationHeadersTestCase: BaseTestCase {
  618. enum ConfigurationType {
  619. case `default`, ephemeral, background
  620. }
  621. func testThatDefaultConfigurationHeadersAreSentWithRequest() {
  622. // Given, When, Then
  623. executeAuthorizationHeaderTest(for: .default)
  624. }
  625. func testThatEphemeralConfigurationHeadersAreSentWithRequest() {
  626. // Given, When, Then
  627. executeAuthorizationHeaderTest(for: .ephemeral)
  628. }
  629. #if os(macOS)
  630. func testThatBackgroundConfigurationHeadersAreSentWithRequest() {
  631. // Given, When, Then
  632. executeAuthorizationHeaderTest(for: .background)
  633. }
  634. #endif
  635. private func executeAuthorizationHeaderTest(for type: ConfigurationType) {
  636. // Given
  637. let manager: SessionManager = {
  638. let configuration: URLSessionConfiguration = {
  639. let configuration: URLSessionConfiguration
  640. switch type {
  641. case .default:
  642. configuration = .default
  643. case .ephemeral:
  644. configuration = .ephemeral
  645. case .background:
  646. let identifier = "org.alamofire.test.manager-configuration-tests"
  647. configuration = .background(withIdentifier: identifier)
  648. }
  649. var headers = SessionManager.defaultHTTPHeaders
  650. headers["Authorization"] = "Bearer 123456"
  651. configuration.httpAdditionalHeaders = headers
  652. return configuration
  653. }()
  654. return SessionManager(configuration: configuration)
  655. }()
  656. let expectation = self.expectation(description: "request should complete successfully")
  657. var response: DataResponse<Any>?
  658. // When
  659. manager.request("https://httpbin.org/headers")
  660. .responseJSON { closureResponse in
  661. response = closureResponse
  662. expectation.fulfill()
  663. }
  664. waitForExpectations(timeout: timeout, handler: nil)
  665. // Then
  666. if let response = response {
  667. XCTAssertNotNil(response.request, "request should not be nil")
  668. XCTAssertNotNil(response.response, "response should not be nil")
  669. XCTAssertNotNil(response.data, "data should not be nil")
  670. XCTAssertTrue(response.result.isSuccess, "result should be a success")
  671. if
  672. let response = response.result.value as? [String: Any],
  673. let headers = response["headers"] as? [String: String],
  674. let authorization = headers["Authorization"]
  675. {
  676. XCTAssertEqual(authorization, "Bearer 123456", "authorization header value does not match")
  677. } else {
  678. XCTFail("failed to extract authorization header value")
  679. }
  680. } else {
  681. XCTFail("response should not be nil")
  682. }
  683. }
  684. }