ValidationTests.swift 32 KB

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