ValidationTests.swift 32 KB

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