mirror of
				https://github.com/python/cpython.git
				synced 2025-11-04 11:49:12 +00:00 
			
		
		
		
	Previously it generated them if they were given a value, but completely ignored them if they were present in the string passed in to be parsed. Now if the flag appears on a cookie, the corresponding Morsel key will reference a True value. Other pre-existing behavior is retained in this maintenance patch: if the source contains something like 'secure=foo', morsel['secure'] will return 'foo'. Since such a value doesn't round trip and never did (and would be a surprising occurrence) a subsequent non-bug-fix patch may change this behavior. Inspired by a patch from Julien Phalip, who reviewed this one.
		
			
				
	
	
		
			234 lines
		
	
	
	
		
			9.2 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			234 lines
		
	
	
	
		
			9.2 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
# Simple test suite for http/cookies.py
 | 
						|
 | 
						|
from test.support import run_unittest, run_doctest, check_warnings
 | 
						|
import unittest
 | 
						|
from http import cookies
 | 
						|
 | 
						|
import warnings
 | 
						|
 | 
						|
class CookieTests(unittest.TestCase):
 | 
						|
 | 
						|
    def setUp(self):
 | 
						|
        self._warnings_manager = check_warnings()
 | 
						|
        self._warnings_manager.__enter__()
 | 
						|
        warnings.filterwarnings("ignore", ".* class is insecure.*",
 | 
						|
                                DeprecationWarning)
 | 
						|
 | 
						|
    def tearDown(self):
 | 
						|
        self._warnings_manager.__exit__(None, None, None)
 | 
						|
 | 
						|
    def test_basic(self):
 | 
						|
        cases = [
 | 
						|
            {'data': 'chips=ahoy; vienna=finger',
 | 
						|
             'dict': {'chips':'ahoy', 'vienna':'finger'},
 | 
						|
             'repr': "<SimpleCookie: chips='ahoy' vienna='finger'>",
 | 
						|
             'output': 'Set-Cookie: chips=ahoy\nSet-Cookie: vienna=finger'},
 | 
						|
 | 
						|
            {'data': 'keebler="E=mc2; L=\\"Loves\\"; fudge=\\012;"',
 | 
						|
             'dict': {'keebler' : 'E=mc2; L="Loves"; fudge=\012;'},
 | 
						|
             'repr': '''<SimpleCookie: keebler='E=mc2; L="Loves"; fudge=\\n;'>''',
 | 
						|
             'output': 'Set-Cookie: keebler="E=mc2; L=\\"Loves\\"; fudge=\\012;"'},
 | 
						|
 | 
						|
            # Check illegal cookies that have an '=' char in an unquoted value
 | 
						|
            {'data': 'keebler=E=mc2',
 | 
						|
             'dict': {'keebler' : 'E=mc2'},
 | 
						|
             'repr': "<SimpleCookie: keebler='E=mc2'>",
 | 
						|
             'output': 'Set-Cookie: keebler=E=mc2'},
 | 
						|
 | 
						|
            # Cookies with ':' character in their name. Though not mentioned in
 | 
						|
            # RFC, servers / browsers allow it.
 | 
						|
 | 
						|
             {'data': 'key:term=value:term',
 | 
						|
             'dict': {'key:term' : 'value:term'},
 | 
						|
             'repr': "<SimpleCookie: key:term='value:term'>",
 | 
						|
             'output': 'Set-Cookie: key:term=value:term'},
 | 
						|
 | 
						|
        ]
 | 
						|
 | 
						|
        for case in cases:
 | 
						|
            C = cookies.SimpleCookie()
 | 
						|
            C.load(case['data'])
 | 
						|
            self.assertEqual(repr(C), case['repr'])
 | 
						|
            self.assertEqual(C.output(sep='\n'), case['output'])
 | 
						|
            for k, v in sorted(case['dict'].items()):
 | 
						|
                self.assertEqual(C[k].value, v)
 | 
						|
 | 
						|
    def test_load(self):
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C.load('Customer="WILE_E_COYOTE"; Version=1; Path=/acme')
 | 
						|
 | 
						|
        self.assertEqual(C['Customer'].value, 'WILE_E_COYOTE')
 | 
						|
        self.assertEqual(C['Customer']['version'], '1')
 | 
						|
        self.assertEqual(C['Customer']['path'], '/acme')
 | 
						|
 | 
						|
        self.assertEqual(C.output(['path']),
 | 
						|
            'Set-Cookie: Customer="WILE_E_COYOTE"; Path=/acme')
 | 
						|
        self.assertEqual(C.js_output(), r"""
 | 
						|
        <script type="text/javascript">
 | 
						|
        <!-- begin hiding
 | 
						|
        document.cookie = "Customer=\"WILE_E_COYOTE\"; Path=/acme; Version=1";
 | 
						|
        // end hiding -->
 | 
						|
        </script>
 | 
						|
        """)
 | 
						|
        self.assertEqual(C.js_output(['path']), r"""
 | 
						|
        <script type="text/javascript">
 | 
						|
        <!-- begin hiding
 | 
						|
        document.cookie = "Customer=\"WILE_E_COYOTE\"; Path=/acme";
 | 
						|
        // end hiding -->
 | 
						|
        </script>
 | 
						|
        """)
 | 
						|
 | 
						|
    def test_extended_encode(self):
 | 
						|
        # Issue 9824: some browsers don't follow the standard; we now
 | 
						|
        # encode , and ; to keep them from tripping up.
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C['val'] = "some,funky;stuff"
 | 
						|
        self.assertEqual(C.output(['val']),
 | 
						|
            'Set-Cookie: val="some\\054funky\\073stuff"')
 | 
						|
 | 
						|
    def test_special_attrs(self):
 | 
						|
        # 'expires'
 | 
						|
        C = cookies.SimpleCookie('Customer="WILE_E_COYOTE"')
 | 
						|
        C['Customer']['expires'] = 0
 | 
						|
        # can't test exact output, it always depends on current date/time
 | 
						|
        self.assertTrue(C.output().endswith('GMT'))
 | 
						|
 | 
						|
        # loading 'expires'
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C.load('Customer="W"; expires=Wed, 01 Jan 2010 00:00:00 GMT')
 | 
						|
        self.assertEqual(C['Customer']['expires'],
 | 
						|
                         'Wed, 01 Jan 2010 00:00:00 GMT')
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C.load('Customer="W"; expires=Wed, 01 Jan 98 00:00:00 GMT')
 | 
						|
        self.assertEqual(C['Customer']['expires'],
 | 
						|
                         'Wed, 01 Jan 98 00:00:00 GMT')
 | 
						|
 | 
						|
        # 'max-age'
 | 
						|
        C = cookies.SimpleCookie('Customer="WILE_E_COYOTE"')
 | 
						|
        C['Customer']['max-age'] = 10
 | 
						|
        self.assertEqual(C.output(),
 | 
						|
                         'Set-Cookie: Customer="WILE_E_COYOTE"; Max-Age=10')
 | 
						|
 | 
						|
    def test_set_secure_httponly_attrs(self):
 | 
						|
        C = cookies.SimpleCookie('Customer="WILE_E_COYOTE"')
 | 
						|
        C['Customer']['secure'] = True
 | 
						|
        C['Customer']['httponly'] = True
 | 
						|
        self.assertEqual(C.output(),
 | 
						|
            'Set-Cookie: Customer="WILE_E_COYOTE"; httponly; secure')
 | 
						|
 | 
						|
    def test_secure_httponly_false_if_not_present(self):
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C.load('eggs=scrambled; Path=/bacon')
 | 
						|
        self.assertFalse(C['eggs']['httponly'])
 | 
						|
        self.assertFalse(C['eggs']['secure'])
 | 
						|
 | 
						|
    def test_secure_httponly_true_if_present(self):
 | 
						|
        # Issue 16611
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C.load('eggs=scrambled; httponly; secure; Path=/bacon')
 | 
						|
        self.assertTrue(C['eggs']['httponly'])
 | 
						|
        self.assertTrue(C['eggs']['secure'])
 | 
						|
 | 
						|
    def test_secure_httponly_true_if_have_value(self):
 | 
						|
        # This isn't really valid, but demonstrates what the current code
 | 
						|
        # is expected to do in this case.
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C.load('eggs=scrambled; httponly=foo; secure=bar; Path=/bacon')
 | 
						|
        self.assertTrue(C['eggs']['httponly'])
 | 
						|
        self.assertTrue(C['eggs']['secure'])
 | 
						|
        # Here is what it actually does; don't depend on this behavior.  These
 | 
						|
        # checks are testing backward compatibility for issue 16611.
 | 
						|
        self.assertEqual(C['eggs']['httponly'], 'foo')
 | 
						|
        self.assertEqual(C['eggs']['secure'], 'bar')
 | 
						|
 | 
						|
    def test_bad_attrs(self):
 | 
						|
        # issue 16611: make sure we don't break backward compatibility.
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C.load('cookie=with; invalid; version; second=cookie;')
 | 
						|
        self.assertEqual(C.output(),
 | 
						|
            'Set-Cookie: cookie=with\r\nSet-Cookie: second=cookie')
 | 
						|
 | 
						|
    def test_extra_spaces(self):
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C.load('eggs  =  scrambled  ;  secure  ;  path  =  bar   ; foo=foo   ')
 | 
						|
        self.assertEqual(C.output(),
 | 
						|
            'Set-Cookie: eggs=scrambled; Path=bar; secure\r\nSet-Cookie: foo=foo')
 | 
						|
 | 
						|
    def test_quoted_meta(self):
 | 
						|
        # Try cookie with quoted meta-data
 | 
						|
        C = cookies.SimpleCookie()
 | 
						|
        C.load('Customer="WILE_E_COYOTE"; Version="1"; Path="/acme"')
 | 
						|
        self.assertEqual(C['Customer'].value, 'WILE_E_COYOTE')
 | 
						|
        self.assertEqual(C['Customer']['version'], '1')
 | 
						|
        self.assertEqual(C['Customer']['path'], '/acme')
 | 
						|
 | 
						|
        self.assertEqual(C.output(['path']),
 | 
						|
                         'Set-Cookie: Customer="WILE_E_COYOTE"; Path=/acme')
 | 
						|
        self.assertEqual(C.js_output(), r"""
 | 
						|
        <script type="text/javascript">
 | 
						|
        <!-- begin hiding
 | 
						|
        document.cookie = "Customer=\"WILE_E_COYOTE\"; Path=/acme; Version=1";
 | 
						|
        // end hiding -->
 | 
						|
        </script>
 | 
						|
        """)
 | 
						|
        self.assertEqual(C.js_output(['path']), r"""
 | 
						|
        <script type="text/javascript">
 | 
						|
        <!-- begin hiding
 | 
						|
        document.cookie = "Customer=\"WILE_E_COYOTE\"; Path=/acme";
 | 
						|
        // end hiding -->
 | 
						|
        </script>
 | 
						|
        """)
 | 
						|
 | 
						|
class MorselTests(unittest.TestCase):
 | 
						|
    """Tests for the Morsel object."""
 | 
						|
 | 
						|
    def test_reserved_keys(self):
 | 
						|
        M = cookies.Morsel()
 | 
						|
        # tests valid and invalid reserved keys for Morsels
 | 
						|
        for i in M._reserved:
 | 
						|
            # Test that all valid keys are reported as reserved and set them
 | 
						|
            self.assertTrue(M.isReservedKey(i))
 | 
						|
            M[i] = '%s_value' % i
 | 
						|
        for i in M._reserved:
 | 
						|
            # Test that valid key values come out fine
 | 
						|
            self.assertEqual(M[i], '%s_value' % i)
 | 
						|
        for i in "the holy hand grenade".split():
 | 
						|
            # Test that invalid keys raise CookieError
 | 
						|
            self.assertRaises(cookies.CookieError,
 | 
						|
                              M.__setitem__, i, '%s_value' % i)
 | 
						|
 | 
						|
    def test_setter(self):
 | 
						|
        M = cookies.Morsel()
 | 
						|
        # tests the .set method to set keys and their values
 | 
						|
        for i in M._reserved:
 | 
						|
            # Makes sure that all reserved keys can't be set this way
 | 
						|
            self.assertRaises(cookies.CookieError,
 | 
						|
                              M.set, i, '%s_value' % i, '%s_value' % i)
 | 
						|
        for i in "thou cast _the- !holy! ^hand| +*grenade~".split():
 | 
						|
            # Try typical use case. Setting decent values.
 | 
						|
            # Check output and js_output.
 | 
						|
            M['path'] = '/foo' # Try a reserved key as well
 | 
						|
            M.set(i, "%s_val" % i, "%s_coded_val" % i)
 | 
						|
            self.assertEqual(
 | 
						|
                M.output(),
 | 
						|
                "Set-Cookie: %s=%s; Path=/foo" % (i, "%s_coded_val" % i))
 | 
						|
            expected_js_output = """
 | 
						|
        <script type="text/javascript">
 | 
						|
        <!-- begin hiding
 | 
						|
        document.cookie = "%s=%s; Path=/foo";
 | 
						|
        // end hiding -->
 | 
						|
        </script>
 | 
						|
        """ % (i, "%s_coded_val" % i)
 | 
						|
            self.assertEqual(M.js_output(), expected_js_output)
 | 
						|
        for i in ["foo bar", "foo@bar"]:
 | 
						|
            # Try some illegal characters
 | 
						|
            self.assertRaises(cookies.CookieError,
 | 
						|
                              M.set, i, '%s_value' % i, '%s_value' % i)
 | 
						|
 | 
						|
 | 
						|
def test_main():
 | 
						|
    run_unittest(CookieTests, MorselTests)
 | 
						|
    run_doctest(cookies)
 | 
						|
 | 
						|
if __name__ == '__main__':
 | 
						|
    test_main()
 |