2
0

ResponseSerializationTests.swift 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414
  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. final class DownloadResponseSerializationTestCase: BaseTestCase {
  629. // MARK: Properties
  630. private let error = AFError.responseSerializationFailed(reason: .inputFileNil)
  631. private var jsonEmptyDataFileURL: URL { url(forResource: "empty_data", withExtension: "json") }
  632. private var jsonValidDataFileURL: URL { url(forResource: "valid_data", withExtension: "json") }
  633. private var jsonInvalidDataFileURL: URL { url(forResource: "invalid_data", withExtension: "json") }
  634. private var stringEmptyDataFileURL: URL { url(forResource: "empty_string", withExtension: "txt") }
  635. private var stringUTF8DataFileURL: URL { url(forResource: "utf8_string", withExtension: "txt") }
  636. private var stringUTF32DataFileURL: URL { url(forResource: "utf32_string", withExtension: "txt") }
  637. private var invalidFileURL: URL { URL(fileURLWithPath: "/this/file/does/not/exist.txt") }
  638. // MARK: Tests - Data Response Serializer
  639. func testThatDataResponseSerializerSucceedsWhenFileDataIsNotNil() {
  640. // Given
  641. let serializer = DataResponseSerializer()
  642. // When
  643. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonValidDataFileURL, error: nil) }
  644. // Then
  645. XCTAssertTrue(result.isSuccess)
  646. XCTAssertNotNil(result.success)
  647. XCTAssertNil(result.failure)
  648. }
  649. func testThatDataResponseSerializerFailsWhenFileDataIsEmpty() {
  650. // Given
  651. let serializer = DataResponseSerializer()
  652. // When
  653. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonEmptyDataFileURL, error: nil) }
  654. // Then
  655. XCTAssertTrue(result.isFailure)
  656. XCTAssertNil(result.success)
  657. XCTAssertNotNil(result.failure)
  658. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  659. }
  660. func testThatDataResponseSerializerFailsWhenFileURLIsNil() {
  661. // Given
  662. let serializer = DataResponseSerializer()
  663. // When
  664. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: nil) }
  665. // Then
  666. XCTAssertTrue(result.isFailure)
  667. XCTAssertNil(result.success)
  668. XCTAssertNotNil(result.failure)
  669. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  670. }
  671. func testThatDataResponseSerializerFailsWhenFileURLIsInvalid() {
  672. // Given
  673. let serializer = DataResponseSerializer()
  674. // When
  675. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: invalidFileURL, error: nil) }
  676. // Then
  677. XCTAssertTrue(result.isFailure)
  678. XCTAssertNil(result.success)
  679. XCTAssertNotNil(result.failure)
  680. XCTAssertEqual(result.failure?.asAFError?.isInputFileReadFailed, true)
  681. }
  682. func testThatDataResponseSerializerFailsWhenErrorIsNotNil() {
  683. // Given
  684. let serializer = DataResponseSerializer()
  685. // When
  686. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: error) }
  687. // Then
  688. XCTAssertTrue(result.isFailure)
  689. XCTAssertNil(result.success)
  690. XCTAssertNotNil(result.failure)
  691. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  692. }
  693. func testThatDataResponseSerializerFailsWhenFileURLIsNilWithNonEmptyResponseStatusCode() {
  694. // Given
  695. let serializer = DataResponseSerializer()
  696. let response = HTTPURLResponse(statusCode: 200)
  697. // When
  698. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: nil, error: nil) }
  699. // Then
  700. XCTAssertTrue(result.isFailure)
  701. XCTAssertNil(result.success)
  702. XCTAssertNotNil(result.failure)
  703. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  704. }
  705. func testThatDataResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  706. // Given
  707. let serializer = DataResponseSerializer()
  708. let response = HTTPURLResponse(statusCode: 205)
  709. // When
  710. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: jsonEmptyDataFileURL, error: nil) }
  711. // Then
  712. XCTAssertTrue(result.isSuccess)
  713. XCTAssertNotNil(result.success)
  714. XCTAssertNil(result.failure)
  715. XCTAssertEqual(result.success?.count, 0)
  716. }
  717. // MARK: Tests - String Response Serializer
  718. func testThatStringResponseSerializerFailsWhenFileURLIsNil() {
  719. // Given
  720. let serializer = StringResponseSerializer()
  721. // When
  722. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: nil) }
  723. // Then
  724. XCTAssertTrue(result.isFailure)
  725. XCTAssertNil(result.success)
  726. XCTAssertNotNil(result.failure)
  727. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  728. }
  729. func testThatStringResponseSerializerFailsWhenFileURLIsInvalid() {
  730. // Given
  731. let serializer = StringResponseSerializer()
  732. // When
  733. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: invalidFileURL, error: nil) }
  734. // Then
  735. XCTAssertEqual(result.isSuccess, false)
  736. XCTAssertNil(result.success)
  737. XCTAssertNotNil(result.failure)
  738. XCTAssertEqual(result.failure?.asAFError?.isInputFileReadFailed, true)
  739. }
  740. func testThatStringResponseSerializerFailsWhenFileDataIsEmpty() {
  741. // Given
  742. let serializer = StringResponseSerializer()
  743. // When
  744. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringEmptyDataFileURL, error: nil) }
  745. // Then
  746. XCTAssertTrue(result.isFailure)
  747. XCTAssertNil(result.success)
  748. XCTAssertNotNil(result.failure)
  749. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  750. }
  751. func testThatStringResponseSerializerSucceedsWithUTF8DataAndNoProvidedEncoding() {
  752. // Given
  753. let serializer = StringResponseSerializer()
  754. // When
  755. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringUTF8DataFileURL, error: nil) }
  756. // Then
  757. XCTAssertTrue(result.isSuccess)
  758. XCTAssertNotNil(result.success)
  759. XCTAssertNil(result.failure)
  760. }
  761. func testThatStringResponseSerializerSucceedsWithUTF8DataAndUTF8ProvidedEncoding() {
  762. // Given
  763. let serializer = StringResponseSerializer(encoding: .utf8)
  764. // When
  765. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringUTF8DataFileURL, error: nil) }
  766. // Then
  767. XCTAssertTrue(result.isSuccess)
  768. XCTAssertNotNil(result.success)
  769. XCTAssertNil(result.failure)
  770. }
  771. func testThatStringResponseSerializerSucceedsWithUTF8DataUsingResponseTextEncodingName() {
  772. // Given
  773. let serializer = StringResponseSerializer()
  774. let response = HTTPURLResponse(statusCode: 200, headers: ["Content-Type": "image/jpeg; charset=utf-8"])
  775. // When
  776. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: stringUTF8DataFileURL, error: nil) }
  777. // Then
  778. XCTAssertTrue(result.isSuccess)
  779. XCTAssertNotNil(result.success)
  780. XCTAssertNil(result.failure)
  781. }
  782. func testThatStringResponseSerializerFailsWithUTF32DataAndUTF8ProvidedEncoding() {
  783. // Given
  784. let serializer = StringResponseSerializer(encoding: .utf8)
  785. // When
  786. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: stringUTF32DataFileURL, error: nil) }
  787. // Then
  788. XCTAssertTrue(result.isFailure)
  789. XCTAssertNil(result.success)
  790. XCTAssertNotNil(result.failure)
  791. XCTAssertEqual(result.failure?.asAFError?.isStringSerializationFailed, true)
  792. XCTAssertEqual(result.failure?.asAFError?.failedStringEncoding, .utf8)
  793. }
  794. func testThatStringResponseSerializerFailsWithUTF32DataAndUTF8ResponseEncoding() {
  795. // Given
  796. let serializer = StringResponseSerializer()
  797. let response = HTTPURLResponse(statusCode: 200, headers: ["Content-Type": "image/jpeg; charset=utf-8"])
  798. // When
  799. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: stringUTF32DataFileURL, error: nil) }
  800. // Then
  801. XCTAssertTrue(result.isFailure)
  802. XCTAssertNil(result.success)
  803. XCTAssertNotNil(result.failure)
  804. XCTAssertEqual(result.failure?.asAFError?.isStringSerializationFailed, true)
  805. XCTAssertEqual(result.failure?.asAFError?.failedStringEncoding, .utf8)
  806. }
  807. func testThatStringResponseSerializerFailsWhenErrorIsNotNil() {
  808. // Given
  809. let serializer = StringResponseSerializer()
  810. // When
  811. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: error) }
  812. // Then
  813. XCTAssertTrue(result.isFailure)
  814. XCTAssertNil(result.success)
  815. XCTAssertNotNil(result.failure)
  816. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  817. }
  818. func testThatStringResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  819. // Given
  820. let serializer = StringResponseSerializer()
  821. let response = HTTPURLResponse(statusCode: 200)
  822. // When
  823. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: nil, error: nil) }
  824. // Then
  825. XCTAssertTrue(result.isFailure)
  826. XCTAssertNil(result.success)
  827. XCTAssertNotNil(result.failure)
  828. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  829. }
  830. func testThatStringResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  831. // Given
  832. let serializer = StringResponseSerializer()
  833. let response = HTTPURLResponse(statusCode: 204)
  834. // When
  835. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: stringEmptyDataFileURL, error: nil) }
  836. // Then
  837. XCTAssertTrue(result.isSuccess)
  838. XCTAssertNotNil(result.success)
  839. XCTAssertNil(result.failure)
  840. XCTAssertEqual(result.success, "")
  841. }
  842. // MARK: Tests - JSON Response Serializer
  843. @available(*, deprecated)
  844. func testThatJSONResponseSerializerFailsWhenFileURLIsNil() {
  845. // Given
  846. let serializer = JSONResponseSerializer()
  847. // When
  848. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: nil) }
  849. // Then
  850. XCTAssertTrue(result.isFailure)
  851. XCTAssertNil(result.success)
  852. XCTAssertNotNil(result.failure)
  853. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  854. }
  855. @available(*, deprecated)
  856. func testThatJSONResponseSerializerFailsWhenFileURLIsInvalid() {
  857. // Given
  858. let serializer = JSONResponseSerializer()
  859. // When
  860. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: invalidFileURL, error: nil) }
  861. // Then
  862. XCTAssertTrue(result.isFailure)
  863. XCTAssertNil(result.success)
  864. XCTAssertNotNil(result.failure)
  865. XCTAssertEqual(result.failure?.asAFError?.isInputFileReadFailed, true)
  866. }
  867. @available(*, deprecated)
  868. func testThatJSONResponseSerializerFailsWhenFileDataIsEmpty() {
  869. // Given
  870. let serializer = JSONResponseSerializer()
  871. // When
  872. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonEmptyDataFileURL, error: nil) }
  873. // Then
  874. XCTAssertTrue(result.isFailure)
  875. XCTAssertNil(result.success)
  876. XCTAssertNotNil(result.failure)
  877. XCTAssertEqual(result.failure?.asAFError?.isInputDataNilOrZeroLength, true)
  878. }
  879. @available(*, deprecated)
  880. func testThatJSONResponseSerializerSucceedsWhenDataIsValidJSON() {
  881. // Given
  882. let serializer = JSONResponseSerializer()
  883. // When
  884. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonValidDataFileURL, error: nil) }
  885. // Then
  886. XCTAssertTrue(result.isSuccess)
  887. XCTAssertNotNil(result.success)
  888. XCTAssertNil(result.failure)
  889. }
  890. @available(*, deprecated)
  891. func testThatJSONResponseSerializerFailsWhenDataIsInvalidJSON() {
  892. // Given
  893. let serializer = JSONResponseSerializer()
  894. // When
  895. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: jsonInvalidDataFileURL, error: nil) }
  896. // Then
  897. XCTAssertTrue(result.isFailure)
  898. XCTAssertNil(result.success)
  899. XCTAssertNotNil(result.failure)
  900. XCTAssertEqual(result.failure?.asAFError?.isJSONSerializationFailed, true)
  901. XCTAssertEqual((result.failure?.asAFError?.underlyingError as? CocoaError)?.code, .propertyListReadCorrupt)
  902. }
  903. @available(*, deprecated)
  904. func testThatJSONResponseSerializerFailsWhenErrorIsNotNil() {
  905. // Given
  906. let serializer = JSONResponseSerializer()
  907. // When
  908. let result = Result { try serializer.serializeDownload(request: nil, response: nil, fileURL: nil, error: error) }
  909. // Then
  910. XCTAssertTrue(result.isFailure)
  911. XCTAssertNil(result.success)
  912. XCTAssertNotNil(result.failure)
  913. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  914. }
  915. @available(*, deprecated)
  916. func testThatJSONResponseSerializerFailsWhenDataIsNilWithNonEmptyResponseStatusCode() {
  917. // Given
  918. let serializer = JSONResponseSerializer()
  919. let response = HTTPURLResponse(statusCode: 200)
  920. // When
  921. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: nil, error: nil) }
  922. // Then
  923. XCTAssertTrue(result.isFailure)
  924. XCTAssertNil(result.success)
  925. XCTAssertNotNil(result.failure)
  926. XCTAssertEqual(result.failure?.asAFError?.isInputFileNil, true)
  927. }
  928. @available(*, deprecated)
  929. func testThatJSONResponseSerializerSucceedsWhenDataIsNilWithEmptyResponseStatusCode() {
  930. // Given
  931. let serializer = JSONResponseSerializer()
  932. let response = HTTPURLResponse(statusCode: 205)
  933. // When
  934. let result = Result { try serializer.serializeDownload(request: nil, response: response, fileURL: jsonEmptyDataFileURL, error: nil) }
  935. // Then
  936. XCTAssertTrue(result.isSuccess)
  937. XCTAssertNotNil(result.success)
  938. XCTAssertNil(result.failure)
  939. XCTAssertEqual(result.success as? NSNull, NSNull())
  940. }
  941. }
  942. final class CustomResponseSerializerTests: BaseTestCase {
  943. func testThatCustomResponseSerializersCanBeWrittenWithoutCompilerIssues() {
  944. // Given
  945. final class UselessResponseSerializer: ResponseSerializer {
  946. func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: Error?) throws -> Data? {
  947. data
  948. }
  949. }
  950. let serializer = UselessResponseSerializer()
  951. let expectation = self.expectation(description: "request should finish")
  952. var data: Data?
  953. // When
  954. AF.request(.default).response(responseSerializer: serializer) { response in
  955. data = response.data
  956. expectation.fulfill()
  957. }
  958. waitForExpectations(timeout: timeout)
  959. // Then
  960. XCTAssertNotNil(data)
  961. }
  962. }
  963. final class DataPreprocessorSerializationTests: BaseTestCase {
  964. struct DropFirst: DataPreprocessor {
  965. func preprocess(_ data: Data) throws -> Data {
  966. data.dropFirst()
  967. }
  968. }
  969. struct Throwing: DataPreprocessor {
  970. struct Error: Swift.Error {}
  971. func preprocess(_ data: Data) throws -> Data {
  972. throw Error()
  973. }
  974. }
  975. func testThatDataResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  976. // Given
  977. let preprocessor = DropFirst()
  978. let serializer = DataResponseSerializer(dataPreprocessor: preprocessor)
  979. let data = Data("abcd".utf8)
  980. // When
  981. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  982. // Then
  983. XCTAssertTrue(result.isSuccess)
  984. XCTAssertEqual(result.success, Data("bcd".utf8))
  985. XCTAssertNil(result.failure)
  986. }
  987. func testThatDataResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  988. // Given
  989. let preprocessor = Throwing()
  990. let serializer = DataResponseSerializer(dataPreprocessor: preprocessor)
  991. let data = Data("abcd".utf8)
  992. // When
  993. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  994. // Then
  995. XCTAssertTrue(result.isFailure)
  996. XCTAssertNil(result.success)
  997. XCTAssertNotNil(result.failure)
  998. }
  999. func testThatStringResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  1000. // Given
  1001. let preprocessor = DropFirst()
  1002. let serializer = StringResponseSerializer(dataPreprocessor: preprocessor)
  1003. let data = Data("abcd".utf8)
  1004. // When
  1005. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1006. // Then
  1007. XCTAssertTrue(result.isSuccess)
  1008. XCTAssertEqual(result.success, "bcd")
  1009. XCTAssertNil(result.failure)
  1010. }
  1011. func testThatStringResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  1012. // Given
  1013. let preprocessor = Throwing()
  1014. let serializer = StringResponseSerializer(dataPreprocessor: preprocessor)
  1015. let data = Data("abcd".utf8)
  1016. // When
  1017. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1018. // Then
  1019. XCTAssertTrue(result.isFailure)
  1020. XCTAssertNil(result.success)
  1021. XCTAssertNotNil(result.failure)
  1022. }
  1023. @available(*, deprecated)
  1024. func testThatJSONResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  1025. // Given
  1026. let preprocessor = DropFirst()
  1027. let serializer = JSONResponseSerializer(dataPreprocessor: preprocessor)
  1028. let data = Data("1\"abcd\"".utf8)
  1029. // When
  1030. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1031. // Then
  1032. XCTAssertTrue(result.isSuccess)
  1033. XCTAssertEqual(result.success as? String, "abcd")
  1034. XCTAssertNil(result.failure)
  1035. }
  1036. @available(*, deprecated)
  1037. func testThatJSONResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  1038. // Given
  1039. let preprocessor = Throwing()
  1040. let serializer = JSONResponseSerializer(dataPreprocessor: preprocessor)
  1041. let data = Data("1\"abcd\"".utf8)
  1042. // When
  1043. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1044. // Then
  1045. XCTAssertTrue(result.isFailure)
  1046. XCTAssertNil(result.success)
  1047. XCTAssertNotNil(result.failure)
  1048. }
  1049. func testThatDecodableResponseSerializerProperlyCallsSuccessfulDataPreprocessor() {
  1050. // Given
  1051. let preprocessor = DropFirst()
  1052. let serializer = DecodableResponseSerializer<DecodableResponseSerializerTests.DecodableValue>(dataPreprocessor: preprocessor)
  1053. let data = Data("1{\"string\":\"string\"}".utf8)
  1054. // When
  1055. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1056. // Then
  1057. XCTAssertTrue(result.isSuccess)
  1058. XCTAssertEqual(result.success?.string, "string")
  1059. XCTAssertNil(result.failure)
  1060. }
  1061. func testThatDecodableResponseSerializerProperlyReceivesErrorFromFailingDataPreprocessor() {
  1062. // Given
  1063. let preprocessor = Throwing()
  1064. let serializer = DecodableResponseSerializer<DecodableResponseSerializerTests.DecodableValue>(dataPreprocessor: preprocessor)
  1065. let data = Data("1{\"string\":\"string\"}".utf8)
  1066. // When
  1067. let result = Result { try serializer.serialize(request: nil, response: nil, data: data, error: nil) }
  1068. // Then
  1069. XCTAssertTrue(result.isFailure)
  1070. XCTAssertNil(result.success)
  1071. XCTAssertNotNil(result.failure)
  1072. }
  1073. }
  1074. final class DataPreprocessorTests: BaseTestCase {
  1075. func testThatPassthroughPreprocessorPassesDataThrough() {
  1076. // Given
  1077. let preprocessor = PassthroughPreprocessor()
  1078. let data = Data("data".utf8)
  1079. // When
  1080. let result = Result { try preprocessor.preprocess(data) }
  1081. // Then
  1082. XCTAssertEqual(data, result.success, "Preprocessed data should equal original data.")
  1083. }
  1084. func testThatGoogleXSSIPreprocessorProperlyPreprocessesData() {
  1085. // Given
  1086. let preprocessor = GoogleXSSIPreprocessor()
  1087. let data = Data(")]}',\nabcd".utf8)
  1088. // When
  1089. let result = Result { try preprocessor.preprocess(data) }
  1090. // Then
  1091. XCTAssertEqual(result.success.map { String(decoding: $0, as: UTF8.self) }, "abcd")
  1092. }
  1093. func testThatGoogleXSSIPreprocessorDoesNotChangeDataIfPrefixDoesNotMatch() {
  1094. // Given
  1095. let preprocessor = GoogleXSSIPreprocessor()
  1096. let data = Data("abcd".utf8)
  1097. // When
  1098. let result = Result { try preprocessor.preprocess(data) }
  1099. // Then
  1100. XCTAssertEqual(result.success.map { String(decoding: $0, as: UTF8.self) }, "abcd")
  1101. }
  1102. }
  1103. #if swift(>=5.5)
  1104. final class StaticDataPreprocessorTests: BaseTestCase {
  1105. func consumeDataPreprocessor(_ dataPreprocessor: DataPreprocessor) {
  1106. _ = dataPreprocessor
  1107. }
  1108. func testThatPassthroughCanBeCreatedStaticallyFromProtocol() {
  1109. // Given, When, Then
  1110. consumeDataPreprocessor(.passthrough)
  1111. }
  1112. func testThatGoogleXSSICanBeCreatedStaticallyFromProtocol() {
  1113. // Given, When, Then
  1114. consumeDataPreprocessor(.googleXSSI)
  1115. }
  1116. }
  1117. #endif
  1118. extension HTTPURLResponse {
  1119. convenience init(statusCode: Int, headers: HTTPHeaders? = nil) {
  1120. let url = Endpoint().url
  1121. #if os(watchOS) || os(Linux) || os(Windows)
  1122. let httpVersion = "HTTP/1.1"
  1123. #else
  1124. let httpVersion = String(kCFHTTPVersion1_1)
  1125. #endif
  1126. self.init(url: url, statusCode: statusCode, httpVersion: httpVersion, headerFields: headers?.dictionary)!
  1127. }
  1128. }