ValidationTests.swift 31 KB

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