Merge lp:~canonical-isd-hackers/canonical-identity-provider/fix-captcha-tests-on-py2.7 into lp:canonical-identity-provider/release

[Łukasz Czyżykowski]

Fix for captcha tests in python 2.7.

Overview
========
This branch fixes test case for captcha which was failing on python 2.7.

Details
=======
Because of changes in the deepcopy in the python 2.7, the way in which the settings were saved for each test is no longer works. Because of that there's new approach, based on context manager (I could swear that there was something similar somewhere in our codebase) was created.

Testing
=======
To test run:

$ fab bootstrap setup_postgresql_server test

Making sure that you're using python 2.7.

[Ricardo Kirkner (ricardokirkner)]

The context manager patch_settings is provided with isd-test-utils, you *could* depend on it, but since it's just the context manager you need, and that the namespace of that package will change (soon?), it's ok to duplicate this code now (as you would be depending on yet another library just for it).

Lines 84-86 need some attention though:
l. 84, I think this could go before the patch_settings call
l. 85-86 these are not really needed

Thanks for making the bootstrap work on python2.7 :)

review: Needs Fixing

[Łukasz Czyżykowski (lukasz-czyzykowski)]

Updated the code.

[Ricardo Kirkner (ricardokirkner)]

LGTM

review: Approve

=== modified file 'identityprovider/tests/test_captcha.py'
--- identityprovider/tests/test_captcha.py	2011-01-20 21:48:43 +0000
+++ identityprovider/tests/test_captcha.py	2011-06-23 08:26:06 +0000
@@ -1,62 +1,62 @@
 # Copyright 2010 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
-
 from urllib2 import HTTPError, URLError
-from copy import deepcopy
 from unittest import TestCase
-
 from django.conf import settings
+from mock import Mock, patch
 
 from identityprovider.models.captcha import Captcha
 
-from mock import Mock, patch
+
+class patch_settings(object):
+
+    def __init__(self, **kwargs):
+        self.marker = object()
+        self.old_settings = {}
+        self.kwargs = kwargs
+
+    def __enter__(self):
+        for setting, new_value in self.kwargs.items():
+            self.old_settings[setting] = getattr(settings, setting, self.marker)
+            setattr(settings, setting, new_value)
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        for setting, old_value in self.old_settings.items():
+            if old_value is self.marker:
+                delattr(settings, setting)
+            else:
+                setattr(settings, setting, old_value)
 
 
 class CaptchaTestCase(TestCase):
 
-    def setUp(self):
-        # save Django settings, to be restored later (that's poking into Django
-        # internals)
-        self._settings = settings._wrapped
-        settings._wrapped = deepcopy(self._settings)
-
-    def tearDown(self):
-        settings._wrapped = self._settings
-
     def test_opener_is_created_during_init(self):
         Captcha.opener = None
 
-        captcha = Captcha('test')
+        Captcha('test')
 
         self.assertTrue(Captcha.opener is not None)
 
-
     @patch('urllib.urlencode')
-    #@patch('django.conf.settings.DISABLE_CAPTCHA_VERIFICATION', False)
     def test_non_ascii_captach_solution(self, mock_urlencode):
-        disable_captcha_verification = settings.DISABLE_CAPTCHA_VERIFICATION
-        settings.DISABLE_CAPTCHA_VERIFICATION = False
-        try:
-            captcha_solution = u'\xa3'
-            encoded_solution = captcha_solution.encode('utf-8')
-            mock_urlencode.return_value = 'some text'
+        captcha_solution = u'\xa3'
+        encoded_solution = captcha_solution.encode('utf-8')
+        mock_urlencode.return_value = 'some text'
 
+        with patch_settings(DISABLE_CAPTCHA_VERIFICATION=False):
             captcha = Captcha(None)
             captcha._open = Mock()
             captcha._open.return_value.is_error = True
             captcha.verify(captcha_solution, 'foobar')
 
-            captcha_response = mock_urlencode.call_args[0][0]['response']
-            self.assertEqual(captcha_response, encoded_solution)
-        finally:
-            settings.DISABLE_CAPTCHA_VERIFICATION = disable_captcha_verification
+        captcha_response = mock_urlencode.call_args[0][0]['response']
+        self.assertEqual(captcha_response, encoded_solution)
 
     def test_opener_is_created_when_proxy_is_required(self):
         Captcha.opener = None
-        settings.CAPTCHA_USE_PROXY = True
-        settings.CAPTCHA_PROXIES = {}
 
-        captcha = Captcha('test')
+        with patch_settings(CAPTCHA_USE_PROXY=True, CAPTCHA_PROXIES={}):
+            Captcha('test')
 
         self.assertTrue(Captcha.opener is not None)
 
@@ -77,10 +77,9 @@
             self.assertTrue(response.is_error)
 
     def test_verify_is_short_circuited_when_disabled_in_settings(self):
-        settings.DISABLE_CAPTCHA_VERIFICATION = True
-
-        captcha = Captcha('test')
-        verify_result = captcha.verify('solution', '127.0.0.1')
+        with patch_settings(DISABLE_CAPTCHA_VERIFICATION=True):
+            captcha = Captcha('test')
+            verify_result = captcha.verify('solution', '127.0.0.1')
 
         self.assertTrue(verify_result)
         self.assertTrue(captcha.response is None)