fix(test_cookies): case sensitivity

[carlwgeorge]

I got these errors while implementing the test suite in the AUR package for falcon. It looks to be
missing proper capitalization. Output has been tweaked to be less than 100 characters per line.

======================================================================
FAIL: test_response_base_case (tests.test_cookies.TestCookies)
tests.test_cookies.TestCookies.test_response_base_case
----------------------------------------------------------------------
testtools.testresult.real._StringException: Traceback (most recent call last):
  File "/home/carl/aur/python-falcon/falcon-0.3.0/tests/test_cookies.py", line 60, in
  test_response_base_case
    self.srmock.headers)
  File "/usr/lib/python3.4/site-packages/testtools/testcase.py", line 356, in assertIn
    self.assertThat(haystack, Contains(needle), message)
  File "/usr/lib/python3.4/site-packages/testtools/testcase.py", line 435, in assertThat
    raise mismatch_error
testtools.matchers._impl.MismatchError:
('set-cookie', 'foo=bar; Domain=example.com; httponly; Path=/; secure')
not in
[
('content-length', '0'),
('set-cookie', 'foo=bar; Domain=example.com; HttpOnly; Path=/; Secure')
]

======================================================================
FAIL: test_response_complex_case (tests.test_cookies.TestCookies)
tests.test_cookies.TestCookies.test_response_complex_case
----------------------------------------------------------------------
testtools.testresult.real._StringException: Traceback (most recent call last):
  File "/home/carl/aur/python-falcon/falcon-0.3.0/tests/test_cookies.py", line 67, in
  test_response_complex_case
    self.srmock.headers)
  File "/usr/lib/python3.4/site-packages/testtools/testcase.py", line 356, in assertIn
    self.assertThat(haystack, Contains(needle), message)
  File "/usr/lib/python3.4/site-packages/testtools/testcase.py", line 435, in assertThat
    raise mismatch_error
testtools.matchers._impl.MismatchError:
('set-cookie', 'foo=bar; httponly; Max-Age=300; secure')
not in
[
('content-type', 'application/json; charset=utf-8'),
('set-cookie', 'bar=baz; Secure'),
('set-cookie', 'foo=bar; HttpOnly; Max-Age=300; Secure')
]

[carlwgeorge]

I'm not sure why the Travis build failed, but here is what I do know.

• Travis is using tox, I used python setup.py test to get those errors
• The errors I got were for Python 3.4. I tried again with Python 2.7 and saw that it did not need the change, i.e. it was looking for lowercase httponly and secure.

If I'm off base here feel free to just close this out. Otherwise I would love feedback on how to improve the pull request. Thanks!

[kgriffs]

@carlgeorge I tested with 2.7.9, 3.4.2, and 3.4.3. It appears that the capitalization change occurred in 3.4.3. There may be a more elegant way to work around this, but my first thought is to explicitly pull out the 'set-cookie' header value, then lowercase in order to normalize capitalization, e.g.,:

actual_value = self.srmock.headers_dict['set-cookie']
self.assertEqual(actual_value.lower(), 
                 'foo=bar; domain=example.com; httponly; path=/; secure')

Thanks!

[carlwgeorge]

I don't think that approach will work in the test_response_complex_case method, since there are two set-cookie cookies. Calling self.srmock.headers_dict there only gets you the second value, since using the same key overrides the first one.

# self.srmock.headers
[
    ('content-type', 'application/json; charset=utf-8'),
    ('set-cookie', 'foo=bar; HttpOnly; Max-Age=300; Secure'),
    ('set-cookie', 'bar=baz; Secure')
]

# self.srmock.headers_dict
CaseInsensitiveDict(
    {
        'content-type': 'application/json; charset=utf-8',
        'set-cookie': 'bar=baz; Secure'
    }
)

Let me brainstorm on this and see if I can come up with a cleaner solution.

[kgriffs]

Domain and Path are capitalized in both CPython 3.4.2 and 3.4.3; it's only HttpOnly and Secure that change.

[kgriffs]

@carlgeorge Just following up to see if you've had a chance to review my latest comments?

[carlwgeorge]

@kgriffs Yes, I've just been busy. I'll try to fix this PR soon.

[carlwgeorge]

@kgriffs Latest commit seems to work, all Travis builds have passed.

[kgriffs]

@carlgeorge This is looking good. What do you think about @desiderius comment in #573 re using unittest.skipif()?

[carlwgeorge]

@kgriffs It would depend on how it is refactored I think. Even if you refactor the test later, I don't see a reason not to merge this fix for now.

@desiderius I'm curious, when you mentioned using skipIf, is your intention to check for the new capitalization on 3.4.3+, and just skip it on older versions? Or just skip the check on 3.4.3+ and only test the older versions?

[desiderius]

@carlgeorge I was thinking about something like splitting the test_response_complex_case() into a set of finer tests:

@unittest.skipIf(sys.version_info < (3, 4, 3), 'Change in attribute capitalization')
def test_head_request_cookie_contains_httponly(self)

@unittest.skipIf(sys.version_info >= (3, 4, 3), 'Change in attribute capitalization')
def test_head_request_cookie_contains_HttpOnly(self)
# ...

💭 maybe the test names differing only in capitalization is so so, but you get the idea.

[carlwgeorge]

@desiderius That seems inefficient to me, because those two test would be the same except for the HttpOnly and Secure parts of the header string. Why duplicate the code when an if/else block works fine?

Regardless, it's up to @kgriffs to decide which approach to take.

[desiderius]

@carlgeorge If by efficiency you mean fast, then you're certainly right that tests must be fast. My thought was more about long term maintainability than anything else. Anyway working code speak stronger than wishful thinking and your commit is here. So as you said latter a refactoring can be made someday if necessary.

[kgriffs]

Merged manually. We can refactor in another patch if needed.

[kgriffs]

@carlgeorge, @desiderius: Thanks for your help!