Debian Codegraph @

Lib/test/test_http_cookies.py

raw
1 # Simple test suite for http/cookies.py
2 import copy
3 import unittest
4 import doctest
5 from http import cookies
6 import pickle
7 from test import support
8 import urllib.parse
9
10
11 class CookieTests(unittest.TestCase):
12
13 def test_basic(self):
14 cases = [
15 {'data': 'chips=ahoy; vienna=finger',
16 'dict': {'chips':'ahoy', 'vienna':'finger'},
17 'repr': "<SimpleCookie: chips='ahoy' vienna='finger'>",
18 'output': 'Set-Cookie: chips=ahoy\nSet-Cookie: vienna=finger'},
19
20 {'data': 'keebler="E=mc2; L=\\"Loves\\"; fudge=;"',
21 'dict': {'keebler' : 'E=mc2; L="Loves"; fudge=;'},
22 'repr': '''<SimpleCookie: keebler='E=mc2; L="Loves"; fudge=;'>''',
23 'output': 'Set-Cookie: keebler="E=mc2; L=\\"Loves\\"; fudge=;"'},
24
25 # Check illegal cookies that have an '=' char in an unquoted value
26 {'data': 'keebler=E=mc2',
27 'dict': {'keebler' : 'E=mc2'},
28 'repr': "<SimpleCookie: keebler='E=mc2'>",
29 'output': 'Set-Cookie: keebler=E=mc2'},
30
31 # Cookies with ':' character in their name. Though not mentioned in
32 # RFC, servers / browsers allow it.
33
34 {'data': 'key:term=value:term',
35 'dict': {'key:term' : 'value:term'},
36 'repr': "<SimpleCookie: key:term='value:term'>",
37 'output': 'Set-Cookie: key:term=value:term'},
38
39 # issue22931 - Adding '[' and ']' as valid characters in cookie
40 # values as defined in RFC 6265
41 {
42 'data': 'a=b; c=[; d=r; f=h',
43 'dict': {'a':'b', 'c':'[', 'd':'r', 'f':'h'},
44 'repr': "<SimpleCookie: a='b' c='[' d='r' f='h'>",
45 'output': '\n'.join((
46 'Set-Cookie: a=b',
47 'Set-Cookie: c=[',
48 'Set-Cookie: d=r',
49 'Set-Cookie: f=h'
50 ))
51 }
52 ]
53
54 for case in cases:
55 C = cookies.SimpleCookie()
56 C.load(case['data'])
57 self.assertEqual(repr(C), case['repr'])
58 self.assertEqual(C.output(sep='\n'), case['output'])
59 for k, v in sorted(case['dict'].items()):
60 self.assertEqual(C[k].value, v)
61
62 def test_obsolete_rfc850_date_format(self):
63 # Test cases with different days and dates in obsolete RFC 850 format
64 test_cases = [
65 # from RFC 850, change EST to GMT
66 # https://datatracker.ietf.org/doc/html/rfc850#section-2
67 {
68 'data': 'key=value; expires=Saturday, 01-Jan-83 00:00:00 GMT',
69 'output': 'Saturday, 01-Jan-83 00:00:00 GMT'
70 },
71 {
72 'data': 'key=value; expires=Friday, 19-Nov-82 16:59:30 GMT',
73 'output': 'Friday, 19-Nov-82 16:59:30 GMT'
74 },
75 # from RFC 9110
76 # https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.7-6
77 {
78 'data': 'key=value; expires=Sunday, 06-Nov-94 08:49:37 GMT',
79 'output': 'Sunday, 06-Nov-94 08:49:37 GMT'
80 },
81 # other test cases
82 {
83 'data': 'key=value; expires=Wednesday, 09-Nov-94 08:49:37 GMT',
84 'output': 'Wednesday, 09-Nov-94 08:49:37 GMT'
85 },
86 {
87 'data': 'key=value; expires=Friday, 11-Nov-94 08:49:37 GMT',
88 'output': 'Friday, 11-Nov-94 08:49:37 GMT'
89 },
90 {
91 'data': 'key=value; expires=Monday, 14-Nov-94 08:49:37 GMT',
92 'output': 'Monday, 14-Nov-94 08:49:37 GMT'
93 },
94 ]
95
96 for case in test_cases:
97 with self.subTest(data=case['data']):
98 C = cookies.SimpleCookie()
99 C.load(case['data'])
100
101 # Extract the cookie name from the data string
102 cookie_name = case['data'].split('=')[0]
103
104 # Check if the cookie is loaded correctly
105 self.assertIn(cookie_name, C)
106 self.assertEqual(C[cookie_name].get('expires'), case['output'])
107
108 def test_unquote(self):
109 cases = [
110 (r'a="b=\""', 'b="'),
111 (r'a="b=\\"', 'b=\\'),
112 (r'a="b=\="', 'b=='),
113 (r'a="b=\n"', 'b=n'),
114 (r'a="b=\042"', 'b="'),
115 (r'a="b=\134"', 'b=\\'),
116 (r'a="b=\377"', 'b=\xff'),
117 (r'a="b=\400"', 'b=400'),
118 (r'a="b=\42"', 'b=42'),
119 (r'a="b=\\042"', 'b=\\042'),
120 (r'a="b=\\134"', 'b=\\134'),
121 (r'a="b=\\\""', 'b=\\"'),
122 (r'a="b=\\\042"', 'b=\\"'),
123 (r'a="b=\134\""', 'b=\\"'),
124 (r'a="b=\134\042"', 'b=\\"'),
125 ]
126 for encoded, decoded in cases:
127 with self.subTest(encoded):
128 C = cookies.SimpleCookie()
129 C.load(encoded)
130 self.assertEqual(C['a'].value, decoded)
131
132 @support.requires_resource('cpu')
133 def test_unquote_large(self):
134 n = 10**6
135 for encoded in r'\\', r'\134':
136 with self.subTest(encoded):
137 data = 'a="b=' + encoded*n + ';"'
138 C = cookies.SimpleCookie()
139 C.load(data)
140 value = C['a'].value
141 self.assertEqual(value[:3], 'b=\\')
142 self.assertEqual(value[-2:], '\\;')
143 self.assertEqual(len(value), n + 3)
144
145 def test_load(self):
146 C = cookies.SimpleCookie()
147 C.load('Customer="WILE_E_COYOTE"; Version=1; Path=/acme')
148
149 self.assertEqual(C['Customer'].value, 'WILE_E_COYOTE')
150 self.assertEqual(C['Customer']['version'], '1')
151 self.assertEqual(C['Customer']['path'], '/acme')
152
153 self.assertEqual(C.output(['path']),
154 'Set-Cookie: Customer="WILE_E_COYOTE"; Path=/acme')
155 cookie_encoded = urllib.parse.quote('Customer="WILE_E_COYOTE"; Path=/acme; Version=1', safe='', encoding='utf-8')
156 self.assertEqual(C.js_output(), fr"""
157 <script type="text/javascript">
158 <!-- begin hiding
159 document.cookie = decodeURIComponent("{cookie_encoded}");
160 // end hiding -->
161 </script>
162 """)
163 cookie_encoded = urllib.parse.quote('Customer="WILE_E_COYOTE"; Path=/acme', safe='', encoding='utf-8')
164 self.assertEqual(C.js_output(['path']), fr"""
165 <script type="text/javascript">
166 <!-- begin hiding
167 document.cookie = decodeURIComponent("{cookie_encoded}");
168 // end hiding -->
169 </script>
170 """)
171
172 def test_extended_encode(self):
173 # Issue 9824: some browsers don't follow the standard; we now
174 # encode , and ; to keep them from tripping up.
175 C = cookies.SimpleCookie()
176 C['val'] = "some,funky;stuff"
177 self.assertEqual(C.output(['val']),
178 'Set-Cookie: val="some\\054funky\\073stuff"')
179
180 def test_special_attrs(self):
181 # 'expires'
182 C = cookies.SimpleCookie('Customer="WILE_E_COYOTE"')
183 C['Customer']['expires'] = 0
184 # can't test exact output, it always depends on current date/time
185 self.assertEndsWith(C.output(), 'GMT')
186
187 # loading 'expires'
188 C = cookies.SimpleCookie()
189 C.load('Customer="W"; expires=Wed, 01 Jan 2010 00:00:00 GMT')
190 self.assertEqual(C['Customer']['expires'],
191 'Wed, 01 Jan 2010 00:00:00 GMT')
192 C = cookies.SimpleCookie()
193 C.load('Customer="W"; expires=Wed, 01 Jan 98 00:00:00 GMT')
194 self.assertEqual(C['Customer']['expires'],
195 'Wed, 01 Jan 98 00:00:00 GMT')
196
197 # 'max-age'
198 C = cookies.SimpleCookie('Customer="WILE_E_COYOTE"')
199 C['Customer']['max-age'] = 10
200 self.assertEqual(C.output(),
201 'Set-Cookie: Customer="WILE_E_COYOTE"; Max-Age=10')
202
203 def test_set_secure_httponly_attrs(self):
204 C = cookies.SimpleCookie('Customer="WILE_E_COYOTE"')
205 C['Customer']['secure'] = True
206 C['Customer']['httponly'] = True
207 self.assertEqual(C.output(),
208 'Set-Cookie: Customer="WILE_E_COYOTE"; HttpOnly; Secure')
209
210 def test_set_secure_httponly_partitioned_attrs(self):
211 C = cookies.SimpleCookie('Customer="WILE_E_COYOTE"')
212 C['Customer']['secure'] = True
213 C['Customer']['httponly'] = True
214 C['Customer']['partitioned'] = True
215 self.assertEqual(C.output(),
216 'Set-Cookie: Customer="WILE_E_COYOTE"; HttpOnly; Partitioned; Secure')
217
218 def test_samesite_attrs(self):
219 samesite_values = ['Strict', 'Lax', 'strict', 'lax']
220 for val in samesite_values:
221 with self.subTest(val=val):
222 C = cookies.SimpleCookie('Customer="WILE_E_COYOTE"')
223 C['Customer']['samesite'] = val
224 self.assertEqual(C.output(),
225 'Set-Cookie: Customer="WILE_E_COYOTE"; SameSite=%s' % val)
226
227 C = cookies.SimpleCookie()
228 C.load('Customer="WILL_E_COYOTE"; SameSite=%s' % val)
229 self.assertEqual(C['Customer']['samesite'], val)
230
231 def test_secure_httponly_false_if_not_present(self):
232 C = cookies.SimpleCookie()
233 C.load('eggs=scrambled; Path=/bacon')
234 self.assertFalse(C['eggs']['httponly'])
235 self.assertFalse(C['eggs']['secure'])
236
237 def test_secure_httponly_true_if_present(self):
238 # Issue 16611
239 C = cookies.SimpleCookie()
240 C.load('eggs=scrambled; httponly; secure; Path=/bacon')
241 self.assertTrue(C['eggs']['httponly'])
242 self.assertTrue(C['eggs']['secure'])
243
244 def test_secure_httponly_true_if_have_value(self):
245 # This isn't really valid, but demonstrates what the current code
246 # is expected to do in this case.
247 C = cookies.SimpleCookie()
248 C.load('eggs=scrambled; httponly=foo; secure=bar; Path=/bacon')
249 self.assertTrue(C['eggs']['httponly'])
250 self.assertTrue(C['eggs']['secure'])
251 # Here is what it actually does; don't depend on this behavior. These
252 # checks are testing backward compatibility for issue 16611.
253 self.assertEqual(C['eggs']['httponly'], 'foo')
254 self.assertEqual(C['eggs']['secure'], 'bar')
255
256 def test_extra_spaces(self):
257 C = cookies.SimpleCookie()
258 C.load('eggs = scrambled ; secure ; path = bar ; foo=foo ')
259 self.assertEqual(C.output(),
260 'Set-Cookie: eggs=scrambled; Path=bar; Secure\r\nSet-Cookie: foo=foo')
261
262 def test_quoted_meta(self):
263 # Try cookie with quoted meta-data
264 C = cookies.SimpleCookie()
265 C.load('Customer="WILE_E_COYOTE"; Version="1"; Path="/acme"')
266 self.assertEqual(C['Customer'].value, 'WILE_E_COYOTE')
267 self.assertEqual(C['Customer']['version'], '1')
268 self.assertEqual(C['Customer']['path'], '/acme')
269
270 self.assertEqual(C.output(['path']),
271 'Set-Cookie: Customer="WILE_E_COYOTE"; Path=/acme')
272 expected_encoded_cookie = urllib.parse.quote('Customer=\"WILE_E_COYOTE\"; Path=/acme; Version=1', safe='', encoding='utf-8')
273 self.assertEqual(C.js_output(), fr"""
274 <script type="text/javascript">
275 <!-- begin hiding
276 document.cookie = decodeURIComponent("{expected_encoded_cookie}");
277 // end hiding -->
278 </script>
279 """)
280 expected_encoded_cookie = urllib.parse.quote('Customer=\"WILE_E_COYOTE\"; Path=/acme', safe='', encoding='utf-8')
281 self.assertEqual(C.js_output(['path']), fr"""
282 <script type="text/javascript">
283 <!-- begin hiding
284 document.cookie = decodeURIComponent("{expected_encoded_cookie}");
285 // end hiding -->
286 </script>
287 """)
288
289 def test_invalid_cookies(self):
290 # Accepting these could be a security issue
291 C = cookies.SimpleCookie()
292 for s in (']foo=x', '[foo=x', 'blah]foo=x', 'blah[foo=x',
293 'Set-Cookie: foo=bar', 'Set-Cookie: foo',
294 'foo=bar; baz', 'baz; foo=bar',
295 'secure;foo=bar', 'Version=1;foo=bar'):
296 C.load(s)
297 self.assertEqual(dict(C), {})
298 self.assertEqual(C.output(), '')
299
300 def test_pickle(self):
301 rawdata = 'Customer="WILE_E_COYOTE"; Path=/acme; Version=1'
302 expected_output = 'Set-Cookie: %s' % rawdata
303
304 C = cookies.SimpleCookie()
305 C.load(rawdata)
306 self.assertEqual(C.output(), expected_output)
307
308 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
309 with self.subTest(proto=proto):
310 C1 = pickle.loads(pickle.dumps(C, protocol=proto))
311 self.assertEqual(C1.output(), expected_output)
312
313 def test_illegal_chars(self):
314 rawdata = "a=b; c,d=e"
315 C = cookies.SimpleCookie()
316 with self.assertRaises(cookies.CookieError):
317 C.load(rawdata)
318
319 def test_comment_quoting(self):
320 c = cookies.SimpleCookie()
321 c['foo'] = '\N{COPYRIGHT SIGN}'
322 self.assertEqual(str(c['foo']), 'Set-Cookie: foo="\\251"')
323 c['foo']['comment'] = 'comment \N{COPYRIGHT SIGN}'
324 self.assertEqual(
325 str(c['foo']),
326 'Set-Cookie: foo="\\251"; Comment="comment \\251"'
327 )
328
329
330 class MorselTests(unittest.TestCase):
331 """Tests for the Morsel object."""
332
333 def test_defaults(self):
334 morsel = cookies.Morsel()
335 self.assertIsNone(morsel.key)
336 self.assertIsNone(morsel.value)
337 self.assertIsNone(morsel.coded_value)
338 self.assertEqual(morsel.keys(), cookies.Morsel._reserved.keys())
339 for key, val in morsel.items():
340 self.assertEqual(val, '', key)
341
342 def test_reserved_keys(self):
343 M = cookies.Morsel()
344 # tests valid and invalid reserved keys for Morsels
345 for i in M._reserved:
346 # Test that all valid keys are reported as reserved and set them
347 self.assertTrue(M.isReservedKey(i))
348 M[i] = '%s_value' % i
349 for i in M._reserved:
350 # Test that valid key values come out fine
351 self.assertEqual(M[i], '%s_value' % i)
352 for i in "the holy hand grenade".split():
353 # Test that invalid keys raise CookieError
354 self.assertRaises(cookies.CookieError,
355 M.__setitem__, i, '%s_value' % i)
356
357 def test_setter(self):
358 M = cookies.Morsel()
359 # tests the .set method to set keys and their values
360 for i in M._reserved:
361 # Makes sure that all reserved keys can't be set this way
362 self.assertRaises(cookies.CookieError,
363 M.set, i, '%s_value' % i, '%s_value' % i)
364 for i in "thou cast _the- !holy! ^hand| +*grenade~".split():
365 # Try typical use case. Setting decent values.
366 # Check output and js_output.
367 M['path'] = '/foo' # Try a reserved key as well
368 M.set(i, "%s_val" % i, "%s_coded_val" % i)
369 self.assertEqual(M.key, i)
370 self.assertEqual(M.value, "%s_val" % i)
371 self.assertEqual(M.coded_value, "%s_coded_val" % i)
372 self.assertEqual(
373 M.output(),
374 "Set-Cookie: %s=%s; Path=/foo" % (i, "%s_coded_val" % i))
375 expected_encoded_cookie = urllib.parse.quote(
376 "%s=%s; Path=/foo" % (i, "%s_coded_val" % i),
377 safe='', encoding='utf-8',
378 )
379 expected_js_output = """
380 <script type="text/javascript">
381 <!-- begin hiding
382 document.cookie = decodeURIComponent("%s");
383 // end hiding -->
384 </script>
385 """ % (expected_encoded_cookie,)
386 self.assertEqual(M.js_output(), expected_js_output)
387 for i in ["foo bar", "foo@bar"]:
388 # Try some illegal characters
389 self.assertRaises(cookies.CookieError,
390 M.set, i, '%s_value' % i, '%s_value' % i)
391
392 def test_set_properties(self):
393 morsel = cookies.Morsel()
394 with self.assertRaises(AttributeError):
395 morsel.key = ''
396 with self.assertRaises(AttributeError):
397 morsel.value = ''
398 with self.assertRaises(AttributeError):
399 morsel.coded_value = ''
400
401 def test_eq(self):
402 base_case = ('key', 'value', '"value"')
403 attribs = {
404 'path': '/',
405 'comment': 'foo',
406 'domain': 'example.com',
407 'version': 2,
408 }
409 morsel_a = cookies.Morsel()
410 morsel_a.update(attribs)
411 morsel_a.set(*base_case)
412 morsel_b = cookies.Morsel()
413 morsel_b.update(attribs)
414 morsel_b.set(*base_case)
415 self.assertTrue(morsel_a == morsel_b)
416 self.assertFalse(morsel_a != morsel_b)
417 cases = (
418 ('key', 'value', 'mismatch'),
419 ('key', 'mismatch', '"value"'),
420 ('mismatch', 'value', '"value"'),
421 )
422 for case_b in cases:
423 with self.subTest(case_b):
424 morsel_b = cookies.Morsel()
425 morsel_b.update(attribs)
426 morsel_b.set(*case_b)
427 self.assertFalse(morsel_a == morsel_b)
428 self.assertTrue(morsel_a != morsel_b)
429
430 morsel_b = cookies.Morsel()
431 morsel_b.update(attribs)
432 morsel_b.set(*base_case)
433 morsel_b['comment'] = 'bar'
434 self.assertFalse(morsel_a == morsel_b)
435 self.assertTrue(morsel_a != morsel_b)
436
437 # test mismatched types
438 self.assertFalse(cookies.Morsel() == 1)
439 self.assertTrue(cookies.Morsel() != 1)
440 self.assertFalse(cookies.Morsel() == '')
441 self.assertTrue(cookies.Morsel() != '')
442 items = list(cookies.Morsel().items())
443 self.assertFalse(cookies.Morsel() == items)
444 self.assertTrue(cookies.Morsel() != items)
445
446 # morsel/dict
447 morsel = cookies.Morsel()
448 morsel.set(*base_case)
449 morsel.update(attribs)
450 self.assertTrue(morsel == dict(morsel))
451 self.assertFalse(morsel != dict(morsel))
452
453 def test_copy(self):
454 morsel_a = cookies.Morsel()
455 morsel_a.set('foo', 'bar', 'baz')
456 morsel_a.update({
457 'version': 2,
458 'comment': 'foo',
459 })
460 morsel_b = morsel_a.copy()
461 self.assertIsInstance(morsel_b, cookies.Morsel)
462 self.assertIsNot(morsel_a, morsel_b)
463 self.assertEqual(morsel_a, morsel_b)
464
465 morsel_b = copy.copy(morsel_a)
466 self.assertIsInstance(morsel_b, cookies.Morsel)
467 self.assertIsNot(morsel_a, morsel_b)
468 self.assertEqual(morsel_a, morsel_b)
469
470 def test_setitem(self):
471 morsel = cookies.Morsel()
472 morsel['expires'] = 0
473 self.assertEqual(morsel['expires'], 0)
474 morsel['Version'] = 2
475 self.assertEqual(morsel['version'], 2)
476 morsel['DOMAIN'] = 'example.com'
477 self.assertEqual(morsel['domain'], 'example.com')
478
479 with self.assertRaises(cookies.CookieError):
480 morsel['invalid'] = 'value'
481 self.assertNotIn('invalid', morsel)
482
483 def test_setdefault(self):
484 morsel = cookies.Morsel()
485 morsel.update({
486 'domain': 'example.com',
487 'version': 2,
488 })
489 # this shouldn't override the default value
490 self.assertEqual(morsel.setdefault('expires', 'value'), '')
491 self.assertEqual(morsel['expires'], '')
492 self.assertEqual(morsel.setdefault('Version', 1), 2)
493 self.assertEqual(morsel['version'], 2)
494 self.assertEqual(morsel.setdefault('DOMAIN', 'value'), 'example.com')
495 self.assertEqual(morsel['domain'], 'example.com')
496
497 with self.assertRaises(cookies.CookieError):
498 morsel.setdefault('invalid', 'value')
499 self.assertNotIn('invalid', morsel)
500
501 def test_update(self):
502 attribs = {'expires': 1, 'Version': 2, 'DOMAIN': 'example.com'}
503 # test dict update
504 morsel = cookies.Morsel()
505 morsel.update(attribs)
506 self.assertEqual(morsel['expires'], 1)
507 self.assertEqual(morsel['version'], 2)
508 self.assertEqual(morsel['domain'], 'example.com')
509 # test iterable update
510 morsel = cookies.Morsel()
511 morsel.update(list(attribs.items()))
512 self.assertEqual(morsel['expires'], 1)
513 self.assertEqual(morsel['version'], 2)
514 self.assertEqual(morsel['domain'], 'example.com')
515 # test iterator update
516 morsel = cookies.Morsel()
517 morsel.update((k, v) for k, v in attribs.items())
518 self.assertEqual(morsel['expires'], 1)
519 self.assertEqual(morsel['version'], 2)
520 self.assertEqual(morsel['domain'], 'example.com')
521
522 with self.assertRaises(cookies.CookieError):
523 morsel.update({'invalid': 'value'})
524 self.assertNotIn('invalid', morsel)
525 self.assertRaises(TypeError, morsel.update)
526 self.assertRaises(TypeError, morsel.update, 0)
527
528 def test_pickle(self):
529 morsel_a = cookies.Morsel()
530 morsel_a.set('foo', 'bar', 'baz')
531 morsel_a.update({
532 'version': 2,
533 'comment': 'foo',
534 })
535 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
536 with self.subTest(proto=proto):
537 morsel_b = pickle.loads(pickle.dumps(morsel_a, proto))
538 self.assertIsInstance(morsel_b, cookies.Morsel)
539 self.assertEqual(morsel_b, morsel_a)
540 self.assertEqual(str(morsel_b), str(morsel_a))
541
542 def test_repr(self):
543 morsel = cookies.Morsel()
544 self.assertEqual(repr(morsel), '<Morsel: None=None>')
545 self.assertEqual(str(morsel), 'Set-Cookie: None=None')
546 morsel.set('key', 'val', 'coded_val')
547 self.assertEqual(repr(morsel), '<Morsel: key=coded_val>')
548 self.assertEqual(str(morsel), 'Set-Cookie: key=coded_val')
549 morsel.update({
550 'path': '/',
551 'comment': 'foo',
552 'domain': 'example.com',
553 'max-age': 0,
554 'secure': 0,
555 'version': 1,
556 })
557 self.assertEqual(repr(morsel),
558 '<Morsel: key=coded_val; Comment=foo; Domain=example.com; '
559 'Max-Age=0; Path=/; Version=1>')
560 self.assertEqual(str(morsel),
561 'Set-Cookie: key=coded_val; Comment=foo; Domain=example.com; '
562 'Max-Age=0; Path=/; Version=1')
563 morsel['secure'] = True
564 morsel['httponly'] = 1
565 self.assertEqual(repr(morsel),
566 '<Morsel: key=coded_val; Comment=foo; Domain=example.com; '
567 'HttpOnly; Max-Age=0; Path=/; Secure; Version=1>')
568 self.assertEqual(str(morsel),
569 'Set-Cookie: key=coded_val; Comment=foo; Domain=example.com; '
570 'HttpOnly; Max-Age=0; Path=/; Secure; Version=1')
571
572 morsel = cookies.Morsel()
573 morsel.set('key', 'val', 'coded_val')
574 morsel['expires'] = 0
575 self.assertRegex(repr(morsel),
576 r'<Morsel: key=coded_val; '
577 r'expires=\w+, \d+ \w+ \d+ \d+:\d+:\d+ \w+>')
578 self.assertRegex(str(morsel),
579 r'Set-Cookie: key=coded_val; '
580 r'expires=\w+, \d+ \w+ \d+ \d+:\d+:\d+ \w+')
581
582 def test_control_characters(self):
583 for c0 in support.control_characters_c0():
584 morsel = cookies.Morsel()
585
586 # .__setitem__()
587 with self.assertRaises(cookies.CookieError):
588 morsel[c0] = "val"
589 with self.assertRaises(cookies.CookieError):
590 morsel["path"] = c0
591
592 # .__setstate__()
593 with self.assertRaises(cookies.CookieError):
594 morsel.__setstate__({'key': c0, 'value': 'val', 'coded_value': 'coded'})
595 with self.assertRaises(cookies.CookieError):
596 morsel.__setstate__({'key': 'key', 'value': c0, 'coded_value': 'coded'})
597 with self.assertRaises(cookies.CookieError):
598 morsel.__setstate__({'key': 'key', 'value': 'val', 'coded_value': c0})
599
600 # .setdefault()
601 with self.assertRaises(cookies.CookieError):
602 morsel.setdefault("path", c0)
603 with self.assertRaises(cookies.CookieError):
604 morsel.setdefault(c0, "val")
605
606 # .set()
607 with self.assertRaises(cookies.CookieError):
608 morsel.set(c0, "val", "coded-value")
609 with self.assertRaises(cookies.CookieError):
610 morsel.set("path", c0, "coded-value")
611 with self.assertRaises(cookies.CookieError):
612 morsel.set("path", "val", c0)
613
614 # .update()
615 with self.assertRaises(cookies.CookieError):
616 morsel.update({"path": c0})
617 with self.assertRaises(cookies.CookieError):
618 morsel.update({c0: "val"})
619
620 # .__ior__()
621 with self.assertRaises(cookies.CookieError):
622 morsel |= {"path": c0}
623 with self.assertRaises(cookies.CookieError):
624 morsel |= {c0: "val"}
625
626 def test_control_characters_output(self):
627 # Tests that even if the internals of Morsel are modified
628 # that a call to .output() has control character safeguards.
629 for c0 in support.control_characters_c0():
630 morsel = cookies.Morsel()
631 morsel.set("key", "value", "coded-value")
632 morsel._key = c0 # Override private variable.
633 cookie = cookies.SimpleCookie()
634 cookie["cookie"] = morsel
635 with self.assertRaises(cookies.CookieError):
636 cookie.output()
637
638 morsel = cookies.Morsel()
639 morsel.set("key", "value", "coded-value")
640 morsel._coded_value = c0 # Override private variable.
641 cookie = cookies.SimpleCookie()
642 cookie["cookie"] = morsel
643 with self.assertRaises(cookies.CookieError):
644 cookie.output()
645
646 # Tests that .js_output() also has control character safeguards.
647 for c0 in support.control_characters_c0():
648 morsel = cookies.Morsel()
649 morsel.set("key", "value", "coded-value")
650 morsel._key = c0 # Override private variable.
651 cookie = cookies.SimpleCookie()
652 cookie["cookie"] = morsel
653 with self.assertRaises(cookies.CookieError):
654 cookie.js_output()
655
656 morsel = cookies.Morsel()
657 morsel.set("key", "value", "coded-value")
658 morsel._coded_value = c0 # Override private variable.
659 cookie = cookies.SimpleCookie()
660 cookie["cookie"] = morsel
661 with self.assertRaises(cookies.CookieError):
662 cookie.js_output()
663
664
665 def load_tests(loader, tests, pattern):
666 tests.addTest(doctest.DocTestSuite(cookies))
667 return tests
668
669
670 if __name__ == '__main__':
671 unittest.main()