Merge lp:~elopio/u1-test-utils/configglue into lp:u1-test-utils

[Leo Arias]

If django is not installed, use u1testutils settings from the XDG config directory.

As we will start testing desktop applications that have nothing to do with django, we need a different way to specify the configuration parameters.
Here I propose to use a specific u1testutils file stored in one of the XDG config directories to load the values.
django_configglue doesn't depend on django, and with it we can get the values easily in the same format as we do for the django projects, so it's a nice fit.

[lp:~elopio/u1-test-utils/configglue]

70. By Leo Arias on 2013-04-29

Use configglue, django_configlue is not needed.

[Leo Arias (elopio)]

I misuderstood configglue docs, we actually don't need django_configglue :)

[lp:~elopio/u1-test-utils/configglue]

71. By Leo Arias on 2013-04-29

Copied the last bits of django configglue.

72. By Leo Arias on 2013-04-29

Allow to get the SSO_BASE_URL from u1testutils config too.

73. By Leo Arias on 2013-05-02

Added the openid section.

74. By Leo Arias on 2013-05-02

Use a var for the settings.

75. By Leo Arias on 2013-05-02

Joined the tests. Moved the file creation to set up.

76. By Leo Arias on 2013-05-02

Cleanup.

77. By Leo Arias on 2013-05-02

Cleanup.

78. By Leo Arias on 2013-05-02

The update must be inside the patched section.

79. By Leo Arias on 2013-05-02

No reason to call it get_django_settings now.

80. By Leo Arias on 2013-05-03

Merged with prerequisite branch.

81. By Leo Arias on 2013-05-06

Added the ubuntuone server url config option.

Unmerged revisions

81. By Leo Arias on 2013-05-06

Added the ubuntuone server url config option.

80. By Leo Arias on 2013-05-03

Merged with prerequisite branch.

79. By Leo Arias on 2013-05-02

No reason to call it get_django_settings now.

78. By Leo Arias on 2013-05-02

The update must be inside the patched section.

77. By Leo Arias on 2013-05-02

Cleanup.

76. By Leo Arias on 2013-05-02

Cleanup.

75. By Leo Arias on 2013-05-02

Joined the tests. Moved the file creation to set up.

74. By Leo Arias on 2013-05-02

Use a var for the settings.

73. By Leo Arias on 2013-05-02

Added the openid section.

72. By Leo Arias on 2013-04-29

Allow to get the SSO_BASE_URL from u1testutils config too.

=== modified file 'requirements.txt'
--- requirements.txt	2013-05-03 03:02:25 +0000
+++ requirements.txt	2013-05-03 03:02:25 +0000
@@ -1,10 +1,11 @@
 # Packages.
 beautifulsoup4
+configglue
+dirspec
 django==1.4
 mock
 pep8
 pyflakes
-testtools
 Twisted
 bzr+ssh://bazaar.launchpad.net/~bloodearnest/localmail/trunk
 bzr+http://bazaar.launchpad.net/~ubuntuone-hackers/payclient/trunk@4

=== modified file 'u1testutils/__init__.py'
--- u1testutils/__init__.py	2013-05-03 03:02:25 +0000
+++ u1testutils/__init__.py	2013-05-03 03:02:25 +0000
@@ -1,4 +1,4 @@
-# Copyright 2013 Canonical Ltd.
+# Copyright 2012, 2013 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Lesser General Public License version 3, as
@@ -10,55 +10,6 @@
 # PURPOSE.  See the GNU Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License along
-# with this program.  If not, see <http://www.gnu.org/licenses/>.
+# with this program.  If not, see <http://www.gnu.org/licenses/
 
 __version__ = '0.3.1'
-
-import importlib
-import os
-import shutil
-import sys
-import tempfile
-
-import mock
-
-
-def set_cwd_to_tmp(test):
-    """Create a temp dir an cd into it for the test duration.
-
-    This is generally called during a test setup.
-
-    The code for this function was taken from
-    https://code.launchpad.net/selenium=simple-test
-    """
-    test.test_base_dir = tempfile.mkdtemp(prefix='mytests-', suffix='.tmp')
-    test.addCleanup(shutil.rmtree, test.test_base_dir, True)
-    current_dir = os.getcwdu()
-    test.addCleanup(os.chdir, current_dir)
-    os.chdir(test.test_base_dir)
-
-
-def protect_imports(test):
-    """Protect sys.modules and sys.path for the test duration.
-
-    This is useful to test imports which modifies sys.modules or requires
-    modifying sys.path.
-
-    The code for this function was based on the protect_imports from 
-    https://code.launchpad.net/~vila/selenium-simple-test/test-loader
-    """
-    # Protect sys.modules and sys.path to be able to test imports
-    patcher = mock.patch('sys.path', list(sys.path))
-    test.addCleanup(patcher.stop)
-    patcher.start()
-    orig_modules = sys.modules.copy()
-    
-    def cleanup_modules():
-        # Remove all added modules
-        added = [m for m in sys.modules.keys() if m not in orig_modules]
-        if added:
-            for m in added:
-                del sys.modules[m]
-        # Restore deleted or modified modules
-        sys.modules.update(orig_modules)
-    test.addCleanup(cleanup_modules)

=== added file 'u1testutils/schema.py'
--- u1testutils/schema.py	1970-01-01 00:00:00 +0000
+++ u1testutils/schema.py	2013-05-03 03:02:25 +0000
@@ -0,0 +1,33 @@
+# Copyright 2013 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/
+
+from configglue import schema
+
+
+class SSOSchema(schema.Schema):
+
+    class testing(schema.Section):
+        sso_test_account_full_name = schema.StringOption()
+        sso_test_account_email = schema.StringOption()
+        sso_test_account_password = schema.StringOption()
+        email_address_pattern = schema.StringOption(raw=True)
+
+
+class U1TestUtilsSchema(schema.Schema):
+
+    class openid(schema.Section):
+        openid_sso_server_url = schema.StringOption()
+
+
+schema = schema.merge(SSOSchema, U1TestUtilsSchema)

=== added file 'u1testutils/selftests/unit/test_settings.py'
--- u1testutils/selftests/unit/test_settings.py	1970-01-01 00:00:00 +0000
+++ u1testutils/selftests/unit/test_settings.py	2013-05-03 03:02:25 +0000
@@ -0,0 +1,69 @@
+# Copyright 2013 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import importlib
+import os
+import shutil
+import sys
+import tempfile
+import unittest
+
+import mock
+
+from u1testutils import schema
+
+
+class SettingsTestCase(unittest.TestCase):
+
+    def setUp(self):
+        super(SettingsTestCase, self).setUp()
+        settings = (
+            '[testing]\n'
+            'sso_test_account_full_name = Test name\n'
+            'sso_test_account_email = [e-mail]\n'
+            'sso_test_account_password = test password\n'
+            'email_address_pattern = [e-mail]\n'
+            '[openid]\n'
+            'openid_sso_server_url = http://example.com\n'
+        )
+        self.config_home = tempfile.mkdtemp()
+        self.addCleanup(shutil.rmtree, self.config_home)
+        self._make_home_config_file(settings)
+
+    def _make_home_config_file(self, settings):
+        config_directory = os.path.join(self.config_home, 'u1testutils')
+        os.mkdir(config_directory)
+        self.config_file_path = os.path.join(
+            config_directory, 'u1testutils.conf')
+        with open(self.config_file_path, 'w') as config_file:
+            config_file.write(settings)
+
+    def _update_settings(self, settings):
+        settings.configglue(schema.schema, settings.get_config_file())
+
+    def test_options(self):
+        needs_update = 'u1testutils.settings' in sys.modules
+        with mock.patch.dict(
+                'os.environ', {'XDG_CONFIG_HOME': self.config_home}):
+            settings = importlib.import_module('u1testutils.settings')
+            if needs_update:
+                self.addCleanup(self._update_settings, settings)
+                self._update_settings(settings)
+
+        self.assertEqual(settings.SSO_TEST_ACCOUNT_FULL_NAME, 'Test name')
+        self.assertEqual(settings.SSO_TEST_ACCOUNT_EMAIL, '[e-mail]')
+        self.assertEqual(settings.SSO_TEST_ACCOUNT_PASSWORD, 'test password')
+        self.assertEqual(
+            settings.EMAIL_ADDRESS_PATTERN, '[e-mail]')
+        self.assertEqual(settings.OPENID_SSO_SERVER_URL, 'http://example.com')

=== removed file 'u1testutils/selftests/unit/test_utils.py'
--- u1testutils/selftests/unit/test_utils.py	2013-05-03 03:02:25 +0000
+++ u1testutils/selftests/unit/test_utils.py	1970-01-01 00:00:00 +0000
@@ -1,96 +0,0 @@
-import os
-import sys
-import tempfile
-
-import testtools
-from testtools.matchers import MatchesRegex
-
-import u1testutils
-
-
-class TestTempCurrentWorkDirectory(testtools.TestCase):
-    
-    def setUp(self):
-        super(TestTempCurrentWorkDirectory, self).setUp()
-        self.original_cwd = os.getcwdu()
-
-    def test_cwd_set_to_tmp(self):
-        self.addCleanup(self._assert_cwd_restored)
-        self.addCleanup(self._assert_tmp_directory_deleted)
-        u1testutils.set_cwd_to_tmp(self)
-
-        cwd = os.getcwdu()
-        expected_regex = '{0}/mytests-.+\.tmp'.format(tempfile.gettempdir())
-        self.assertThat(cwd, MatchesRegex(expected_regex))
-
-    def _assert_cwd_restored(self):
-        cwd = os.getcwdu()
-        self.assertEqual(cwd, self.original_cwd)
-
-    def _assert_tmp_directory_deleted(self):
-        self.assertFalse(os.path.isdir(self.test_base_dir))
-
-
-class TestProtectImports(testtools.TestCase):
-    # The code for this test case was taken from 
-    # https://code.launchpad.net/~vila/selenium-simple-test/test-loader
-
-    def setUp(self):
-        super(TestProtectImports, self).setUp()
-        u1testutils.protect_imports(self)
-
-    def run_successful_test(self, test):
-        result = testtools.TestResult()
-        test.run(result)
-        self.assertTrue(result.wasSuccessful())
-
-    def test_add_module(self):
-        self.assertIs(None, sys.modules.get('foo', None))
-
-        class Test(testtools.TestCase):
-
-            def test_it(self):
-                u1testutils.protect_imports(self)
-                sys.modules['foo'] = 'bar'
-
-        self.run_successful_test(Test('test_it'))
-        self.assertIs(None, sys.modules.get('foo', None))
-
-    def test_remove_module(self):
-        self.assertIs(None, sys.modules.get('I_dont_exist', None))
-        sys.modules['I_dont_exist'] = 'bar'
-
-        class Test(testtools.TestCase):
-
-            def test_it(self):
-                u1testutils.protect_imports(self)
-                self.assertEqual('bar', sys.modules['I_dont_exist'])
-                del sys.modules['I_dont_exist']
-        self.run_successful_test(Test('test_it'))
-        self.assertEqual('bar', sys.modules['I_dont_exist'])
-
-    def test_modify_module(self):
-        self.assertIs(None, sys.modules.get('I_dont_exist', None))
-        sys.modules['I_dont_exist'] = 'bar'
-
-        class Test(testtools.TestCase):
-
-            def test_it(self):
-                u1testutils.protect_imports(self)
-                self.assertEqual('bar', sys.modules['I_dont_exist'])
-                sys.modules['I_dont_exist'] = 'qux'
-        self.run_successful_test(Test('test_it'))
-        self.assertEqual('bar', sys.modules['I_dont_exist'])
-
-    def test_sys_path_restored(self):
-        u1testutils.set_cwd_to_tmp(self)
-        inserted = self.test_base_dir
-        self.assertFalse(inserted in sys.path)
-
-        class Test(testtools.TestCase):
-
-            def test_it(self):
-                u1testutils.protect_imports(self)
-                sys.path.insert(0, inserted)
-        self.run_successful_test(Test('test_it'))
-        self.assertFalse(inserted in sys.path)

=== added file 'u1testutils/settings.py'
--- u1testutils/settings.py	1970-01-01 00:00:00 +0000
+++ u1testutils/settings.py	2013-05-03 03:02:25 +0000
@@ -0,0 +1,54 @@
+# Copyright 2013 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/
+
+import os.path
+import sys
+
+from dirspec import basedir
+from configglue import parser
+
+from u1testutils import schema
+
+
+CONFIG_FILE = 'u1testutils.conf'
+SETTINGS_ENCODING = 'utf-8'
+
+
+def configglue(schema_class, configs):
+    scp = parser.SchemaConfigParser(schema_class())
+    scp.read(configs)
+    _update_settings(scp)
+
+
+def _update_settings(parser):
+    settings = _get_uppercase_settings(parser)
+    target = sys.modules[__name__]
+    for name, value in settings.items():
+        setattr(target, name, value)
+
+
+def _get_uppercase_settings(parser):
+    result = {}
+    for section, data in parser.values().items():
+        for option, value in data.items():
+            result[option.upper()] = value.encode(SETTINGS_ENCODING)
+    return result
+
+
+def get_config_file():
+    xdg_config_dir = basedir.load_first_config('u1testutils')
+    return os.path.join(xdg_config_dir, CONFIG_FILE)
+
+
+configglue(schema.schema, get_config_file())

=== modified file 'u1testutils/sso/data.py'
--- u1testutils/sso/data.py	2013-04-09 19:06:01 +0000
+++ u1testutils/sso/data.py	2013-05-03 03:02:25 +0000
@@ -14,7 +14,10 @@
 
 import uuid
 
-from django.conf import settings
+try:
+    from django.conf import settings
+except ImportError:
+    from u1testutils import settings
 
 from u1testutils.sso import client
 

=== modified file 'u1testutils/sso/environment.py'
--- u1testutils/sso/environment.py	2013-04-09 19:06:01 +0000
+++ u1testutils/sso/environment.py	2013-05-03 03:02:25 +0000
@@ -12,7 +12,10 @@
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from django.conf import settings
+try:
+    from django.conf import settings
+except ImportError:
+    from u1testutils import settings
 
 
 def get_sso_base_url(default='http://localhost:8000'):

=== modified file 'u1testutils/sso/selftests/unit/test_data.py'
--- u1testutils/sso/selftests/unit/test_data.py	2013-05-03 03:02:25 +0000
+++ u1testutils/sso/selftests/unit/test_data.py	2013-05-03 03:02:25 +0000
@@ -14,14 +14,11 @@
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/
 
-import os
-import sys
-import tempfile
 import unittest
 
 from mock import patch
 
-import u1testutils
+import u1testutils.django
 from u1testutils.sso import data
 
 
@@ -36,62 +33,32 @@
         self.assertEqual(user.email, '[e-mail]')
         self.assertEqual(user.password, 'Hola123*')
 
-    def _make_django_settings_file(self, settings):
-        u1testutils.set_cwd_to_tmp(self)
-        cwd = os.getcwdu()
-        sys.path.insert(0, cwd)
-        settings_file = tempfile.NamedTemporaryFile(
-            suffix='.py', dir=cwd, delete=False)
-        with settings_file:
-            settings_file.write(settings)
-        settings_module_name = os.path.splitext(
-            os.path.basename(settings_file.name))[0]
-        return settings_module_name
-
-    def _reload_data_module(self):
-        for module in (
-                'u1testutils.sso.data',
-                'django.conf',
-                'django.conf.global_settings'): 
-            if module in sys.modules:
-                del sys.modules[module]
-        import u1testutils.sso.data
-        return u1testutils.sso.data
-        
     def test_make_exising_user_from_configuration(self):
-        u1testutils.protect_imports(self)
-        settings = ('SSO_TEST_ACCOUNT_FULL_NAME = "Test existing name"\n'
-                    'SSO_TEST_ACCOUNT_EMAIL = "[e-mail]"\n'
-                    'SSO_TEST_ACCOUNT_PASSWORD = "test existing password"\n')
-        settings_module = self._make_django_settings_file(settings)
-        with patch.dict(
-            'os.environ', {'DJANGO_SETTINGS_MODULE': settings_module}):
-            data = self._reload_data_module()
+        with u1testutils.django.patch_settings(
+                SSO_TEST_ACCOUNT_FULL_NAME='Test existing name',
+                SSO_TEST_ACCOUNT_EMAIL='[e-mail]',
+                SSO_TEST_ACCOUNT_PASSWORD='existing password'):
             user = data.User.make_from_configuration()
 
         self.assertEqual(user.full_name, 'Test existing name')
-        self.assertEqual(user.email, '[e-mail]')
-        self.assertEqual(user.password, 'test existing password')
+        self.assertEqual(user.email, '[e-mail]')
+        self.assertEqual(user.password, 'existing password')
 
     def test_make_new_user_from_configuration(self):
-        u1testutils.protect_imports(self)
-        settings = ('EMAIL_ADDRESS_PATTERN = "[e-mail]"\n'
-                    'SSO_TEST_ACCOUNT_PASSWORD = "test new password"\n')
-        settings_module = self._make_django_settings_file(settings)
-        with patch.dict(
-                'os.environ', {'DJANGO_SETTINGS_MODULE': settings_module}):
+        with u1testutils.django.patch_settings(
+                EMAIL_ADDRESS_PATTERN='[e-mail]',
+                SSO_TEST_ACCOUNT_PASSWORD='new password'):
             with patch('uuid.uuid1') as mock_uuid:
                 mock_uuid.return_value = 'test_uuid'
-                data = self._reload_data_module()
                 user = data.User.make_from_configuration(new_user=True)
 
         self.assertEqual(user.full_name, 'Test user test_uuid')
-        self.assertEqual(user.email, '[e-mail]')
-        self.assertEqual(user.password, 'test new password')
+        self.assertEqual(user.email, '[e-mail]')
+        self.assertEqual(user.password, 'new password')
 
 
 class UserTestCase(unittest.TestCase):
-    
+
     def setUp(self):
         self.user = data.User.make_from_configuration()
 
@@ -99,17 +66,15 @@
         self.assertIsNone(self.user._openid)
 
     def test_openid_for_valid_account(self):
-        name = 'u1testutils.sso.data.client.get_account_openid'
-        with patch(name) as mock_client:
-            mock_client.return_value = 'foo1234'
+        with patch('u1testutils.sso.data.client') as mock_client:
+            mock_client.get_account_openid.return_value = 'foo1234'
 
             self.assertEqual(self.user.openid, 'foo1234')
             self.assertEqual(self.user._openid, 'foo1234')
 
     def test_openid_for_invalid_account(self):
-        name = 'u1testutils.sso.data.client.get_account_openid'
-        with patch(name) as mock_client:
-            mock_client.return_value = None
+        with patch('u1testutils.sso.data.client') as mock_client:
+            mock_client.get_account_openid.return_value = None
 
             self.assertEqual(self.user.openid, None)
             self.assertIsNone(self.user._openid, None)

=== modified file 'u1testutils/sso/sst/__init__.py'
--- u1testutils/sso/sst/__init__.py	2013-05-03 03:02:25 +0000
+++ u1testutils/sso/sst/__init__.py	2013-04-24 04:03:24 +0000
@@ -11,7 +11,6 @@
 #
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
-
 import sst.actions
 
 from u1testutils.sso import mail