Merge lp:~ricardokirkner/django-pgtools/allow-backend-subclasses into lp:django-pgtools

[Ricardo Kirkner]

Support any backend that inherits from postgresql_psycopg2.

Support any backend that inherits from postgresql_psycopg2.

Also got tests to run again.

[Ubuntu One Auto Pilot (otto-pilot)]

Voting does not meet specified criteria. Required: Approve >= 1, Disapprove == 0, Needs Fixing == 0, Needs Information == 0, Resubmit == 0, Pending == 0. Got: 1 Pending.

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

review: Approve

=== modified file 'pgtools/tests.py'
--- pgtools/tests.py	2012-04-13 18:11:02 +0000
+++ pgtools/tests.py	2013-02-21 15:03:28 +0000
@@ -13,11 +13,14 @@
 
 from mock import Mock, patch
 
+import django
 from django.conf import settings
 from django.core.management import call_command
 from django.core.management.base import CommandError
 from django.db import connection
+from django.db.backends import postgresql_psycopg2
 from django.db.models.loading import get_models
+from django.db.utils import load_backend
 from django.test import TestCase
 
 
@@ -102,7 +105,7 @@
                 connection.settings_dict[setting_name] = attvalue
             else:
                 # Django 1.0 doesn't have setting cache, so there's nothing to
-                # refresh 
+                # refresh
                 pass
         connection.close()
 
@@ -441,20 +444,25 @@
             self.assertEqual(str(err),
                 "User cannot be deleted: %s" % TEST_USER_NAME1)
 
+    def get_backends(self):
+        django_version = django.VERSION[:2]
+        backends = ['django.db.backends.postgresql_psycopg2']
+        if django_version < (1,4):
+            backends.insert(0, 'postgresql_psycopg2')
+        return backends
+
     def test_utils_check_database_engine_11_style(self):
         # Test default: 'postgresql_psycopg2' (hopefully)
         settings_to_patch = {}
         if hasattr(settings, 'DATABASES'):
             settings_to_patch['DATABASES'] = None
-        for engine in [
-            'postgresql_psycopg2',
-            'django.db.backends.postgresql_psycopg2']:
+        for engine in self.get_backends():
             settings_to_patch['DATABASE_ENGINE'] = engine
             with patch_settings(**settings_to_patch):
                 check_database_engine()
 
         # Test an unsupported engine
-        settings_to_patch['DATABASE_ENGINE'] = 'sqlite3'
+        settings_to_patch['DATABASE_ENGINE'] = 'django.db.backends.sqlite3'
         with patch_settings(**settings_to_patch):
             self.assertRaises(CommandError, check_database_engine)
 
@@ -462,16 +470,35 @@
     def test_utils_check_database_engine_13_style(self, mock_settings):
         dbconfig = {'default': {'NAME': 'mydatabase'}}
         mock_settings.DATABASES = dbconfig
-        for engine in ['postgresql_psycopg2',
-            'django.db.backends.postgresql_psycopg2']:
+        for engine in self.get_backends():
             dbconfig['default']['ENGINE'] = engine
-            mock_settings.DATABASE_ENGINE = 'sqlite3'
+            mock_settings.DATABASE_ENGINE = 'django.db.backends.sqlite3'
             check_database_engine()
         # Test an unsupported engine
-        dbconfig['default']['ENGINE'] = 'sqlite3'
-        mock_settings.DATABASE_ENGINE = 'postgresql_psycopg2'
+        dbconfig['default']['ENGINE'] = 'django.db.backends.sqlite3'
+        mock_settings.DATABASE_ENGINE = 'django.db.backends.postgresql_psycopg2'
         self.assertRaises(CommandError, check_database_engine)
 
+    @patch('pgtools.utils.settings')
+    def test_utils_check_database_engine_subclass_13_style(self,
+                                                           mock_settings):
+        class CustomDatabaseWrapper(postgresql_psycopg2.base.DatabaseWrapper):
+            pass
+
+        dbconfig = {'default': {'NAME': 'mydatabase',
+                                'ENGINE': 'custom_backend'}}
+        mock_settings.DATABASE_ENGINE = 'custom_backend'
+        mock_settings.DATABASES = dbconfig
+        def mock_load_backend(name):
+            if name == 'custom_backend':
+                backend = Mock()
+                backend.DatabaseWrapper = CustomDatabaseWrapper
+                return backend
+            return load_backend(name)
+
+        with patch('pgtools.utils.load_backend', mock_load_backend):
+            check_database_engine()
+
     def test_utils_get_rolename_from_settings(self):
         # Test with default (nothing set)
         self.assertRaises(CommandError, get_rolename_from_settings)
 
=== modified file 'pgtools/utils.py'
--- pgtools/utils.py	2012-04-13 18:11:02 +0000
+++ pgtools/utils.py	2013-02-21 15:03:28 +0000
@@ -4,18 +4,25 @@
 
 from django.conf import settings
 from django.core.management.base import CommandError
+from django.db.utils import load_backend
 
 
 def check_database_engine():
     all_psql = True
+    postgresql_psycopg2_engine = load_backend('django.db.backends.postgresql_psycopg2')
     if getattr(settings, 'DATABASES', None):
         # Django 1.2+ style
         for db in settings.DATABASES.values():
-            if not db['ENGINE'].endswith('postgresql_psycopg2'):
+            engine = load_backend(db['ENGINE'])
+            if not issubclass(engine.DatabaseWrapper,
+                              postgresql_psycopg2_engine.DatabaseWrapper):
                 all_psql = False
     else:
         # Django -1.1 style
-        all_psql = settings.DATABASE_ENGINE.endswith('postgresql_psycopg2')
+        engine = load_backend(settings.DATABASE_ENGINE)
+        if not issubclass(engine.DatabaseWrapper,
+                          postgresql_psycopg2_engine.DatabaseWrapper):
+            all_psql = False
     if not all_psql:
         raise CommandError(
             'Only the postgresql_psycopg2 database engine is supported.')
 
=== modified file 'setup.py'
--- setup.py	2011-06-02 14:54:18 +0000
+++ setup.py	2013-02-21 15:03:28 +0000
@@ -18,17 +18,41 @@
     def run(self):
         """Run the project tests."""
 
+        import django
         from django.conf import settings
         from django.core.management import call_command
 
-        settings.configure(**{
-            'DATABASE_ENGINE': 'postgresql_psycopg2',
-            'DATABASE_NAME': 'pgtools',
-            'DATABASE_USER': 'postgres',
+        config = {
             'SITE_ID': 1,
             'ROOT_URLCONF': '',
-            'INSTALLED_APPS': ['pgtools'],
-        })
+            'INSTALLED_APPS': [
+                'django.contrib.admin',
+                'django.contrib.auth',
+                'django.contrib.contenttypes',
+                'django.contrib.sessions',
+                'pgtools',
+            ],
+        }
+
+        django_version = django.VERSION[:2]
+        if django_version > (1,1):
+            config.update({
+                'DATABASES': {
+                    'default': {
+                        'NAME': 'pgtools',
+                        'ENGINE': 'django.db.backends.postgresql_psycopg2',
+                        'USER': 'postgres',
+                    }
+                }
+            })
+        if django_version < (1,4):
+            config.update({
+                'DATABASE_ENGINE': 'django.db.backends.postgresql_psycopg2',
+                'DATABASE_NAME': 'pgtools',
+                'DATABASE_USER': 'postgres',
+            })
+
+        settings.configure(**config)
 
         call_command('test', interactive=False)