import os import unittest from datetime import datetime, timedelta from email.utils import formataddr 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 ANYMAIL_TEST_SPARKPOST_API_KEY = os.getenv("ANYMAIL_TEST_SPARKPOST_API_KEY") ANYMAIL_TEST_SPARKPOST_DOMAIN = os.getenv("ANYMAIL_TEST_SPARKPOST_DOMAIN") @tag("sparkpost", "live") @unittest.skipUnless( ANYMAIL_TEST_SPARKPOST_API_KEY and ANYMAIL_TEST_SPARKPOST_DOMAIN, "Set ANYMAIL_TEST_SPARKPOST_API_KEY and ANYMAIL_TEST_SPARKPOST_DOMAIN " "environment variables to run SparkPost integration tests", ) @override_settings( ANYMAIL_SPARKPOST_API_KEY=ANYMAIL_TEST_SPARKPOST_API_KEY, EMAIL_BACKEND="anymail.backends.sparkpost.EmailBackend", ) class SparkPostBackendIntegrationTests(AnymailTestMixin, SimpleTestCase): """SparkPost API integration tests These tests run against the **live** SparkPost API, using the environment variable `ANYMAIL_TEST_SPARKPOST_API_KEY` as the API key If that variable is not set, these tests won't run. SparkPost 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 SparkPost's "sink domain" @*.sink.sparkpostmail.com. https://www.sparkpost.com/docs/faq/using-sink-server/ """ def setUp(self): super().setUp() self.from_email = "test@%s" % ANYMAIL_TEST_SPARKPOST_DOMAIN self.message = AnymailMessage( "Anymail SparkPost integration test", "Text content", self.from_email, ["to@test.sink.sparkpostmail.com"], ) self.message.attach_alternative("

HTML content

", "text/html") def test_simple_send(self): # Example of getting the SparkPost send status # and transmission 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["to@test.sink.sparkpostmail.com"].status message_id = anymail_status.recipients[ "to@test.sink.sparkpostmail.com" ].message_id self.assertEqual(sent_status, "queued") # SparkPost always queues # this is actually the transmission_id; should be non-blank: self.assertRegex(message_id, r".+") # set of all recipient statuses: self.assertEqual(anymail_status.status, {sent_status}) self.assertEqual(anymail_status.message_id, message_id) def test_all_options(self): send_at = datetime.now() + timedelta(minutes=2) message = AnymailMessage( subject="Anymail all-options integration test", body="This is the text body", from_email=formataddr(("Test From, with comma", self.from_email)), to=[ "to1@test.sink.sparkpostmail.com", "Recipient 2 ", ], # Limit the live b/cc's to avoid running through our small monthly # allowance: cc=["Copy To "], reply_to=["reply1@example.com", "Reply 2 "], headers={"X-Anymail-Test": "value"}, metadata={"meta1": "simple string", "meta2": 2}, send_at=send_at, tags=["tag 1"], # SparkPost only supports single tags track_clicks=True, track_opens=True, ) 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( "

HTML: with link" "and image: " % cid, "text/html", ) message.send() # SparkPost always queues: self.assertEqual(message.anymail_status.status, {"queued"}) def test_merge_data(self): message = AnymailMessage( subject="Anymail merge_data test: {{ value }}", body="This body includes merge data: {{ value }}\n" "And global merge data: {{ global }}", from_email=formataddr(("Test From", self.from_email)), to=[ "to1@test.sink.sparkpostmail.com", "Recipient 2 ", ], merge_data={ "to1@test.sink.sparkpostmail.com": {"value": "one"}, "to2@test.sink.sparkpostmail.com": {"value": "two"}, }, merge_global_data={"global": "global_value"}, merge_metadata={ "to1@test.sink.sparkpostmail.com": {"meta1": "one"}, "to2@test.sink.sparkpostmail.com": {"meta1": "two"}, }, headers={ "X-Custom": "custom header default", }, merge_headers={ # (Note that SparkPost doesn't support custom List-Unsubscribe headers) "to1@test.sink.sparkpostmail.com": { "X-Custom": "custom header one", }, }, ) message.send() recipient_status = message.anymail_status.recipients self.assertEqual( recipient_status["to1@test.sink.sparkpostmail.com"].status, "queued" ) self.assertEqual( recipient_status["to2@test.sink.sparkpostmail.com"].status, "queued" ) def test_stored_template(self): message = AnymailMessage( # a real template in our SparkPost test account: template_id="test-template", to=["to1@test.sink.sparkpostmail.com"], merge_data={ "to1@test.sink.sparkpostmail.com": { "name": "Test Recipient", } }, merge_global_data={ "order": "12345", }, ) message.from_email = None # from_email must come from stored template message.send() recipient_status = message.anymail_status.recipients self.assertEqual( recipient_status["to1@test.sink.sparkpostmail.com"].status, "queued" ) @override_settings(ANYMAIL_SPARKPOST_API_KEY="Hey, that's not an API key!") def test_invalid_api_key(self): with self.assertRaises(AnymailAPIError) as cm: self.message.send() err = cm.exception self.assertEqual(err.status_code, 401) # Make sure the exception message includes SparkPost's response: self.assertIn("Unauthorized", str(err))