ValidationTests.swift 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978
  1. //
  2. // ValidationTests.swift
  3. //
  4. // Copyright (c) 2014-2016 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 StatusCodeValidationTestCase: BaseTestCase {
  28. func testThatValidationForRequestWithAcceptableStatusCodeResponseSucceeds() {
  29. // Given
  30. let urlString = "https://httpbin.org/status/200"
  31. let expectation1 = self.expectation(description: "request should return 200 status code")
  32. let expectation2 = self.expectation(description: "download should return 200 status code")
  33. var requestError: Error?
  34. var downloadError: Error?
  35. // When
  36. Alamofire.request(urlString)
  37. .validate(statusCode: 200..<300)
  38. .response { resp in
  39. requestError = resp.error
  40. expectation1.fulfill()
  41. }
  42. Alamofire.download(urlString)
  43. .validate(statusCode: 200..<300)
  44. .response { resp in
  45. downloadError = resp.error
  46. expectation2.fulfill()
  47. }
  48. waitForExpectations(timeout: timeout, handler: nil)
  49. // Then
  50. XCTAssertNil(requestError)
  51. XCTAssertNil(downloadError)
  52. }
  53. func testThatValidationForRequestWithUnacceptableStatusCodeResponseFails() {
  54. // Given
  55. let urlString = "https://httpbin.org/status/404"
  56. let expectation1 = self.expectation(description: "request should return 404 status code")
  57. let expectation2 = self.expectation(description: "download should return 404 status code")
  58. var requestError: Error?
  59. var downloadError: Error?
  60. // When
  61. Alamofire.request(urlString)
  62. .validate(statusCode: [200])
  63. .response { resp in
  64. requestError = resp.error
  65. expectation1.fulfill()
  66. }
  67. Alamofire.download(urlString)
  68. .validate(statusCode: [200])
  69. .response { resp in
  70. downloadError = resp.error
  71. expectation2.fulfill()
  72. }
  73. waitForExpectations(timeout: timeout, handler: nil)
  74. // Then
  75. XCTAssertNotNil(requestError)
  76. XCTAssertNotNil(downloadError)
  77. for error in [requestError, downloadError] {
  78. if let error = error as? AFError, let statusCode = error.responseCode {
  79. XCTAssertTrue(error.isUnacceptableStatusCode)
  80. XCTAssertEqual(statusCode, 404)
  81. } else {
  82. XCTFail("Error should not be nil, should be an AFError, and should have an associated statusCode.")
  83. }
  84. }
  85. }
  86. func testThatValidationForRequestWithNoAcceptableStatusCodesFails() {
  87. // Given
  88. let urlString = "https://httpbin.org/status/201"
  89. let expectation1 = self.expectation(description: "request should return 201 status code")
  90. let expectation2 = self.expectation(description: "download should return 201 status code")
  91. var requestError: Error?
  92. var downloadError: Error?
  93. // When
  94. Alamofire.request(urlString)
  95. .validate(statusCode: [])
  96. .response { resp in
  97. requestError = resp.error
  98. expectation1.fulfill()
  99. }
  100. Alamofire.download(urlString)
  101. .validate(statusCode: [])
  102. .response { resp in
  103. downloadError = resp.error
  104. expectation2.fulfill()
  105. }
  106. waitForExpectations(timeout: timeout, handler: nil)
  107. // Then
  108. XCTAssertNotNil(requestError)
  109. XCTAssertNotNil(downloadError)
  110. for error in [requestError, downloadError] {
  111. if let error = error as? AFError, let statusCode = error.responseCode {
  112. XCTAssertTrue(error.isUnacceptableStatusCode)
  113. XCTAssertEqual(statusCode, 201)
  114. } else {
  115. XCTFail("Error should not be nil, should be an AFError, and should have an associated statusCode.")
  116. }
  117. }
  118. }
  119. }
  120. // MARK: -
  121. class ContentTypeValidationTestCase: BaseTestCase {
  122. func testThatValidationForRequestWithAcceptableContentTypeResponseSucceeds() {
  123. // Given
  124. let urlString = "https://httpbin.org/ip"
  125. let expectation1 = self.expectation(description: "request should succeed and return ip")
  126. let expectation2 = self.expectation(description: "download should succeed and return ip")
  127. var requestError: Error?
  128. var downloadError: Error?
  129. // When
  130. Alamofire.request(urlString)
  131. .validate(contentType: ["application/json"])
  132. .validate(contentType: ["application/json;charset=utf8"])
  133. .validate(contentType: ["application/json;q=0.8;charset=utf8"])
  134. .response { resp in
  135. requestError = resp.error
  136. expectation1.fulfill()
  137. }
  138. Alamofire.download(urlString)
  139. .validate(contentType: ["application/json"])
  140. .validate(contentType: ["application/json;charset=utf8"])
  141. .validate(contentType: ["application/json;q=0.8;charset=utf8"])
  142. .response { resp in
  143. downloadError = resp.error
  144. expectation2.fulfill()
  145. }
  146. waitForExpectations(timeout: timeout, handler: nil)
  147. // Then
  148. XCTAssertNil(requestError)
  149. XCTAssertNil(downloadError)
  150. }
  151. func testThatValidationForRequestWithAcceptableWildcardContentTypeResponseSucceeds() {
  152. // Given
  153. let urlString = "https://httpbin.org/ip"
  154. let expectation1 = self.expectation(description: "request should succeed and return ip")
  155. let expectation2 = self.expectation(description: "download should succeed and return ip")
  156. var requestError: Error?
  157. var downloadError: Error?
  158. // When
  159. Alamofire.request(urlString)
  160. .validate(contentType: ["*/*"])
  161. .validate(contentType: ["application/*"])
  162. .validate(contentType: ["*/json"])
  163. .response { resp in
  164. requestError = resp.error
  165. expectation1.fulfill()
  166. }
  167. Alamofire.download(urlString)
  168. .validate(contentType: ["*/*"])
  169. .validate(contentType: ["application/*"])
  170. .validate(contentType: ["*/json"])
  171. .response { resp in
  172. downloadError = resp.error
  173. expectation2.fulfill()
  174. }
  175. waitForExpectations(timeout: timeout, handler: nil)
  176. // Then
  177. XCTAssertNil(requestError)
  178. XCTAssertNil(downloadError)
  179. }
  180. func testThatValidationForRequestWithUnacceptableContentTypeResponseFails() {
  181. // Given
  182. let urlString = "https://httpbin.org/xml"
  183. let expectation1 = self.expectation(description: "request should succeed and return xml")
  184. let expectation2 = self.expectation(description: "download should succeed and return xml")
  185. var requestError: Error?
  186. var downloadError: Error?
  187. // When
  188. Alamofire.request(urlString)
  189. .validate(contentType: ["application/octet-stream"])
  190. .response { resp in
  191. requestError = resp.error
  192. expectation1.fulfill()
  193. }
  194. Alamofire.download(urlString)
  195. .validate(contentType: ["application/octet-stream"])
  196. .response { resp in
  197. downloadError = resp.error
  198. expectation2.fulfill()
  199. }
  200. waitForExpectations(timeout: timeout, handler: nil)
  201. // Then
  202. XCTAssertNotNil(requestError)
  203. XCTAssertNotNil(downloadError)
  204. for error in [requestError, downloadError] {
  205. if let error = error as? AFError {
  206. XCTAssertTrue(error.isUnacceptableContentType)
  207. XCTAssertEqual(error.responseContentType, "application/xml")
  208. XCTAssertEqual(error.acceptableContentTypes?.first, "application/octet-stream")
  209. } else {
  210. XCTFail("error should not be nil")
  211. }
  212. }
  213. }
  214. func testThatValidationForRequestWithNoAcceptableContentTypeResponseFails() {
  215. // Given
  216. let urlString = "https://httpbin.org/xml"
  217. let expectation1 = self.expectation(description: "request should succeed and return xml")
  218. let expectation2 = self.expectation(description: "download should succeed and return xml")
  219. var requestError: Error?
  220. var downloadError: Error?
  221. // When
  222. Alamofire.request(urlString)
  223. .validate(contentType: [])
  224. .response { resp in
  225. requestError = resp.error
  226. expectation1.fulfill()
  227. }
  228. Alamofire.download(urlString)
  229. .validate(contentType: [])
  230. .response { resp in
  231. downloadError = resp.error
  232. expectation2.fulfill()
  233. }
  234. waitForExpectations(timeout: timeout, handler: nil)
  235. // Then
  236. XCTAssertNotNil(requestError)
  237. XCTAssertNotNil(downloadError)
  238. for error in [requestError, downloadError] {
  239. if let error = error as? AFError {
  240. XCTAssertTrue(error.isUnacceptableContentType)
  241. XCTAssertEqual(error.responseContentType, "application/xml")
  242. XCTAssertTrue(error.acceptableContentTypes?.isEmpty ?? false)
  243. } else {
  244. XCTFail("error should not be nil")
  245. }
  246. }
  247. }
  248. func testThatValidationForRequestWithNoAcceptableContentTypeResponseSucceedsWhenNoDataIsReturned() {
  249. // Given
  250. let urlString = "https://httpbin.org/status/204"
  251. let expectation1 = self.expectation(description: "request should succeed and return no data")
  252. let expectation2 = self.expectation(description: "download should succeed and return no data")
  253. var requestError: Error?
  254. var downloadError: Error?
  255. // When
  256. Alamofire.request(urlString)
  257. .validate(contentType: [])
  258. .response { resp in
  259. requestError = resp.error
  260. expectation1.fulfill()
  261. }
  262. Alamofire.download(urlString)
  263. .validate(contentType: [])
  264. .response { resp in
  265. downloadError = resp.error
  266. expectation2.fulfill()
  267. }
  268. waitForExpectations(timeout: timeout, handler: nil)
  269. // Then
  270. XCTAssertNil(requestError)
  271. XCTAssertNil(downloadError)
  272. }
  273. func testThatValidationForRequestWithAcceptableWildcardContentTypeResponseSucceedsWhenResponseIsNil() {
  274. // Given
  275. class MockManager: SessionManager {
  276. override func request(resource urlRequest: URLRequestConvertible) -> DataRequest {
  277. do {
  278. let originalRequest = try urlRequest.asURLRequest()
  279. let originalTask = DataRequest.Requestable(urlRequest: originalRequest)
  280. let task = try originalTask.task(session: session, adapter: adapter, queue: queue)
  281. let request = MockDataRequest(
  282. session: session,
  283. requestType: .data,
  284. task: task,
  285. originalTask: originalTask
  286. )
  287. delegate[task] = request
  288. if startRequestsImmediately { request.resume() }
  289. return request
  290. } catch {
  291. return DataRequest(session: session, requestType: .data, error: error)
  292. }
  293. }
  294. override func download(
  295. resource urlRequest: URLRequestConvertible,
  296. to destination: DownloadRequest.DownloadFileDestination? = nil)
  297. -> DownloadRequest
  298. {
  299. do {
  300. let originalRequest = try urlRequest.asURLRequest()
  301. let originalTask = DownloadRequest.Downloadable.request(originalRequest)
  302. let task = try originalTask.task(session: session, adapter: adapter, queue: queue)
  303. let request = MockDownloadRequest(
  304. session: session,
  305. requestType: .download,
  306. task: task,
  307. originalTask: originalTask
  308. )
  309. request.downloadDelegate.destination = destination
  310. delegate[task] = request
  311. if startRequestsImmediately { request.resume() }
  312. return request
  313. } catch {
  314. return DownloadRequest(session: session, requestType: .download, error: error)
  315. }
  316. }
  317. }
  318. class MockDataRequest: DataRequest {
  319. override var response: HTTPURLResponse? {
  320. return MockHTTPURLResponse(
  321. url: request!.url!,
  322. statusCode: 204,
  323. httpVersion: "HTTP/1.1",
  324. headerFields: nil
  325. )
  326. }
  327. }
  328. class MockDownloadRequest: DownloadRequest {
  329. override var response: HTTPURLResponse? {
  330. return MockHTTPURLResponse(
  331. url: request!.url!,
  332. statusCode: 204,
  333. httpVersion: "HTTP/1.1",
  334. headerFields: nil
  335. )
  336. }
  337. }
  338. class MockHTTPURLResponse: HTTPURLResponse {
  339. override var mimeType: String? { return nil }
  340. }
  341. let manager: SessionManager = {
  342. let configuration: URLSessionConfiguration = {
  343. let configuration = URLSessionConfiguration.ephemeral
  344. configuration.httpAdditionalHeaders = SessionManager.defaultHTTPHeaders
  345. return configuration
  346. }()
  347. return MockManager(configuration: configuration)
  348. }()
  349. let urlString = "https://httpbin.org/delete"
  350. let expectation1 = self.expectation(description: "request should be stubbed and return 204 status code")
  351. let expectation2 = self.expectation(description: "download should be stubbed and return 204 status code")
  352. var requestResponse: DefaultDataResponse?
  353. var downloadResponse: DefaultDownloadResponse?
  354. // When
  355. manager.request(urlString, method: .delete)
  356. .validate(contentType: ["*/*"])
  357. .response { resp in
  358. requestResponse = resp
  359. expectation1.fulfill()
  360. }
  361. manager.download(urlString, method: .delete)
  362. .validate(contentType: ["*/*"])
  363. .response { resp in
  364. downloadResponse = resp
  365. expectation2.fulfill()
  366. }
  367. waitForExpectations(timeout: timeout, handler: nil)
  368. // Then
  369. XCTAssertNotNil(requestResponse?.response)
  370. XCTAssertNotNil(requestResponse?.data)
  371. XCTAssertNil(requestResponse?.error)
  372. XCTAssertEqual(requestResponse?.response?.statusCode, 204)
  373. XCTAssertNil(requestResponse?.response?.mimeType)
  374. XCTAssertNotNil(downloadResponse?.response)
  375. XCTAssertNotNil(downloadResponse?.temporaryURL)
  376. XCTAssertNil(downloadResponse?.destinationURL)
  377. XCTAssertNil(downloadResponse?.error)
  378. XCTAssertEqual(downloadResponse?.response?.statusCode, 204)
  379. XCTAssertNil(downloadResponse?.response?.mimeType)
  380. }
  381. }
  382. // MARK: -
  383. class MultipleValidationTestCase: BaseTestCase {
  384. func testThatValidationForRequestWithAcceptableStatusCodeAndContentTypeResponseSucceeds() {
  385. // Given
  386. let urlString = "https://httpbin.org/ip"
  387. let expectation1 = self.expectation(description: "request should succeed and return ip")
  388. let expectation2 = self.expectation(description: "request should succeed and return ip")
  389. var requestError: Error?
  390. var downloadError: Error?
  391. // When
  392. Alamofire.request(urlString)
  393. .validate(statusCode: 200..<300)
  394. .validate(contentType: ["application/json"])
  395. .response { resp in
  396. requestError = resp.error
  397. expectation1.fulfill()
  398. }
  399. Alamofire.download(urlString)
  400. .validate(statusCode: 200..<300)
  401. .validate(contentType: ["application/json"])
  402. .response { resp in
  403. downloadError = resp.error
  404. expectation2.fulfill()
  405. }
  406. waitForExpectations(timeout: timeout, handler: nil)
  407. // Then
  408. XCTAssertNil(requestError)
  409. XCTAssertNil(downloadError)
  410. }
  411. func testThatValidationForRequestWithUnacceptableStatusCodeAndContentTypeResponseFailsWithStatusCodeError() {
  412. // Given
  413. let urlString = "https://httpbin.org/xml"
  414. let expectation1 = self.expectation(description: "request should succeed and return xml")
  415. let expectation2 = self.expectation(description: "download should succeed and return xml")
  416. var requestError: Error?
  417. var downloadError: Error?
  418. // When
  419. Alamofire.request(urlString)
  420. .validate(statusCode: 400..<600)
  421. .validate(contentType: ["application/octet-stream"])
  422. .response { resp in
  423. requestError = resp.error
  424. expectation1.fulfill()
  425. }
  426. Alamofire.download(urlString)
  427. .validate(statusCode: 400..<600)
  428. .validate(contentType: ["application/octet-stream"])
  429. .response { resp in
  430. downloadError = resp.error
  431. expectation2.fulfill()
  432. }
  433. waitForExpectations(timeout: timeout, handler: nil)
  434. // Then
  435. XCTAssertNotNil(requestError)
  436. XCTAssertNotNil(downloadError)
  437. for error in [requestError, downloadError] {
  438. if let error = error as? AFError {
  439. XCTAssertTrue(error.isUnacceptableStatusCode)
  440. XCTAssertEqual(error.responseCode, 200)
  441. } else {
  442. XCTFail("error should not be nil")
  443. }
  444. }
  445. }
  446. func testThatValidationForRequestWithUnacceptableStatusCodeAndContentTypeResponseFailsWithContentTypeError() {
  447. // Given
  448. let urlString = "https://httpbin.org/xml"
  449. let expectation1 = self.expectation(description: "request should succeed and return xml")
  450. let expectation2 = self.expectation(description: "download should succeed and return xml")
  451. var requestError: Error?
  452. var downloadError: Error?
  453. // When
  454. Alamofire.request(urlString)
  455. .validate(contentType: ["application/octet-stream"])
  456. .validate(statusCode: 400..<600)
  457. .response { resp in
  458. requestError = resp.error
  459. expectation1.fulfill()
  460. }
  461. Alamofire.download(urlString)
  462. .validate(contentType: ["application/octet-stream"])
  463. .validate(statusCode: 400..<600)
  464. .response { resp in
  465. downloadError = resp.error
  466. expectation2.fulfill()
  467. }
  468. waitForExpectations(timeout: timeout, handler: nil)
  469. // Then
  470. XCTAssertNotNil(requestError)
  471. XCTAssertNotNil(downloadError)
  472. for error in [requestError, downloadError] {
  473. if let error = error as? AFError {
  474. XCTAssertTrue(error.isUnacceptableContentType)
  475. XCTAssertEqual(error.responseContentType, "application/xml")
  476. XCTAssertEqual(error.acceptableContentTypes?.first, "application/octet-stream")
  477. } else {
  478. XCTFail("error should not be nil")
  479. }
  480. }
  481. }
  482. }
  483. // MARK: -
  484. class AutomaticValidationTestCase: BaseTestCase {
  485. func testThatValidationForRequestWithAcceptableStatusCodeAndContentTypeResponseSucceeds() {
  486. // Given
  487. let url = URL(string: "https://httpbin.org/ip")!
  488. var urlRequest = URLRequest(url: url)
  489. urlRequest.setValue("application/json", forHTTPHeaderField: "Accept")
  490. let expectation1 = self.expectation(description: "request should succeed and return ip")
  491. let expectation2 = self.expectation(description: "download should succeed and return ip")
  492. var requestError: Error?
  493. var downloadError: Error?
  494. // When
  495. Alamofire.request(resource: urlRequest)
  496. .validate()
  497. .response { resp in
  498. requestError = resp.error
  499. expectation1.fulfill()
  500. }
  501. Alamofire.download(resource: urlRequest)
  502. .validate()
  503. .response { resp in
  504. downloadError = resp.error
  505. expectation2.fulfill()
  506. }
  507. waitForExpectations(timeout: timeout, handler: nil)
  508. // Then
  509. XCTAssertNil(requestError)
  510. XCTAssertNil(downloadError)
  511. }
  512. func testThatValidationForRequestWithUnacceptableStatusCodeResponseFails() {
  513. // Given
  514. let urlString = "https://httpbin.org/status/404"
  515. let expectation1 = self.expectation(description: "request should return 404 status code")
  516. let expectation2 = self.expectation(description: "download should return 404 status code")
  517. var requestError: Error?
  518. var downloadError: Error?
  519. // When
  520. Alamofire.request(urlString)
  521. .validate()
  522. .response { resp in
  523. requestError = resp.error
  524. expectation1.fulfill()
  525. }
  526. Alamofire.download(urlString)
  527. .validate()
  528. .response { resp in
  529. downloadError = resp.error
  530. expectation2.fulfill()
  531. }
  532. waitForExpectations(timeout: timeout, handler: nil)
  533. // Then
  534. XCTAssertNotNil(requestError)
  535. XCTAssertNotNil(downloadError)
  536. for error in [requestError, downloadError] {
  537. if let error = error as? AFError, let statusCode = error.responseCode {
  538. XCTAssertTrue(error.isUnacceptableStatusCode)
  539. XCTAssertEqual(statusCode, 404)
  540. } else {
  541. XCTFail("error should not be nil")
  542. }
  543. }
  544. }
  545. func testThatValidationForRequestWithAcceptableWildcardContentTypeResponseSucceeds() {
  546. // Given
  547. let url = URL(string: "https://httpbin.org/ip")!
  548. var urlRequest = URLRequest(url: url)
  549. urlRequest.setValue("application/*", forHTTPHeaderField: "Accept")
  550. let expectation1 = self.expectation(description: "request should succeed and return ip")
  551. let expectation2 = self.expectation(description: "download should succeed and return ip")
  552. var requestError: Error?
  553. var downloadError: Error?
  554. // When
  555. Alamofire.request(resource: urlRequest)
  556. .validate()
  557. .response { resp in
  558. requestError = resp.error
  559. expectation1.fulfill()
  560. }
  561. Alamofire.download(resource: urlRequest)
  562. .validate()
  563. .response { resp in
  564. downloadError = resp.error
  565. expectation2.fulfill()
  566. }
  567. waitForExpectations(timeout: timeout, handler: nil)
  568. // Then
  569. XCTAssertNil(requestError)
  570. XCTAssertNil(downloadError)
  571. }
  572. func testThatValidationForRequestWithAcceptableComplexContentTypeResponseSucceeds() {
  573. // Given
  574. let url = URL(string: "https://httpbin.org/xml")!
  575. var urlRequest = URLRequest(url: url)
  576. let headerValue = "text/xml, application/xml, application/xhtml+xml, text/html;q=0.9, text/plain;q=0.8,*/*;q=0.5"
  577. urlRequest.setValue(headerValue, forHTTPHeaderField: "Accept")
  578. let expectation1 = self.expectation(description: "request should succeed and return xml")
  579. let expectation2 = self.expectation(description: "request should succeed and return xml")
  580. var requestError: Error?
  581. var downloadError: Error?
  582. // When
  583. Alamofire.request(resource: urlRequest)
  584. .validate()
  585. .response { resp in
  586. requestError = resp.error
  587. expectation1.fulfill()
  588. }
  589. Alamofire.download(resource: urlRequest)
  590. .validate()
  591. .response { resp in
  592. downloadError = resp.error
  593. expectation2.fulfill()
  594. }
  595. waitForExpectations(timeout: timeout, handler: nil)
  596. // Then
  597. XCTAssertNil(requestError)
  598. XCTAssertNil(downloadError)
  599. }
  600. func testThatValidationForRequestWithUnacceptableContentTypeResponseFails() {
  601. // Given
  602. let url = URL(string: "https://httpbin.org/xml")!
  603. var urlRequest = URLRequest(url: url)
  604. urlRequest.setValue("application/json", forHTTPHeaderField: "Accept")
  605. let expectation1 = self.expectation(description: "request should succeed and return xml")
  606. let expectation2 = self.expectation(description: "download should succeed and return xml")
  607. var requestError: Error?
  608. var downloadError: Error?
  609. // When
  610. Alamofire.request(resource: urlRequest)
  611. .validate()
  612. .response { resp in
  613. requestError = resp.error
  614. expectation1.fulfill()
  615. }
  616. Alamofire.download(resource: urlRequest)
  617. .validate()
  618. .response { resp in
  619. downloadError = resp.error
  620. expectation2.fulfill()
  621. }
  622. waitForExpectations(timeout: timeout, handler: nil)
  623. // Then
  624. XCTAssertNotNil(requestError)
  625. XCTAssertNotNil(downloadError)
  626. for error in [requestError, downloadError] {
  627. if let error = error as? AFError {
  628. XCTAssertTrue(error.isUnacceptableContentType)
  629. XCTAssertEqual(error.responseContentType, "application/xml")
  630. XCTAssertEqual(error.acceptableContentTypes?.first, "application/json")
  631. } else {
  632. XCTFail("error should not be nil")
  633. }
  634. }
  635. }
  636. }
  637. // MARK: -
  638. private enum ValidationError: Error {
  639. case missingData, missingFile, fileReadFailed
  640. }
  641. extension DataRequest {
  642. func validateDataExists() -> Self {
  643. return validate { request, response, data in
  644. guard data != nil else { return .failure(ValidationError.missingData) }
  645. return .success
  646. }
  647. }
  648. func validate(with error: Error) -> Self {
  649. return validate { _, _, _ in .failure(error) }
  650. }
  651. }
  652. extension DownloadRequest {
  653. func validateDataExists() -> Self {
  654. return validate { request, response, _, _ in
  655. let fileURL = self.downloadDelegate.fileURL
  656. guard let validFileURL = fileURL else { return .failure(ValidationError.missingFile) }
  657. do {
  658. let _ = try Data(contentsOf: validFileURL)
  659. return .success
  660. } catch {
  661. return .failure(ValidationError.fileReadFailed)
  662. }
  663. }
  664. }
  665. func validate(with error: Error) -> Self {
  666. return validate { _, _, _, _ in .failure(error) }
  667. }
  668. }
  669. // MARK: -
  670. class CustomValidationTestCase: BaseTestCase {
  671. func testThatCustomValidationClosureHasAccessToServerResponseData() {
  672. // Given
  673. let urlString = "https://httpbin.org/get"
  674. let expectation1 = self.expectation(description: "request should return 200 status code")
  675. let expectation2 = self.expectation(description: "download should return 200 status code")
  676. var requestError: Error?
  677. var downloadError: Error?
  678. // When
  679. Alamofire.request(urlString)
  680. .validate { request, response, data in
  681. guard data != nil else { return .failure(ValidationError.missingData) }
  682. return .success
  683. }
  684. .response { resp in
  685. requestError = resp.error
  686. expectation1.fulfill()
  687. }
  688. Alamofire.download(urlString)
  689. .validate { request, response, temporaryURL, destinationURL in
  690. guard let fileURL = temporaryURL else { return .failure(ValidationError.missingFile) }
  691. do {
  692. let _ = try Data(contentsOf: fileURL)
  693. return .success
  694. } catch {
  695. return .failure(ValidationError.fileReadFailed)
  696. }
  697. }
  698. .response { resp in
  699. downloadError = resp.error
  700. expectation2.fulfill()
  701. }
  702. waitForExpectations(timeout: timeout, handler: nil)
  703. // Then
  704. XCTAssertNil(requestError)
  705. XCTAssertNil(downloadError)
  706. }
  707. func testThatCustomValidationCanThrowCustomError() {
  708. // Given
  709. let urlString = "https://httpbin.org/get"
  710. let expectation1 = self.expectation(description: "request should return 200 status code")
  711. let expectation2 = self.expectation(description: "download should return 200 status code")
  712. var requestError: Error?
  713. var downloadError: Error?
  714. // When
  715. Alamofire.request(urlString)
  716. .validate { _, _, _ in .failure(ValidationError.missingData) }
  717. .validate { _, _, _ in .failure(ValidationError.missingFile) } // should be ignored
  718. .response { resp in
  719. requestError = resp.error
  720. expectation1.fulfill()
  721. }
  722. Alamofire.download(urlString)
  723. .validate { _, _, _, _ in .failure(ValidationError.missingFile) }
  724. .validate { _, _, _, _ in .failure(ValidationError.fileReadFailed) } // should be ignored
  725. .response { resp in
  726. downloadError = resp.error
  727. expectation2.fulfill()
  728. }
  729. waitForExpectations(timeout: timeout, handler: nil)
  730. // Then
  731. XCTAssertEqual(requestError as? ValidationError, ValidationError.missingData)
  732. XCTAssertEqual(downloadError as? ValidationError, ValidationError.missingFile)
  733. }
  734. func testThatValidationExtensionHasAccessToServerResponseData() {
  735. // Given
  736. let urlString = "https://httpbin.org/get"
  737. let expectation1 = self.expectation(description: "request should return 200 status code")
  738. let expectation2 = self.expectation(description: "download should return 200 status code")
  739. var requestError: Error?
  740. var downloadError: Error?
  741. // When
  742. Alamofire.request(urlString)
  743. .validateDataExists()
  744. .response { resp in
  745. requestError = resp.error
  746. expectation1.fulfill()
  747. }
  748. Alamofire.download(urlString)
  749. .validateDataExists()
  750. .response { resp in
  751. downloadError = resp.error
  752. expectation2.fulfill()
  753. }
  754. waitForExpectations(timeout: timeout, handler: nil)
  755. // Then
  756. XCTAssertNil(requestError)
  757. XCTAssertNil(downloadError)
  758. }
  759. func testThatValidationExtensionCanThrowCustomError() {
  760. // Given
  761. let urlString = "https://httpbin.org/get"
  762. let expectation1 = self.expectation(description: "request should return 200 status code")
  763. let expectation2 = self.expectation(description: "download should return 200 status code")
  764. var requestError: Error?
  765. var downloadError: Error?
  766. // When
  767. Alamofire.request(urlString)
  768. .validate(with: ValidationError.missingData)
  769. .validate(with: ValidationError.missingFile) // should be ignored
  770. .response { resp in
  771. requestError = resp.error
  772. expectation1.fulfill()
  773. }
  774. Alamofire.download(urlString)
  775. .validate(with: ValidationError.missingFile)
  776. .validate(with: ValidationError.fileReadFailed) // should be ignored
  777. .response { resp in
  778. downloadError = resp.error
  779. expectation2.fulfill()
  780. }
  781. waitForExpectations(timeout: timeout, handler: nil)
  782. // Then
  783. XCTAssertEqual(requestError as? ValidationError, ValidationError.missingData)
  784. XCTAssertEqual(downloadError as? ValidationError, ValidationError.missingFile)
  785. }
  786. }