from mock import patch from django.conf import settings from django.core import mail from django.core.exceptions import ImproperlyConfigured from django.test import TestCase from django.utils import simplejson as json from djrill.mail import DjrillMessage class DjrillBackendMockAPITestCase(TestCase): """TestCase that uses Djrill EmailBackend with a mocked Mandrill API""" class MockResponse: """requests.post return value mock sufficient for DjrillBackend""" def __init__(self, status_code=200): self.status_code = status_code def setUp(self): self.patch = patch('requests.post') self.mock_post = self.patch.start() self.mock_post.return_value = self.MockResponse() settings.MANDRILL_API_KEY = "FAKE_API_KEY_FOR_TESTING" settings.MANDRILL_API_URL = "http://mandrillapp.com/api/1.0" # Django TestCase sets up locmem EmailBackend; override it here self.original_email_backend = settings.EMAIL_BACKEND settings.EMAIL_BACKEND = "djrill.mail.backends.djrill.DjrillBackend" def tearDown(self): self.patch.stop() settings.EMAIL_BACKEND = self.original_email_backend def get_api_call_data(self): """Returns the data posted to the Mandrill API. Fails test if API wasn't called. """ if self.mock_post.call_args is None: raise AssertionError("Mandrill API was not called") (args, kwargs) = self.mock_post.call_args if 'data' not in kwargs: raise AssertionError("requests.post was called without data kwarg " "-- Maybe tests need to be updated for backend changes?") return json.loads(kwargs['data']) class DjrillBackendTests(DjrillBackendMockAPITestCase): """Test Djrill's support for Django mail wrappers""" def test_send_mail(self): mail.send_mail('Subject here', 'Here is the message.', 'from@example.com', ['to@example.com'], fail_silently=False) data = self.get_api_call_data() self.assertEqual(data['message']['subject'], "Subject here") self.assertEqual(data['message']['text'], "Here is the message.") self.assertFalse('from_name' in data['message']) self.assertEqual(data['message']['from_email'], "from@example.com") self.assertEqual(len(data['message']['to']), 1) self.assertEqual(data['message']['to'][0]['email'], "to@example.com") def test_missing_api_key(self): del settings.MANDRILL_API_KEY with self.assertRaises(ImproperlyConfigured): mail.send_mail('Subject', 'Message', 'from@example.com', ['to@example.com']) def test_name_addr(self): """Make sure RFC2822 name-addr format (with display-name) is allowed (Test both sender and recipient addresses) """ mail.send_mail('Subject', 'Message', 'From Name ', ['Recipient #1 ', 'to2@example.com']) data = self.get_api_call_data() self.assertEqual(data['message']['from_name'], "From Name") self.assertEqual(data['message']['from_email'], "from@example.com") self.assertEqual(len(data['message']['to']), 2) self.assertEqual(data['message']['to'][0]['name'], "Recipient #1") self.assertEqual(data['message']['to'][0]['email'], "to1@example.com") self.assertEqual(data['message']['to'][1]['name'], "") self.assertEqual(data['message']['to'][1]['email'], "to2@example.com") def test_email_message(self): email = mail.EmailMessage('Subject', 'Body goes here', 'from@example.com', ['to1@example.com', 'Also To '], bcc=['bcc1@example.com', 'Also BCC '], cc=['cc1@example.com', 'Also CC '], headers={'Reply-To': 'another@example.com', 'X-MyHeader': 'my value', 'Errors-To': 'silently stripped'}) email.send() data = self.get_api_call_data() self.assertEqual(data['message']['subject'], "Subject") self.assertEqual(data['message']['text'], "Body goes here") self.assertEqual(data['message']['from_email'], "from@example.com") self.assertEqual(data['message']['headers'], { 'Reply-To': 'another@example.com', 'X-MyHeader': 'my value' }) # Mandrill doesn't have a notion of cc, and only allows a single bcc. # Djrill just treats cc and bcc as though they were "to" addresses, # which may or may not be what you want. self.assertEqual(len(data['message']['to']), 6) self.assertEqual(data['message']['to'][0]['email'], "to1@example.com") self.assertEqual(data['message']['to'][1]['email'], "to2@example.com") self.assertEqual(data['message']['to'][2]['email'], "cc1@example.com") self.assertEqual(data['message']['to'][3]['email'], "cc2@example.com") self.assertEqual(data['message']['to'][4]['email'], "bcc1@example.com") self.assertEqual(data['message']['to'][5]['email'], "bcc2@example.com") def test_html_message(self): text_content = 'This is an important message.' html_content = '

This is an important message.

' email = mail.EmailMultiAlternatives('Subject', text_content, 'from@example.com', ['to@example.com']) email.attach_alternative(html_content, "text/html") email.send() data = self.get_api_call_data() self.assertEqual(data['message']['text'], text_content) self.assertEqual(data['message']['html'], html_content) def test_alternative_errors(self): # Multiple alternatives not allowed email = mail.EmailMultiAlternatives('Subject', 'Body', 'from@example.com', ['to@example.com']) email.attach_alternative("

First html is OK

", "text/html") email.attach_alternative("

But not second html

", "text/html") with self.assertRaises(ValueError): email.send() # Only html alternatives allowed email = mail.EmailMultiAlternatives('Subject', 'Body', 'from@example.com', ['to@example.com']) email.attach_alternative("{'not': 'allowed'}", "application/json") with self.assertRaises(ValueError): email.send() # Make sure fail_silently is respected email = mail.EmailMultiAlternatives('Subject', 'Body', 'from@example.com', ['to@example.com']) email.attach_alternative("{'not': 'allowed'}", "application/json") sent = email.send(fail_silently=True) self.assertFalse(self.mock_post.called, msg="Mandrill API should not be called when send fails silently") self.assertEqual(sent, 0) class DjrillMessageTests(TestCase): def setUp(self): self.subject = "Djrill baby djrill." self.from_name = "Tarzan" self.from_email = "test@example" self.to = ["King Kong ", "Cheetah