Merge lp:~zyga/django-testscenarios/0.6 into lp:django-testscenarios

[Zygmunt Krynicki]

Fix design issue and release 0.6

The design issue was related to way django-testproject worked. It previously assumed that local test project would always have the name 'test_project'. This turned out to be a bad decision because of the way django double-imports settings with different paths. With simple scenario it could lead to wrong test_project being imported (different one in each python process).

To fix this I had to break backwards compatibility. There are few ways this affects users:

1) Instead of django_testproject.tests.run_tests() you must use django_testproject.tests.run_tests_for() and call it with the name of your settings module ("myapp.test_project.settings"). The old call is retained and works as before but is now deprecated.

2) To make it possible to import django_testscenarios.test_project directly I had to move some code from django_testproject/__init__.py into sub-module. This affects anyone who imported test cases from that package. They are all now in django_testscenarios.ubertest. This breaks compatibility directly.

=== modified file 'django_testproject/settings.py'
--- django_testproject/settings.py	2011-01-04 09:24:44 +0000
+++ django_testproject/settings.py	2011-05-23 14:59:46 +0000
@@ -7,6 +7,9 @@
 import django
 
 
+DJANGO_TESTPROJECT_DIR = os.path.abspath(os.path.dirname(__file__))
+
+
 def _get_default_settings(project_dir):
     """
     Produce default settings
@@ -28,28 +31,27 @@
     SITE_ID = 1
     TEMPLATE_LOADERS = (
         'django.template.loaders.filesystem.load_template_source',
-        'django.template.loaders.app_directories.load_template_source',
-    )
+        'django.template.loaders.app_directories.load_template_source',)
     TEMPLATE_DIRS = (
-        os.path.join(project_dir, "templates")
-    )
+        os.path.join(project_dir, "templates"),
+        os.path.join(DJANGO_TESTPROJECT_DIR, "templates"))
     MIDDLEWARE_CLASSES = (
         'django.middleware.common.CommonMiddleware',
         'django.contrib.sessions.middleware.SessionMiddleware',
         'django.contrib.auth.middleware.AuthenticationMiddleware',
-        'django.middleware.transaction.TransactionMiddleware',
-    )
+        'django.middleware.transaction.TransactionMiddleware',)
     if django.VERSION[0:2] >= (1, 2):
         DATABASES = {
             'default': {
-                'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
-                'NAME': os.path.join(project_dir, 'test.db'),               # Or path to database file if using sqlite3.
-                'USER': '',                      # Not used with sqlite3.
-                'PASSWORD': '',                  # Not used with sqlite3.
-                'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
-                'PORT': '',                      # Set to empty string for default. Not used with sqlite3.
-            }
-        }
+                # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
+                'ENGINE': 'django.db.backends.sqlite3',
+                # Or path to database file if using sqlite3.
+                'NAME': os.path.join(project_dir, 'test.db'),
+                'USER': '',  # Not used with sqlite3.
+                'PASSWORD': '',  # Not used with sqlite3.
+                'HOST': '',  # Set to empty string for localhost. Not used with sqlite3.
+                'PORT': '',  # Set to empty string for default. Not used with sqlite3.
+            }}
     else:
         DATABASE_ENGINE = 'sqlite3'
         DATABASE_NAME = os.path.join(project_dir, 'test.db')

=== added directory 'django_testproject/templates'
=== added directory 'django_testproject/templates/django_testproject'
=== added file 'django_testproject/templates/django_testproject/base.html'
--- django_testproject/templates/django_testproject/base.html	1970-01-01 00:00:00 +0000
+++ django_testproject/templates/django_testproject/base.html	2011-05-23 14:59:46 +0000
@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="{{ LANGUAGE_CODE }}" xml:lang="{{ LANGUAGE_CODE }}" {% if LANGUAGE_BIDI %}dir="rtl"{% endif %}>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+    <title>{% block title %}{% endblock %}</title>
+  </head>
+  <body>
+    {% block content %}{% endblock %}
+  </body>
+</html>

=== added directory 'django_testproject/templates/registration'
=== added file 'django_testproject/templates/registration/base.html'
--- django_testproject/templates/registration/base.html	1970-01-01 00:00:00 +0000
+++ django_testproject/templates/registration/base.html	2011-05-23 14:59:46 +0000
@@ -0,0 +1,4 @@
+{% extends "django_testproject/base.html" %}
+
+
+{% block title %}Account management{% endblock %}

=== added file 'django_testproject/templates/registration/logged_out.html'
--- django_testproject/templates/registration/logged_out.html	1970-01-01 00:00:00 +0000
+++ django_testproject/templates/registration/logged_out.html	2011-05-23 14:59:46 +0000
@@ -0,0 +1,3 @@
+{% block content %}
+<p>You have been signed out</p>
+{% endblock %}

=== added file 'django_testproject/templates/registration/login.html'
--- django_testproject/templates/registration/login.html	1970-01-01 00:00:00 +0000
+++ django_testproject/templates/registration/login.html	2011-05-23 14:59:46 +0000
@@ -0,0 +1,25 @@
+{% extends "registration/base.html" %}
+
+
+{% block title %}{{block.super }} | Sign in {% endblock %}
+
+
+{% block header %}
+{% if next %}
+  <h1>You need to sign-in to access that page</h1>
+{% else %}
+  <h1>Sign in</h1>
+{% endif %}
+{% endblock %}
+
+
+{% block content %}
+<form method="post" action="{% url django.contrib.auth.views.login %}">
+  {% csrf_token %} 
+  <p>{{ form.username }}</p>
+  <p>{{ form.password }}</p>
+  {{ form.errors }}
+  <input id="id_submit" type="submit" value="Sign in with username and password" />
+  <input type="hidden" name="next" value="{{ next }}" />
+</form>
+{% endblock %}

=== modified file 'django_testproject/tests.py'
--- django_testproject/tests.py	2011-01-19 11:02:44 +0000
+++ django_testproject/tests.py	2011-05-23 14:59:46 +0000
@@ -1,13 +1,52 @@
+# Copyright (C) 2010, 2011 Linaro Limited
+#
+# Author: Zygmunt Krynicki <[e-mail]>
+#
+# This file is part of django-testscenarios.
+#
+# django-testscenarios 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
+#
+# django-testscenarios is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with django-testscenarios.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Helper function for running tests via setup.py test
+"""
+
 import os
 import sys
 
 import django
 
-def run_tests(test_last_n_apps=-1):
-    os.environ['DJANGO_SETTINGS_MODULE'] = 'test_project.settings'
+
+def run_tests_for(settings_module_name, test_last_n_apps=-1):
+    """
+    Helper function that simplifies testing Django applications via setup.py
+    test
+
+    The idea is to test your application in a small test project. Since not
+    everything in your project is relevant (you don't want to test
+    django.contrib.auth gazillion times just because you use it in your
+    application) run_tests allows you to run just a subset of applications. By
+    default last item in INSTALLED_APPLICATIONS is tested. You can change it by
+    calling run_tests() with different argument. If you really want to test all
+    applications just pass None as test_last_n_apps.
+    """
+    os.environ['DJANGO_SETTINGS_MODULE'] = settings_module_name
+
     from django.conf import settings
     from django.test.utils import get_runner
-    test_labels = settings.INSTALLED_APPS[test_last_n_apps:]
+    if test_last_n_apps is None:
+        test_labels = None
+    else:
+        test_labels = settings.INSTALLED_APPS[test_last_n_apps:]
     if django.VERSION[0:2] <= (1, 1):
         # Prior to django 1.2 the runner was a plain function
         runner_fn = get_runner(settings)
@@ -18,3 +57,11 @@
         runner = runner_cls(verbosity=2, interactive=False).run_tests
     failures = runner(test_labels)
     sys.exit(failures)
+
+
+def run_tests(test_last_n_apps=-1):
+    """
+    Like run_tests_for but assumes that settings_module_name is
+    "test_project.settings"
+    """
+    return run_tests_for("test_project.settings", test_last_n_apps)

=== added file 'django_testscenarios/__init__.py'
--- django_testscenarios/__init__.py	1970-01-01 00:00:00 +0000
+++ django_testscenarios/__init__.py	2011-05-23 14:59:46 +0000
@@ -0,0 +1,17 @@
+# Copyright (C) 2010, 2011 Linaro Limited
+#
+# Author: Zygmunt Krynicki <[e-mail]>
+#
+# This file is part of django-testscenarios.
+#
+# django-testscenarios 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
+#
+# django-testscenarios is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with django-testscenarios.  If not, see <http://www.gnu.org/licenses/>.

=== modified file 'django_testscenarios/models.py'
--- django_testscenarios/models.py	2010-11-22 15:06:15 +0000
+++ django_testscenarios/models.py	2011-05-23 14:59:46 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Linaro Limited
+# Copyright (C) 2010, 2011 Linaro Limited
 #
 # Author: Zygmunt Krynicki <[e-mail]>
 #

=== renamed directory 'test_project' => 'django_testscenarios/test_project'
=== modified file 'django_testscenarios/test_project/__init__.py'
--- test_project/__init__.py	2010-11-22 15:06:15 +0000
+++ django_testscenarios/test_project/__init__.py	2011-05-23 14:59:46 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Linaro Limited
+# Copyright (C) 2010, 2011 Linaro Limited
 #
 # Author: Zygmunt Krynicki <[e-mail]>
 #

=== modified file 'django_testscenarios/test_project/manage.py'
--- test_project/manage.py	2011-01-03 23:57:16 +0000
+++ django_testscenarios/test_project/manage.py	2011-05-23 14:59:46 +0000
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (C) 2010 Linaro Limited
+# Copyright (C) 2010, 2011 Linaro Limited
 #
 # Author: Zygmunt Krynicki <[e-mail]>
 #
@@ -20,7 +20,7 @@
 
 from django.core.management import execute_manager
 try:
-    import settings # Assumed to be in the same directory.
+    import django_testscenarios.test_project.settings as settings
 except ImportError:
     import sys
     sys.stderr.write("Error: Can't find the file 'settings.py' in the directory containing %r. It appears you've customized things.\nYou'll have to run django-admin.py, passing it your settings module.\n(If the file settings.py does indeed exist, it's causing an ImportError somehow.)\n" % __file__)

=== modified file 'django_testscenarios/test_project/settings.py'
--- test_project/settings.py	2011-01-04 09:24:44 +0000
+++ django_testscenarios/test_project/settings.py	2011-05-23 14:59:46 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Linaro Limited
+# Copyright (C) 2010, 2011 Linaro Limited
 #
 # Author: Zygmunt Krynicki <[e-mail]>
 #
@@ -21,8 +21,4 @@
 
 locals().update(
     gen_settings(
-        INSTALLED_APPS=[
-            'django_testscenarios',
-        ]
-    )
-)
+        INSTALLED_APPS=['django_testscenarios']))

=== modified file 'django_testscenarios/test_project/tests.py'
--- test_project/tests.py	2011-01-03 23:57:16 +0000
+++ django_testscenarios/test_project/tests.py	2011-05-23 14:59:46 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Linaro Limited
+# Copyright (C) 2010, 2011 Linaro Limited
 #
 # Author: Zygmunt Krynicki <[e-mail]>
 #
@@ -17,7 +17,11 @@
 # along with django-testscenarios.  If not, see <http://www.gnu.org/licenses/>.
 
 
-from django_testproject.tests import run_tests
+from django_testproject.tests import run_tests_for
+
+
+def run_tests():
+    return run_tests_for("django_testscenarios.test_project.settings")
 
 
 if __name__ == '__main__':

=== modified file 'django_testscenarios/tests.py'
--- django_testscenarios/tests.py	2010-12-07 21:35:59 +0000
+++ django_testscenarios/tests.py	2011-05-23 14:59:46 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Linaro Limited
+# Copyright (C) 2010, 2011 Linaro Limited
 #
 # Author: Zygmunt Krynicki <[e-mail]>
 #
@@ -21,15 +21,13 @@
 from django.db import models, transaction
 from django.test import (
     TestCase as DjangoTestCase,
-    TransactionTestCase as DjangoTransactionTestCase
-)
+    TransactionTestCase as DjangoTransactionTestCase)
 
-from django_testscenarios import (
+from django_testscenarios.ubertest import (
     TestCase,
     TestCaseWithScenarios,
     TransactionTestCase,
-    TransactionTestCaseWithScenarios,
-)
+    TransactionTestCaseWithScenarios)
 
 
 class TestModel(models.Model):
@@ -95,8 +93,10 @@
         finally:
             transaction.leave_transaction_management()
 
+
 # Non-transaction tests
 
+
 class TestsWorkWithPlainDjangoTestCase(
     DjangoTestCase,
     PlainDatabaseChecks):

=== renamed file 'django_testscenarios/__init__.py' => 'django_testscenarios/ubertest.py'
--- django_testscenarios/__init__.py	2010-12-07 21:35:59 +0000
+++ django_testscenarios/ubertest.py	2011-05-23 14:59:46 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Linaro Limited
+# Copyright (C) 2010, 2011 Linaro Limited
 #
 # Author: Zygmunt Krynicki <[e-mail]>
 #
@@ -16,6 +16,7 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with django-testscenarios.  If not, see <http://www.gnu.org/licenses/>.
 
+
 """
 An uber-test class for Django that mixes:
  * testtools.TestCase
@@ -67,8 +68,7 @@
                 self.__class__.__module__,
                 self.__class__.__name__,
                 self._testMethodName,
-                self._testScenarioName
-            )
+                self._testScenarioName)
 
     def shortDescription(self):
         # XXX this makes setup.py test and test_project/manage.py test
@@ -176,7 +176,7 @@
     # cleanup _after_ a transaction test case. This works correctly
     # since (after sorting test cases) subsequent transaction test case
     # startup code will purge the database before running user code.
-    #  
+    #
     # Hence, our implementation makes the TransactionTestCase the base
     # class and the plain TestCase derived class.
     django.test.TestCase,
@@ -190,5 +190,4 @@
     "TestCase",
     "TestCaseWithScenarios",
     "TransactionTestCase",
-    "TransactionTestCaseWithScenarios"
-]
+    "TransactionTestCaseWithScenarios"]

=== modified file 'setup.py'
--- setup.py	2011-02-28 13:52:11 +0000
+++ setup.py	2011-05-23 14:59:46 +0000
@@ -20,16 +20,16 @@
 from setuptools import setup
 
 setup(
-    name = 'django-testscenarios',
-    version = "0.5.3",
-    author = "Zygmunt Krynicki",
-    author_email = "[e-mail]",
-    description = "Django-compatible testscenarios.TestWithScenarios",
-    url = 'https://launchpad.net/django-testscenarios',
-    test_suite = 'test_project.tests.run_tests',
+    name='django-testscenarios',
+    version="0.6",
+    author="Zygmunt Krynicki",
+    author_email="[e-mail]",
+    description="Django-compatible testscenarios.TestWithScenarios",
+    url='https://launchpad.net/django-testscenarios',
+    test_suite='django_testscenarios.test_project.tests.run_tests',
     license='LGPLv3',
-    keywords = ['django', 'testing', 'scenarios'],
-    classifiers = [
+    keywords=['django', 'testing', 'scenarios'],
+    classifiers=[
         "Development Status :: 4 - Beta",
         'Environment :: Web Environment',
         'Framework :: Django',
@@ -39,15 +39,12 @@
         "Programming Language :: Python :: 2.6",
         "Topic :: Software Development :: Testing",
     ],
-    zip_safe = True,
-    packages = [
+    zip_safe=True,
+    packages=[
         'django_testproject',
         'django_testscenarios',
     ],
-    # dependencies
     install_requires=[
         'django >= 1.0',
         'testtools >= 0.9.2',
-        'testscenarios >= 0.1',
-    ],
-)
+        'testscenarios >= 0.1'])