Merge lp:~registry/horizon/25_dashboard_model_tests into lp:~hudson-openstack/horizon/trunk

[Mark Gius]

Unit tests for django-openstack.models

[lp:~registry/horizon/25_dashboard_model_tests]

66. By Mark Gius on 2011-06-10

Merge localization changes from trunk

[Devin Carlen (devcamcar)]

A few style nits:

These should go above the from ... imports for consistency:

65 +import datetime
66 +import hashlib
67 +import mox
68 +import random

Use the full module path in this case, which I think is probably from django_openstack.test_models or something:

51 from django_openstack.nova.tests import *
52 +
53 +from test_models import *

Prefer underscores to camelCase (ignore the fact that the setUp and tearDown methods ignore this - its a weird holdover from the old pyunit library):

84 + testCred = nova_models.CredentialsAuthorization()
85 + testCred.username = TEST_USER
86 + testCred.project = TEST_PROJECT
87 + testCred.auth_date = TEST_AUTH_DATE
88 + testCred.auth_token = TEST_AUTH_TOKEN
89 + testCred.save()

Use utcnow() instead of now():

122 + cred.auth_date = datetime.datetime.now() - AUTH_EXPIRATION_LENGTH \
123 + - HOUR

Better yet, don't use datetime directly at all, since it makes testing hard. Nova gets around this problem by supplying a utils.utcnow() method that wraps this and makes it a little more syntactically pretty.

180 + # testing with time is tricky. Mock out "right now" test to avoid
181 + # timing issues
182 + time = datetime.datetime.now()

Supernit! Need a space to left of equals:

248 +CREDENTIAL_DOWNLOAD_URL= TESTSERVER + '/credentials/'

review: Needs Fixing

[lp:~registry/horizon/25_dashboard_model_tests]

67. By Mark Gius on 2011-06-13

Address review comments

68. By Mark Gius on 2011-06-14

Remove hacky post_save short-circuit. Post_save tests to follow later

[Devin Carlen (devcamcar)]

Looks good. Only one minor nit:

156 + self.assertTrue(cred.username == TEST_USER2)
157 + self.assertTrue(cred.project == TEST_PROJECT)
158 + self.assertTrue(cred.auth_token == TEST_AUTH_TOKEN_2)

self.assertTrue should be replaced with assertEquals.

review: Needs Fixing

[lp:~registry/horizon/25_dashboard_model_tests]

69. By Mark Gius on 2011-06-14

Fix final nit

[Devin Carlen (devcamcar)]

lgtm

review: Approve

=== modified file 'django-openstack/src/django_openstack/models.py'
--- django-openstack/src/django_openstack/models.py	2011-06-08 04:58:56 +0000
+++ django-openstack/src/django_openstack/models.py	2011-06-14 19:58:47 +0000
@@ -31,7 +31,8 @@
 from django.db.models.signals import post_save
 from django.template.loader import render_to_string
 from django_openstack import log as logging
-from django_openstack.core.connection import get_nova_admin_connection
+from django_openstack.core import connection
+from django_openstack import utils
 
 
 LOG = logging.getLogger('django_openstack')
@@ -75,13 +76,13 @@
         expiration_date = datetime.timedelta(
                 days=int(settings.CREDENTIAL_AUTHORIZATION_DAYS))
 
-        return self.auth_date + expiration_date <= datetime.datetime.now()
+        return self.auth_date + expiration_date <= utils.utcnow()
 
     def get_download_url(self):
         return settings.CREDENTIAL_DOWNLOAD_URL + self.auth_token
 
     def get_zip(self):
-        nova = get_nova_admin_connection()
+        nova = connection.get_nova_admin_connection()
         self.delete()
         return nova.get_zip(self.username, self.project)
 
@@ -118,11 +119,11 @@
     """
 
     # NOTE(devcamcar): If running unit tests, don't use a real endpoint.
-    if settings.NOVA_DEFAULT_ENDPOINT == 'none':
+    if settings.NOVA_DEFAULT_ENDPOINT is None:
         return
 
     if created:
-        nova = get_nova_admin_connection()
+        nova = connection.get_nova_admin_connection()
         if not nova.has_user(instance.username):
             nova.create_user(instance.username)
             LOG.info('User "%s" created in Nova' % instance.username)

=== modified file 'django-openstack/src/django_openstack/tests/__init__.py'
--- django-openstack/src/django_openstack/tests/__init__.py	2011-05-16 19:57:48 +0000
+++ django-openstack/src/django_openstack/tests/__init__.py	2011-06-14 19:58:47 +0000
@@ -1,1 +1,3 @@
 from django_openstack.nova.tests import *
+
+from django_openstack.tests.test_models import *

=== added file 'django-openstack/src/django_openstack/tests/test_models.py'
--- django-openstack/src/django_openstack/tests/test_models.py	1970-01-01 00:00:00 +0000
+++ django-openstack/src/django_openstack/tests/test_models.py	2011-06-14 19:58:47 +0000
@@ -0,0 +1,169 @@
+import datetime
+import hashlib
+import mox
+import random
+
+from django import test
+from django.conf import settings
+from django.db.models.signals import post_save
+from django_openstack import models as nova_models
+from django_openstack import utils
+from django_openstack.core import connection
+from nova_adminclient import NovaAdminClient
+
+
+TEST_USER = 'testUser'
+TEST_PROJECT = 'testProject'
+TEST_AUTH_TOKEN = hashlib.sha1('').hexdigest()
+TEST_AUTH_DATE = utils.utcnow()
+TEST_BAD_AUTH_TOKEN = 'badToken'
+
+HOUR = datetime.timedelta(seconds=3600)
+AUTH_EXPIRATION_LENGTH = \
+        datetime.timedelta(days=int(settings.CREDENTIAL_AUTHORIZATION_DAYS))
+
+
+class CredentialsAuthorizationTests(test.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        # these post_save methods interact with external resources, shut them
+        # down to test credentials
+        post_save.disconnect(sender=nova_models.CredentialsAuthorization,
+            dispatch_uid='django_openstack.CredentialsAuthorization.post_save')
+        post_save.disconnect(sender=nova_models.CredentialsAuthorization,
+                dispatch_uid='django_openstack.User.post_save')
+
+    def setUp(self):
+        test_cred = nova_models.CredentialsAuthorization()
+        test_cred.username = TEST_USER
+        test_cred.project = TEST_PROJECT
+        test_cred.auth_date = TEST_AUTH_DATE
+        test_cred.auth_token = TEST_AUTH_TOKEN
+        test_cred.save()
+
+        badTestCred = nova_models.CredentialsAuthorization()
+        badTestCred.username = TEST_USER
+        badTestCred.project = TEST_PROJECT
+        badTestCred.auth_date = TEST_AUTH_DATE
+        badTestCred.auth_token = TEST_BAD_AUTH_TOKEN
+        badTestCred.save()
+
+        self.mox = mox.Mox()
+
+    def tearDown(self):
+        self.mox.UnsetStubs()
+
+    def test_get_by_token(self):
+        TEST_MISSING_AUTH_TOKEN = hashlib.sha1('notAToken').hexdigest()
+
+        # Token not a sha1, but exists in system
+        cred = nova_models.CredentialsAuthorization.get_by_token(
+                TEST_BAD_AUTH_TOKEN)
+        self.assertTrue(cred is None)
+
+        # Token doesn't exist
+        cred = nova_models.CredentialsAuthorization.get_by_token(
+                TEST_MISSING_AUTH_TOKEN)
+        self.assertTrue(cred is None)
+
+        # Good token
+        cred = nova_models.CredentialsAuthorization.get_by_token(
+                TEST_AUTH_TOKEN)
+        self.assertTrue(cred is not None)
+
+        # Expire the token
+        cred.auth_date = utils.utcnow() - AUTH_EXPIRATION_LENGTH \
+                                                 - HOUR
+        cred.save()
+
+        # Expired token
+        cred = nova_models.CredentialsAuthorization.get_by_token(
+                TEST_AUTH_TOKEN)
+        self.assertTrue(cred is None)
+
+    def test_authorize(self):
+        TEST_USER2 = TEST_USER + '2'
+        TEST_AUTH_TOKEN_2 = hashlib.sha1('token2').hexdigest()
+
+        cred_class = nova_models.CredentialsAuthorization
+        self.mox.StubOutWithMock(cred_class, 'create_auth_token')
+        cred_class.create_auth_token(TEST_USER2).AndReturn(
+                TEST_AUTH_TOKEN_2)
+
+        self.mox.ReplayAll()
+
+        cred = cred_class.authorize(TEST_USER2, TEST_PROJECT)
+
+        self.mox.VerifyAll()
+
+        self.assertTrue(cred is not None)
+        self.assertEqual(cred.username, TEST_USER2)
+        self.assertEqual(cred.project, TEST_PROJECT)
+        self.assertEqual(cred.auth_token, TEST_AUTH_TOKEN_2)
+        self.assertFalse(cred.auth_token_expired())
+
+        cred = cred_class.get_by_token(TEST_AUTH_TOKEN_2)
+        self.assertTrue(cred is not None)
+
+    def test_create_auth_token(self):
+        rand_state = random.getstate()
+        expected_salt = hashlib.sha1(str(random.random())).hexdigest()[:5]
+        expected_token = hashlib.sha1(expected_salt + TEST_USER).hexdigest()
+
+        random.setstate(rand_state)
+        auth_token = \
+            nova_models.CredentialsAuthorization.create_auth_token(TEST_USER)
+        self.assertEqual(expected_token, auth_token)
+
+    def test_auth_token_expired(self):
+        '''
+        Test expired in past, expires in future, expires _right now_
+        '''
+        cred = \
+            nova_models.CredentialsAuthorization.get_by_token(TEST_AUTH_TOKEN)
+
+        cred.auth_date = utils.utcnow() - AUTH_EXPIRATION_LENGTH \
+                                                 - HOUR
+        self.assertTrue(cred.auth_token_expired())
+
+        cred.auth_date = utils.utcnow()
+
+        self.assertFalse(cred.auth_token_expired())
+
+        # testing with time is tricky. Mock out "right now" test to avoid
+        # timing issues
+        time = utils.utcnow.override_time = utils.utcnow()
+        cred.auth_date = time - AUTH_EXPIRATION_LENGTH
+
+        self.assertTrue(cred.auth_token_expired())
+
+        utils.utcnow.override_time = None
+
+    def test_get_download_url(self):
+        cred = \
+            nova_models.CredentialsAuthorization.get_by_token(TEST_AUTH_TOKEN)
+
+        expected_url = settings.CREDENTIAL_DOWNLOAD_URL + TEST_AUTH_TOKEN
+        self.assertEqual(expected_url, cred.get_download_url())
+
+    def test_get_zip(self):
+        cred = \
+            nova_models.CredentialsAuthorization.get_by_token(TEST_AUTH_TOKEN)
+
+        admin_mock = self.mox.CreateMock(NovaAdminClient)
+
+        self.mox.StubOutWithMock(connection, 'get_nova_admin_connection')
+        connection.get_nova_admin_connection().AndReturn(admin_mock)
+
+        admin_mock.get_zip(TEST_USER, TEST_PROJECT)
+
+        self.mox.ReplayAll()
+
+        cred.get_zip()
+
+        self.mox.VerifyAll()
+
+        cred = \
+            nova_models.CredentialsAuthorization.get_by_token(TEST_AUTH_TOKEN)
+
+        self.assertTrue(cred is None)

=== modified file 'django-openstack/src/django_openstack/testsettings.py'
--- django-openstack/src/django_openstack/testsettings.py	2011-05-26 00:48:41 +0000
+++ django-openstack/src/django_openstack/testsettings.py	2011-06-14 19:58:47 +0000
@@ -8,17 +8,23 @@
 INSTALLED_APPS = ['django.contrib.auth',
                   'django.contrib.contenttypes',
                   'django.contrib.sessions',
+                  'django.contrib.sites',
                   'django_openstack',
+                  'django_openstack.tests',
                   'django_openstack.templatetags',
                   'django_openstack.nova']
 ROOT_URLCONF = 'django_openstack.testurls'
 TEMPLATE_DIRS = (
     os.path.join(ROOT_PATH, 'tests', 'templates')
 )
+SITE_ID = 1
 SITE_BRANDING = 'OpenStack'
 SITE_NAME = 'openstack'
 ENABLE_VNC = True
-NOVA_DEFAULT_ENDPOINT = 'none'
+NOVA_DEFAULT_ENDPOINT = None
 NOVA_DEFAULT_REGION = 'test'
 NOVA_ACCESS_KEY = 'test'
 NOVA_SECRET_KEY = 'test'
+
+CREDENTIAL_AUTHORIZATION_DAYS = 2
+CREDENTIAL_DOWNLOAD_URL = TESTSERVER + '/credentials/'

=== added file 'django-openstack/src/django_openstack/utils.py'
--- django-openstack/src/django_openstack/utils.py	1970-01-01 00:00:00 +0000
+++ django-openstack/src/django_openstack/utils.py	2011-06-14 19:58:47 +0000
@@ -0,0 +1,9 @@
+import datetime
+
+def utcnow():
+    '''Overridable version of datetime.datetime.utcnow'''
+    if utcnow.override_time:
+        return utcnow.override_time
+    return datetime.datetime.utcnow()
+
+utcnow.override_time = None