ValidationTests.swift 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954
  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=utf-8"])
  133. .validate(contentType: ["application/json; q=0.8; charset=utf-8"])
  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=utf-8"])
  141. .validate(contentType: ["application/json; q=0.8; charset=utf-8"])
  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(_ 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(session: session, requestTask: .data(originalTask, task))
  282. delegate[task] = request
  283. if startRequestsImmediately { request.resume() }
  284. return request
  285. } catch {
  286. let request = DataRequest(session: session, requestTask: .data(nil, nil), error: error)
  287. if startRequestsImmediately { request.resume() }
  288. return request
  289. }
  290. }
  291. override func download(
  292. _ urlRequest: URLRequestConvertible,
  293. to destination: DownloadRequest.DownloadFileDestination? = nil)
  294. -> DownloadRequest
  295. {
  296. do {
  297. let originalRequest = try urlRequest.asURLRequest()
  298. let originalTask = DownloadRequest.Downloadable.request(originalRequest)
  299. let task = try originalTask.task(session: session, adapter: adapter, queue: queue)
  300. let request = MockDownloadRequest(session: session, requestTask: .download(originalTask, task))
  301. request.downloadDelegate.destination = destination
  302. delegate[task] = request
  303. if startRequestsImmediately { request.resume() }
  304. return request
  305. } catch {
  306. let download = DownloadRequest(session: session, requestTask: .download(nil, nil), error: error)
  307. if startRequestsImmediately { download.resume() }
  308. return download
  309. }
  310. }
  311. }
  312. class MockDataRequest: DataRequest {
  313. override var response: HTTPURLResponse? {
  314. return MockHTTPURLResponse(
  315. url: request!.url!,
  316. statusCode: 204,
  317. httpVersion: "HTTP/1.1",
  318. headerFields: nil
  319. )
  320. }
  321. }
  322. class MockDownloadRequest: DownloadRequest {
  323. override var response: HTTPURLResponse? {
  324. return MockHTTPURLResponse(
  325. url: request!.url!,
  326. statusCode: 204,
  327. httpVersion: "HTTP/1.1",
  328. headerFields: nil
  329. )
  330. }
  331. }
  332. class MockHTTPURLResponse: HTTPURLResponse {
  333. override var mimeType: String? { return nil }
  334. }
  335. let manager: SessionManager = {
  336. let configuration: URLSessionConfiguration = {
  337. let configuration = URLSessionConfiguration.ephemeral
  338. configuration.httpAdditionalHeaders = SessionManager.defaultHTTPHeaders
  339. return configuration
  340. }()
  341. return MockManager(configuration: configuration)
  342. }()
  343. let urlString = "https://httpbin.org/delete"
  344. let expectation1 = self.expectation(description: "request should be stubbed and return 204 status code")
  345. let expectation2 = self.expectation(description: "download should be stubbed and return 204 status code")
  346. var requestResponse: DefaultDataResponse?
  347. var downloadResponse: DefaultDownloadResponse?
  348. // When
  349. manager.request(urlString, method: .delete)
  350. .validate(contentType: ["*/*"])
  351. .response { resp in
  352. requestResponse = resp
  353. expectation1.fulfill()
  354. }
  355. manager.download(urlString, method: .delete)
  356. .validate(contentType: ["*/*"])
  357. .response { resp in
  358. downloadResponse = resp
  359. expectation2.fulfill()
  360. }
  361. waitForExpectations(timeout: timeout, handler: nil)
  362. // Then
  363. XCTAssertNotNil(requestResponse?.response)
  364. XCTAssertNotNil(requestResponse?.data)
  365. XCTAssertNil(requestResponse?.error)
  366. XCTAssertEqual(requestResponse?.response?.statusCode, 204)
  367. XCTAssertNil(requestResponse?.response?.mimeType)
  368. XCTAssertNotNil(downloadResponse?.response)
  369. XCTAssertNotNil(downloadResponse?.temporaryURL)
  370. XCTAssertNil(downloadResponse?.destinationURL)
  371. XCTAssertNil(downloadResponse?.error)
  372. XCTAssertEqual(downloadResponse?.response?.statusCode, 204)
  373. XCTAssertNil(downloadResponse?.response?.mimeType)
  374. }
  375. }
  376. // MARK: -
  377. class MultipleValidationTestCase: BaseTestCase {
  378. func testThatValidationForRequestWithAcceptableStatusCodeAndContentTypeResponseSucceeds() {
  379. // Given
  380. let urlString = "https://httpbin.org/ip"
  381. let expectation1 = self.expectation(description: "request should succeed and return ip")
  382. let expectation2 = self.expectation(description: "request should succeed and return ip")
  383. var requestError: Error?
  384. var downloadError: Error?
  385. // When
  386. Alamofire.request(urlString)
  387. .validate(statusCode: 200..<300)
  388. .validate(contentType: ["application/json"])
  389. .response { resp in
  390. requestError = resp.error
  391. expectation1.fulfill()
  392. }
  393. Alamofire.download(urlString)
  394. .validate(statusCode: 200..<300)
  395. .validate(contentType: ["application/json"])
  396. .response { resp in
  397. downloadError = resp.error
  398. expectation2.fulfill()
  399. }
  400. waitForExpectations(timeout: timeout, handler: nil)
  401. // Then
  402. XCTAssertNil(requestError)
  403. XCTAssertNil(downloadError)
  404. }
  405. func testThatValidationForRequestWithUnacceptableStatusCodeAndContentTypeResponseFailsWithStatusCodeError() {
  406. // Given
  407. let urlString = "https://httpbin.org/xml"
  408. let expectation1 = self.expectation(description: "request should succeed and return xml")
  409. let expectation2 = self.expectation(description: "download should succeed and return xml")
  410. var requestError: Error?
  411. var downloadError: Error?
  412. // When
  413. Alamofire.request(urlString)
  414. .validate(statusCode: 400..<600)
  415. .validate(contentType: ["application/octet-stream"])
  416. .response { resp in
  417. requestError = resp.error
  418. expectation1.fulfill()
  419. }
  420. Alamofire.download(urlString)
  421. .validate(statusCode: 400..<600)
  422. .validate(contentType: ["application/octet-stream"])
  423. .response { resp in
  424. downloadError = resp.error
  425. expectation2.fulfill()
  426. }
  427. waitForExpectations(timeout: timeout, handler: nil)
  428. // Then
  429. XCTAssertNotNil(requestError)
  430. XCTAssertNotNil(downloadError)
  431. for error in [requestError, downloadError] {
  432. if let error = error as? AFError {
  433. XCTAssertTrue(error.isUnacceptableStatusCode)
  434. XCTAssertEqual(error.responseCode, 200)
  435. } else {
  436. XCTFail("error should not be nil")
  437. }
  438. }
  439. }
  440. func testThatValidationForRequestWithUnacceptableStatusCodeAndContentTypeResponseFailsWithContentTypeError() {
  441. // Given
  442. let urlString = "https://httpbin.org/xml"
  443. let expectation1 = self.expectation(description: "request should succeed and return xml")
  444. let expectation2 = self.expectation(description: "download should succeed and return xml")
  445. var requestError: Error?
  446. var downloadError: Error?
  447. // When
  448. Alamofire.request(urlString)
  449. .validate(contentType: ["application/octet-stream"])
  450. .validate(statusCode: 400..<600)
  451. .response { resp in
  452. requestError = resp.error
  453. expectation1.fulfill()
  454. }
  455. Alamofire.download(urlString)
  456. .validate(contentType: ["application/octet-stream"])
  457. .validate(statusCode: 400..<600)
  458. .response { resp in
  459. downloadError = resp.error
  460. expectation2.fulfill()
  461. }
  462. waitForExpectations(timeout: timeout, handler: nil)
  463. // Then
  464. XCTAssertNotNil(requestError)
  465. XCTAssertNotNil(downloadError)
  466. for error in [requestError, downloadError] {
  467. if let error = error as? AFError {
  468. XCTAssertTrue(error.isUnacceptableContentType)
  469. XCTAssertEqual(error.responseContentType, "application/xml")
  470. XCTAssertEqual(error.acceptableContentTypes?.first, "application/octet-stream")
  471. } else {
  472. XCTFail("error should not be nil")
  473. }
  474. }
  475. }
  476. }
  477. // MARK: -
  478. class AutomaticValidationTestCase: BaseTestCase {
  479. func testThatValidationForRequestWithAcceptableStatusCodeAndContentTypeResponseSucceeds() {
  480. // Given
  481. let url = URL(string: "https://httpbin.org/ip")!
  482. var urlRequest = URLRequest(url: url)
  483. urlRequest.setValue("application/json", forHTTPHeaderField: "Accept")
  484. let expectation1 = self.expectation(description: "request should succeed and return ip")
  485. let expectation2 = self.expectation(description: "download should succeed and return ip")
  486. var requestError: Error?
  487. var downloadError: Error?
  488. // When
  489. Alamofire.request(urlRequest).validate().response { resp in
  490. requestError = resp.error
  491. expectation1.fulfill()
  492. }
  493. Alamofire.download(urlRequest).validate().response { resp in
  494. downloadError = resp.error
  495. expectation2.fulfill()
  496. }
  497. waitForExpectations(timeout: timeout, handler: nil)
  498. // Then
  499. XCTAssertNil(requestError)
  500. XCTAssertNil(downloadError)
  501. }
  502. func testThatValidationForRequestWithUnacceptableStatusCodeResponseFails() {
  503. // Given
  504. let urlString = "https://httpbin.org/status/404"
  505. let expectation1 = self.expectation(description: "request should return 404 status code")
  506. let expectation2 = self.expectation(description: "download should return 404 status code")
  507. var requestError: Error?
  508. var downloadError: Error?
  509. // When
  510. Alamofire.request(urlString)
  511. .validate()
  512. .response { resp in
  513. requestError = resp.error
  514. expectation1.fulfill()
  515. }
  516. Alamofire.download(urlString)
  517. .validate()
  518. .response { resp in
  519. downloadError = resp.error
  520. expectation2.fulfill()
  521. }
  522. waitForExpectations(timeout: timeout, handler: nil)
  523. // Then
  524. XCTAssertNotNil(requestError)
  525. XCTAssertNotNil(downloadError)
  526. for error in [requestError, downloadError] {
  527. if let error = error as? AFError, let statusCode = error.responseCode {
  528. XCTAssertTrue(error.isUnacceptableStatusCode)
  529. XCTAssertEqual(statusCode, 404)
  530. } else {
  531. XCTFail("error should not be nil")
  532. }
  533. }
  534. }
  535. func testThatValidationForRequestWithAcceptableWildcardContentTypeResponseSucceeds() {
  536. // Given
  537. let url = URL(string: "https://httpbin.org/ip")!
  538. var urlRequest = URLRequest(url: url)
  539. urlRequest.setValue("application/*", forHTTPHeaderField: "Accept")
  540. let expectation1 = self.expectation(description: "request should succeed and return ip")
  541. let expectation2 = self.expectation(description: "download should succeed and return ip")
  542. var requestError: Error?
  543. var downloadError: Error?
  544. // When
  545. Alamofire.request(urlRequest).validate().response { resp in
  546. requestError = resp.error
  547. expectation1.fulfill()
  548. }
  549. Alamofire.download(urlRequest).validate().response { resp in
  550. downloadError = resp.error
  551. expectation2.fulfill()
  552. }
  553. waitForExpectations(timeout: timeout, handler: nil)
  554. // Then
  555. XCTAssertNil(requestError)
  556. XCTAssertNil(downloadError)
  557. }
  558. func testThatValidationForRequestWithAcceptableComplexContentTypeResponseSucceeds() {
  559. // Given
  560. let url = URL(string: "https://httpbin.org/xml")!
  561. var urlRequest = URLRequest(url: url)
  562. let headerValue = "text/xml, application/xml, application/xhtml+xml, text/html;q=0.9, text/plain;q=0.8,*/*;q=0.5"
  563. urlRequest.setValue(headerValue, forHTTPHeaderField: "Accept")
  564. let expectation1 = self.expectation(description: "request should succeed and return xml")
  565. let expectation2 = self.expectation(description: "request should succeed and return xml")
  566. var requestError: Error?
  567. var downloadError: Error?
  568. // When
  569. Alamofire.request(urlRequest).validate().response { resp in
  570. requestError = resp.error
  571. expectation1.fulfill()
  572. }
  573. Alamofire.download(urlRequest).validate().response { resp in
  574. downloadError = resp.error
  575. expectation2.fulfill()
  576. }
  577. waitForExpectations(timeout: timeout, handler: nil)
  578. // Then
  579. XCTAssertNil(requestError)
  580. XCTAssertNil(downloadError)
  581. }
  582. func testThatValidationForRequestWithUnacceptableContentTypeResponseFails() {
  583. // Given
  584. let url = URL(string: "https://httpbin.org/xml")!
  585. var urlRequest = URLRequest(url: url)
  586. urlRequest.setValue("application/json", forHTTPHeaderField: "Accept")
  587. let expectation1 = self.expectation(description: "request should succeed and return xml")
  588. let expectation2 = self.expectation(description: "download should succeed and return xml")
  589. var requestError: Error?
  590. var downloadError: Error?
  591. // When
  592. Alamofire.request(urlRequest).validate().response { resp in
  593. requestError = resp.error
  594. expectation1.fulfill()
  595. }
  596. Alamofire.download(urlRequest).validate().response { resp in
  597. downloadError = resp.error
  598. expectation2.fulfill()
  599. }
  600. waitForExpectations(timeout: timeout, handler: nil)
  601. // Then
  602. XCTAssertNotNil(requestError)
  603. XCTAssertNotNil(downloadError)
  604. for error in [requestError, downloadError] {
  605. if let error = error as? AFError {
  606. XCTAssertTrue(error.isUnacceptableContentType)
  607. XCTAssertEqual(error.responseContentType, "application/xml")
  608. XCTAssertEqual(error.acceptableContentTypes?.first, "application/json")
  609. } else {
  610. XCTFail("error should not be nil")
  611. }
  612. }
  613. }
  614. }
  615. // MARK: -
  616. private enum ValidationError: Error {
  617. case missingData, missingFile, fileReadFailed
  618. }
  619. extension DataRequest {
  620. func validateDataExists() -> Self {
  621. return validate { request, response, data in
  622. guard data != nil else { return .failure(ValidationError.missingData) }
  623. return .success
  624. }
  625. }
  626. func validate(with error: Error) -> Self {
  627. return validate { _, _, _ in .failure(error) }
  628. }
  629. }
  630. extension DownloadRequest {
  631. func validateDataExists() -> Self {
  632. return validate { request, response, _, _ in
  633. let fileURL = self.downloadDelegate.fileURL
  634. guard let validFileURL = fileURL else { return .failure(ValidationError.missingFile) }
  635. do {
  636. let _ = try Data(contentsOf: validFileURL)
  637. return .success
  638. } catch {
  639. return .failure(ValidationError.fileReadFailed)
  640. }
  641. }
  642. }
  643. func validate(with error: Error) -> Self {
  644. return validate { _, _, _, _ in .failure(error) }
  645. }
  646. }
  647. // MARK: -
  648. class CustomValidationTestCase: BaseTestCase {
  649. func testThatCustomValidationClosureHasAccessToServerResponseData() {
  650. // Given
  651. let urlString = "https://httpbin.org/get"
  652. let expectation1 = self.expectation(description: "request should return 200 status code")
  653. let expectation2 = self.expectation(description: "download should return 200 status code")
  654. var requestError: Error?
  655. var downloadError: Error?
  656. // When
  657. Alamofire.request(urlString)
  658. .validate { request, response, data in
  659. guard data != nil else { return .failure(ValidationError.missingData) }
  660. return .success
  661. }
  662. .response { resp in
  663. requestError = resp.error
  664. expectation1.fulfill()
  665. }
  666. Alamofire.download(urlString)
  667. .validate { request, response, temporaryURL, destinationURL in
  668. guard let fileURL = temporaryURL else { return .failure(ValidationError.missingFile) }
  669. do {
  670. let _ = try Data(contentsOf: fileURL)
  671. return .success
  672. } catch {
  673. return .failure(ValidationError.fileReadFailed)
  674. }
  675. }
  676. .response { resp in
  677. downloadError = resp.error
  678. expectation2.fulfill()
  679. }
  680. waitForExpectations(timeout: timeout, handler: nil)
  681. // Then
  682. XCTAssertNil(requestError)
  683. XCTAssertNil(downloadError)
  684. }
  685. func testThatCustomValidationCanThrowCustomError() {
  686. // Given
  687. let urlString = "https://httpbin.org/get"
  688. let expectation1 = self.expectation(description: "request should return 200 status code")
  689. let expectation2 = self.expectation(description: "download should return 200 status code")
  690. var requestError: Error?
  691. var downloadError: Error?
  692. // When
  693. Alamofire.request(urlString)
  694. .validate { _, _, _ in .failure(ValidationError.missingData) }
  695. .validate { _, _, _ in .failure(ValidationError.missingFile) } // should be ignored
  696. .response { resp in
  697. requestError = resp.error
  698. expectation1.fulfill()
  699. }
  700. Alamofire.download(urlString)
  701. .validate { _, _, _, _ in .failure(ValidationError.missingFile) }
  702. .validate { _, _, _, _ in .failure(ValidationError.fileReadFailed) } // should be ignored
  703. .response { resp in
  704. downloadError = resp.error
  705. expectation2.fulfill()
  706. }
  707. waitForExpectations(timeout: timeout, handler: nil)
  708. // Then
  709. XCTAssertEqual(requestError as? ValidationError, ValidationError.missingData)
  710. XCTAssertEqual(downloadError as? ValidationError, ValidationError.missingFile)
  711. }
  712. func testThatValidationExtensionHasAccessToServerResponseData() {
  713. // Given
  714. let urlString = "https://httpbin.org/get"
  715. let expectation1 = self.expectation(description: "request should return 200 status code")
  716. let expectation2 = self.expectation(description: "download should return 200 status code")
  717. var requestError: Error?
  718. var downloadError: Error?
  719. // When
  720. Alamofire.request(urlString)
  721. .validateDataExists()
  722. .response { resp in
  723. requestError = resp.error
  724. expectation1.fulfill()
  725. }
  726. Alamofire.download(urlString)
  727. .validateDataExists()
  728. .response { resp in
  729. downloadError = resp.error
  730. expectation2.fulfill()
  731. }
  732. waitForExpectations(timeout: timeout, handler: nil)
  733. // Then
  734. XCTAssertNil(requestError)
  735. XCTAssertNil(downloadError)
  736. }
  737. func testThatValidationExtensionCanThrowCustomError() {
  738. // Given
  739. let urlString = "https://httpbin.org/get"
  740. let expectation1 = self.expectation(description: "request should return 200 status code")
  741. let expectation2 = self.expectation(description: "download should return 200 status code")
  742. var requestError: Error?
  743. var downloadError: Error?
  744. // When
  745. Alamofire.request(urlString)
  746. .validate(with: ValidationError.missingData)
  747. .validate(with: ValidationError.missingFile) // should be ignored
  748. .response { resp in
  749. requestError = resp.error
  750. expectation1.fulfill()
  751. }
  752. Alamofire.download(urlString)
  753. .validate(with: ValidationError.missingFile)
  754. .validate(with: ValidationError.fileReadFailed) // should be ignored
  755. .response { resp in
  756. downloadError = resp.error
  757. expectation2.fulfill()
  758. }
  759. waitForExpectations(timeout: timeout, handler: nil)
  760. // Then
  761. XCTAssertEqual(requestError as? ValidationError, ValidationError.missingData)
  762. XCTAssertEqual(downloadError as? ValidationError, ValidationError.missingFile)
  763. }
  764. }