tests.py 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775
  1. import copy
  2. import json
  3. import os
  4. import pickle
  5. import unittest
  6. import uuid
  7. from django.core.exceptions import DisallowedRedirect
  8. from django.core.serializers.json import DjangoJSONEncoder
  9. from django.core.signals import request_finished
  10. from django.db import close_old_connections
  11. from django.http import (
  12. BadHeaderError, HttpResponse, HttpResponseNotAllowed,
  13. HttpResponseNotModified, HttpResponsePermanentRedirect,
  14. HttpResponseRedirect, JsonResponse, QueryDict, SimpleCookie,
  15. StreamingHttpResponse, parse_cookie,
  16. )
  17. from django.test import SimpleTestCase
  18. from django.utils.functional import lazystr
  19. class QueryDictTests(SimpleTestCase):
  20. def test_create_with_no_args(self):
  21. self.assertEqual(QueryDict(), QueryDict(''))
  22. def test_missing_key(self):
  23. q = QueryDict()
  24. with self.assertRaises(KeyError):
  25. q.__getitem__('foo')
  26. def test_immutability(self):
  27. q = QueryDict()
  28. with self.assertRaises(AttributeError):
  29. q.__setitem__('something', 'bar')
  30. with self.assertRaises(AttributeError):
  31. q.setlist('foo', ['bar'])
  32. with self.assertRaises(AttributeError):
  33. q.appendlist('foo', ['bar'])
  34. with self.assertRaises(AttributeError):
  35. q.update({'foo': 'bar'})
  36. with self.assertRaises(AttributeError):
  37. q.pop('foo')
  38. with self.assertRaises(AttributeError):
  39. q.popitem()
  40. with self.assertRaises(AttributeError):
  41. q.clear()
  42. def test_immutable_get_with_default(self):
  43. q = QueryDict()
  44. self.assertEqual(q.get('foo', 'default'), 'default')
  45. def test_immutable_basic_operations(self):
  46. q = QueryDict()
  47. self.assertEqual(q.getlist('foo'), [])
  48. self.assertNotIn('foo', q)
  49. self.assertEqual(list(q), [])
  50. self.assertEqual(list(q.items()), [])
  51. self.assertEqual(list(q.lists()), [])
  52. self.assertEqual(list(q.keys()), [])
  53. self.assertEqual(list(q.values()), [])
  54. self.assertEqual(len(q), 0)
  55. self.assertEqual(q.urlencode(), '')
  56. def test_single_key_value(self):
  57. """Test QueryDict with one key/value pair"""
  58. q = QueryDict('foo=bar')
  59. self.assertEqual(q['foo'], 'bar')
  60. with self.assertRaises(KeyError):
  61. q.__getitem__('bar')
  62. with self.assertRaises(AttributeError):
  63. q.__setitem__('something', 'bar')
  64. self.assertEqual(q.get('foo', 'default'), 'bar')
  65. self.assertEqual(q.get('bar', 'default'), 'default')
  66. self.assertEqual(q.getlist('foo'), ['bar'])
  67. self.assertEqual(q.getlist('bar'), [])
  68. with self.assertRaises(AttributeError):
  69. q.setlist('foo', ['bar'])
  70. with self.assertRaises(AttributeError):
  71. q.appendlist('foo', ['bar'])
  72. self.assertIn('foo', q)
  73. self.assertNotIn('bar', q)
  74. self.assertEqual(list(q), ['foo'])
  75. self.assertEqual(list(q.items()), [('foo', 'bar')])
  76. self.assertEqual(list(q.lists()), [('foo', ['bar'])])
  77. self.assertEqual(list(q.keys()), ['foo'])
  78. self.assertEqual(list(q.values()), ['bar'])
  79. self.assertEqual(len(q), 1)
  80. with self.assertRaises(AttributeError):
  81. q.update({'foo': 'bar'})
  82. with self.assertRaises(AttributeError):
  83. q.pop('foo')
  84. with self.assertRaises(AttributeError):
  85. q.popitem()
  86. with self.assertRaises(AttributeError):
  87. q.clear()
  88. with self.assertRaises(AttributeError):
  89. q.setdefault('foo', 'bar')
  90. self.assertEqual(q.urlencode(), 'foo=bar')
  91. def test_urlencode(self):
  92. q = QueryDict(mutable=True)
  93. q['next'] = '/a&b/'
  94. self.assertEqual(q.urlencode(), 'next=%2Fa%26b%2F')
  95. self.assertEqual(q.urlencode(safe='/'), 'next=/a%26b/')
  96. q = QueryDict(mutable=True)
  97. q['next'] = '/t\xebst&key/'
  98. self.assertEqual(q.urlencode(), 'next=%2Ft%C3%ABst%26key%2F')
  99. self.assertEqual(q.urlencode(safe='/'), 'next=/t%C3%ABst%26key/')
  100. def test_mutable_copy(self):
  101. """A copy of a QueryDict is mutable."""
  102. q = QueryDict().copy()
  103. with self.assertRaises(KeyError):
  104. q.__getitem__("foo")
  105. q['name'] = 'john'
  106. self.assertEqual(q['name'], 'john')
  107. def test_mutable_delete(self):
  108. q = QueryDict(mutable=True)
  109. q['name'] = 'john'
  110. del q['name']
  111. self.assertNotIn('name', q)
  112. def test_basic_mutable_operations(self):
  113. q = QueryDict(mutable=True)
  114. q['name'] = 'john'
  115. self.assertEqual(q.get('foo', 'default'), 'default')
  116. self.assertEqual(q.get('name', 'default'), 'john')
  117. self.assertEqual(q.getlist('name'), ['john'])
  118. self.assertEqual(q.getlist('foo'), [])
  119. q.setlist('foo', ['bar', 'baz'])
  120. self.assertEqual(q.get('foo', 'default'), 'baz')
  121. self.assertEqual(q.getlist('foo'), ['bar', 'baz'])
  122. q.appendlist('foo', 'another')
  123. self.assertEqual(q.getlist('foo'), ['bar', 'baz', 'another'])
  124. self.assertEqual(q['foo'], 'another')
  125. self.assertIn('foo', q)
  126. self.assertCountEqual(q, ['foo', 'name'])
  127. self.assertCountEqual(q.items(), [('foo', 'another'), ('name', 'john')])
  128. self.assertCountEqual(q.lists(), [('foo', ['bar', 'baz', 'another']), ('name', ['john'])])
  129. self.assertCountEqual(q.keys(), ['foo', 'name'])
  130. self.assertCountEqual(q.values(), ['another', 'john'])
  131. q.update({'foo': 'hello'})
  132. self.assertEqual(q['foo'], 'hello')
  133. self.assertEqual(q.get('foo', 'not available'), 'hello')
  134. self.assertEqual(q.getlist('foo'), ['bar', 'baz', 'another', 'hello'])
  135. self.assertEqual(q.pop('foo'), ['bar', 'baz', 'another', 'hello'])
  136. self.assertEqual(q.pop('foo', 'not there'), 'not there')
  137. self.assertEqual(q.get('foo', 'not there'), 'not there')
  138. self.assertEqual(q.setdefault('foo', 'bar'), 'bar')
  139. self.assertEqual(q['foo'], 'bar')
  140. self.assertEqual(q.getlist('foo'), ['bar'])
  141. self.assertIn(q.urlencode(), ['foo=bar&name=john', 'name=john&foo=bar'])
  142. q.clear()
  143. self.assertEqual(len(q), 0)
  144. def test_multiple_keys(self):
  145. """Test QueryDict with two key/value pairs with same keys."""
  146. q = QueryDict('vote=yes&vote=no')
  147. self.assertEqual(q['vote'], 'no')
  148. with self.assertRaises(AttributeError):
  149. q.__setitem__('something', 'bar')
  150. self.assertEqual(q.get('vote', 'default'), 'no')
  151. self.assertEqual(q.get('foo', 'default'), 'default')
  152. self.assertEqual(q.getlist('vote'), ['yes', 'no'])
  153. self.assertEqual(q.getlist('foo'), [])
  154. with self.assertRaises(AttributeError):
  155. q.setlist('foo', ['bar', 'baz'])
  156. with self.assertRaises(AttributeError):
  157. q.setlist('foo', ['bar', 'baz'])
  158. with self.assertRaises(AttributeError):
  159. q.appendlist('foo', ['bar'])
  160. self.assertIn('vote', q)
  161. self.assertNotIn('foo', q)
  162. self.assertEqual(list(q), ['vote'])
  163. self.assertEqual(list(q.items()), [('vote', 'no')])
  164. self.assertEqual(list(q.lists()), [('vote', ['yes', 'no'])])
  165. self.assertEqual(list(q.keys()), ['vote'])
  166. self.assertEqual(list(q.values()), ['no'])
  167. self.assertEqual(len(q), 1)
  168. with self.assertRaises(AttributeError):
  169. q.update({'foo': 'bar'})
  170. with self.assertRaises(AttributeError):
  171. q.pop('foo')
  172. with self.assertRaises(AttributeError):
  173. q.popitem()
  174. with self.assertRaises(AttributeError):
  175. q.clear()
  176. with self.assertRaises(AttributeError):
  177. q.setdefault('foo', 'bar')
  178. with self.assertRaises(AttributeError):
  179. q.__delitem__('vote')
  180. def test_pickle(self):
  181. q = QueryDict()
  182. q1 = pickle.loads(pickle.dumps(q, 2))
  183. self.assertEqual(q, q1)
  184. q = QueryDict('a=b&c=d')
  185. q1 = pickle.loads(pickle.dumps(q, 2))
  186. self.assertEqual(q, q1)
  187. q = QueryDict('a=b&c=d&a=1')
  188. q1 = pickle.loads(pickle.dumps(q, 2))
  189. self.assertEqual(q, q1)
  190. def test_update_from_querydict(self):
  191. """Regression test for #8278: QueryDict.update(QueryDict)"""
  192. x = QueryDict("a=1&a=2", mutable=True)
  193. y = QueryDict("a=3&a=4")
  194. x.update(y)
  195. self.assertEqual(x.getlist('a'), ['1', '2', '3', '4'])
  196. def test_non_default_encoding(self):
  197. """#13572 - QueryDict with a non-default encoding"""
  198. q = QueryDict('cur=%A4', encoding='iso-8859-15')
  199. self.assertEqual(q.encoding, 'iso-8859-15')
  200. self.assertEqual(list(q.items()), [('cur', '€')])
  201. self.assertEqual(q.urlencode(), 'cur=%A4')
  202. q = q.copy()
  203. self.assertEqual(q.encoding, 'iso-8859-15')
  204. self.assertEqual(list(q.items()), [('cur', '€')])
  205. self.assertEqual(q.urlencode(), 'cur=%A4')
  206. self.assertEqual(copy.copy(q).encoding, 'iso-8859-15')
  207. self.assertEqual(copy.deepcopy(q).encoding, 'iso-8859-15')
  208. def test_querydict_fromkeys(self):
  209. self.assertEqual(QueryDict.fromkeys(['key1', 'key2', 'key3']), QueryDict('key1&key2&key3'))
  210. def test_fromkeys_with_nonempty_value(self):
  211. self.assertEqual(
  212. QueryDict.fromkeys(['key1', 'key2', 'key3'], value='val'),
  213. QueryDict('key1=val&key2=val&key3=val')
  214. )
  215. def test_fromkeys_is_immutable_by_default(self):
  216. # Match behavior of __init__() which is also immutable by default.
  217. q = QueryDict.fromkeys(['key1', 'key2', 'key3'])
  218. with self.assertRaisesMessage(AttributeError, 'This QueryDict instance is immutable'):
  219. q['key4'] = 'nope'
  220. def test_fromkeys_mutable_override(self):
  221. q = QueryDict.fromkeys(['key1', 'key2', 'key3'], mutable=True)
  222. q['key4'] = 'yep'
  223. self.assertEqual(q, QueryDict('key1&key2&key3&key4=yep'))
  224. def test_duplicates_in_fromkeys_iterable(self):
  225. self.assertEqual(QueryDict.fromkeys('xyzzy'), QueryDict('x&y&z&z&y'))
  226. def test_fromkeys_with_nondefault_encoding(self):
  227. key_utf16 = b'\xff\xfe\x8e\x02\xdd\x01\x9e\x02'
  228. value_utf16 = b'\xff\xfe\xdd\x01n\x00l\x00P\x02\x8c\x02'
  229. q = QueryDict.fromkeys([key_utf16], value=value_utf16, encoding='utf-16')
  230. expected = QueryDict('', mutable=True)
  231. expected['ʎǝʞ'] = 'ǝnlɐʌ'
  232. self.assertEqual(q, expected)
  233. def test_fromkeys_empty_iterable(self):
  234. self.assertEqual(QueryDict.fromkeys([]), QueryDict(''))
  235. def test_fromkeys_noniterable(self):
  236. with self.assertRaises(TypeError):
  237. QueryDict.fromkeys(0)
  238. class HttpResponseTests(unittest.TestCase):
  239. def test_headers_type(self):
  240. r = HttpResponse()
  241. # ASCII strings or bytes values are converted to strings.
  242. r['key'] = 'test'
  243. self.assertEqual(r['key'], 'test')
  244. r['key'] = 'test'.encode('ascii')
  245. self.assertEqual(r['key'], 'test')
  246. self.assertIn(b'test', r.serialize_headers())
  247. # Non-ASCII values are serialized to Latin-1.
  248. r['key'] = 'café'
  249. self.assertIn('café'.encode('latin-1'), r.serialize_headers())
  250. # Other unicode values are MIME-encoded (there's no way to pass them as bytes).
  251. r['key'] = '†'
  252. self.assertEqual(r['key'], '=?utf-8?b?4oCg?=')
  253. self.assertIn(b'=?utf-8?b?4oCg?=', r.serialize_headers())
  254. # The response also converts string or bytes keys to strings, but requires
  255. # them to contain ASCII
  256. r = HttpResponse()
  257. del r['Content-Type']
  258. r['foo'] = 'bar'
  259. headers = list(r.items())
  260. self.assertEqual(len(headers), 1)
  261. self.assertEqual(headers[0], ('foo', 'bar'))
  262. r = HttpResponse()
  263. del r['Content-Type']
  264. r[b'foo'] = 'bar'
  265. headers = list(r.items())
  266. self.assertEqual(len(headers), 1)
  267. self.assertEqual(headers[0], ('foo', 'bar'))
  268. self.assertIsInstance(headers[0][0], str)
  269. r = HttpResponse()
  270. with self.assertRaises(UnicodeError):
  271. r.__setitem__('føø', 'bar')
  272. with self.assertRaises(UnicodeError):
  273. r.__setitem__('føø'.encode(), 'bar')
  274. def test_long_line(self):
  275. # Bug #20889: long lines trigger newlines to be added to headers
  276. # (which is not allowed due to bug #10188)
  277. h = HttpResponse()
  278. f = 'zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz a\xcc\x88'.encode('latin-1')
  279. f = f.decode('utf-8')
  280. h['Content-Disposition'] = 'attachment; filename="%s"' % f
  281. # This one is triggering http://bugs.python.org/issue20747, that is Python
  282. # will itself insert a newline in the header
  283. h['Content-Disposition'] = 'attachment; filename="EdelRot_Blu\u0308te (3)-0.JPG"'
  284. def test_newlines_in_headers(self):
  285. # Bug #10188: Do not allow newlines in headers (CR or LF)
  286. r = HttpResponse()
  287. with self.assertRaises(BadHeaderError):
  288. r.__setitem__('test\rstr', 'test')
  289. with self.assertRaises(BadHeaderError):
  290. r.__setitem__('test\nstr', 'test')
  291. def test_dict_behavior(self):
  292. """
  293. Test for bug #14020: Make HttpResponse.get work like dict.get
  294. """
  295. r = HttpResponse()
  296. self.assertIsNone(r.get('test'))
  297. def test_non_string_content(self):
  298. # Bug 16494: HttpResponse should behave consistently with non-strings
  299. r = HttpResponse(12345)
  300. self.assertEqual(r.content, b'12345')
  301. # test content via property
  302. r = HttpResponse()
  303. r.content = 12345
  304. self.assertEqual(r.content, b'12345')
  305. def test_iter_content(self):
  306. r = HttpResponse(['abc', 'def', 'ghi'])
  307. self.assertEqual(r.content, b'abcdefghi')
  308. # test iter content via property
  309. r = HttpResponse()
  310. r.content = ['idan', 'alex', 'jacob']
  311. self.assertEqual(r.content, b'idanalexjacob')
  312. r = HttpResponse()
  313. r.content = [1, 2, 3]
  314. self.assertEqual(r.content, b'123')
  315. # test odd inputs
  316. r = HttpResponse()
  317. r.content = ['1', '2', 3, '\u079e']
  318. # '\xde\x9e' == unichr(1950).encode()
  319. self.assertEqual(r.content, b'123\xde\x9e')
  320. # .content can safely be accessed multiple times.
  321. r = HttpResponse(iter(['hello', 'world']))
  322. self.assertEqual(r.content, r.content)
  323. self.assertEqual(r.content, b'helloworld')
  324. # __iter__ can safely be called multiple times (#20187).
  325. self.assertEqual(b''.join(r), b'helloworld')
  326. self.assertEqual(b''.join(r), b'helloworld')
  327. # Accessing .content still works.
  328. self.assertEqual(r.content, b'helloworld')
  329. # Accessing .content also works if the response was iterated first.
  330. r = HttpResponse(iter(['hello', 'world']))
  331. self.assertEqual(b''.join(r), b'helloworld')
  332. self.assertEqual(r.content, b'helloworld')
  333. # Additional content can be written to the response.
  334. r = HttpResponse(iter(['hello', 'world']))
  335. self.assertEqual(r.content, b'helloworld')
  336. r.write('!')
  337. self.assertEqual(r.content, b'helloworld!')
  338. def test_iterator_isnt_rewound(self):
  339. # Regression test for #13222
  340. r = HttpResponse('abc')
  341. i = iter(r)
  342. self.assertEqual(list(i), [b'abc'])
  343. self.assertEqual(list(i), [])
  344. def test_lazy_content(self):
  345. r = HttpResponse(lazystr('helloworld'))
  346. self.assertEqual(r.content, b'helloworld')
  347. def test_file_interface(self):
  348. r = HttpResponse()
  349. r.write(b"hello")
  350. self.assertEqual(r.tell(), 5)
  351. r.write("привет")
  352. self.assertEqual(r.tell(), 17)
  353. r = HttpResponse(['abc'])
  354. r.write('def')
  355. self.assertEqual(r.tell(), 6)
  356. self.assertEqual(r.content, b'abcdef')
  357. # with Content-Encoding header
  358. r = HttpResponse()
  359. r['Content-Encoding'] = 'winning'
  360. r.write(b'abc')
  361. r.write(b'def')
  362. self.assertEqual(r.content, b'abcdef')
  363. def test_stream_interface(self):
  364. r = HttpResponse('asdf')
  365. self.assertEqual(r.getvalue(), b'asdf')
  366. r = HttpResponse()
  367. self.assertIs(r.writable(), True)
  368. r.writelines(['foo\n', 'bar\n', 'baz\n'])
  369. self.assertEqual(r.content, b'foo\nbar\nbaz\n')
  370. def test_unsafe_redirect(self):
  371. bad_urls = [
  372. 'data:text/html,<script>window.alert("xss")</script>',
  373. 'mailto:test@example.com',
  374. 'file:///etc/passwd',
  375. ]
  376. for url in bad_urls:
  377. with self.assertRaises(DisallowedRedirect):
  378. HttpResponseRedirect(url)
  379. with self.assertRaises(DisallowedRedirect):
  380. HttpResponsePermanentRedirect(url)
  381. class HttpResponseSubclassesTests(SimpleTestCase):
  382. def test_redirect(self):
  383. response = HttpResponseRedirect('/redirected/')
  384. self.assertEqual(response.status_code, 302)
  385. # Standard HttpResponse init args can be used
  386. response = HttpResponseRedirect(
  387. '/redirected/',
  388. content='The resource has temporarily moved',
  389. content_type='text/html',
  390. )
  391. self.assertContains(response, 'The resource has temporarily moved', status_code=302)
  392. self.assertEqual(response.url, response['Location'])
  393. def test_redirect_lazy(self):
  394. """Make sure HttpResponseRedirect works with lazy strings."""
  395. r = HttpResponseRedirect(lazystr('/redirected/'))
  396. self.assertEqual(r.url, '/redirected/')
  397. def test_redirect_repr(self):
  398. response = HttpResponseRedirect('/redirected/')
  399. expected = '<HttpResponseRedirect status_code=302, "text/html; charset=utf-8", url="/redirected/">'
  400. self.assertEqual(repr(response), expected)
  401. def test_invalid_redirect_repr(self):
  402. """
  403. If HttpResponseRedirect raises DisallowedRedirect, its __repr__()
  404. should work (in the debug view, for example).
  405. """
  406. response = HttpResponseRedirect.__new__(HttpResponseRedirect)
  407. with self.assertRaisesMessage(DisallowedRedirect, "Unsafe redirect to URL with protocol 'ssh'"):
  408. HttpResponseRedirect.__init__(response, 'ssh://foo')
  409. expected = '<HttpResponseRedirect status_code=302, "text/html; charset=utf-8", url="ssh://foo">'
  410. self.assertEqual(repr(response), expected)
  411. def test_not_modified(self):
  412. response = HttpResponseNotModified()
  413. self.assertEqual(response.status_code, 304)
  414. # 304 responses should not have content/content-type
  415. with self.assertRaises(AttributeError):
  416. response.content = "Hello dear"
  417. self.assertNotIn('content-type', response)
  418. def test_not_modified_repr(self):
  419. response = HttpResponseNotModified()
  420. self.assertEqual(repr(response), '<HttpResponseNotModified status_code=304>')
  421. def test_not_allowed(self):
  422. response = HttpResponseNotAllowed(['GET'])
  423. self.assertEqual(response.status_code, 405)
  424. # Standard HttpResponse init args can be used
  425. response = HttpResponseNotAllowed(['GET'], content='Only the GET method is allowed', content_type='text/html')
  426. self.assertContains(response, 'Only the GET method is allowed', status_code=405)
  427. def test_not_allowed_repr(self):
  428. response = HttpResponseNotAllowed(['GET', 'OPTIONS'], content_type='text/plain')
  429. expected = '<HttpResponseNotAllowed [GET, OPTIONS] status_code=405, "text/plain">'
  430. self.assertEqual(repr(response), expected)
  431. def test_not_allowed_repr_no_content_type(self):
  432. response = HttpResponseNotAllowed(('GET', 'POST'))
  433. del response['Content-Type']
  434. self.assertEqual(repr(response), '<HttpResponseNotAllowed [GET, POST] status_code=405>')
  435. class JsonResponseTests(SimpleTestCase):
  436. def test_json_response_non_ascii(self):
  437. data = {'key': 'łóżko'}
  438. response = JsonResponse(data)
  439. self.assertEqual(json.loads(response.content.decode()), data)
  440. def test_json_response_raises_type_error_with_default_setting(self):
  441. with self.assertRaisesMessage(
  442. TypeError,
  443. 'In order to allow non-dict objects to be serialized set the '
  444. 'safe parameter to False'
  445. ):
  446. JsonResponse([1, 2, 3])
  447. def test_json_response_text(self):
  448. response = JsonResponse('foobar', safe=False)
  449. self.assertEqual(json.loads(response.content.decode()), 'foobar')
  450. def test_json_response_list(self):
  451. response = JsonResponse(['foo', 'bar'], safe=False)
  452. self.assertEqual(json.loads(response.content.decode()), ['foo', 'bar'])
  453. def test_json_response_uuid(self):
  454. u = uuid.uuid4()
  455. response = JsonResponse(u, safe=False)
  456. self.assertEqual(json.loads(response.content.decode()), str(u))
  457. def test_json_response_custom_encoder(self):
  458. class CustomDjangoJSONEncoder(DjangoJSONEncoder):
  459. def encode(self, o):
  460. return json.dumps({'foo': 'bar'})
  461. response = JsonResponse({}, encoder=CustomDjangoJSONEncoder)
  462. self.assertEqual(json.loads(response.content.decode()), {'foo': 'bar'})
  463. def test_json_response_passing_arguments_to_json_dumps(self):
  464. response = JsonResponse({'foo': 'bar'}, json_dumps_params={'indent': 2})
  465. self.assertEqual(response.content.decode(), '{\n "foo": "bar"\n}')
  466. class StreamingHttpResponseTests(SimpleTestCase):
  467. def test_streaming_response(self):
  468. r = StreamingHttpResponse(iter(['hello', 'world']))
  469. # iterating over the response itself yields bytestring chunks.
  470. chunks = list(r)
  471. self.assertEqual(chunks, [b'hello', b'world'])
  472. for chunk in chunks:
  473. self.assertIsInstance(chunk, bytes)
  474. # and the response can only be iterated once.
  475. self.assertEqual(list(r), [])
  476. # even when a sequence that can be iterated many times, like a list,
  477. # is given as content.
  478. r = StreamingHttpResponse(['abc', 'def'])
  479. self.assertEqual(list(r), [b'abc', b'def'])
  480. self.assertEqual(list(r), [])
  481. # iterating over strings still yields bytestring chunks.
  482. r.streaming_content = iter(['hello', 'café'])
  483. chunks = list(r)
  484. # '\xc3\xa9' == unichr(233).encode()
  485. self.assertEqual(chunks, [b'hello', b'caf\xc3\xa9'])
  486. for chunk in chunks:
  487. self.assertIsInstance(chunk, bytes)
  488. # streaming responses don't have a `content` attribute.
  489. self.assertFalse(hasattr(r, 'content'))
  490. # and you can't accidentally assign to a `content` attribute.
  491. with self.assertRaises(AttributeError):
  492. r.content = 'xyz'
  493. # but they do have a `streaming_content` attribute.
  494. self.assertTrue(hasattr(r, 'streaming_content'))
  495. # that exists so we can check if a response is streaming, and wrap or
  496. # replace the content iterator.
  497. r.streaming_content = iter(['abc', 'def'])
  498. r.streaming_content = (chunk.upper() for chunk in r.streaming_content)
  499. self.assertEqual(list(r), [b'ABC', b'DEF'])
  500. # coercing a streaming response to bytes doesn't return a complete HTTP
  501. # message like a regular response does. it only gives us the headers.
  502. r = StreamingHttpResponse(iter(['hello', 'world']))
  503. self.assertEqual(bytes(r), b'Content-Type: text/html; charset=utf-8')
  504. # and this won't consume its content.
  505. self.assertEqual(list(r), [b'hello', b'world'])
  506. # additional content cannot be written to the response.
  507. r = StreamingHttpResponse(iter(['hello', 'world']))
  508. with self.assertRaises(Exception):
  509. r.write('!')
  510. # and we can't tell the current position.
  511. with self.assertRaises(Exception):
  512. r.tell()
  513. r = StreamingHttpResponse(iter(['hello', 'world']))
  514. self.assertEqual(r.getvalue(), b'helloworld')
  515. class FileCloseTests(SimpleTestCase):
  516. def setUp(self):
  517. # Disable the request_finished signal during this test
  518. # to avoid interfering with the database connection.
  519. request_finished.disconnect(close_old_connections)
  520. def tearDown(self):
  521. request_finished.connect(close_old_connections)
  522. def test_response(self):
  523. filename = os.path.join(os.path.dirname(__file__), 'abc.txt')
  524. # file isn't closed until we close the response.
  525. file1 = open(filename)
  526. r = HttpResponse(file1)
  527. self.assertTrue(file1.closed)
  528. r.close()
  529. # when multiple file are assigned as content, make sure they are all
  530. # closed with the response.
  531. file1 = open(filename)
  532. file2 = open(filename)
  533. r = HttpResponse(file1)
  534. r.content = file2
  535. self.assertTrue(file1.closed)
  536. self.assertTrue(file2.closed)
  537. def test_streaming_response(self):
  538. filename = os.path.join(os.path.dirname(__file__), 'abc.txt')
  539. # file isn't closed until we close the response.
  540. file1 = open(filename)
  541. r = StreamingHttpResponse(file1)
  542. self.assertFalse(file1.closed)
  543. r.close()
  544. self.assertTrue(file1.closed)
  545. # when multiple file are assigned as content, make sure they are all
  546. # closed with the response.
  547. file1 = open(filename)
  548. file2 = open(filename)
  549. r = StreamingHttpResponse(file1)
  550. r.streaming_content = file2
  551. self.assertFalse(file1.closed)
  552. self.assertFalse(file2.closed)
  553. r.close()
  554. self.assertTrue(file1.closed)
  555. self.assertTrue(file2.closed)
  556. class CookieTests(unittest.TestCase):
  557. def test_encode(self):
  558. """Semicolons and commas are encoded."""
  559. c = SimpleCookie()
  560. c['test'] = "An,awkward;value"
  561. self.assertNotIn(";", c.output().rstrip(';')) # IE compat
  562. self.assertNotIn(",", c.output().rstrip(';')) # Safari compat
  563. def test_decode(self):
  564. """Semicolons and commas are decoded."""
  565. c = SimpleCookie()
  566. c['test'] = "An,awkward;value"
  567. c2 = SimpleCookie()
  568. c2.load(c.output()[12:])
  569. self.assertEqual(c['test'].value, c2['test'].value)
  570. c3 = parse_cookie(c.output()[12:])
  571. self.assertEqual(c['test'].value, c3['test'])
  572. def test_nonstandard_keys(self):
  573. """
  574. A single non-standard cookie name doesn't affect all cookies (#13007).
  575. """
  576. self.assertIn('good_cookie', parse_cookie('good_cookie=yes;bad:cookie=yes'))
  577. def test_repeated_nonstandard_keys(self):
  578. """
  579. A repeated non-standard name doesn't affect all cookies (#15852).
  580. """
  581. self.assertIn('good_cookie', parse_cookie('a:=b; a:=c; good_cookie=yes'))
  582. def test_python_cookies(self):
  583. """
  584. Test cases copied from Python's Lib/test/test_http_cookies.py
  585. """
  586. self.assertEqual(parse_cookie('chips=ahoy; vienna=finger'), {'chips': 'ahoy', 'vienna': 'finger'})
  587. # Here parse_cookie() differs from Python's cookie parsing in that it
  588. # treats all semicolons as delimiters, even within quotes.
  589. self.assertEqual(
  590. parse_cookie('keebler="E=mc2; L=\\"Loves\\"; fudge=\\012;"'),
  591. {'keebler': '"E=mc2', 'L': '\\"Loves\\"', 'fudge': '\\012', '': '"'}
  592. )
  593. # Illegal cookies that have an '=' char in an unquoted value.
  594. self.assertEqual(parse_cookie('keebler=E=mc2'), {'keebler': 'E=mc2'})
  595. # Cookies with ':' character in their name.
  596. self.assertEqual(parse_cookie('key:term=value:term'), {'key:term': 'value:term'})
  597. # Cookies with '[' and ']'.
  598. self.assertEqual(parse_cookie('a=b; c=[; d=r; f=h'), {'a': 'b', 'c': '[', 'd': 'r', 'f': 'h'})
  599. def test_cookie_edgecases(self):
  600. # Cookies that RFC6265 allows.
  601. self.assertEqual(parse_cookie('a=b; Domain=example.com'), {'a': 'b', 'Domain': 'example.com'})
  602. # parse_cookie() has historically kept only the last cookie with the
  603. # same name.
  604. self.assertEqual(parse_cookie('a=b; h=i; a=c'), {'a': 'c', 'h': 'i'})
  605. def test_invalid_cookies(self):
  606. """
  607. Cookie strings that go against RFC6265 but browsers will send if set
  608. via document.cookie.
  609. """
  610. # Chunks without an equals sign appear as unnamed values per
  611. # https://bugzilla.mozilla.org/show_bug.cgi?id=169091
  612. self.assertIn('django_language', parse_cookie('abc=def; unnamed; django_language=en'))
  613. # Even a double quote may be an unamed value.
  614. self.assertEqual(parse_cookie('a=b; "; c=d'), {'a': 'b', '': '"', 'c': 'd'})
  615. # Spaces in names and values, and an equals sign in values.
  616. self.assertEqual(parse_cookie('a b c=d e = f; gh=i'), {'a b c': 'd e = f', 'gh': 'i'})
  617. # More characters the spec forbids.
  618. self.assertEqual(parse_cookie('a b,c<>@:/[]?{}=d " =e,f g'), {'a b,c<>@:/[]?{}': 'd " =e,f g'})
  619. # Unicode characters. The spec only allows ASCII.
  620. self.assertEqual(parse_cookie('saint=André Bessette'), {'saint': 'André Bessette'})
  621. # Browsers don't send extra whitespace or semicolons in Cookie headers,
  622. # but parse_cookie() should parse whitespace the same way
  623. # document.cookie parses whitespace.
  624. self.assertEqual(parse_cookie(' = b ; ; = ; c = ; '), {'': 'b', 'c': ''})
  625. def test_samesite(self):
  626. c = SimpleCookie('name=value; samesite=lax; httponly')
  627. self.assertEqual(c['name']['samesite'], 'lax')
  628. self.assertIn('SameSite=lax', c.output())
  629. def test_httponly_after_load(self):
  630. c = SimpleCookie()
  631. c.load("name=val")
  632. c['name']['httponly'] = True
  633. self.assertTrue(c['name']['httponly'])
  634. def test_load_dict(self):
  635. c = SimpleCookie()
  636. c.load({'name': 'val'})
  637. self.assertEqual(c['name'].value, 'val')
  638. def test_pickle(self):
  639. rawdata = 'Customer="WILE_E_COYOTE"; Path=/acme; Version=1'
  640. expected_output = 'Set-Cookie: %s' % rawdata
  641. C = SimpleCookie()
  642. C.load(rawdata)
  643. self.assertEqual(C.output(), expected_output)
  644. for proto in range(pickle.HIGHEST_PROTOCOL + 1):
  645. C1 = pickle.loads(pickle.dumps(C, protocol=proto))
  646. self.assertEqual(C1.output(), expected_output)