Added redirection for email services during test conditions.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@5173 bcc190cf-cafb-0310-a4f2-bffc1f526a37

django/test/testcases.py

@@ -1,7 +1,7 @@
 import re, doctest, unittest
 from urlparse import urlparse
 from django.db import transaction
-from django.core import management
+from django.core import management, mail
 from django.db.models import get_apps
 from django.test.client import Client
 
@@ -33,23 +33,27 @@ class DocTestRunner(doctest.DocTestRunner):
         transaction.rollback_unless_managed()
 
 class TestCase(unittest.TestCase):    
-    def install_fixtures(self):
-        """If the Test Case class has a 'fixtures' member, clear the database and
-        install the named fixtures at the start of each test.
+    def _pre_setup(self):
+        """Perform any pre-test setup. This includes:
         
+            * If the Test Case class has a 'fixtures' member, clearing the 
+            database and installing the named fixtures at the start of each test.
+            * Clearing the mail test outbox.
+            
         """
         management.flush(verbosity=0, interactive=False)
         if hasattr(self, 'fixtures'):
             management.load_data(self.fixtures, verbosity=0)
-
+        mail.outbox = []
+        
     def run(self, result=None):
-        """Wrapper around default run method so that user-defined Test Cases 
-        automatically call install_fixtures without having to include a call to 
-        super().
+        """Wrapper around default run method to perform common Django test set up.
+        This means that user-defined Test Cases aren't required to include a call 
+        to super().setUp().
         
         """
         self.client = Client()
-        self.install_fixtures()
+        self._pre_setup()
         super(TestCase, self).run(result)
 
     def assertRedirects(self, response, expected_path):

django/test/utils.py

@@ -1,7 +1,7 @@
 import sys, time
 from django.conf import settings
 from django.db import connection, transaction, backend
-from django.core import management
+from django.core import management, mail
 from django.dispatch import dispatcher
 from django.test import signals
 from django.template import Template
@@ -18,24 +18,54 @@ def instrumented_test_render(self, context):
     dispatcher.send(signal=signals.template_rendered, sender=self, template=self, context=context)
     return self.nodelist.render(context)
     
+class TestSMTPConnection(object):
+    """A substitute SMTP connection for use during test sessions.
+    The test connection stores email messages in a dummy outbox,
+    rather than sending them out on the wire.
+    
+    """
+    def __init__(*args, **kwargs):
+        pass
+    def open(self):
+        "Mock the SMTPConnection open() interface"
+        pass
+    def close(self):
+        "Mock the SMTPConnection close() interface"
+        pass
+    def send_messages(self, messages):
+        "Redirect messages to the dummy outbox"
+        mail.outbox.extend(messages)
+
 def setup_test_environment():
     """Perform any global pre-test setup. This involves:
         
         - Installing the instrumented test renderer
+        - Diverting the email sending functions to a test buffer
         
     """
     Template.original_render = Template.render
     Template.render = instrumented_test_render
     
+    mail.original_SMTPConnection = mail.SMTPConnection
+    mail.SMTPConnection = TestSMTPConnection
+
+    mail.outbox = []
+    
 def teardown_test_environment():
     """Perform any global post-test teardown. This involves:
 
         - Restoring the original test renderer
+        - Restoring the email sending functions
         
     """
     Template.render = Template.original_render
     del Template.original_render
     
+    mail.SMTPConnection = mail.original_SMTPConnection
+    del mail.original_SMTPConnection
+    
+    del mail.outbox
+    
 def _set_autocommit(connection):
     "Make sure a connection is in autocommit mode."
     if hasattr(connection.connection, "autocommit"):