ValidationTests.swift 32 KB

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