ValidationTests.swift 32 KB

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