ResponseSerializationTests.swift 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411
  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. final class StaticSerializationTests: BaseTestCase {
  378. func consumeDownloadResponseSerializer<Serializer: DownloadResponseSerializerProtocol>(_ responseSerializer: Serializer) {
  379. _ = responseSerializer
  380. }
  381. func consumeStreamSerializer<Serializer: DataStreamSerializer>(_ serializer: Serializer) {
  382. _ = serializer
  383. }
  384. func consumeResponseSerializer<Serializer: ResponseSerializer>(_ responseSerializer: Serializer) {
  385. _ = responseSerializer
  386. }
  387. func testThatURLSerializerCanBeCreatedStaticallyFromProtocol() {
  388. // Given, When, Then
  389. consumeDownloadResponseSerializer(.url)
  390. }
  391. func testThatDataSerializerCanBeCreatedStaticallyFromProtocol() {
  392. // Given, When, Then
  393. consumeResponseSerializer(.data())
  394. }
  395. func testThatStringSerializerCanBeCreatedStaticallyFromProtocol() {
  396. // Given, When, Then
  397. consumeResponseSerializer(.string())
  398. }
  399. func testThatDecodableSerializerCanBeCreatedStaticallyFromProtocol() {
  400. // Given, When, Then
  401. consumeResponseSerializer(.decodable(of: TestResponse.self))
  402. }
  403. func testThatPassthroughStreamSerializerCanBeCreatedStaticallyFromProtocol() {
  404. // Given, When, Then
  405. consumeStreamSerializer(.passthrough)
  406. }
  407. func testThatStringStreamSerializerCanBeCreatedStaticallyFromProtocol() {
  408. // Given, When, Then
  409. consumeStreamSerializer(.string)
  410. }
  411. func testThatDecodableStreamSerializerCanBeCreatedStaticallyFromProtocol() {
  412. // Given, When, Then
  413. consumeStreamSerializer(.decodable(of: TestResponse.self))
  414. }
  415. }
  416. // MARK: -
  417. final class URLResponseSerializerTests: BaseTestCase {
  418. func testThatURLResponseSerializerProducesURLOnSuccess() {
  419. // Given
  420. let serializer = URLResponseSerializer()
  421. let request = Endpoint().urlRequest
  422. let response = HTTPURLResponse(statusCode: 200)
  423. let url = URL(fileURLWithPath: "/")
  424. // When
  425. let result = Result { try serializer.serializeDownload(request: request,
  426. response: response,
  427. fileURL: url,
  428. error: nil) }
  429. // Then
  430. XCTAssertEqual(result.success, url)
  431. }
  432. func testThatURLResponseSerializerProducesErrorFromIncomingErrors() {
  433. // Given
  434. let serializer = URLResponseSerializer()
  435. let request = Endpoint().urlRequest
  436. let response = HTTPURLResponse(statusCode: 200)
  437. let error = AFError.responseValidationFailed(reason: .unacceptableStatusCode(code: 404))
  438. // When
  439. let result = Result { try serializer.serializeDownload(request: request,
  440. response: response,
  441. fileURL: nil,
  442. error: error) }
  443. // Then
  444. XCTAssertEqual(result.failure?.localizedDescription, error.localizedDescription)
  445. }
  446. func testThatURLResponseSerializerProducesInputFileNilErrorWhenNoURL() {
  447. // Given
  448. let serializer = URLResponseSerializer()
  449. let request = Endpoint().urlRequest
  450. let response = HTTPURLResponse(statusCode: 200)
  451. // When
  452. let result = Result { try serializer.serializeDownload(request: request,
  453. response: response,
  454. fileURL: nil,
  455. error: nil) }
  456. // Then
  457. XCTAssertTrue(result.failure?.asAFError?.isInputFileNil == true)
  458. }
  459. }
  460. // MARK: -
  461. // used by testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseConformingTypeAndEmptyResponseStatusCode
  462. extension Swift.Bool: Alamofire.EmptyResponse {
  463. public static func emptyValue() -> Bool {
  464. true
  465. }
  466. }
  467. final class DecodableResponseSerializerTests: BaseTestCase {
  468. private let error = AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength)
  469. struct DecodableValue: Decodable, EmptyResponse {
  470. static func emptyValue() -> DecodableValue {
  471. DecodableValue(string: "")
  472. }
  473. let string: String
  474. }
  475. func testThatDecodableResponseSerializerFailsWhenDataIsNil() {
  476. // Given
  477. let serializer = DecodableResponseSerializer<DecodableValue>()
  478. // When
  479. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: nil) }
  480. // Then
  481. XCTAssertTrue(result.isFailure)
  482. XCTAssertNil(result.success)
  483. XCTAssertNotNil(result.failure)
  484. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  485. }
  486. func testThatDecodableResponseSerializerFailsWhenDataIsEmpty() {
  487. // Given
  488. let serializer = DecodableResponseSerializer<DecodableValue>()
  489. // When
  490. let result = Result { try serializer.serialize(request: nil, response: nil, data: Data(), error: nil) }
  491. // Then
  492. XCTAssertTrue(result.isFailure)
  493. XCTAssertNil(result.success)
  494. XCTAssertNotNil(result.failure)
  495. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  496. }
  497. func testThatDecodableResponseSerializerSucceedsWhenDataIsValidJSON() {
  498. // Given
  499. let data = Data("{\"string\":\"string\"}".utf8)
  500. let serializer = DecodableResponseSerializer<DecodableValue>()
  501. // When
  502. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  503. // Then
  504. XCTAssertTrue(result.isSuccess)
  505. XCTAssertNotNil(result.success)
  506. XCTAssertEqual(result.success?.string, "string")
  507. XCTAssertNil(result.failure)
  508. }
  509. func testThatDecodableResponseSerializerFailsWhenDataIsInvalidRepresentation() {
  510. // Given
  511. let serializer = DecodableResponseSerializer<DecodableValue>()
  512. let data = Data("definitely not valid".utf8)
  513. // When
  514. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  515. // Then
  516. XCTAssertTrue(result.isFailure)
  517. XCTAssertNil(result.success)
  518. XCTAssertNotNil(result.failure)
  519. }
  520. func testThatDecodableResponseSerializerFailsWhenErrorIsNotNil() {
  521. // Given
  522. let serializer = DecodableResponseSerializer<DecodableValue>()
  523. // When
  524. let result = Result { try serializer.serialize(request: nil, response: nil, data: nil, error: error) }
  525. // Then
  526. XCTAssertTrue(result.isFailure)
  527. XCTAssertNil(result.success)
  528. XCTAssertNotNil(result.failure)
  529. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  530. }
  531. func testThatDecodableResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  532. // Given
  533. let serializer = DecodableResponseSerializer<DecodableValue>()
  534. let response = HTTPURLResponse(statusCode: 200)
  535. // When
  536. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  537. // Then
  538. XCTAssertTrue(result.isFailure)
  539. XCTAssertNil(result.success)
  540. XCTAssertNotNil(result.failure)
  541. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  542. }
  543. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  544. // Given
  545. let serializer = DecodableResponseSerializer<DecodableValue>()
  546. let response = HTTPURLResponse(statusCode: 204)
  547. // When
  548. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  549. // Then
  550. XCTAssertTrue(result.isSuccess)
  551. XCTAssertNotNil(result.success)
  552. XCTAssertNil(result.failure)
  553. }
  554. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithEmptyTypeAndEmptyResponseStatusCode() {
  555. // Given
  556. let serializer = DecodableResponseSerializer<Empty>()
  557. let response = HTTPURLResponse(statusCode: 204)
  558. // When
  559. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  560. // Then
  561. XCTAssertTrue(result.isSuccess)
  562. XCTAssertNotNil(result.success)
  563. XCTAssertNil(result.failure)
  564. }
  565. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd204ResponseStatusCode() {
  566. // Given
  567. let serializer = DecodableResponseSerializer<Empty>()
  568. let request = Endpoint().urlRequest
  569. let response = HTTPURLResponse(statusCode: 204)
  570. // When
  571. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  572. // Then
  573. XCTAssertTrue(result.isSuccess)
  574. XCTAssertNotNil(result.success)
  575. XCTAssertNil(result.failure)
  576. }
  577. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithGETRequestAnd205ResponseStatusCode() {
  578. // Given
  579. let serializer = DecodableResponseSerializer<Empty>()
  580. let request = Endpoint().urlRequest
  581. let response = HTTPURLResponse(statusCode: 205)
  582. // When
  583. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  584. // Then
  585. XCTAssertTrue(result.isSuccess)
  586. XCTAssertNotNil(result.success)
  587. XCTAssertNil(result.failure)
  588. }
  589. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithHEADRequestAnd200ResponseStatusCode() {
  590. // Given
  591. let serializer = DecodableResponseSerializer<Empty>()
  592. let request = Endpoint(method: .head).urlRequest
  593. let response = HTTPURLResponse(statusCode: 200)
  594. // When
  595. let result = Result { try serializer.serialize(request: request, response: response, data: nil, error: nil) }
  596. // Then
  597. XCTAssertTrue(result.isSuccess)
  598. XCTAssertNotNil(result.success)
  599. XCTAssertNil(result.failure)
  600. }
  601. func testThatDecodableResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseConformingTypeAndEmptyResponseStatusCode() {
  602. // Given
  603. let serializer = DecodableResponseSerializer<Bool>()
  604. let response = HTTPURLResponse(statusCode: 204)
  605. // When
  606. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  607. // Then
  608. XCTAssertTrue(result.isSuccess)
  609. XCTAssertNotNil(result.success)
  610. XCTAssertNil(result.failure)
  611. }
  612. func testThatDecodableResponseSerializerFailsWhenDataIsNilWithEmptyResponseNonconformingTypeAndEmptyResponseStatusCode() {
  613. // Given
  614. let serializer = DecodableResponseSerializer<Int>()
  615. let response = HTTPURLResponse(statusCode: 204)
  616. // When
  617. let result = Result { try serializer.serialize(request: nil, response: response, data: nil, error: nil) }
  618. // Then
  619. XCTAssertTrue(result.isFailure)
  620. XCTAssertNil(result.success)
  621. XCTAssertNotNil(result.failure)
  622. XCTAssertEqual(result.failure?.asAFError?.isInvalidEmptyResponse, true)
  623. }
  624. }
  625. // MARK: -
  626. final class DownloadResponseSerializationTestCase: BaseTestCase {
  627. // MARK: Properties
  628. private let error = AFError.responseSerializationFailed(reason: .inputFileNil)
  629. private var jsonEmptyDataFileURL: URL { url(forResource: "empty_data", withExtension: "json") }
  630. private var jsonValidDataFileURL: URL { url(forResource: "valid_data", withExtension: "json") }
  631. private var jsonInvalidDataFileURL: URL { url(forResource: "invalid_data", withExtension: "json") }
  632. private var stringEmptyDataFileURL: URL { url(forResource: "empty_string", withExtension: "txt") }
  633. private var stringUTF8DataFileURL: URL { url(forResource: "utf8_string", withExtension: "txt") }
  634. private var stringUTF32DataFileURL: URL { url(forResource: "utf32_string", withExtension: "txt") }
  635. private var invalidFileURL: URL { URL(fileURLWithPath: "/this/file/does/not/exist.txt") }
  636. // MARK: Tests - Data Response Serializer
  637. func testThatDataResponseSerializerSucceedsWhenFileDataIsNotNil() {
  638. // Given
  639. let serializer = DataResponseSerializer()
  640. // When
  641. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonValidDataFileURL, error: nil) }
  642. // Then
  643. XCTAssertTrue(result.isSuccess)
  644. XCTAssertNotNil(result.success)
  645. XCTAssertNil(result.failure)
  646. }
  647. func testThatDataResponseSerializerFailsWhenFileDataIsEmpty() {
  648. // Given
  649. let serializer = DataResponseSerializer()
  650. // When
  651. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonEmptyDataFileURL, error: nil) }
  652. // Then
  653. XCTAssertTrue(result.isFailure)
  654. XCTAssertNil(result.success)
  655. XCTAssertNotNil(result.failure)
  656. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  657. }
  658. func testThatDataResponseSerializerFailsWhenFileURLIsNil() {
  659. // Given
  660. let serializer = DataResponseSerializer()
  661. // When
  662. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: nil) }
  663. // Then
  664. XCTAssertTrue(result.isFailure)
  665. XCTAssertNil(result.success)
  666. XCTAssertNotNil(result.failure)
  667. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  668. }
  669. func testThatDataResponseSerializerFailsWhenFileURLIsInvalid() {
  670. // Given
  671. let serializer = DataResponseSerializer()
  672. // When
  673. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: invalidFileURL, error: nil) }
  674. // Then
  675. XCTAssertTrue(result.isFailure)
  676. XCTAssertNil(result.success)
  677. XCTAssertNotNil(result.failure)
  678. XCTAssertEqual(result.failure?.asAFError?.isInputFileReadFailed, true)
  679. }
  680. func testThatDataResponseSerializerFailsWhenErrorIsNotNil() {
  681. // Given
  682. let serializer = DataResponseSerializer()
  683. // When
  684. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: error) }
  685. // Then
  686. XCTAssertTrue(result.isFailure)
  687. XCTAssertNil(result.success)
  688. XCTAssertNotNil(result.failure)
  689. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  690. }
  691. func testThatDataResponseSerializerFailsWhenFileURLIsNilWithNonEmptyResponseStatusCode() {
  692. // Given
  693. let serializer = DataResponseSerializer()
  694. let response = HTTPURLResponse(statusCode: 200)
  695. // When
  696. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: nil, error: nil) }
  697. // Then
  698. XCTAssertTrue(result.isFailure)
  699. XCTAssertNil(result.success)
  700. XCTAssertNotNil(result.failure)
  701. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  702. }
  703. func testThatDataResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  704. // Given
  705. let serializer = DataResponseSerializer()
  706. let response = HTTPURLResponse(statusCode: 205)
  707. // When
  708. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: jsonEmptyDataFileURL, error: nil) }
  709. // Then
  710. XCTAssertTrue(result.isSuccess)
  711. XCTAssertNotNil(result.success)
  712. XCTAssertNil(result.failure)
  713. XCTAssertEqual(result.success?.count, 0)
  714. }
  715. // MARK: Tests - String Response Serializer
  716. func testThatStringResponseSerializerFailsWhenFileURLIsNil() {
  717. // Given
  718. let serializer = StringResponseSerializer()
  719. // When
  720. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: nil) }
  721. // Then
  722. XCTAssertTrue(result.isFailure)
  723. XCTAssertNil(result.success)
  724. XCTAssertNotNil(result.failure)
  725. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  726. }
  727. func testThatStringResponseSerializerFailsWhenFileURLIsInvalid() {
  728. // Given
  729. let serializer = StringResponseSerializer()
  730. // When
  731. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: invalidFileURL, error: nil) }
  732. // Then
  733. XCTAssertEqual(result.isSuccess, false)
  734. XCTAssertNil(result.success)
  735. XCTAssertNotNil(result.failure)
  736. XCTAssertEqual(result.failure?.asAFError?.isInputFileReadFailed, true)
  737. }
  738. func testThatStringResponseSerializerFailsWhenFileDataIsEmpty() {
  739. // Given
  740. let serializer = StringResponseSerializer()
  741. // When
  742. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringEmptyDataFileURL, error: nil) }
  743. // Then
  744. XCTAssertTrue(result.isFailure)
  745. XCTAssertNil(result.success)
  746. XCTAssertNotNil(result.failure)
  747. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  748. }
  749. func testThatStringResponseSerializerSucceedsWithUTF8DataAndNoProvidedEncoding() {
  750. // Given
  751. let serializer = StringResponseSerializer()
  752. // When
  753. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringUTF8DataFileURL, error: nil) }
  754. // Then
  755. XCTAssertTrue(result.isSuccess)
  756. XCTAssertNotNil(result.success)
  757. XCTAssertNil(result.failure)
  758. }
  759. func testThatStringResponseSerializerSucceedsWithUTF8DataAndUTF8ProvidedEncoding() {
  760. // Given
  761. let serializer = StringResponseSerializer(encoding: .utf8)
  762. // When
  763. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringUTF8DataFileURL, error: nil) }
  764. // Then
  765. XCTAssertTrue(result.isSuccess)
  766. XCTAssertNotNil(result.success)
  767. XCTAssertNil(result.failure)
  768. }
  769. func testThatStringResponseSerializerSucceedsWithUTF8DataUsingResponseTextEncodingName() {
  770. // Given
  771. let serializer = StringResponseSerializer()
  772. let response = HTTPURLResponse(statusCode: 200, headers: ["Content-Type": "image/jpeg; charset=utf-8"])
  773. // When
  774. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: stringUTF8DataFileURL, error: nil) }
  775. // Then
  776. XCTAssertTrue(result.isSuccess)
  777. XCTAssertNotNil(result.success)
  778. XCTAssertNil(result.failure)
  779. }
  780. func testThatStringResponseSerializerFailsWithUTF32DataAndUTF8ProvidedEncoding() {
  781. // Given
  782. let serializer = StringResponseSerializer(encoding: .utf8)
  783. // When
  784. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringUTF32DataFileURL, error: nil) }
  785. // Then
  786. XCTAssertTrue(result.isFailure)
  787. XCTAssertNil(result.success)
  788. XCTAssertNotNil(result.failure)
  789. XCTAssertEqual(result.failure?.asAFError?.isStringSerializationFailed, true)
  790. XCTAssertEqual(result.failure?.asAFError?.failedStringEncoding, .utf8)
  791. }
  792. func testThatStringResponseSerializerFailsWithUTF32DataAndUTF8ResponseEncoding() {
  793. // Given
  794. let serializer = StringResponseSerializer()
  795. let response = HTTPURLResponse(statusCode: 200, headers: ["Content-Type": "image/jpeg; charset=utf-8"])
  796. // When
  797. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: stringUTF32DataFileURL, error: nil) }
  798. // Then
  799. XCTAssertTrue(result.isFailure)
  800. XCTAssertNil(result.success)
  801. XCTAssertNotNil(result.failure)
  802. XCTAssertEqual(result.failure?.asAFError?.isStringSerializationFailed, true)
  803. XCTAssertEqual(result.failure?.asAFError?.failedStringEncoding, .utf8)
  804. }
  805. func testThatStringResponseSerializerFailsWhenErrorIsNotNil() {
  806. // Given
  807. let serializer = StringResponseSerializer()
  808. // When
  809. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: error) }
  810. // Then
  811. XCTAssertTrue(result.isFailure)
  812. XCTAssertNil(result.success)
  813. XCTAssertNotNil(result.failure)
  814. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  815. }
  816. func testThatStringResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  817. // Given
  818. let serializer = StringResponseSerializer()
  819. let response = HTTPURLResponse(statusCode: 200)
  820. // When
  821. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: nil, error: nil) }
  822. // Then
  823. XCTAssertTrue(result.isFailure)
  824. XCTAssertNil(result.success)
  825. XCTAssertNotNil(result.failure)
  826. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  827. }
  828. func testThatStringResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  829. // Given
  830. let serializer = StringResponseSerializer()
  831. let response = HTTPURLResponse(statusCode: 204)
  832. // When
  833. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: stringEmptyDataFileURL, error: nil) }
  834. // Then
  835. XCTAssertTrue(result.isSuccess)
  836. XCTAssertNotNil(result.success)
  837. XCTAssertNil(result.failure)
  838. XCTAssertEqual(result.success, "")
  839. }
  840. // MARK: Tests - JSON Response Serializer
  841. @available(*, deprecated)
  842. func testThatJSONResponseSerializerFailsWhenFileURLIsNil() {
  843. // Given
  844. let serializer = JSONResponseSerializer()
  845. // When
  846. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: nil) }
  847. // Then
  848. XCTAssertTrue(result.isFailure)
  849. XCTAssertNil(result.success)
  850. XCTAssertNotNil(result.failure)
  851. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  852. }
  853. @available(*, deprecated)
  854. func testThatJSONResponseSerializerFailsWhenFileURLIsInvalid() {
  855. // Given
  856. let serializer = JSONResponseSerializer()
  857. // When
  858. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: invalidFileURL, error: nil) }
  859. // Then
  860. XCTAssertTrue(result.isFailure)
  861. XCTAssertNil(result.success)
  862. XCTAssertNotNil(result.failure)
  863. XCTAssertEqual(result.failure?.asAFError?.isInputFileReadFailed, true)
  864. }
  865. @available(*, deprecated)
  866. func testThatJSONResponseSerializerFailsWhenFileDataIsEmpty() {
  867. // Given
  868. let serializer = JSONResponseSerializer()
  869. // When
  870. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonEmptyDataFileURL, error: nil) }
  871. // Then
  872. XCTAssertTrue(result.isFailure)
  873. XCTAssertNil(result.success)
  874. XCTAssertNotNil(result.failure)
  875. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  876. }
  877. @available(*, deprecated)
  878. func testThatJSONResponseSerializerSucceedsWhenDataIsValidJSON() {
  879. // Given
  880. let serializer = JSONResponseSerializer()
  881. // When
  882. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonValidDataFileURL, error: nil) }
  883. // Then
  884. XCTAssertTrue(result.isSuccess)
  885. XCTAssertNotNil(result.success)
  886. XCTAssertNil(result.failure)
  887. }
  888. @available(*, deprecated)
  889. func testThatJSONResponseSerializerFailsWhenDataIsInvalidJSON() {
  890. // Given
  891. let serializer = JSONResponseSerializer()
  892. // When
  893. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonInvalidDataFileURL, error: nil) }
  894. // Then
  895. XCTAssertTrue(result.isFailure)
  896. XCTAssertNil(result.success)
  897. XCTAssertNotNil(result.failure)
  898. XCTAssertEqual(result.failure?.asAFError?.isJSONSerializationFailed, true)
  899. XCTAssertEqual((result.failure?.asAFError?.underlyingError as? CocoaError)?.code, .propertyListReadCorrupt)
  900. }
  901. @available(*, deprecated)
  902. func testThatJSONResponseSerializerFailsWhenErrorIsNotNil() {
  903. // Given
  904. let serializer = JSONResponseSerializer()
  905. // When
  906. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: error) }
  907. // Then
  908. XCTAssertTrue(result.isFailure)
  909. XCTAssertNil(result.success)
  910. XCTAssertNotNil(result.failure)
  911. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  912. }
  913. @available(*, deprecated)
  914. func testThatJSONResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  915. // Given
  916. let serializer = JSONResponseSerializer()
  917. let response = HTTPURLResponse(statusCode: 200)
  918. // When
  919. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: nil, error: nil) }
  920. // Then
  921. XCTAssertTrue(result.isFailure)
  922. XCTAssertNil(result.success)
  923. XCTAssertNotNil(result.failure)
  924. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  925. }
  926. @available(*, deprecated)
  927. func testThatJSONResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  928. // Given
  929. let serializer = JSONResponseSerializer()
  930. let response = HTTPURLResponse(statusCode: 205)
  931. // When
  932. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: jsonEmptyDataFileURL, error: nil) }
  933. // Then
  934. XCTAssertTrue(result.isSuccess)
  935. XCTAssertNotNil(result.success)
  936. XCTAssertNil(result.failure)
  937. XCTAssertEqual(result.success as? NSNull, NSNull())
  938. }
  939. }
  940. final class CustomResponseSerializerTests: BaseTestCase {
  941. @MainActor
  942. func testThatCustomResponseSerializersCanBeWrittenWithoutCompilerIssues() {
  943. // Given
  944. final class UselessResponseSerializer: ResponseSerializer {
  945. func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: (any Error)?) throws -> Data? {
  946. data
  947. }
  948. }
  949. let serializer = UselessResponseSerializer()
  950. let expectation = expectation(description: "request should finish")
  951. var data: Data?
  952. // When
  953. AF.request(.default).response(responseSerializer: serializer) { response in
  954. data = response.data
  955. expectation.fulfill()
  956. }
  957. waitForExpectations(timeout: timeout)
  958. // Then
  959. XCTAssertNotNil(data)
  960. }
  961. }
  962. final class DataPreprocessorSerializationTests: BaseTestCase {
  963. struct DropFirst: DataPreprocessor {
  964. func preprocess(_ data: Data) throws -> Data {
  965. data.dropFirst()
  966. }
  967. }
  968. struct Throwing: DataPreprocessor {
  969. struct Error: Swift.Error {}
  970. func preprocess(_ data: Data) throws -> Data {
  971. throw Error()
  972. }
  973. }
  974. func testThatDataResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  975. // Given
  976. let preprocessor = DropFirst()
  977. let serializer = DataResponseSerializer(dataPreprocessor: preprocessor)
  978. let data = Data("abcd".utf8)
  979. // When
  980. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  981. // Then
  982. XCTAssertTrue(result.isSuccess)
  983. XCTAssertEqual(result.success, Data("bcd".utf8))
  984. XCTAssertNil(result.failure)
  985. }
  986. func testThatDataResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  987. // Given
  988. let preprocessor = Throwing()
  989. let serializer = DataResponseSerializer(dataPreprocessor: preprocessor)
  990. let data = Data("abcd".utf8)
  991. // When
  992. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  993. // Then
  994. XCTAssertTrue(result.isFailure)
  995. XCTAssertNil(result.success)
  996. XCTAssertNotNil(result.failure)
  997. }
  998. func testThatStringResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  999. // Given
  1000. let preprocessor = DropFirst()
  1001. let serializer = StringResponseSerializer(dataPreprocessor: preprocessor)
  1002. let data = Data("abcd".utf8)
  1003. // When
  1004. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1005. // Then
  1006. XCTAssertTrue(result.isSuccess)
  1007. XCTAssertEqual(result.success, "bcd")
  1008. XCTAssertNil(result.failure)
  1009. }
  1010. func testThatStringResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  1011. // Given
  1012. let preprocessor = Throwing()
  1013. let serializer = StringResponseSerializer(dataPreprocessor: preprocessor)
  1014. let data = Data("abcd".utf8)
  1015. // When
  1016. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1017. // Then
  1018. XCTAssertTrue(result.isFailure)
  1019. XCTAssertNil(result.success)
  1020. XCTAssertNotNil(result.failure)
  1021. }
  1022. @available(*, deprecated)
  1023. func testThatJSONResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  1024. // Given
  1025. let preprocessor = DropFirst()
  1026. let serializer = JSONResponseSerializer(dataPreprocessor: preprocessor)
  1027. let data = Data("1\"abcd\"".utf8)
  1028. // When
  1029. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1030. // Then
  1031. XCTAssertTrue(result.isSuccess)
  1032. XCTAssertEqual(result.success as? String, "abcd")
  1033. XCTAssertNil(result.failure)
  1034. }
  1035. @available(*, deprecated)
  1036. func testThatJSONResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  1037. // Given
  1038. let preprocessor = Throwing()
  1039. let serializer = JSONResponseSerializer(dataPreprocessor: preprocessor)
  1040. let data = Data("1\"abcd\"".utf8)
  1041. // When
  1042. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1043. // Then
  1044. XCTAssertTrue(result.isFailure)
  1045. XCTAssertNil(result.success)
  1046. XCTAssertNotNil(result.failure)
  1047. }
  1048. func testThatDecodableResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  1049. // Given
  1050. let preprocessor = DropFirst()
  1051. let serializer = DecodableResponseSerializer<DecodableResponseSerializerTests.DecodableValue>(dataPreprocessor: preprocessor)
  1052. let data = Data("1{\"string\":\"string\"}".utf8)
  1053. // When
  1054. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1055. // Then
  1056. XCTAssertTrue(result.isSuccess)
  1057. XCTAssertEqual(result.success?.string, "string")
  1058. XCTAssertNil(result.failure)
  1059. }
  1060. func testThatDecodableResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  1061. // Given
  1062. let preprocessor = Throwing()
  1063. let serializer = DecodableResponseSerializer<DecodableResponseSerializerTests.DecodableValue>(dataPreprocessor: preprocessor)
  1064. let data = Data("1{\"string\":\"string\"}".utf8)
  1065. // When
  1066. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1067. // Then
  1068. XCTAssertTrue(result.isFailure)
  1069. XCTAssertNil(result.success)
  1070. XCTAssertNotNil(result.failure)
  1071. }
  1072. }
  1073. final class DataPreprocessorTests: BaseTestCase {
  1074. func testThatPassthroughPreprocessorPassesDataThrough() {
  1075. // Given
  1076. let preprocessor = PassthroughPreprocessor()
  1077. let data = Data("data".utf8)
  1078. // When
  1079. let result = Result { try preprocessor.preprocess(data) }
  1080. // Then
  1081. XCTAssertEqual(data, result.success, "Preprocessed data should equal original data.")
  1082. }
  1083. func testThatGoogleXSSIPreprocessorProperlyPreprocessesData() {
  1084. // Given
  1085. let preprocessor = GoogleXSSIPreprocessor()
  1086. let data = Data(")]}',\nabcd".utf8)
  1087. // When
  1088. let result = Result { try preprocessor.preprocess(data) }
  1089. // Then
  1090. XCTAssertEqual(result.success.map { String(decoding: $0, as: UTF8.self) }, "abcd")
  1091. }
  1092. func testThatGoogleXSSIPreprocessorDoesNotChangeDataIfPrefixDoesNotMatch() {
  1093. // Given
  1094. let preprocessor = GoogleXSSIPreprocessor()
  1095. let data = Data("abcd".utf8)
  1096. // When
  1097. let result = Result { try preprocessor.preprocess(data) }
  1098. // Then
  1099. XCTAssertEqual(result.success.map { String(decoding: $0, as: UTF8.self) }, "abcd")
  1100. }
  1101. }
  1102. final class StaticDataPreprocessorTests: BaseTestCase {
  1103. func consumeDataPreprocessor(_ dataPreprocessor: any DataPreprocessor) {
  1104. _ = dataPreprocessor
  1105. }
  1106. func testThatPassthroughCanBeCreatedStaticallyFromProtocol() {
  1107. // Given, When, Then
  1108. consumeDataPreprocessor(.passthrough)
  1109. }
  1110. func testThatGoogleXSSICanBeCreatedStaticallyFromProtocol() {
  1111. // Given, When, Then
  1112. consumeDataPreprocessor(.googleXSSI)
  1113. }
  1114. }
  1115. extension HTTPURLResponse {
  1116. convenience init(statusCode: Int, headers: HTTPHeaders? = nil) {
  1117. let url = Endpoint().url
  1118. #if os(watchOS) || os(Linux) || os(Windows) || os(Android)
  1119. let httpVersion = "HTTP/1.1"
  1120. #else
  1121. let httpVersion = String(kCFHTTPVersion1_1)
  1122. #endif
  1123. self.init(url: url, statusCode: statusCode, httpVersion: httpVersion, headerFields: headers?.dictionary)!
  1124. }
  1125. }