ParameterEncodingTests.swift 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679
  1. //
  2. // ParameterEncodingTests.swift
  3. //
  4. // Copyright (c) 2014-2016 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. class ParameterEncodingTestCase: BaseTestCase {
  28. let urlRequest = URLRequest(url: URL(string: "https://example.com/")!)
  29. }
  30. // MARK: -
  31. class URLParameterEncodingTestCase: ParameterEncodingTestCase {
  32. // MARK: Properties
  33. let encoding: ParameterEncoding = .url
  34. // MARK: Tests - Parameter Types
  35. func testURLParameterEncodeNilParameters() {
  36. // Given, When
  37. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: nil)
  38. // Then
  39. XCTAssertNil(urlRequest.url?.query, "query should be nil")
  40. }
  41. func testURLParameterEncodeEmptyDictionaryParameter() {
  42. // Given
  43. let parameters: [String: Any] = [:]
  44. // When
  45. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  46. // Then
  47. XCTAssertNil(urlRequest.url?.query, "query should be nil")
  48. }
  49. func testURLParameterEncodeOneStringKeyStringValueParameter() {
  50. // Given
  51. let parameters = ["foo": "bar"]
  52. // When
  53. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  54. // Then
  55. XCTAssertEqual(urlRequest.url?.query ?? "", "foo=bar", "query is incorrect")
  56. }
  57. func testURLParameterEncodeOneStringKeyStringValueParameterAppendedToQuery() {
  58. // Given
  59. var mutableURLRequest = self.urlRequest.urlRequest
  60. var urlComponents = URLComponents(url: mutableURLRequest.url!, resolvingAgainstBaseURL: false)!
  61. urlComponents.query = "baz=qux"
  62. mutableURLRequest.url = urlComponents.url
  63. let parameters = ["foo": "bar"]
  64. // When
  65. let (urlRequest, _) = encoding.encode(mutableURLRequest, parameters: parameters)
  66. // Then
  67. XCTAssertEqual(urlRequest.url?.query ?? "", "baz=qux&foo=bar", "query is incorrect")
  68. }
  69. func testURLParameterEncodeTwoStringKeyStringValueParameters() {
  70. // Given
  71. let parameters = ["foo": "bar", "baz": "qux"]
  72. // When
  73. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  74. // Then
  75. XCTAssertEqual(urlRequest.url?.query ?? "", "baz=qux&foo=bar", "query is incorrect")
  76. }
  77. func testURLParameterEncodeStringKeyIntegerValueParameter() {
  78. // Given
  79. let parameters = ["foo": 1]
  80. // When
  81. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  82. // Then
  83. XCTAssertEqual(urlRequest.url?.query ?? "", "foo=1", "query is incorrect")
  84. }
  85. func testURLParameterEncodeStringKeyDoubleValueParameter() {
  86. // Given
  87. let parameters = ["foo": 1.1]
  88. // When
  89. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  90. // Then
  91. XCTAssertEqual(urlRequest.url?.query ?? "", "foo=1.1", "query is incorrect")
  92. }
  93. func testURLParameterEncodeStringKeyBoolValueParameter() {
  94. // Given
  95. let parameters = ["foo": true]
  96. // When
  97. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  98. // Then
  99. XCTAssertEqual(urlRequest.url?.query ?? "", "foo=1", "query is incorrect")
  100. }
  101. func testURLParameterEncodeStringKeyArrayValueParameter() {
  102. // Given
  103. let parameters = ["foo": ["a", 1, true]]
  104. // When
  105. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  106. // Then
  107. XCTAssertEqual(urlRequest.url?.query ?? "", "foo%5B%5D=a&foo%5B%5D=1&foo%5B%5D=1", "query is incorrect")
  108. }
  109. func testURLParameterEncodeStringKeyDictionaryValueParameter() {
  110. // Given
  111. let parameters = ["foo": ["bar": 1]]
  112. // When
  113. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  114. // Then
  115. XCTAssertEqual(urlRequest.url?.query ?? "", "foo%5Bbar%5D=1", "query is incorrect")
  116. }
  117. func testURLParameterEncodeStringKeyNestedDictionaryValueParameter() {
  118. // Given
  119. let parameters = ["foo": ["bar": ["baz": 1]]]
  120. // When
  121. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  122. // Then
  123. XCTAssertEqual(urlRequest.url?.query ?? "", "foo%5Bbar%5D%5Bbaz%5D=1", "query is incorrect")
  124. }
  125. func testURLParameterEncodeStringKeyNestedDictionaryArrayValueParameter() {
  126. // Given
  127. let parameters = ["foo": ["bar": ["baz": ["a", 1, true]]]]
  128. // When
  129. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  130. // Then
  131. let expectedQuery = "foo%5Bbar%5D%5Bbaz%5D%5B%5D=a&foo%5Bbar%5D%5Bbaz%5D%5B%5D=1&foo%5Bbar%5D%5Bbaz%5D%5B%5D=1"
  132. XCTAssertEqual(urlRequest.url?.query ?? "", expectedQuery, "query is incorrect")
  133. }
  134. // MARK: Tests - All Reserved / Unreserved / Illegal Characters According to RFC 3986
  135. func testThatReservedCharactersArePercentEscapedMinusQuestionMarkAndForwardSlash() {
  136. // Given
  137. let generalDelimiters = ":#[]@"
  138. let subDelimiters = "!$&'()*+,;="
  139. let parameters = ["reserved": "\(generalDelimiters)\(subDelimiters)"]
  140. // When
  141. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  142. // Then
  143. let expectedQuery = "reserved=%3A%23%5B%5D%40%21%24%26%27%28%29%2A%2B%2C%3B%3D"
  144. XCTAssertEqual(urlRequest.url?.query ?? "", expectedQuery, "query is incorrect")
  145. }
  146. func testThatReservedCharactersQuestionMarkAndForwardSlashAreNotPercentEscaped() {
  147. // Given
  148. let parameters = ["reserved": "?/"]
  149. // When
  150. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  151. // Then
  152. XCTAssertEqual(urlRequest.url?.query ?? "", "reserved=?/", "query is incorrect")
  153. }
  154. func testThatUnreservedNumericCharactersAreNotPercentEscaped() {
  155. // Given
  156. let parameters = ["numbers": "0123456789"]
  157. // When
  158. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  159. // Then
  160. XCTAssertEqual(urlRequest.url?.query ?? "", "numbers=0123456789", "query is incorrect")
  161. }
  162. func testThatUnreservedLowercaseCharactersAreNotPercentEscaped() {
  163. // Given
  164. let parameters = ["lowercase": "abcdefghijklmnopqrstuvwxyz"]
  165. // When
  166. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  167. // Then
  168. XCTAssertEqual(urlRequest.url?.query ?? "", "lowercase=abcdefghijklmnopqrstuvwxyz", "query is incorrect")
  169. }
  170. func testThatUnreservedUppercaseCharactersAreNotPercentEscaped() {
  171. // Given
  172. let parameters = ["uppercase": "ABCDEFGHIJKLMNOPQRSTUVWXYZ"]
  173. // When
  174. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  175. // Then
  176. XCTAssertEqual(urlRequest.url?.query ?? "", "uppercase=ABCDEFGHIJKLMNOPQRSTUVWXYZ", "query is incorrect")
  177. }
  178. func testThatIllegalASCIICharactersArePercentEscaped() {
  179. // Given
  180. let parameters = ["illegal": " \"#%<>[]\\^`{}|"]
  181. // When
  182. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  183. // Then
  184. let expectedQuery = "illegal=%20%22%23%25%3C%3E%5B%5D%5C%5E%60%7B%7D%7C"
  185. XCTAssertEqual(urlRequest.url?.query ?? "", expectedQuery, "query is incorrect")
  186. }
  187. // MARK: Tests - Special Character Queries
  188. func testURLParameterEncodeStringWithAmpersandKeyStringWithAmpersandValueParameter() {
  189. // Given
  190. let parameters = ["foo&bar": "baz&qux", "foobar": "bazqux"]
  191. // When
  192. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  193. // Then
  194. XCTAssertEqual(urlRequest.url?.query ?? "", "foo%26bar=baz%26qux&foobar=bazqux", "query is incorrect")
  195. }
  196. func testURLParameterEncodeStringWithQuestionMarkKeyStringWithQuestionMarkValueParameter() {
  197. // Given
  198. let parameters = ["?foo?": "?bar?"]
  199. // When
  200. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  201. // Then
  202. XCTAssertEqual(urlRequest.url?.query ?? "", "?foo?=?bar?", "query is incorrect")
  203. }
  204. func testURLParameterEncodeStringWithSlashKeyStringWithQuestionMarkValueParameter() {
  205. // Given
  206. let parameters = ["foo": "/bar/baz/qux"]
  207. // When
  208. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  209. // Then
  210. XCTAssertEqual(urlRequest.url?.query ?? "", "foo=/bar/baz/qux", "query is incorrect")
  211. }
  212. func testURLParameterEncodeStringWithSpaceKeyStringWithSpaceValueParameter() {
  213. // Given
  214. let parameters = [" foo ": " bar "]
  215. // When
  216. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  217. // Then
  218. XCTAssertEqual(urlRequest.url?.query ?? "", "%20foo%20=%20bar%20", "query is incorrect")
  219. }
  220. func testURLParameterEncodeStringWithPlusKeyStringWithPlusValueParameter() {
  221. // Given
  222. let parameters = ["+foo+": "+bar+"]
  223. // When
  224. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  225. // Then
  226. XCTAssertEqual(urlRequest.url?.query ?? "", "%2Bfoo%2B=%2Bbar%2B", "query is incorrect")
  227. }
  228. func testURLParameterEncodeStringKeyPercentEncodedStringValueParameter() {
  229. // Given
  230. let parameters = ["percent": "%25"]
  231. // When
  232. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  233. // Then
  234. XCTAssertEqual(urlRequest.url?.query ?? "", "percent=%2525", "query is incorrect")
  235. }
  236. func testURLParameterEncodeStringKeyNonLatinStringValueParameter() {
  237. // Given
  238. let parameters = [
  239. "french": "français",
  240. "japanese": "日本語",
  241. "arabic": "العربية",
  242. "emoji": "😃"
  243. ]
  244. // When
  245. let (urlRequest, _) = encoding.encode(self.urlRequest, parameters: parameters)
  246. // Then
  247. let expectedParameterValues = [
  248. "arabic=%D8%A7%D9%84%D8%B9%D8%B1%D8%A8%D9%8A%D8%A9",
  249. "emoji=%F0%9F%98%83",
  250. "french=fran%C3%A7ais",
  251. "japanese=%E6%97%A5%E6%9C%AC%E8%AA%9E"
  252. ]
  253. let expectedQuery = expectedParameterValues.joined(separator: "&")
  254. XCTAssertEqual(urlRequest.url?.query ?? "", expectedQuery, "query is incorrect")
  255. }
  256. func testURLParameterEncodeStringForRequestWithPrecomposedQuery() {
  257. // Given
  258. let url = URL(string: "https://example.com/movies?hd=[1]")!
  259. let parameters = ["page": "0"]
  260. // When
  261. let (urlRequest, _) = encoding.encode(URLRequest(url: url), parameters: parameters)
  262. // Then
  263. XCTAssertEqual(urlRequest.url?.query ?? "", "hd=%5B1%5D&page=0", "query is incorrect")
  264. }
  265. func testURLParameterEncodeStringWithPlusKeyStringWithPlusValueParameterForRequestWithPrecomposedQuery() {
  266. // Given
  267. let url = URL(string: "https://example.com/movie?hd=[1]")!
  268. let parameters = ["+foo+": "+bar+"]
  269. // When
  270. let (urlRequest, _) = encoding.encode(URLRequest(url: url), parameters: parameters)
  271. // Then
  272. XCTAssertEqual(urlRequest.url?.query ?? "", "hd=%5B1%5D&%2Bfoo%2B=%2Bbar%2B", "query is incorrect")
  273. }
  274. func testURLParameterEncodeStringWithThousandsOfChineseCharacters() {
  275. // Given
  276. let repeatedCount = 2_000
  277. let url = URL(string: "https://example.com/movies")!
  278. let parameters = ["chinese": String(count: repeatedCount, repeatedString: "一二三四五六七八九十")]
  279. // When
  280. let (urlRequest, _) = encoding.encode(URLRequest(url: url), parameters: parameters)
  281. // Then
  282. var expected = "chinese="
  283. for _ in 0..<repeatedCount {
  284. expected += "%E4%B8%80%E4%BA%8C%E4%B8%89%E5%9B%9B%E4%BA%94%E5%85%AD%E4%B8%83%E5%85%AB%E4%B9%9D%E5%8D%81"
  285. }
  286. XCTAssertEqual(urlRequest.url?.query ?? "", expected, "query is incorrect")
  287. }
  288. // MARK: Tests - Varying HTTP Methods
  289. func testThatURLParameterEncodingEncodesGETParametersInURL() {
  290. // Given
  291. var mutableURLRequest = self.urlRequest.urlRequest
  292. mutableURLRequest.httpMethod = HTTPMethod.get.rawValue
  293. let parameters = ["foo": 1, "bar": 2]
  294. // When
  295. let (urlRequest, _) = encoding.encode(mutableURLRequest, parameters: parameters)
  296. // Then
  297. XCTAssertEqual(urlRequest.url?.query ?? "", "bar=2&foo=1", "query is incorrect")
  298. XCTAssertNil(urlRequest.value(forHTTPHeaderField: "Content-Type"), "Content-Type should be nil")
  299. XCTAssertNil(urlRequest.httpBody, "HTTPBody should be nil")
  300. }
  301. func testThatURLParameterEncodingEncodesPOSTParametersInHTTPBody() {
  302. // Given
  303. var mutableURLRequest = self.urlRequest.urlRequest
  304. mutableURLRequest.httpMethod = HTTPMethod.post.rawValue
  305. let parameters = ["foo": 1, "bar": 2]
  306. // When
  307. let (urlRequest, _) = encoding.encode(mutableURLRequest, parameters: parameters)
  308. // Then
  309. XCTAssertEqual(
  310. urlRequest.value(forHTTPHeaderField: "Content-Type") ?? "",
  311. "application/x-www-form-urlencoded; charset=utf-8",
  312. "Content-Type should be application/x-www-form-urlencoded"
  313. )
  314. XCTAssertNotNil(urlRequest.httpBody, "HTTPBody should not be nil")
  315. if
  316. let httpBody = urlRequest.httpBody,
  317. let decodedHTTPBody = String(data: httpBody, encoding: String.Encoding.utf8)
  318. {
  319. XCTAssertEqual(decodedHTTPBody, "bar=2&foo=1", "HTTPBody is incorrect")
  320. } else {
  321. XCTFail("decoded http body should not be nil")
  322. }
  323. }
  324. func testThatURLEncodedInURLParameterEncodingEncodesPOSTParametersInURL() {
  325. // Given
  326. var mutableURLRequest = self.urlRequest.urlRequest
  327. mutableURLRequest.httpMethod = HTTPMethod.post.rawValue
  328. let parameters = ["foo": 1, "bar": 2]
  329. // When
  330. let (urlRequest, _) = ParameterEncoding.urlEncodedInURL.encode(mutableURLRequest, parameters: parameters)
  331. // Then
  332. XCTAssertEqual(urlRequest.url?.query ?? "", "bar=2&foo=1", "query is incorrect")
  333. XCTAssertNil(urlRequest.value(forHTTPHeaderField: "Content-Type"), "Content-Type should be nil")
  334. XCTAssertNil(urlRequest.httpBody, "HTTPBody should be nil")
  335. }
  336. }
  337. // MARK: -
  338. class JSONParameterEncodingTestCase: ParameterEncodingTestCase {
  339. // MARK: Properties
  340. let encoding: ParameterEncoding = .json
  341. // MARK: Tests
  342. func testJSONParameterEncodeNilParameters() {
  343. // Given, When
  344. let (URLRequest, error) = encoding.encode(self.urlRequest, parameters: nil)
  345. // Then
  346. XCTAssertNil(error, "error should be nil")
  347. XCTAssertNil(URLRequest.url?.query, "query should be nil")
  348. XCTAssertNil(URLRequest.value(forHTTPHeaderField: "Content-Type"), "Content-Type should be nil")
  349. XCTAssertNil(URLRequest.httpBody, "HTTPBody should be nil")
  350. }
  351. func testJSONParameterEncodeComplexParameters() {
  352. // Given
  353. let parameters: [String: Any] = [
  354. "foo": "bar",
  355. "baz": ["a", 1, true],
  356. "qux": [
  357. "a": 1,
  358. "b": [2, 2],
  359. "c": [3, 3, 3]
  360. ]
  361. ]
  362. // When
  363. let (URLRequest, error) = encoding.encode(self.urlRequest, parameters: parameters)
  364. // Then
  365. XCTAssertNil(error, "error should be nil")
  366. XCTAssertNil(URLRequest.url?.query, "query should be nil")
  367. XCTAssertNotNil(URLRequest.value(forHTTPHeaderField: "Content-Type"), "Content-Type should not be nil")
  368. XCTAssertEqual(
  369. URLRequest.value(forHTTPHeaderField: "Content-Type") ?? "",
  370. "application/json",
  371. "Content-Type should be application/json"
  372. )
  373. XCTAssertNotNil(URLRequest.httpBody, "HTTPBody should not be nil")
  374. if let HTTPBody = URLRequest.httpBody {
  375. do {
  376. let JSON = try JSONSerialization.jsonObject(with: HTTPBody, options: .allowFragments)
  377. if let JSON = JSON as? NSObject {
  378. XCTAssertEqual(JSON, parameters as NSObject, "HTTPBody JSON does not equal parameters")
  379. } else {
  380. XCTFail("JSON should be an NSObject")
  381. }
  382. } catch {
  383. XCTFail("JSON should not be nil")
  384. }
  385. } else {
  386. XCTFail("JSON should not be nil")
  387. }
  388. }
  389. func testJSONParameterEncodeParametersRetainsCustomContentType() {
  390. // Given
  391. var mutableURLRequest = URLRequest(url: URL(string: "https://example.com/")!)
  392. mutableURLRequest.setValue("application/custom-json-type+json", forHTTPHeaderField: "Content-Type")
  393. let parameters = ["foo": "bar"]
  394. // When
  395. let (urlRequest, error) = encoding.encode(mutableURLRequest, parameters: parameters)
  396. // Then
  397. XCTAssertNil(error)
  398. XCTAssertNil(urlRequest.url?.query)
  399. XCTAssertEqual(urlRequest.value(forHTTPHeaderField: "Content-Type"), "application/custom-json-type+json")
  400. }
  401. }
  402. // MARK: -
  403. class PropertyListParameterEncodingTestCase: ParameterEncodingTestCase {
  404. // MARK: Properties
  405. let encoding: ParameterEncoding = .propertyList(.xml, 0)
  406. // MARK: Tests
  407. func testPropertyListParameterEncodeNilParameters() {
  408. // Given, When
  409. let (URLRequest, error) = encoding.encode(self.urlRequest, parameters: nil)
  410. // Then
  411. XCTAssertNil(error, "error should be nil")
  412. XCTAssertNil(URLRequest.url?.query, "query should be nil")
  413. XCTAssertNil(URLRequest.value(forHTTPHeaderField: "Content-Type"), "Content-Type should be nil")
  414. XCTAssertNil(URLRequest.httpBody, "HTTPBody should be nil")
  415. }
  416. func testPropertyListParameterEncodeComplexParameters() {
  417. // Given
  418. let parameters: [String: Any] = [
  419. "foo": "bar",
  420. "baz": ["a", 1, true],
  421. "qux": [
  422. "a": 1,
  423. "b": [2, 2],
  424. "c": [3, 3, 3]
  425. ]
  426. ]
  427. // When
  428. let (URLRequest, error) = encoding.encode(self.urlRequest, parameters: parameters)
  429. // Then
  430. XCTAssertNil(error, "error should be nil")
  431. XCTAssertNil(URLRequest.url?.query, "query should be nil")
  432. XCTAssertNotNil(URLRequest.value(forHTTPHeaderField: "Content-Type"), "Content-Type should not be nil")
  433. XCTAssertEqual(
  434. URLRequest.value(forHTTPHeaderField: "Content-Type") ?? "",
  435. "application/x-plist",
  436. "Content-Type should be application/x-plist"
  437. )
  438. XCTAssertNotNil(URLRequest.httpBody, "HTTPBody should not be nil")
  439. if let HTTPBody = URLRequest.httpBody {
  440. do {
  441. let plist = try PropertyListSerialization.propertyList(
  442. from: HTTPBody,
  443. options: PropertyListSerialization.MutabilityOptions(),
  444. format: nil
  445. )
  446. if let plist = plist as? NSObject {
  447. XCTAssertEqual(plist, parameters as NSObject, "HTTPBody plist does not equal parameters")
  448. } else {
  449. XCTFail("plist should be an NSObject")
  450. }
  451. } catch {
  452. XCTFail("plist should not be nil")
  453. }
  454. }
  455. }
  456. func testPropertyListParameterEncodeDateAndDataParameters() {
  457. // Given
  458. let date: Date = Date()
  459. let data: Data = "data".data(using: String.Encoding.utf8, allowLossyConversion: false)!
  460. let parameters: [String: Any] = [
  461. "date": date,
  462. "data": data
  463. ]
  464. // When
  465. let (urlRequest, error) = encoding.encode(self.urlRequest, parameters: parameters)
  466. // Then
  467. XCTAssertNil(error, "error should be nil")
  468. XCTAssertNil(urlRequest.url?.query, "query should be nil")
  469. XCTAssertNotNil(urlRequest.value(forHTTPHeaderField: "Content-Type"), "Content-Type should not be nil")
  470. XCTAssertEqual(
  471. urlRequest.value(forHTTPHeaderField: "Content-Type") ?? "",
  472. "application/x-plist",
  473. "Content-Type should be application/x-plist"
  474. )
  475. XCTAssertNotNil(urlRequest.httpBody, "HTTPBody should not be nil")
  476. if let HTTPBody = urlRequest.httpBody {
  477. do {
  478. let plist = try PropertyListSerialization.propertyList(
  479. from: HTTPBody,
  480. options: PropertyListSerialization.MutabilityOptions(),
  481. format: nil
  482. ) as AnyObject
  483. XCTAssertTrue(plist.value(forKey: "date") is Date, "date is not Date")
  484. XCTAssertTrue(plist.value(forKey: "data") is Data, "data is not Data")
  485. } catch {
  486. XCTFail("plist should not be nil")
  487. }
  488. } else {
  489. XCTFail("HTTPBody should not be nil")
  490. }
  491. }
  492. func testPropertyListParameterEncodeParametersRetainsCustomContentType() {
  493. // Given
  494. var mutableURLRequest = URLRequest(url: URL(string: "https://example.com/")!)
  495. mutableURLRequest.setValue("application/custom-plist-type+plist", forHTTPHeaderField: "Content-Type")
  496. let parameters = ["foo": "bar"]
  497. // When
  498. let (urlRequest, error) = encoding.encode(mutableURLRequest, parameters: parameters)
  499. // Then
  500. XCTAssertNil(error)
  501. XCTAssertNil(urlRequest.url?.query)
  502. XCTAssertEqual(urlRequest.value(forHTTPHeaderField: "Content-Type"), "application/custom-plist-type+plist")
  503. }
  504. }
  505. // MARK: -
  506. class CustomParameterEncodingTestCase: ParameterEncodingTestCase {
  507. // MARK: Tests
  508. func testCustomParameterEncode() {
  509. // Given
  510. let encodingClosure: (URLRequestConvertible, [String: Any]?) -> (URLRequest, Error?) = { urlRequest, parameters in
  511. guard let parameters = parameters else { return (urlRequest.urlRequest, nil) }
  512. var urlString = urlRequest.urlRequest.urlString + "?"
  513. parameters.forEach { urlString += "\($0)=\($1)" }
  514. var mutableURLRequest = urlRequest.urlRequest
  515. mutableURLRequest.url = URL(string: urlString)!
  516. return (mutableURLRequest, nil)
  517. }
  518. // When
  519. let encoding: ParameterEncoding = .custom(encodingClosure)
  520. // Then
  521. let url = URL(string: "https://example.com")!
  522. let urlRequest = URLRequest(url: url)
  523. let parameters = ["foo": "bar"]
  524. let result = encoding.encode(urlRequest, parameters: parameters)
  525. XCTAssertEqual(result.0.urlString, "https://example.com?foo=bar")
  526. }
  527. }