ResponseSerializationTests.swift 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416
  1. //
  2. // ResponseSerializationTests.swift
  3. //
  4. // Copyright (c) 2014-2020 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. import Alamofire
  25. import Foundation
  26. import XCTest
  27. final class DataResponseSerializationTestCase: BaseTestCase {
  28. // MARK: Properties
  29. private let error = AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength)
  30. // MARK: DataResponseSerializer
  31. func testThatDataResponseSerializerSucceedsWhenDataIsNotNil() {
  32. // Given
  33. let serializer = DataResponseSerializer()
  34. let data = Data("data".utf8)
  35. // When
  36. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  37. // Then
  38. XCTAssertTrue(result.isSuccess)
  39. XCTAssertNotNil(result.success)
  40. XCTAssertNil(result.failure)
  41. }
  42. func testThatDataResponseSerializerFailsWhenDataIsNil() {
  43. // Given
  44. let serializer = DataResponseSerializer()
  45. // When
  46. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: nil) }
  47. // Then
  48. XCTAssertTrue(result.isFailure)
  49. XCTAssertNil(result.success)
  50. XCTAssertNotNil(result.failure)
  51. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  52. }
  53. func testThatDataResponseSerializerFailsWhenErrorIsNotNil() {
  54. // Given
  55. let serializer = DataResponseSerializer()
  56. // When
  57. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: error) }
  58. // Then
  59. XCTAssertTrue(result.isFailure)
  60. XCTAssertNil(result.success)
  61. XCTAssertNotNil(result.failure)
  62. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  63. }
  64. func testThatDataResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  65. // Given
  66. let serializer = DataResponseSerializer()
  67. let response = HTTPURLResponse(statusCode: 200)
  68. // When
  69. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  70. // Then
  71. XCTAssertTrue(result.isFailure, "result is failure should be true")
  72. XCTAssertNil(result.success, "result value should be nil")
  73. XCTAssertNotNil(result.failure, "result error should not be nil")
  74. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  75. }
  76. func testThatDataResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd204ResponseStatusCode() {
  77. // Given
  78. let serializer = DataResponseSerializer()
  79. let request = Endpoint().urlRequest
  80. let response = HTTPURLResponse(statusCode: 204)
  81. // When
  82. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  83. // Then
  84. XCTAssertTrue(result.isSuccess)
  85. XCTAssertNotNil(result.success)
  86. XCTAssertNil(result.failure)
  87. XCTAssertEqual(result.success?.count, 0)
  88. }
  89. func testThatDataResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd205ResponseStatusCode() {
  90. // Given
  91. let serializer = DataResponseSerializer()
  92. let request = Endpoint().urlRequest
  93. let response = HTTPURLResponse(statusCode: 205)
  94. // When
  95. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  96. // Then
  97. XCTAssertTrue(result.isSuccess)
  98. XCTAssertNotNil(result.success)
  99. XCTAssertNil(result.failure)
  100. XCTAssertEqual(result.success?.count, 0)
  101. }
  102. func testThatDataResponseSerializerSucceedsWhenDataIsNilWithHEADRequestAnd200ResponseStatusCode() {
  103. // Given
  104. let serializer = DataResponseSerializer()
  105. let request = Endpoint(method: .head).urlRequest
  106. let response = HTTPURLResponse(statusCode: 200)
  107. // When
  108. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  109. // Then
  110. XCTAssertTrue(result.isSuccess)
  111. XCTAssertNotNil(result.success)
  112. XCTAssertNil(result.failure)
  113. XCTAssertEqual(result.success?.count, 0)
  114. }
  115. // MARK: StringResponseSerializer
  116. func testThatStringResponseSerializerFailsWhenDataIsNil() {
  117. // Given
  118. let serializer = DataResponseSerializer()
  119. // When
  120. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: nil) }
  121. // Then
  122. XCTAssertTrue(result.isFailure)
  123. XCTAssertNil(result.success)
  124. XCTAssertNotNil(result.failure)
  125. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  126. }
  127. func testThatStringResponseSerializerFailsWhenDataIsEmpty() {
  128. // Given
  129. let serializer = StringResponseSerializer()
  130. // When
  131. let result = Result { try serializer.serialize(request: nil, response: nil, data: Data(), error: nil) }
  132. // Then
  133. XCTAssertTrue(result.isFailure)
  134. XCTAssertNil(result.success)
  135. XCTAssertNotNil(result.failure)
  136. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  137. }
  138. func testThatStringResponseSerializerSucceedsWithUTF8DataAndNoProvidedEncoding() {
  139. let serializer = StringResponseSerializer()
  140. let data = Data("data".utf8)
  141. // When
  142. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  143. // Then
  144. XCTAssertTrue(result.isSuccess)
  145. XCTAssertNotNil(result.success)
  146. XCTAssertNil(result.failure)
  147. }
  148. func testThatStringResponseSerializerSucceedsWithUTF8DataAndUTF8ProvidedEncoding() {
  149. let serializer = StringResponseSerializer(encoding: .utf8)
  150. let data = Data("data".utf8)
  151. // When
  152. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  153. // Then
  154. XCTAssertTrue(result.isSuccess)
  155. XCTAssertNotNil(result.success)
  156. XCTAssertNil(result.failure)
  157. }
  158. func testThatStringResponseSerializerSucceedsWithUTF8DataUsingResponseTextEncodingName() {
  159. let serializer = StringResponseSerializer()
  160. let data = Data("data".utf8)
  161. let response = HTTPURLResponse(statusCode: 200, headers: ["Content-Type": "image/jpeg; charset=utf-8"])
  162. // When
  163. let result = Result { try serializer.serialize(request: nil, response: response, data: data, error: nil) }
  164. // Then
  165. XCTAssertTrue(result.isSuccess)
  166. XCTAssertNotNil(result.success)
  167. XCTAssertNil(result.failure)
  168. }
  169. func testThatStringResponseSerializerFailsWithUTF32DataAndUTF8ProvidedEncoding() {
  170. // Given
  171. let serializer = StringResponseSerializer(encoding: .utf8)
  172. let data = "random data".data(using: .utf32)!
  173. // When
  174. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  175. // Then
  176. XCTAssertTrue(result.isFailure)
  177. XCTAssertNil(result.success)
  178. XCTAssertNotNil(result.failure)
  179. XCTAssertEqual(result.failure?.asAFError?.isStringSerializationFailed, true)
  180. XCTAssertEqual(result.failure?.asAFError?.failedStringEncoding, .utf8)
  181. }
  182. func testThatStringResponseSerializerFailsWithUTF32DataAndUTF8ResponseEncoding() {
  183. // Given
  184. let serializer = StringResponseSerializer()
  185. let data = "random data".data(using: .utf32)!
  186. let response = HTTPURLResponse(statusCode: 200, headers: ["Content-Type": "image/jpeg; charset=utf-8"])
  187. // When
  188. let result = Result { try serializer.serialize(request: nil, response: response, data: data, error: nil) }
  189. // Then
  190. XCTAssertTrue(result.isFailure)
  191. XCTAssertNil(result.success)
  192. XCTAssertNotNil(result.failure)
  193. XCTAssertEqual(result.failure?.asAFError?.isStringSerializationFailed, true)
  194. XCTAssertEqual(result.failure?.asAFError?.failedStringEncoding, .utf8)
  195. }
  196. func testThatStringResponseSerializerFailsWhenErrorIsNotNil() {
  197. // Given
  198. let serializer = StringResponseSerializer()
  199. // When
  200. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: error) }
  201. // Then
  202. XCTAssertTrue(result.isFailure)
  203. XCTAssertNil(result.success)
  204. XCTAssertNotNil(result.failure)
  205. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  206. }
  207. func testThatStringResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  208. // Given
  209. let serializer = StringResponseSerializer()
  210. let response = HTTPURLResponse(statusCode: 200)
  211. // When
  212. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  213. // Then
  214. XCTAssertTrue(result.isFailure)
  215. XCTAssertNil(result.success)
  216. XCTAssertNotNil(result.failure)
  217. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  218. }
  219. func testThatStringResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd204ResponseStatusCode() {
  220. // Given
  221. let serializer = StringResponseSerializer()
  222. let request = Endpoint().urlRequest
  223. let response = HTTPURLResponse(statusCode: 204)
  224. // When
  225. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  226. // Then
  227. XCTAssertTrue(result.isSuccess)
  228. XCTAssertNotNil(result.success)
  229. XCTAssertNil(result.failure)
  230. XCTAssertEqual(result.success, "")
  231. }
  232. func testThatStringResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd205ResponseStatusCode() {
  233. // Given
  234. let serializer = StringResponseSerializer()
  235. let request = Endpoint().urlRequest
  236. let response = HTTPURLResponse(statusCode: 205)
  237. // When
  238. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  239. // Then
  240. XCTAssertTrue(result.isSuccess)
  241. XCTAssertNotNil(result.success)
  242. XCTAssertNil(result.failure)
  243. XCTAssertEqual(result.success, "")
  244. }
  245. func testThatStringResponseSerializerSucceedsWhenDataIsNilWithHEADRequestAnd200ResponseStatusCode() {
  246. // Given
  247. let serializer = StringResponseSerializer()
  248. let request = Endpoint(method: .head).urlRequest
  249. let response = HTTPURLResponse(statusCode: 200)
  250. // When
  251. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  252. // Then
  253. XCTAssertTrue(result.isSuccess)
  254. XCTAssertNotNil(result.success)
  255. XCTAssertNil(result.failure)
  256. XCTAssertEqual(result.success, "")
  257. }
  258. // MARK: JSONResponseSerializer
  259. @available(*, deprecated)
  260. func testThatJSONResponseSerializerFailsWhenDataIsNil() {
  261. // Given
  262. let serializer = JSONResponseSerializer()
  263. // When
  264. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: nil) }
  265. // Then
  266. XCTAssertTrue(result.isFailure)
  267. XCTAssertNil(result.success)
  268. XCTAssertNotNil(result.failure)
  269. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  270. }
  271. @available(*, deprecated)
  272. func testThatJSONResponseSerializerFailsWhenDataIsEmpty() {
  273. // Given
  274. let serializer = JSONResponseSerializer()
  275. // When
  276. let result = Result { try serializer.serialize(request: nil, response: nil, data: Data(), error: nil) }
  277. // Then
  278. XCTAssertTrue(result.isFailure)
  279. XCTAssertNil(result.success)
  280. XCTAssertNotNil(result.failure)
  281. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  282. }
  283. @available(*, deprecated)
  284. func testThatJSONResponseSerializerSucceedsWhenDataIsValidJSON() {
  285. // Given
  286. let serializer = JSONResponseSerializer()
  287. let data = Data("{\"json\": true}".utf8)
  288. // When
  289. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  290. // Then
  291. XCTAssertTrue(result.isSuccess)
  292. XCTAssertNotNil(result.success)
  293. XCTAssertNil(result.failure)
  294. }
  295. @available(*, deprecated)
  296. func testThatJSONResponseSerializerFailsWhenDataIsInvalidJSON() {
  297. // Given
  298. let serializer = JSONResponseSerializer()
  299. let data = Data("definitely not valid json".utf8)
  300. // When
  301. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  302. // Then
  303. XCTAssertTrue(result.isFailure)
  304. XCTAssertNil(result.success)
  305. XCTAssertNotNil(result.failure)
  306. XCTAssertEqual(result.failure?.asAFError?.isJSONSerializationFailed, true)
  307. XCTAssertEqual((result.failure?.asAFError?.underlyingError as? CocoaError)?.code, .propertyListReadCorrupt)
  308. }
  309. @available(*, deprecated)
  310. func testThatJSONResponseSerializerFailsWhenErrorIsNotNil() {
  311. // Given
  312. let serializer = JSONResponseSerializer()
  313. // When
  314. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: error) }
  315. // Then
  316. XCTAssertTrue(result.isFailure)
  317. XCTAssertNil(result.success)
  318. XCTAssertNotNil(result.failure)
  319. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  320. }
  321. @available(*, deprecated)
  322. func testThatJSONResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  323. // Given
  324. let serializer = JSONResponseSerializer()
  325. let response = HTTPURLResponse(statusCode: 200)
  326. // When
  327. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  328. // Then
  329. XCTAssertTrue(result.isFailure)
  330. XCTAssertNil(result.success)
  331. XCTAssertNotNil(result.failure)
  332. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  333. }
  334. @available(*, deprecated)
  335. func testThatJSONResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd204ResponseStatusCode() {
  336. // Given
  337. let serializer = JSONResponseSerializer()
  338. let request = Endpoint().urlRequest
  339. let response = HTTPURLResponse(statusCode: 204)
  340. // When
  341. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  342. // Then
  343. XCTAssertTrue(result.isSuccess)
  344. XCTAssertNotNil(result.success)
  345. XCTAssertNil(result.failure)
  346. XCTAssertEqual(result.success as? NSNull, NSNull())
  347. }
  348. @available(*, deprecated)
  349. func testThatJSONResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd205ResponseStatusCode() {
  350. // Given
  351. let serializer = JSONResponseSerializer()
  352. let request = Endpoint().urlRequest
  353. let response = HTTPURLResponse(statusCode: 205)
  354. // When
  355. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  356. // Then
  357. XCTAssertTrue(result.isSuccess)
  358. XCTAssertNotNil(result.success)
  359. XCTAssertNil(result.failure)
  360. XCTAssertEqual(result.success as? NSNull, NSNull())
  361. }
  362. @available(*, deprecated)
  363. func testThatJSONResponseSerializerSucceedsWhenDataIsNilWithHEADRequestAnd200ResponseStatusCode() {
  364. // Given
  365. let serializer = JSONResponseSerializer()
  366. let request = Endpoint(method: .head).urlRequest
  367. let response = HTTPURLResponse(statusCode: 200)
  368. // When
  369. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  370. // Then
  371. XCTAssertTrue(result.isSuccess)
  372. XCTAssertNotNil(result.success)
  373. XCTAssertNil(result.failure)
  374. XCTAssertEqual(result.success as? NSNull, NSNull())
  375. }
  376. }
  377. #if swift(>=5.5)
  378. final class StaticSerializationTests: BaseTestCase {
  379. func consumeDownloadResponseSerializer<Serializer: DownloadResponseSerializerProtocol>(_ responseSerializer: Serializer) {
  380. _ = responseSerializer
  381. }
  382. func consumeStreamSerializer<Serializer: DataStreamSerializer>(_ serializer: Serializer) {
  383. _ = serializer
  384. }
  385. func consumeResponseSerializer<Serializer: ResponseSerializer>(_ responseSerializer: Serializer) {
  386. _ = responseSerializer
  387. }
  388. func testThatURLSerializerCanBeCreatedStaticallyFromProtocol() {
  389. // Given, When, Then
  390. consumeDownloadResponseSerializer(.url)
  391. }
  392. func testThatDataSerializerCanBeCreatedStaticallyFromProtocol() {
  393. // Given, When, Then
  394. consumeResponseSerializer(.data())
  395. }
  396. func testThatStringSerializerCanBeCreatedStaticallyFromProtocol() {
  397. // Given, When, Then
  398. consumeResponseSerializer(.string())
  399. }
  400. func testThatDecodableSerializerCanBeCreatedStaticallyFromProtocol() {
  401. // Given, When, Then
  402. consumeResponseSerializer(.decodable(of: TestResponse.self))
  403. }
  404. func testThatPassthroughStreamSerializerCanBeCreatedStaticallyFromProtocol() {
  405. // Given, When, Then
  406. consumeStreamSerializer(.passthrough)
  407. }
  408. func testThatStringStreamSerializerCanBeCreatedStaticallyFromProtocol() {
  409. // Given, When, Then
  410. consumeStreamSerializer(.string)
  411. }
  412. func testThatDecodableStreamSerializerCanBeCreatedStaticallyFromProtocol() {
  413. // Given, When, Then
  414. consumeStreamSerializer(.decodable(of: TestResponse.self))
  415. }
  416. }
  417. #endif
  418. // MARK: -
  419. final class URLResponseSerializerTests: BaseTestCase {
  420. func testThatURLResponseSerializerProducesURLOnSuccess() {
  421. // Given
  422. let serializer = URLResponseSerializer()
  423. let request = Endpoint().urlRequest
  424. let response = HTTPURLResponse(statusCode: 200)
  425. let url = URL(fileURLWithPath: "/")
  426. // When
  427. let result = Result { try serializer.serializeDownload(request: request,
  428. response: response,
  429. fileURL: url,
  430. error: nil) }
  431. // Then
  432. XCTAssertEqual(result.success, url)
  433. }
  434. func testThatURLResponseSerializerProducesErrorFromIncomingErrors() {
  435. // Given
  436. let serializer = URLResponseSerializer()
  437. let request = Endpoint().urlRequest
  438. let response = HTTPURLResponse(statusCode: 200)
  439. let error = AFError.responseValidationFailed(reason: .unacceptableStatusCode(code: 404))
  440. // When
  441. let result = Result { try serializer.serializeDownload(request: request,
  442. response: response,
  443. fileURL: nil,
  444. error: error) }
  445. // Then
  446. XCTAssertEqual(result.failure?.localizedDescription, error.localizedDescription)
  447. }
  448. func testThatURLResponseSerializerProducesInputFileNilErrorWhenNoURL() {
  449. // Given
  450. let serializer = URLResponseSerializer()
  451. let request = Endpoint().urlRequest
  452. let response = HTTPURLResponse(statusCode: 200)
  453. // When
  454. let result = Result { try serializer.serializeDownload(request: request,
  455. response: response,
  456. fileURL: nil,
  457. error: nil) }
  458. // Then
  459. XCTAssertTrue(result.failure?.asAFError?.isInputFileNil == true)
  460. }
  461. }
  462. // MARK: -
  463. // used by testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseConformingTypeAndEmptyResponseStatusCode
  464. extension Bool: EmptyResponse {
  465. public static func emptyValue() -> Bool {
  466. true
  467. }
  468. }
  469. final class DecodableResponseSerializerTests: BaseTestCase {
  470. private let error = AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength)
  471. struct DecodableValue: Decodable, EmptyResponse {
  472. static func emptyValue() -> DecodableValue {
  473. DecodableValue(string: "")
  474. }
  475. let string: String
  476. }
  477. func testThatDecodableResponseSerializerFailsWhenDataIsNil() {
  478. // Given
  479. let serializer = DecodableResponseSerializer<DecodableValue>()
  480. // When
  481. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: nil) }
  482. // Then
  483. XCTAssertTrue(result.isFailure)
  484. XCTAssertNil(result.success)
  485. XCTAssertNotNil(result.failure)
  486. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  487. }
  488. func testThatDecodableResponseSerializerFailsWhenDataIsEmpty() {
  489. // Given
  490. let serializer = DecodableResponseSerializer<DecodableValue>()
  491. // When
  492. let result = Result { try serializer.serialize(request: nil, response: nil, data: Data(), error: nil) }
  493. // Then
  494. XCTAssertTrue(result.isFailure)
  495. XCTAssertNil(result.success)
  496. XCTAssertNotNil(result.failure)
  497. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  498. }
  499. func testThatDecodableResponseSerializerSucceedsWhenDataIsValidJSON() {
  500. // Given
  501. let data = Data("{\"string\":\"string\"}".utf8)
  502. let serializer = DecodableResponseSerializer<DecodableValue>()
  503. // When
  504. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  505. // Then
  506. XCTAssertTrue(result.isSuccess)
  507. XCTAssertNotNil(result.success)
  508. XCTAssertEqual(result.success?.string, "string")
  509. XCTAssertNil(result.failure)
  510. }
  511. func testThatDecodableResponseSerializerFailsWhenDataIsInvalidRepresentation() {
  512. // Given
  513. let serializer = DecodableResponseSerializer<DecodableValue>()
  514. let data = Data("definitely not valid".utf8)
  515. // When
  516. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  517. // Then
  518. XCTAssertTrue(result.isFailure)
  519. XCTAssertNil(result.success)
  520. XCTAssertNotNil(result.failure)
  521. }
  522. func testThatDecodableResponseSerializerFailsWhenErrorIsNotNil() {
  523. // Given
  524. let serializer = DecodableResponseSerializer<DecodableValue>()
  525. // When
  526. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: error) }
  527. // Then
  528. XCTAssertTrue(result.isFailure)
  529. XCTAssertNil(result.success)
  530. XCTAssertNotNil(result.failure)
  531. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  532. }
  533. func testThatDecodableResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  534. // Given
  535. let serializer = DecodableResponseSerializer<DecodableValue>()
  536. let response = HTTPURLResponse(statusCode: 200)
  537. // When
  538. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  539. // Then
  540. XCTAssertTrue(result.isFailure)
  541. XCTAssertNil(result.success)
  542. XCTAssertNotNil(result.failure)
  543. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  544. }
  545. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  546. // Given
  547. let serializer = DecodableResponseSerializer<DecodableValue>()
  548. let response = HTTPURLResponse(statusCode: 204)
  549. // When
  550. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  551. // Then
  552. XCTAssertTrue(result.isSuccess)
  553. XCTAssertNotNil(result.success)
  554. XCTAssertNil(result.failure)
  555. }
  556. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithEmptyTypeAndEmptyResponseStatusCode() {
  557. // Given
  558. let serializer = DecodableResponseSerializer<Empty>()
  559. let response = HTTPURLResponse(statusCode: 204)
  560. // When
  561. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  562. // Then
  563. XCTAssertTrue(result.isSuccess)
  564. XCTAssertNotNil(result.success)
  565. XCTAssertNil(result.failure)
  566. }
  567. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd204ResponseStatusCode() {
  568. // Given
  569. let serializer = DecodableResponseSerializer<Empty>()
  570. let request = Endpoint().urlRequest
  571. let response = HTTPURLResponse(statusCode: 204)
  572. // When
  573. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  574. // Then
  575. XCTAssertTrue(result.isSuccess)
  576. XCTAssertNotNil(result.success)
  577. XCTAssertNil(result.failure)
  578. }
  579. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd205ResponseStatusCode() {
  580. // Given
  581. let serializer = DecodableResponseSerializer<Empty>()
  582. let request = Endpoint().urlRequest
  583. let response = HTTPURLResponse(statusCode: 205)
  584. // When
  585. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  586. // Then
  587. XCTAssertTrue(result.isSuccess)
  588. XCTAssertNotNil(result.success)
  589. XCTAssertNil(result.failure)
  590. }
  591. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithHEADRequestAnd200ResponseStatusCode() {
  592. // Given
  593. let serializer = DecodableResponseSerializer<Empty>()
  594. let request = Endpoint(method: .head).urlRequest
  595. let response = HTTPURLResponse(statusCode: 200)
  596. // When
  597. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  598. // Then
  599. XCTAssertTrue(result.isSuccess)
  600. XCTAssertNotNil(result.success)
  601. XCTAssertNil(result.failure)
  602. }
  603. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseConformingTypeAndEmptyResponseStatusCode() {
  604. // Given
  605. let serializer = DecodableResponseSerializer<Bool>()
  606. let response = HTTPURLResponse(statusCode: 204)
  607. // When
  608. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  609. // Then
  610. XCTAssertTrue(result.isSuccess)
  611. XCTAssertNotNil(result.success)
  612. XCTAssertNil(result.failure)
  613. }
  614. func testThatDecodableResponseSerializerFailsWhenDataIsNilWithEmptyResponseNonconformingTypeAndEmptyResponseStatusCode() {
  615. // Given
  616. let serializer = DecodableResponseSerializer<Int>()
  617. let response = HTTPURLResponse(statusCode: 204)
  618. // When
  619. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  620. // Then
  621. XCTAssertTrue(result.isFailure)
  622. XCTAssertNil(result.success)
  623. XCTAssertNotNil(result.failure)
  624. XCTAssertEqual(result.failure?.asAFError?.isInvalidEmptyResponse, true)
  625. }
  626. }
  627. // MARK: -
  628. #if !SWIFT_PACKAGE
  629. final class DownloadResponseSerializationTestCase: BaseTestCase {
  630. // MARK: Properties
  631. private let error = AFError.responseSerializationFailed(reason: .inputFileNil)
  632. private var jsonEmptyDataFileURL: URL { url(forResource: "empty_data", withExtension: "json") }
  633. private var jsonValidDataFileURL: URL { url(forResource: "valid_data", withExtension: "json") }
  634. private var jsonInvalidDataFileURL: URL { url(forResource: "invalid_data", withExtension: "json") }
  635. private var stringEmptyDataFileURL: URL { url(forResource: "empty_string", withExtension: "txt") }
  636. private var stringUTF8DataFileURL: URL { url(forResource: "utf8_string", withExtension: "txt") }
  637. private var stringUTF32DataFileURL: URL { url(forResource: "utf32_string", withExtension: "txt") }
  638. private var invalidFileURL: URL { URL(fileURLWithPath: "/this/file/does/not/exist.txt") }
  639. // MARK: Tests - Data Response Serializer
  640. func testThatDataResponseSerializerSucceedsWhenFileDataIsNotNil() {
  641. // Given
  642. let serializer = DataResponseSerializer()
  643. // When
  644. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonValidDataFileURL, error: nil) }
  645. // Then
  646. XCTAssertTrue(result.isSuccess)
  647. XCTAssertNotNil(result.success)
  648. XCTAssertNil(result.failure)
  649. }
  650. func testThatDataResponseSerializerFailsWhenFileDataIsEmpty() {
  651. // Given
  652. let serializer = DataResponseSerializer()
  653. // When
  654. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonEmptyDataFileURL, error: nil) }
  655. // Then
  656. XCTAssertTrue(result.isFailure)
  657. XCTAssertNil(result.success)
  658. XCTAssertNotNil(result.failure)
  659. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  660. }
  661. func testThatDataResponseSerializerFailsWhenFileURLIsNil() {
  662. // Given
  663. let serializer = DataResponseSerializer()
  664. // When
  665. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: nil) }
  666. // Then
  667. XCTAssertTrue(result.isFailure)
  668. XCTAssertNil(result.success)
  669. XCTAssertNotNil(result.failure)
  670. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  671. }
  672. func testThatDataResponseSerializerFailsWhenFileURLIsInvalid() {
  673. // Given
  674. let serializer = DataResponseSerializer()
  675. // When
  676. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: invalidFileURL, error: nil) }
  677. // Then
  678. XCTAssertTrue(result.isFailure)
  679. XCTAssertNil(result.success)
  680. XCTAssertNotNil(result.failure)
  681. XCTAssertEqual(result.failure?.asAFError?.isInputFileReadFailed, true)
  682. }
  683. func testThatDataResponseSerializerFailsWhenErrorIsNotNil() {
  684. // Given
  685. let serializer = DataResponseSerializer()
  686. // When
  687. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: error) }
  688. // Then
  689. XCTAssertTrue(result.isFailure)
  690. XCTAssertNil(result.success)
  691. XCTAssertNotNil(result.failure)
  692. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  693. }
  694. func testThatDataResponseSerializerFailsWhenFileURLIsNilWithNonEmptyResponseStatusCode() {
  695. // Given
  696. let serializer = DataResponseSerializer()
  697. let response = HTTPURLResponse(statusCode: 200)
  698. // When
  699. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: nil, error: nil) }
  700. // Then
  701. XCTAssertTrue(result.isFailure)
  702. XCTAssertNil(result.success)
  703. XCTAssertNotNil(result.failure)
  704. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  705. }
  706. func testThatDataResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  707. // Given
  708. let serializer = DataResponseSerializer()
  709. let response = HTTPURLResponse(statusCode: 205)
  710. // When
  711. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: jsonEmptyDataFileURL, error: nil) }
  712. // Then
  713. XCTAssertTrue(result.isSuccess)
  714. XCTAssertNotNil(result.success)
  715. XCTAssertNil(result.failure)
  716. XCTAssertEqual(result.success?.count, 0)
  717. }
  718. // MARK: Tests - String Response Serializer
  719. func testThatStringResponseSerializerFailsWhenFileURLIsNil() {
  720. // Given
  721. let serializer = StringResponseSerializer()
  722. // When
  723. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: nil) }
  724. // Then
  725. XCTAssertTrue(result.isFailure)
  726. XCTAssertNil(result.success)
  727. XCTAssertNotNil(result.failure)
  728. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  729. }
  730. func testThatStringResponseSerializerFailsWhenFileURLIsInvalid() {
  731. // Given
  732. let serializer = StringResponseSerializer()
  733. // When
  734. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: invalidFileURL, error: nil) }
  735. // Then
  736. XCTAssertEqual(result.isSuccess, false)
  737. XCTAssertNil(result.success)
  738. XCTAssertNotNil(result.failure)
  739. XCTAssertEqual(result.failure?.asAFError?.isInputFileReadFailed, true)
  740. }
  741. func testThatStringResponseSerializerFailsWhenFileDataIsEmpty() {
  742. // Given
  743. let serializer = StringResponseSerializer()
  744. // When
  745. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringEmptyDataFileURL, error: nil) }
  746. // Then
  747. XCTAssertTrue(result.isFailure)
  748. XCTAssertNil(result.success)
  749. XCTAssertNotNil(result.failure)
  750. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  751. }
  752. func testThatStringResponseSerializerSucceedsWithUTF8DataAndNoProvidedEncoding() {
  753. // Given
  754. let serializer = StringResponseSerializer()
  755. // When
  756. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringUTF8DataFileURL, error: nil) }
  757. // Then
  758. XCTAssertTrue(result.isSuccess)
  759. XCTAssertNotNil(result.success)
  760. XCTAssertNil(result.failure)
  761. }
  762. func testThatStringResponseSerializerSucceedsWithUTF8DataAndUTF8ProvidedEncoding() {
  763. // Given
  764. let serializer = StringResponseSerializer(encoding: .utf8)
  765. // When
  766. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringUTF8DataFileURL, error: nil) }
  767. // Then
  768. XCTAssertTrue(result.isSuccess)
  769. XCTAssertNotNil(result.success)
  770. XCTAssertNil(result.failure)
  771. }
  772. func testThatStringResponseSerializerSucceedsWithUTF8DataUsingResponseTextEncodingName() {
  773. // Given
  774. let serializer = StringResponseSerializer()
  775. let response = HTTPURLResponse(statusCode: 200, headers: ["Content-Type": "image/jpeg; charset=utf-8"])
  776. // When
  777. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: stringUTF8DataFileURL, error: nil) }
  778. // Then
  779. XCTAssertTrue(result.isSuccess)
  780. XCTAssertNotNil(result.success)
  781. XCTAssertNil(result.failure)
  782. }
  783. func testThatStringResponseSerializerFailsWithUTF32DataAndUTF8ProvidedEncoding() {
  784. // Given
  785. let serializer = StringResponseSerializer(encoding: .utf8)
  786. // When
  787. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringUTF32DataFileURL, error: nil) }
  788. // Then
  789. XCTAssertTrue(result.isFailure)
  790. XCTAssertNil(result.success)
  791. XCTAssertNotNil(result.failure)
  792. XCTAssertEqual(result.failure?.asAFError?.isStringSerializationFailed, true)
  793. XCTAssertEqual(result.failure?.asAFError?.failedStringEncoding, .utf8)
  794. }
  795. func testThatStringResponseSerializerFailsWithUTF32DataAndUTF8ResponseEncoding() {
  796. // Given
  797. let serializer = StringResponseSerializer()
  798. let response = HTTPURLResponse(statusCode: 200, headers: ["Content-Type": "image/jpeg; charset=utf-8"])
  799. // When
  800. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: stringUTF32DataFileURL, error: nil) }
  801. // Then
  802. XCTAssertTrue(result.isFailure)
  803. XCTAssertNil(result.success)
  804. XCTAssertNotNil(result.failure)
  805. XCTAssertEqual(result.failure?.asAFError?.isStringSerializationFailed, true)
  806. XCTAssertEqual(result.failure?.asAFError?.failedStringEncoding, .utf8)
  807. }
  808. func testThatStringResponseSerializerFailsWhenErrorIsNotNil() {
  809. // Given
  810. let serializer = StringResponseSerializer()
  811. // When
  812. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: error) }
  813. // Then
  814. XCTAssertTrue(result.isFailure)
  815. XCTAssertNil(result.success)
  816. XCTAssertNotNil(result.failure)
  817. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  818. }
  819. func testThatStringResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  820. // Given
  821. let serializer = StringResponseSerializer()
  822. let response = HTTPURLResponse(statusCode: 200)
  823. // When
  824. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: nil, error: nil) }
  825. // Then
  826. XCTAssertTrue(result.isFailure)
  827. XCTAssertNil(result.success)
  828. XCTAssertNotNil(result.failure)
  829. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  830. }
  831. func testThatStringResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  832. // Given
  833. let serializer = StringResponseSerializer()
  834. let response = HTTPURLResponse(statusCode: 204)
  835. // When
  836. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: stringEmptyDataFileURL, error: nil) }
  837. // Then
  838. XCTAssertTrue(result.isSuccess)
  839. XCTAssertNotNil(result.success)
  840. XCTAssertNil(result.failure)
  841. XCTAssertEqual(result.success, "")
  842. }
  843. // MARK: Tests - JSON Response Serializer
  844. @available(*, deprecated)
  845. func testThatJSONResponseSerializerFailsWhenFileURLIsNil() {
  846. // Given
  847. let serializer = JSONResponseSerializer()
  848. // When
  849. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: nil) }
  850. // Then
  851. XCTAssertTrue(result.isFailure)
  852. XCTAssertNil(result.success)
  853. XCTAssertNotNil(result.failure)
  854. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  855. }
  856. @available(*, deprecated)
  857. func testThatJSONResponseSerializerFailsWhenFileURLIsInvalid() {
  858. // Given
  859. let serializer = JSONResponseSerializer()
  860. // When
  861. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: invalidFileURL, error: nil) }
  862. // Then
  863. XCTAssertTrue(result.isFailure)
  864. XCTAssertNil(result.success)
  865. XCTAssertNotNil(result.failure)
  866. XCTAssertEqual(result.failure?.asAFError?.isInputFileReadFailed, true)
  867. }
  868. @available(*, deprecated)
  869. func testThatJSONResponseSerializerFailsWhenFileDataIsEmpty() {
  870. // Given
  871. let serializer = JSONResponseSerializer()
  872. // When
  873. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonEmptyDataFileURL, error: nil) }
  874. // Then
  875. XCTAssertTrue(result.isFailure)
  876. XCTAssertNil(result.success)
  877. XCTAssertNotNil(result.failure)
  878. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  879. }
  880. @available(*, deprecated)
  881. func testThatJSONResponseSerializerSucceedsWhenDataIsValidJSON() {
  882. // Given
  883. let serializer = JSONResponseSerializer()
  884. // When
  885. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonValidDataFileURL, error: nil) }
  886. // Then
  887. XCTAssertTrue(result.isSuccess)
  888. XCTAssertNotNil(result.success)
  889. XCTAssertNil(result.failure)
  890. }
  891. @available(*, deprecated)
  892. func testThatJSONResponseSerializerFailsWhenDataIsInvalidJSON() {
  893. // Given
  894. let serializer = JSONResponseSerializer()
  895. // When
  896. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonInvalidDataFileURL, error: nil) }
  897. // Then
  898. XCTAssertTrue(result.isFailure)
  899. XCTAssertNil(result.success)
  900. XCTAssertNotNil(result.failure)
  901. XCTAssertEqual(result.failure?.asAFError?.isJSONSerializationFailed, true)
  902. XCTAssertEqual((result.failure?.asAFError?.underlyingError as? CocoaError)?.code, .propertyListReadCorrupt)
  903. }
  904. @available(*, deprecated)
  905. func testThatJSONResponseSerializerFailsWhenErrorIsNotNil() {
  906. // Given
  907. let serializer = JSONResponseSerializer()
  908. // When
  909. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: error) }
  910. // Then
  911. XCTAssertTrue(result.isFailure)
  912. XCTAssertNil(result.success)
  913. XCTAssertNotNil(result.failure)
  914. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  915. }
  916. @available(*, deprecated)
  917. func testThatJSONResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  918. // Given
  919. let serializer = JSONResponseSerializer()
  920. let response = HTTPURLResponse(statusCode: 200)
  921. // When
  922. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: nil, error: nil) }
  923. // Then
  924. XCTAssertTrue(result.isFailure)
  925. XCTAssertNil(result.success)
  926. XCTAssertNotNil(result.failure)
  927. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  928. }
  929. @available(*, deprecated)
  930. func testThatJSONResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  931. // Given
  932. let serializer = JSONResponseSerializer()
  933. let response = HTTPURLResponse(statusCode: 205)
  934. // When
  935. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: jsonEmptyDataFileURL, error: nil) }
  936. // Then
  937. XCTAssertTrue(result.isSuccess)
  938. XCTAssertNotNil(result.success)
  939. XCTAssertNil(result.failure)
  940. XCTAssertEqual(result.success as? NSNull, NSNull())
  941. }
  942. }
  943. #endif
  944. final class CustomResponseSerializerTests: BaseTestCase {
  945. func testThatCustomResponseSerializersCanBeWrittenWithoutCompilerIssues() {
  946. // Given
  947. final class UselessResponseSerializer: ResponseSerializer {
  948. func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: Error?) throws -> Data? {
  949. data
  950. }
  951. }
  952. let serializer = UselessResponseSerializer()
  953. let expectation = self.expectation(description: "request should finish")
  954. var data: Data?
  955. // When
  956. AF.request(.default).response(responseSerializer: serializer) { response in
  957. data = response.data
  958. expectation.fulfill()
  959. }
  960. waitForExpectations(timeout: timeout)
  961. // Then
  962. XCTAssertNotNil(data)
  963. }
  964. }
  965. final class DataPreprocessorSerializationTests: BaseTestCase {
  966. struct DropFirst: DataPreprocessor {
  967. func preprocess(_ data: Data) throws -> Data {
  968. data.dropFirst()
  969. }
  970. }
  971. struct Throwing: DataPreprocessor {
  972. struct Error: Swift.Error {}
  973. func preprocess(_ data: Data) throws -> Data {
  974. throw Error()
  975. }
  976. }
  977. func testThatDataResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  978. // Given
  979. let preprocessor = DropFirst()
  980. let serializer = DataResponseSerializer(dataPreprocessor: preprocessor)
  981. let data = Data("abcd".utf8)
  982. // When
  983. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  984. // Then
  985. XCTAssertTrue(result.isSuccess)
  986. XCTAssertEqual(result.success, Data("bcd".utf8))
  987. XCTAssertNil(result.failure)
  988. }
  989. func testThatDataResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  990. // Given
  991. let preprocessor = Throwing()
  992. let serializer = DataResponseSerializer(dataPreprocessor: preprocessor)
  993. let data = Data("abcd".utf8)
  994. // When
  995. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  996. // Then
  997. XCTAssertTrue(result.isFailure)
  998. XCTAssertNil(result.success)
  999. XCTAssertNotNil(result.failure)
  1000. }
  1001. func testThatStringResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  1002. // Given
  1003. let preprocessor = DropFirst()
  1004. let serializer = StringResponseSerializer(dataPreprocessor: preprocessor)
  1005. let data = Data("abcd".utf8)
  1006. // When
  1007. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1008. // Then
  1009. XCTAssertTrue(result.isSuccess)
  1010. XCTAssertEqual(result.success, "bcd")
  1011. XCTAssertNil(result.failure)
  1012. }
  1013. func testThatStringResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  1014. // Given
  1015. let preprocessor = Throwing()
  1016. let serializer = StringResponseSerializer(dataPreprocessor: preprocessor)
  1017. let data = Data("abcd".utf8)
  1018. // When
  1019. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1020. // Then
  1021. XCTAssertTrue(result.isFailure)
  1022. XCTAssertNil(result.success)
  1023. XCTAssertNotNil(result.failure)
  1024. }
  1025. @available(*, deprecated)
  1026. func testThatJSONResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  1027. // Given
  1028. let preprocessor = DropFirst()
  1029. let serializer = JSONResponseSerializer(dataPreprocessor: preprocessor)
  1030. let data = Data("1\"abcd\"".utf8)
  1031. // When
  1032. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1033. // Then
  1034. XCTAssertTrue(result.isSuccess)
  1035. XCTAssertEqual(result.success as? String, "abcd")
  1036. XCTAssertNil(result.failure)
  1037. }
  1038. @available(*, deprecated)
  1039. func testThatJSONResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  1040. // Given
  1041. let preprocessor = Throwing()
  1042. let serializer = JSONResponseSerializer(dataPreprocessor: preprocessor)
  1043. let data = Data("1\"abcd\"".utf8)
  1044. // When
  1045. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1046. // Then
  1047. XCTAssertTrue(result.isFailure)
  1048. XCTAssertNil(result.success)
  1049. XCTAssertNotNil(result.failure)
  1050. }
  1051. func testThatDecodableResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  1052. // Given
  1053. let preprocessor = DropFirst()
  1054. let serializer = DecodableResponseSerializer<DecodableResponseSerializerTests.DecodableValue>(dataPreprocessor: preprocessor)
  1055. let data = Data("1{\"string\":\"string\"}".utf8)
  1056. // When
  1057. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1058. // Then
  1059. XCTAssertTrue(result.isSuccess)
  1060. XCTAssertEqual(result.success?.string, "string")
  1061. XCTAssertNil(result.failure)
  1062. }
  1063. func testThatDecodableResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  1064. // Given
  1065. let preprocessor = Throwing()
  1066. let serializer = DecodableResponseSerializer<DecodableResponseSerializerTests.DecodableValue>(dataPreprocessor: preprocessor)
  1067. let data = Data("1{\"string\":\"string\"}".utf8)
  1068. // When
  1069. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1070. // Then
  1071. XCTAssertTrue(result.isFailure)
  1072. XCTAssertNil(result.success)
  1073. XCTAssertNotNil(result.failure)
  1074. }
  1075. }
  1076. final class DataPreprocessorTests: BaseTestCase {
  1077. func testThatPassthroughPreprocessorPassesDataThrough() {
  1078. // Given
  1079. let preprocessor = PassthroughPreprocessor()
  1080. let data = Data("data".utf8)
  1081. // When
  1082. let result = Result { try preprocessor.preprocess(data) }
  1083. // Then
  1084. XCTAssertEqual(data, result.success, "Preprocessed data should equal original data.")
  1085. }
  1086. func testThatGoogleXSSIPreprocessorProperlyPreprocessesData() {
  1087. // Given
  1088. let preprocessor = GoogleXSSIPreprocessor()
  1089. let data = Data(")]}',\nabcd".utf8)
  1090. // When
  1091. let result = Result { try preprocessor.preprocess(data) }
  1092. // Then
  1093. XCTAssertEqual(result.success.map { String(decoding: $0, as: UTF8.self) }, "abcd")
  1094. }
  1095. func testThatGoogleXSSIPreprocessorDoesNotChangeDataIfPrefixDoesNotMatch() {
  1096. // Given
  1097. let preprocessor = GoogleXSSIPreprocessor()
  1098. let data = Data("abcd".utf8)
  1099. // When
  1100. let result = Result { try preprocessor.preprocess(data) }
  1101. // Then
  1102. XCTAssertEqual(result.success.map { String(decoding: $0, as: UTF8.self) }, "abcd")
  1103. }
  1104. }
  1105. #if swift(>=5.5)
  1106. final class StaticDataPreprocessorTests: BaseTestCase {
  1107. func consumeDataPreprocessor(_ dataPreprocessor: DataPreprocessor) {
  1108. _ = dataPreprocessor
  1109. }
  1110. func testThatPassthroughCanBeCreatedStaticallyFromProtocol() {
  1111. // Given, When, Then
  1112. consumeDataPreprocessor(.passthrough)
  1113. }
  1114. func testThatGoogleXSSICanBeCreatedStaticallyFromProtocol() {
  1115. // Given, When, Then
  1116. consumeDataPreprocessor(.googleXSSI)
  1117. }
  1118. }
  1119. #endif
  1120. extension HTTPURLResponse {
  1121. convenience init(statusCode: Int, headers: HTTPHeaders? = nil) {
  1122. let url = Endpoint().url
  1123. #if os(watchOS) || os(Linux) || os(Windows)
  1124. let httpVersion = "HTTP/1.1"
  1125. #else
  1126. let httpVersion = String(kCFHTTPVersion1_1)
  1127. #endif
  1128. self.init(url: url, statusCode: statusCode, httpVersion: httpVersion, headerFields: headers?.dictionary)!
  1129. }
  1130. }