mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 11:51:05 -05:00
978996d7b8
Tox: * Add Tox factor for extras (all, none, individual ESP). For now, only break out ESPs that have specific extra dependencies (amazon_ses, sparkpost). * Install most package dependencies (including extras) through the package itself. * Use new runtests.py environment vars to limit test tags when Tox isn't installing all extras. Travis: * Rework matrix to request specific TOXENVs directly; drop tox-travis. Test runner (runtests.py): * Centralize RUN_LIVE_TESTS logic in runtests.py * Add ANYMAIL_ONLY_TEST and ANYMAIL_SKIP_TESTS env vars (comma-separated lists of tags) Test implementations: * Tag all ESP-specific tests with ESP * Tag live tests with "live" * Don't import ESP-specific packages at test module level. (Test discovery imports test modules before tag-based filtering.) Closes #104
162 lines
8.1 KiB
Python
162 lines
8.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
from __future__ import unicode_literals
|
|
|
|
import os
|
|
import unittest
|
|
import warnings
|
|
|
|
from django.test import SimpleTestCase, override_settings, tag
|
|
|
|
from anymail.exceptions import AnymailAPIError
|
|
from anymail.message import AnymailMessage
|
|
|
|
from .utils import AnymailTestMixin, sample_image_path
|
|
|
|
try:
|
|
ResourceWarning
|
|
except NameError:
|
|
ResourceWarning = Warning # Python 2
|
|
|
|
|
|
AMAZON_SES_TEST_ACCESS_KEY_ID = os.getenv("AMAZON_SES_TEST_ACCESS_KEY_ID")
|
|
AMAZON_SES_TEST_SECRET_ACCESS_KEY = os.getenv("AMAZON_SES_TEST_SECRET_ACCESS_KEY")
|
|
AMAZON_SES_TEST_REGION_NAME = os.getenv("AMAZON_SES_TEST_REGION_NAME", "us-east-1")
|
|
|
|
|
|
@unittest.skipUnless(AMAZON_SES_TEST_ACCESS_KEY_ID and AMAZON_SES_TEST_SECRET_ACCESS_KEY,
|
|
"Set AMAZON_SES_TEST_ACCESS_KEY_ID and AMAZON_SES_TEST_SECRET_ACCESS_KEY "
|
|
"environment variables to run Amazon SES integration tests")
|
|
@override_settings(
|
|
EMAIL_BACKEND="anymail.backends.amazon_ses.EmailBackend",
|
|
ANYMAIL={
|
|
"AMAZON_SES_CLIENT_PARAMS": {
|
|
# This setting provides Anymail-specific AWS credentials to boto3.client(),
|
|
# overriding any credentials in the environment or boto config. It's often
|
|
# *not* the best approach -- see the Anymail and boto3 docs for other options.
|
|
"aws_access_key_id": AMAZON_SES_TEST_ACCESS_KEY_ID,
|
|
"aws_secret_access_key": AMAZON_SES_TEST_SECRET_ACCESS_KEY,
|
|
"region_name": AMAZON_SES_TEST_REGION_NAME,
|
|
# Can supply any other boto3.client params, including botocore.config.Config as dict
|
|
"config": {"retries": {"max_attempts": 2}},
|
|
},
|
|
"AMAZON_SES_CONFIGURATION_SET_NAME": "TestConfigurationSet", # actual config set in Anymail test account
|
|
})
|
|
@tag('amazon_ses', 'live')
|
|
class AmazonSESBackendIntegrationTests(SimpleTestCase, AnymailTestMixin):
|
|
"""Amazon SES API integration tests
|
|
|
|
These tests run against the **live** Amazon SES API, using the environment
|
|
variables `AMAZON_SES_TEST_ACCESS_KEY_ID` and `AMAZON_SES_TEST_SECRET_ACCESS_KEY`
|
|
as AWS credentials. If those variables are not set, these tests won't run.
|
|
(You can also set the environment variable `AMAZON_SES_TEST_REGION_NAME`
|
|
to test SES using a region other than the default "us-east-1".)
|
|
|
|
Amazon SES doesn't offer a test mode -- it tries to send everything you ask.
|
|
To avoid stacking up a pile of undeliverable @example.com
|
|
emails, the tests use Amazon's @simulator.amazonses.com addresses.
|
|
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mailbox-simulator.html
|
|
|
|
Amazon SES also doesn't support arbitrary senders (so no from@example.com).
|
|
We've set up @test-ses.anymail.info as a validated sending domain for these tests.
|
|
You may need to change the from_email to your own address when testing.
|
|
|
|
"""
|
|
|
|
def setUp(self):
|
|
super(AmazonSESBackendIntegrationTests, self).setUp()
|
|
self.message = AnymailMessage('Anymail Amazon SES integration test', 'Text content',
|
|
'test@test-ses.anymail.info', ['success@simulator.amazonses.com'])
|
|
self.message.attach_alternative('<p>HTML content</p>', "text/html")
|
|
|
|
# boto3 relies on GC to close connections. Python 3 warns about unclosed ssl.SSLSocket during cleanup.
|
|
# We don't care. (It might not be a real problem worth warning, but in any case it's not our problem.)
|
|
# https://www.google.com/search?q=unittest+boto3+ResourceWarning+unclosed+ssl.SSLSocket
|
|
# Filter in TestCase.setUp because unittest resets the warning filters for each test.
|
|
# https://stackoverflow.com/a/26620811/647002
|
|
warnings.filterwarnings("ignore", message=r"unclosed <ssl\.SSLSocket", category=ResourceWarning)
|
|
|
|
def test_simple_send(self):
|
|
# Example of getting the Amazon SES send status and message id from the message
|
|
sent_count = self.message.send()
|
|
self.assertEqual(sent_count, 1)
|
|
|
|
anymail_status = self.message.anymail_status
|
|
sent_status = anymail_status.recipients['success@simulator.amazonses.com'].status
|
|
message_id = anymail_status.recipients['success@simulator.amazonses.com'].message_id
|
|
|
|
self.assertEqual(sent_status, 'queued') # Amazon SES always queues (or raises an error)
|
|
self.assertRegex(message_id, r'[0-9a-f-]+') # Amazon SES message ids are groups of hex chars
|
|
self.assertEqual(anymail_status.status, {sent_status}) # set of all recipient statuses
|
|
self.assertEqual(anymail_status.message_id, message_id)
|
|
|
|
def test_all_options(self):
|
|
message = AnymailMessage(
|
|
subject="Anymail Amazon SES all-options integration test",
|
|
body="This is the text body",
|
|
from_email='"Test From" <test@test-ses.anymail.info>',
|
|
to=["success+to1@simulator.amazonses.com", "Recipient 2 <success+to2@simulator.amazonses.com>"],
|
|
cc=["success+cc1@simulator.amazonses.com", "Copy 2 <success+cc2@simulator.amazonses.com>"],
|
|
bcc=["success+bcc1@simulator.amazonses.com", "Blind Copy 2 <success+bcc2@simulator.amazonses.com>"],
|
|
reply_to=["reply1@example.com", "Reply 2 <reply2@example.com>"],
|
|
headers={"X-Anymail-Test": "value"},
|
|
metadata={"meta1": "simple_string", "meta2": 2},
|
|
tags=["Re-engagement", "Cohort 12/2017"],
|
|
)
|
|
message.attach("attachment1.txt", "Here is some\ntext for you", "text/plain")
|
|
message.attach("attachment2.csv", "ID,Name\n1,Amy Lina", "text/csv")
|
|
cid = message.attach_inline_image_file(sample_image_path())
|
|
message.attach_alternative(
|
|
"<p><b>HTML:</b> with <a href='http://example.com'>link</a>"
|
|
"and image: <img src='cid:%s'></div>" % cid,
|
|
"text/html")
|
|
|
|
message.attach_alternative(
|
|
"Amazon SES SendRawEmail actually supports multiple alternative parts",
|
|
"text/x-note-for-email-geeks")
|
|
|
|
message.send()
|
|
self.assertEqual(message.anymail_status.status, {'queued'})
|
|
|
|
def test_stored_template(self):
|
|
# Using a template created like this:
|
|
# boto3.client('ses').create_template(Template={
|
|
# "TemplateName": "TestTemplate",
|
|
# "SubjectPart": "Your order {{order}} shipped",
|
|
# "HtmlPart": "<h1>Dear {{name}}:</h1><p>Your order {{order}} shipped {{ship_date}}.</p>",
|
|
# "TextPart": "Dear {{name}}:\r\nYour order {{order}} shipped {{ship_date}}."
|
|
# })
|
|
message = AnymailMessage(
|
|
template_id='TestTemplate',
|
|
from_email='"Test From" <test@test-ses.anymail.info>',
|
|
to=["First Recipient <success+to1@simulator.amazonses.com>",
|
|
"success+to2@simulator.amazonses.com"],
|
|
merge_data={
|
|
'success+to1@simulator.amazonses.com': {'order': 12345, 'name': "Test Recipient"},
|
|
'success+to2@simulator.amazonses.com': {'order': 6789},
|
|
},
|
|
merge_global_data={
|
|
'name': "Customer", # default
|
|
'ship_date': "today"
|
|
},
|
|
)
|
|
message.send()
|
|
recipient_status = message.anymail_status.recipients
|
|
self.assertEqual(recipient_status['success+to1@simulator.amazonses.com'].status, 'queued')
|
|
self.assertRegex(recipient_status['success+to1@simulator.amazonses.com'].message_id, r'[0-9a-f-]+')
|
|
self.assertEqual(recipient_status['success+to2@simulator.amazonses.com'].status, 'queued')
|
|
self.assertRegex(recipient_status['success+to2@simulator.amazonses.com'].message_id, r'[0-9a-f-]+')
|
|
|
|
@override_settings(ANYMAIL={
|
|
"AMAZON_SES_CLIENT_PARAMS": {
|
|
"aws_access_key_id": "test-invalid-access-key-id",
|
|
"aws_secret_access_key": "test-invalid-secret-access-key",
|
|
"region_name": AMAZON_SES_TEST_REGION_NAME,
|
|
}
|
|
})
|
|
def test_invalid_aws_credentials(self):
|
|
with self.assertRaises(AnymailAPIError) as cm:
|
|
self.message.send()
|
|
err = cm.exception
|
|
# Make sure the exception message includes AWS's response:
|
|
self.assertIn("The security token included in the request is invalid", str(err))
|