from __future__ import unicode_literals import os import unittest from datetime import datetime, timedelta from django.core.mail import send_mail from django.test import SimpleTestCase from django.test.utils import override_settings from anymail.exceptions import AnymailAPIError from anymail.message import AnymailMessage from .utils import AnymailTestMixin, sample_image_path # For API_KEY auth tests: SENDGRID_TEST_API_KEY = os.getenv('SENDGRID_TEST_API_KEY') # For USERNAME/PASSWORD auth tests: SENDGRID_TEST_USERNAME = os.getenv('SENDGRID_TEST_USERNAME') SENDGRID_TEST_PASSWORD = os.getenv('SENDGRID_TEST_PASSWORD') @unittest.skipUnless(SENDGRID_TEST_API_KEY, "Set SENDGRID_TEST_API_KEY environment variable " "to run SendGrid integration tests") @override_settings(ANYMAIL_SENDGRID_API_KEY=SENDGRID_TEST_API_KEY, EMAIL_BACKEND="anymail.backends.sendgrid.SendGridBackend") class SendGridBackendIntegrationTests(SimpleTestCase, AnymailTestMixin): """SendGrid API integration tests These tests run against the **live** SendGrid API, using the environment variable `SENDGRID_TEST_API_KEY` as the API key If those variables are not set, these tests won't run. SendGrid 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 SendGrid's "sink domain" @sink.sendgrid.net. https://support.sendgrid.com/hc/en-us/articles/201995663-Safely-Test-Your-Sending-Speed """ def setUp(self): super(SendGridBackendIntegrationTests, self).setUp() self.message = AnymailMessage('Anymail SendGrid integration test', 'Text content', 'from@example.com', ['to@sink.sendgrid.net']) self.message.attach_alternative('

HTML content

', "text/html") def test_simple_send(self): # Example of getting the SendGrid 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['to@sink.sendgrid.net'].status message_id = anymail_status.recipients['to@sink.sendgrid.net'].message_id self.assertEqual(sent_status, 'queued') # SendGrid always queues self.assertRegex(message_id, r'\<.+@example\.com\>') # should use from_email's domain 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): send_at = datetime.now().replace(microsecond=0) + timedelta(minutes=2) message = AnymailMessage( subject="Anymail all-options integration test FILES", body="This is the text body", from_email="Test From ", to=["to1@sink.sendgrid.net", "Recipient 2 "], cc=["cc1@sink.sendgrid.net", "Copy 2 "], bcc=["bcc1@sink.sendgrid.net", "Blind Copy 2 "], 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", "tag 2"], 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() self.assertEqual(message.anymail_status.status, {'queued'}) # SendGrid always queues def test_merge_data(self): message = AnymailMessage( subject="Anymail merge_data test: %value%", body="This body includes merge data: %value%", from_email="Test From ", to=["to1@sink.sendgrid.net", "Recipient 2 "], merge_data={ 'to1@sink.sendgrid.net': {'value': 'one'}, 'to2@sink.sendgrid.net': {'value': 'two'}, }, esp_extra={ 'merge_field_format': '%{}%', }, ) message.send() recipient_status = message.anymail_status.recipients self.assertEqual(recipient_status['to1@sink.sendgrid.net'].status, 'queued') self.assertEqual(recipient_status['to2@sink.sendgrid.net'].status, 'queued') @override_settings(ANYMAIL_SENDGRID_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, 400) # Make sure the exception message includes SendGrid's response: self.assertIn("authorization grant is invalid", str(err)) @unittest.skipUnless(SENDGRID_TEST_USERNAME and SENDGRID_TEST_PASSWORD, "Set SENDGRID_TEST_USERNAME and SENDGRID_TEST_PASSWORD" "environment variables to run SendGrid integration tests") @override_settings(ANYMAIL_SENDGRID_USERNAME=SENDGRID_TEST_USERNAME, ANYMAIL_SENDGRID_PASSWORD=SENDGRID_TEST_PASSWORD, EMAIL_BACKEND="anymail.backends.sendgrid.SendGridBackend") class SendGridBackendUserPassIntegrationTests(SimpleTestCase, AnymailTestMixin): """SendGrid username/password API integration tests (See notes above for the API-key tests) """ def test_valid_auth(self): sent_count = send_mail('Anymail SendGrid username/password integration test', 'Text content', 'from@example.com', ['to@sink.sendgrid.net']) self.assertEqual(sent_count, 1) @override_settings(ANYMAIL_SENDGRID_PASSWORD="Hey, this isn't the password!") def test_invalid_auth(self): with self.assertRaises(AnymailAPIError) as cm: send_mail('Anymail SendGrid username/password integration test', 'Text content', 'from@example.com', ['to@sink.sendgrid.net']) err = cm.exception self.assertEqual(err.status_code, 400) # Make sure the exception message includes SendGrid's response: self.assertIn("Bad username / password", str(err))