mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-21 04:11:06 -05:00
Tests: break apart tests.py into tests directory
This commit is contained in:
medmunds
3
djrill/tests/__init__.py
Normal file
3
djrill/tests/__init__.py
Normal file
@@ -0,0 +1,3 @@
|
||||
from test_admin import *
|
||||
from test_legacy import *
|
||||
from test_mandrill_send import *
|
||||
16
djrill/tests/admin_urls.py
Normal file
16
djrill/tests/admin_urls.py
Normal file
@@ -0,0 +1,16 @@
|
||||
try:
|
||||
from django.conf.urls import include, patterns, url
|
||||
except ImportError:
|
||||
# Django 1.3
|
||||
from django.conf.urls.defaults import include, patterns, url
|
||||
|
||||
from django.contrib import admin
|
||||
|
||||
from djrill import DjrillAdminSite
|
||||
|
||||
admin.site = DjrillAdminSite()
|
||||
admin.autodiscover()
|
||||
|
||||
urlpatterns = patterns('',
|
||||
url(r'^admin/', include(admin.site.urls)),
|
||||
)
|
||||
44
djrill/tests/mock_backend.py
Normal file
44
djrill/tests/mock_backend.py
Normal file
@@ -0,0 +1,44 @@
|
||||
from mock import patch
|
||||
|
||||
from django.conf import settings
|
||||
from django.test import TestCase
|
||||
from django.utils import simplejson as json
|
||||
|
||||
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, content="{}"):
|
||||
self.status_code = status_code
|
||||
self.content = content
|
||||
|
||||
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"
|
||||
|
||||
# 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'])
|
||||
|
||||
|
||||
72
djrill/tests/test_admin.py
Normal file
72
djrill/tests/test_admin.py
Normal file
@@ -0,0 +1,72 @@
|
||||
import sys
|
||||
|
||||
from django.test import TestCase
|
||||
from django.contrib.auth.models import User
|
||||
from django.contrib import admin
|
||||
|
||||
from djrill.tests.mock_backend import DjrillBackendMockAPITestCase
|
||||
|
||||
|
||||
def reset_admin_site():
|
||||
"""Return the Django admin globals to their original state"""
|
||||
admin.site = admin.AdminSite() # restore default
|
||||
if 'djrill.admin' in sys.modules:
|
||||
del sys.modules['djrill.admin'] # force autodiscover to re-import
|
||||
|
||||
|
||||
class DjrillAdminTests(DjrillBackendMockAPITestCase):
|
||||
"""Test the Djrill admin site"""
|
||||
|
||||
# These tests currently just verify that the admin site pages load
|
||||
# without error -- they don't test any Mandrill-supplied content.
|
||||
# (Future improvements could mock the Mandrill responses.)
|
||||
|
||||
# These urls set up the DjrillAdminSite as suggested in the readme
|
||||
urls = 'djrill.tests.admin_urls'
|
||||
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
# Other test cases may muck with the Django admin site globals,
|
||||
# so return it to the default state before loading test_admin_urls
|
||||
reset_admin_site()
|
||||
|
||||
def setUp(self):
|
||||
super(DjrillAdminTests, self).setUp()
|
||||
# Must be authenticated staff to access admin site...
|
||||
admin = User.objects.create_user('admin', 'admin@example.com', 'secret')
|
||||
admin.is_staff = True
|
||||
admin.save()
|
||||
self.client.login(username='admin', password='secret')
|
||||
|
||||
def test_admin_senders(self):
|
||||
response = self.client.get('/admin/djrill/senders/')
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, "Senders")
|
||||
|
||||
def test_admin_status(self):
|
||||
response = self.client.get('/admin/djrill/status/')
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, "Status")
|
||||
|
||||
def test_admin_tags(self):
|
||||
response = self.client.get('/admin/djrill/tags/')
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, "Tags")
|
||||
|
||||
def test_admin_urls(self):
|
||||
response = self.client.get('/admin/djrill/urls/')
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, "URLs")
|
||||
|
||||
def test_admin_index(self):
|
||||
"""Make sure Djrill section is included in the admin index page"""
|
||||
response = self.client.get('/admin/')
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, "Djrill")
|
||||
|
||||
|
||||
class DjrillNoAdminTests(TestCase):
|
||||
def test_admin_autodiscover_without_djrill(self):
|
||||
"""Make sure autodiscover doesn't die without DjrillAdminSite"""
|
||||
reset_admin_site()
|
||||
admin.autodiscover() # test: this shouldn't error
|
||||
74
djrill/tests/test_legacy.py
Normal file
74
djrill/tests/test_legacy.py
Normal file
@@ -0,0 +1,74 @@
|
||||
# Tests deprecated Djrill features
|
||||
|
||||
from django.test import TestCase
|
||||
|
||||
from djrill.mail import DjrillMessage
|
||||
|
||||
|
||||
class DjrillMessageTests(TestCase):
|
||||
"""Test the DjrillMessage class (deprecated as of Djrill v0.2.0)
|
||||
|
||||
Maintained for compatibility with older code.
|
||||
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
self.subject = "Djrill baby djrill."
|
||||
self.from_name = "Tarzan"
|
||||
self.from_email = "test@example"
|
||||
self.to = ["King Kong <kingkong@example.com>",
|
||||
"Cheetah <cheetah@example.com", "bubbles@example.com"]
|
||||
self.text_content = "Wonderful fallback text content."
|
||||
self.html_content = "<h1>That's a nice HTML email right there.</h1>"
|
||||
self.headers = {"Reply-To": "tarzan@example.com"}
|
||||
self.tags = ["track", "this"]
|
||||
|
||||
def test_djrill_message_success(self):
|
||||
msg = DjrillMessage(self.subject, self.text_content, self.from_email,
|
||||
self.to, tags=self.tags, headers=self.headers,
|
||||
from_name=self.from_name)
|
||||
|
||||
self.assertIsInstance(msg, DjrillMessage)
|
||||
self.assertEqual(msg.body, self.text_content)
|
||||
self.assertEqual(msg.recipients(), self.to)
|
||||
self.assertEqual(msg.tags, self.tags)
|
||||
self.assertEqual(msg.extra_headers, self.headers)
|
||||
self.assertEqual(msg.from_name, self.from_name)
|
||||
|
||||
def test_djrill_message_html_success(self):
|
||||
msg = DjrillMessage(self.subject, self.text_content, self.from_email,
|
||||
self.to, tags=self.tags)
|
||||
msg.attach_alternative(self.html_content, "text/html")
|
||||
|
||||
self.assertEqual(msg.alternatives[0][0], self.html_content)
|
||||
|
||||
def test_djrill_message_tag_failure(self):
|
||||
with self.assertRaises(ValueError):
|
||||
DjrillMessage(self.subject, self.text_content, self.from_email,
|
||||
self.to, tags=["_fail"])
|
||||
|
||||
def test_djrill_message_tag_skip(self):
|
||||
"""
|
||||
Test that tags over 50 chars are not included in the tags list.
|
||||
"""
|
||||
tags = ["works", "awesomesauce",
|
||||
"iwilltestmycodeiwilltestmycodeiwilltestmycodeiwilltestmycode"]
|
||||
msg = DjrillMessage(self.subject, self.text_content, self.from_email,
|
||||
self.to, tags=tags)
|
||||
|
||||
self.assertIsInstance(msg, DjrillMessage)
|
||||
self.assertIn(tags[0], msg.tags)
|
||||
self.assertIn(tags[1], msg.tags)
|
||||
self.assertNotIn(tags[2], msg.tags)
|
||||
|
||||
def test_djrill_message_no_options(self):
|
||||
"""DjrillMessage with only basic EmailMessage options should work"""
|
||||
msg = DjrillMessage(self.subject, self.text_content,
|
||||
self.from_email, self.to) # no Mandrill-specific options
|
||||
|
||||
self.assertIsInstance(msg, DjrillMessage)
|
||||
self.assertEqual(msg.body, self.text_content)
|
||||
self.assertEqual(msg.recipients(), self.to)
|
||||
self.assertFalse(hasattr(msg, 'tags'))
|
||||
self.assertFalse(hasattr(msg, 'from_name'))
|
||||
self.assertFalse(hasattr(msg, 'preserve_recipients'))
|
||||
252
djrill/tests/test_mandrill_send.py
Normal file
252
djrill/tests/test_mandrill_send.py
Normal file
@@ -0,0 +1,252 @@
|
||||
from django.conf import settings
|
||||
from django.core import mail
|
||||
from django.core.exceptions import ImproperlyConfigured
|
||||
|
||||
from djrill.mail.backends.djrill import DjrillBackendHTTPError
|
||||
from djrill.tests.mock_backend import DjrillBackendMockAPITestCase
|
||||
|
||||
|
||||
class DjrillBackendTests(DjrillBackendMockAPITestCase):
|
||||
"""Test Djrill backend 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 <from@example.com>',
|
||||
['Recipient #1 <to1@example.com>', '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 <to2@example.com>'],
|
||||
bcc=['bcc1@example.com', 'Also BCC <bcc2@example.com>'],
|
||||
cc=['cc1@example.com', 'Also CC <cc2@example.com>'],
|
||||
headers={'Reply-To': 'another@example.com',
|
||||
'X-MyHeader': 'my value'})
|
||||
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 = '<p>This is an <strong>important</strong> message.</p>'
|
||||
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_extra_header_errors(self):
|
||||
email = mail.EmailMessage('Subject', 'Body', 'from@example.com',
|
||||
['to@example.com'],
|
||||
headers={'Non-X-Non-Reply-To-Header': 'not permitted'})
|
||||
with self.assertRaises(ValueError):
|
||||
email.send()
|
||||
|
||||
# Make sure fail_silently is respected
|
||||
email = mail.EmailMessage('Subject', 'Body', 'from@example.com',
|
||||
['to@example.com'],
|
||||
headers={'Non-X-Non-Reply-To-Header': 'not permitted'})
|
||||
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)
|
||||
|
||||
def test_alternative_errors(self):
|
||||
# Multiple alternatives not allowed
|
||||
email = mail.EmailMultiAlternatives('Subject', 'Body',
|
||||
'from@example.com', ['to@example.com'])
|
||||
email.attach_alternative("<p>First html is OK</p>", "text/html")
|
||||
email.attach_alternative("<p>But not second html</p>", "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)
|
||||
|
||||
def test_mandrill_api_failure(self):
|
||||
self.mock_post.return_value = self.MockResponse(status_code=400)
|
||||
with self.assertRaises(DjrillBackendHTTPError):
|
||||
sent = mail.send_mail('Subject', 'Body', 'from@example.com',
|
||||
['to@example.com'])
|
||||
self.assertEqual(sent, 0)
|
||||
|
||||
# Make sure fail_silently is respected
|
||||
self.mock_post.return_value = self.MockResponse(status_code=400)
|
||||
sent = mail.send_mail('Subject', 'Body', 'from@example.com',
|
||||
['to@example.com'], fail_silently=True)
|
||||
self.assertEqual(sent, 0)
|
||||
|
||||
|
||||
class DjrillMandrillFeatureTests(DjrillBackendMockAPITestCase):
|
||||
"""Test Djrill backend support for Mandrill-specific features"""
|
||||
|
||||
def setUp(self):
|
||||
super(DjrillMandrillFeatureTests, self).setUp()
|
||||
self.message = mail.EmailMessage('Subject', 'Text Body',
|
||||
'from@example.com', ['to@example.com'])
|
||||
|
||||
def test_tracking(self):
|
||||
# First make sure we're not setting the API param if the track_click
|
||||
# attr isn't there. (The Mandrill account option of True for html,
|
||||
# False for plaintext can't be communicated through the API, other than
|
||||
# by omitting the track_clicks API param to use your account default.)
|
||||
self.message.send()
|
||||
data = self.get_api_call_data()
|
||||
self.assertFalse('track_clicks' in data['message'])
|
||||
# Now re-send with the params set
|
||||
self.message.track_opens = True
|
||||
self.message.track_clicks = True
|
||||
self.message.url_strip_qs = True
|
||||
self.message.send()
|
||||
data = self.get_api_call_data()
|
||||
self.assertEqual(data['message']['track_opens'], True)
|
||||
self.assertEqual(data['message']['track_clicks'], True)
|
||||
self.assertEqual(data['message']['url_strip_qs'], True)
|
||||
|
||||
def test_message_options(self):
|
||||
self.message.auto_text = True
|
||||
self.message.preserve_recipients = True
|
||||
self.message.send()
|
||||
data = self.get_api_call_data()
|
||||
self.assertEqual(data['message']['auto_text'], True)
|
||||
self.assertEqual(data['message']['preserve_recipients'], True)
|
||||
|
||||
def test_merge(self):
|
||||
# Djrill expands simple python dicts into the more-verbose name/value
|
||||
# structures the Mandrill API uses
|
||||
self.message.global_merge_vars = { 'GREETING': "Hello",
|
||||
'ACCOUNT_TYPE': "Basic" }
|
||||
self.message.merge_vars = {
|
||||
"customer@example.com": { 'GREETING': "Dear Customer",
|
||||
'ACCOUNT_TYPE': "Premium" },
|
||||
"guest@example.com": { 'GREETING': "Dear Guest" },
|
||||
}
|
||||
self.message.send()
|
||||
data = self.get_api_call_data()
|
||||
self.assertEqual(data['message']['global_merge_vars'],
|
||||
[ {'name': 'ACCOUNT_TYPE', 'value': "Basic"},
|
||||
{'name': "GREETING", 'value': "Hello"} ])
|
||||
self.assertEqual(data['message']['merge_vars'],
|
||||
[ { 'rcpt': "customer@example.com",
|
||||
'vars': [{ 'name': 'ACCOUNT_TYPE', 'value': "Premium" },
|
||||
{ 'name': "GREETING", 'value': "Dear Customer"}] },
|
||||
{ 'rcpt': "guest@example.com",
|
||||
'vars': [{ 'name': "GREETING", 'value': "Dear Guest"}] }
|
||||
])
|
||||
|
||||
def test_tags(self):
|
||||
self.message.tags = ["receipt", "repeat-user"]
|
||||
self.message.send()
|
||||
data = self.get_api_call_data()
|
||||
self.assertEqual(data['message']['tags'], ["receipt", "repeat-user"])
|
||||
|
||||
def test_google_analytics(self):
|
||||
self.message.google_analytics_domains = ["example.com"]
|
||||
self.message.google_analytics_campaign = "Email Receipts"
|
||||
self.message.send()
|
||||
data = self.get_api_call_data()
|
||||
self.assertEqual(data['message']['google_analytics_domains'],
|
||||
["example.com"])
|
||||
self.assertEqual(data['message']['google_analytics_campaign'],
|
||||
"Email Receipts")
|
||||
|
||||
def test_metadata(self):
|
||||
self.message.metadata = { 'batch_num': "12345", 'type': "Receipts" }
|
||||
self.message.recipient_metadata = {
|
||||
# Djrill expands simple python dicts into the more-verbose
|
||||
# name/value structures the Mandrill API uses
|
||||
"customer@example.com": { 'cust_id': "67890", 'order_id': "54321" },
|
||||
"guest@example.com": { 'cust_id': "94107", 'order_id': "43215" }
|
||||
}
|
||||
self.message.send()
|
||||
data = self.get_api_call_data()
|
||||
self.assertEqual(data['message']['metadata'], { 'batch_num': "12345",
|
||||
'type': "Receipts" })
|
||||
self.assertEqual(data['message']['recipient_metadata'],
|
||||
[ { 'rcpt': "customer@example.com",
|
||||
'values': { 'cust_id': "67890", 'order_id': "54321" } },
|
||||
{ 'rcpt': "guest@example.com",
|
||||
'values': { 'cust_id': "94107", 'order_id': "43215" } }
|
||||
])
|
||||
|
||||
def test_default_omits_options(self):
|
||||
"""Make sure by default we don't send any Mandrill-specific options.
|
||||
|
||||
Options not specified by the caller should be omitted entirely from
|
||||
the Mandrill API call (*not* sent as False or empty). This ensures
|
||||
that your Mandrill account settings apply by default.
|
||||
"""
|
||||
self.message.send()
|
||||
data = self.get_api_call_data()
|
||||
self.assertFalse('from_name' in data['message'])
|
||||
self.assertFalse('track_opens' in data['message'])
|
||||
self.assertFalse('track_clicks' in data['message'])
|
||||
self.assertFalse('auto_text' in data['message'])
|
||||
self.assertFalse('url_strip_qs' in data['message'])
|
||||
self.assertFalse('tags' in data['message'])
|
||||
self.assertFalse('preserve_recipients' in data['message'])
|
||||
self.assertFalse('google_analytics_domains' in data['message'])
|
||||
self.assertFalse('google_analytics_campaign' in data['message'])
|
||||
self.assertFalse('metadata' in data['message'])
|
||||
self.assertFalse('global_merge_vars' in data['message'])
|
||||
self.assertFalse('merge_vars' in data['message'])
|
||||
self.assertFalse('recipient_metadata' in data['message'])
|
||||
|
||||
|
||||
Reference in New Issue
Block a user