From 02e6daf9d4f74c93b440db6e83362457b7f6d70d Mon Sep 17 00:00:00 2001 From: medmunds Date: Wed, 30 May 2018 16:02:21 -0700 Subject: [PATCH] SendGrid: drop deprecated sendgrid_v2 EmailBackend --- anymail/backends/sendgrid.py | 6 +- anymail/backends/sendgrid_v2.py | 301 ------------ docs/esps/sendgrid.rst | 190 +------- tests/test_sendgrid_backend.py | 11 +- tests/test_sendgrid_v2_backend.py | 630 -------------------------- tests/test_sendgrid_v2_integration.py | 146 ------ 6 files changed, 12 insertions(+), 1272 deletions(-) delete mode 100644 anymail/backends/sendgrid_v2.py delete mode 100644 tests/test_sendgrid_v2_backend.py delete mode 100644 tests/test_sendgrid_v2_integration.py diff --git a/anymail/backends/sendgrid.py b/anymail/backends/sendgrid.py index 4ab3cab..34e31f1 100644 --- a/anymail/backends/sendgrid.py +++ b/anymail/backends/sendgrid.py @@ -26,8 +26,7 @@ class EmailBackend(AnymailRequestsBackend): password = get_anymail_setting('password', esp_name=esp_name, kwargs=kwargs, default=None, allow_bare=True) if username or password: raise AnymailConfigurationError( - "SendGrid v3 API doesn't support username/password auth; Please change to API key.\n" - "(For legacy v2 API, use anymail.backends.sendgrid_v2.EmailBackend.)") + "SendGrid v3 API doesn't support username/password auth; Please change to API key.") self.api_key = get_anymail_setting('api_key', esp_name=esp_name, kwargs=kwargs, allow_bare=True) @@ -307,7 +306,6 @@ class SendGridPayload(RequestsPayload): if "x-smtpapi" in extra: raise AnymailConfigurationError( "You are attempting to use SendGrid v2 API-style x-smtpapi params " - "with the SendGrid v3 API. Please update your `esp_extra` to the new API, " - "or use 'anymail.backends.sendgrid_v2.EmailBackend' for the old API." + "with the SendGrid v3 API. Please update your `esp_extra` to the new API." ) update_deep(self.data, extra) diff --git a/anymail/backends/sendgrid_v2.py b/anymail/backends/sendgrid_v2.py deleted file mode 100644 index beff5d6..0000000 --- a/anymail/backends/sendgrid_v2.py +++ /dev/null @@ -1,301 +0,0 @@ -import uuid -import warnings - -from requests.structures import CaseInsensitiveDict - -from ..exceptions import AnymailConfigurationError, AnymailRequestsAPIError, AnymailWarning -from ..message import AnymailRecipientStatus -from ..utils import BASIC_NUMERIC_TYPES, get_anymail_setting, timestamp - -from .base_requests import AnymailRequestsBackend, RequestsPayload - - -class EmailBackend(AnymailRequestsBackend): - """ - SendGrid v2 API Email Backend (deprecated) - """ - - esp_name = "SendGrid" - - def __init__(self, **kwargs): - """Init options from Django settings""" - # Auth requires *either* SENDGRID_API_KEY or SENDGRID_USERNAME+SENDGRID_PASSWORD - esp_name = self.esp_name - self.api_key = get_anymail_setting('api_key', esp_name=esp_name, kwargs=kwargs, - default=None, allow_bare=True) - self.username = get_anymail_setting('username', esp_name=esp_name, kwargs=kwargs, - default=None, allow_bare=True) - self.password = get_anymail_setting('password', esp_name=esp_name, kwargs=kwargs, - default=None, allow_bare=True) - if self.api_key is None and (self.username is None or self.password is None): - raise AnymailConfigurationError( - "You must set either SENDGRID_API_KEY or both SENDGRID_USERNAME and " - "SENDGRID_PASSWORD in your Django ANYMAIL settings." - ) - - self.generate_message_id = get_anymail_setting('generate_message_id', esp_name=esp_name, - kwargs=kwargs, default=True) - self.merge_field_format = get_anymail_setting('merge_field_format', esp_name=esp_name, - kwargs=kwargs, default=None) - - # This is SendGrid's older Web API v2 - api_url = get_anymail_setting('api_url', esp_name=esp_name, kwargs=kwargs, - default="https://api.sendgrid.com/api/") - if not api_url.endswith("/"): - api_url += "/" - super(EmailBackend, self).__init__(api_url, **kwargs) - - def build_message_payload(self, message, defaults): - return SendGridPayload(message, defaults, self) - - def parse_recipient_status(self, response, payload, message): - parsed_response = self.deserialize_json_response(response, payload, message) - try: - sendgrid_message = parsed_response["message"] - except (KeyError, TypeError): - raise AnymailRequestsAPIError("Invalid SendGrid API response format", - email_message=message, payload=payload, response=response, - backend=self) - if sendgrid_message != "success": - errors = parsed_response.get("errors", []) - raise AnymailRequestsAPIError("SendGrid send failed: '%s'" % "; ".join(errors), - email_message=message, payload=payload, response=response, - backend=self) - # Simulate a per-recipient status of "queued": - status = AnymailRecipientStatus(message_id=payload.message_id, status="queued") - return {recipient.addr_spec: status for recipient in payload.all_recipients} - - -class SendGridPayload(RequestsPayload): - """ - SendGrid v2 API Mail Send payload - """ - - def __init__(self, message, defaults, backend, *args, **kwargs): - self.all_recipients = [] # used for backend.parse_recipient_status - self.generate_message_id = backend.generate_message_id - self.message_id = None # Message-ID -- assigned in serialize_data unless provided in headers - self.smtpapi = {} # SendGrid x-smtpapi field - self.to_list = [] # needed for build_merge_data - self.merge_field_format = backend.merge_field_format - self.merge_data = None # late-bound per-recipient data - self.merge_global_data = None - - http_headers = kwargs.pop('headers', {}) - query_params = kwargs.pop('params', {}) - if backend.api_key is not None: - http_headers['Authorization'] = 'Bearer %s' % backend.api_key - else: - query_params['api_user'] = backend.username - query_params['api_key'] = backend.password - super(SendGridPayload, self).__init__(message, defaults, backend, - params=query_params, headers=http_headers, - *args, **kwargs) - - def get_api_endpoint(self): - return "mail.send.json" - - def serialize_data(self): - """Performs any necessary serialization on self.data, and returns the result.""" - - if self.generate_message_id: - self.set_anymail_id() - - self.build_merge_data() - if self.merge_data is not None: - # Move the 'to' recipients to smtpapi, so SG does batch send - # (else all recipients would see each other's emails). - # Regular 'to' must still be a valid email (even though "ignored")... - # we use the from_email as recommended by SG support - # (See https://github.com/anymail/django-anymail/pull/14#issuecomment-220231250) - self.smtpapi['to'] = [email.address for email in self.to_list] - self.data['to'] = [self.data['from']] - self.data['toname'] = [self.data.get('fromname', " ")] - - # Serialize x-smtpapi to json: - if len(self.smtpapi) > 0: - # If esp_extra was also used to set x-smtpapi, need to merge it - if "x-smtpapi" in self.data: - esp_extra_smtpapi = self.data["x-smtpapi"] - for key, value in esp_extra_smtpapi.items(): - if key == "filters": - # merge filters (else it's difficult to mix esp_extra with other features) - self.smtpapi.setdefault(key, {}).update(value) - else: - # all other keys replace any current value - self.smtpapi[key] = value - self.data["x-smtpapi"] = self.serialize_json(self.smtpapi) - elif "x-smtpapi" in self.data: - self.data["x-smtpapi"] = self.serialize_json(self.data["x-smtpapi"]) - - # Serialize extra headers to json: - if self.data["headers"]: - self.data["headers"] = self.serialize_json(self.data["headers"]) - else: - del self.data["headers"] - - return self.data - - def set_anymail_id(self): - """Ensure message has a known anymail_id for later event tracking""" - - self.message_id = str(uuid.uuid4()) - self.smtpapi.setdefault('unique_args', {})["anymail_id"] = self.message_id - - def build_merge_data(self): - """Set smtpapi['sub'] and ['section']""" - if self.merge_data is not None: - # Convert from {to1: {a: A1, b: B1}, to2: {a: A2}} (merge_data format) - # to {a: [A1, A2], b: [B1, ""]} ({field: [data in to-list order], ...}) - all_fields = set() - for recipient_data in self.merge_data.values(): - all_fields = all_fields.union(recipient_data.keys()) - recipients = [email.addr_spec for email in self.to_list] - - if self.merge_field_format is None and all(field.isalnum() for field in all_fields): - warnings.warn( - "Your SendGrid merge fields don't seem to have delimiters, " - "which can cause unexpected results with Anymail's merge_data. " - "Search SENDGRID_MERGE_FIELD_FORMAT in the Anymail docs for more info.", - AnymailWarning) - - sub_field_fmt = self.merge_field_format or '{}' - sub_fields = {field: sub_field_fmt.format(field) for field in all_fields} - - self.smtpapi['sub'] = { - # If field data is missing for recipient, use (formatted) field as the substitution. - # (This allows default to resolve from global "section" substitutions.) - sub_fields[field]: [self.merge_data.get(recipient, {}).get(field, sub_fields[field]) - for recipient in recipients] - for field in all_fields - } - - if self.merge_global_data is not None: - section_field_fmt = self.merge_field_format or '{}' - self.smtpapi['section'] = { - section_field_fmt.format(field): data - for field, data in self.merge_global_data.items() - } - - # - # Payload construction - # - - def init_payload(self): - self.data = {} # {field: [multiple, values]} - self.files = {} - self.data['headers'] = CaseInsensitiveDict() # headers keys are case-insensitive - - def set_from_email(self, email): - self.data["from"] = email.addr_spec - if email.display_name: - self.data["fromname"] = email.display_name - - def set_to(self, emails): - self.to_list = emails # track for later use by build_merge_data - self.set_recipients('to', emails) - - def set_recipients(self, recipient_type, emails): - assert recipient_type in ["to", "cc", "bcc"] - if emails: - self.data[recipient_type] = [email.addr_spec for email in emails] - empty_name = " " # SendGrid API balks on complete empty name fields - self.data[recipient_type + "name"] = [email.display_name or empty_name for email in emails] - self.all_recipients += emails # used for backend.parse_recipient_status - - def set_subject(self, subject): - self.data["subject"] = subject - - def set_reply_to(self, emails): - # Note: SendGrid mangles the 'replyto' API param: it drops - # all but the last email in a multi-address replyto, and - # drops all the display names. [tested 2016-03-10] - # - # To avoid those quirks, we provide a fully-formed Reply-To - # in the custom headers, which makes it through intact. - if emails: - reply_to = ", ".join([email.address for email in emails]) - self.data["headers"]["Reply-To"] = reply_to - - def set_extra_headers(self, headers): - # SendGrid requires header values to be strings -- not integers. - # We'll stringify ints and floats; anything else is the caller's responsibility. - # (This field gets converted to json in self.serialize_data) - self.data["headers"].update({ - k: str(v) if isinstance(v, BASIC_NUMERIC_TYPES) else v - for k, v in headers.items() - }) - - def set_text_body(self, body): - self.data["text"] = body - - def set_html_body(self, body): - if "html" in self.data: - # second html body could show up through multiple alternatives, or html body + alternative - self.unsupported_feature("multiple html parts") - self.data["html"] = body - - def add_attachment(self, attachment): - filename = attachment.name or "" - if attachment.inline: - filename = filename or attachment.cid # must have non-empty name for the cid matching - content_field = "content[%s]" % filename - self.data[content_field] = attachment.cid - - files_field = "files[%s]" % filename - if files_field in self.files: - # It's possible SendGrid could actually handle this case (needs testing), - # but requests doesn't seem to accept a list of tuples for a files field. - # (See the Mailgun EmailBackend version for a different approach that might work.) - self.unsupported_feature( - "multiple attachments with the same filename ('%s')" % filename if filename - else "multiple unnamed attachments") - - self.files[files_field] = (filename, attachment.content, attachment.mimetype) - - def set_metadata(self, metadata): - self.smtpapi['unique_args'] = metadata - - def set_send_at(self, send_at): - # Backend has converted pretty much everything to - # a datetime by here; SendGrid expects unix timestamp - self.smtpapi["send_at"] = int(timestamp(send_at)) # strip microseconds - - def set_tags(self, tags): - self.smtpapi["category"] = tags - - def add_filter(self, filter_name, setting, val): - self.smtpapi.setdefault('filters', {})\ - .setdefault(filter_name, {})\ - .setdefault('settings', {})[setting] = val - - def set_track_clicks(self, track_clicks): - self.add_filter('clicktrack', 'enable', int(track_clicks)) - - def set_track_opens(self, track_opens): - # SendGrid's opentrack filter also supports a "replace" - # parameter, which Anymail doesn't offer directly. - # (You could add it through esp_extra.) - self.add_filter('opentrack', 'enable', int(track_opens)) - - def set_template_id(self, template_id): - self.add_filter('templates', 'enable', 1) - self.add_filter('templates', 'template_id', template_id) - # Must ensure text and html are non-empty, or template parts won't render. - # https://sendgrid.com/docs/API_Reference/Web_API_v3/Transactional_Templates/smtpapi.html#-Text-or-HTML-Templates - if not self.data.get("text", ""): - self.data["text"] = " " - if not self.data.get("html", ""): - self.data["html"] = " " - - def set_merge_data(self, merge_data): - # Becomes smtpapi['sub'] in build_merge_data, after we know recipients and merge_field_format. - self.merge_data = merge_data - - def set_merge_global_data(self, merge_global_data): - # Becomes smtpapi['section'] in build_merge_data, after we know merge_field_format. - self.merge_global_data = merge_global_data - - def set_esp_extra(self, extra): - self.merge_field_format = extra.pop('merge_field_format', self.merge_field_format) - self.data.update(extra) diff --git a/docs/esps/sendgrid.rst b/docs/esps/sendgrid.rst index 7208bb7..e69f370 100644 --- a/docs/esps/sendgrid.rst +++ b/docs/esps/sendgrid.rst @@ -5,11 +5,6 @@ SendGrid Anymail integrates with the `SendGrid`_ email service, using their `Web API v3`_. -.. versionchanged:: 0.8 - - Earlier Anymail releases used SendGrid's v2 API. If you are upgrading, - please review the :ref:`porting notes `. - .. important:: **Troubleshooting:** @@ -188,8 +183,7 @@ Limitations and quirks isn't present.) **Single Reply-To** - SendGrid's v3 API only supports a single Reply-To address (and blocks - a workaround that was possible with the v2 API). + SendGrid's v3 API only supports a single Reply-To address. If your message has multiple reply addresses, you'll get an :exc:`~anymail.exceptions.AnymailUnsupportedFeature` error---or @@ -344,185 +338,3 @@ digests). But disabling it *may* use less memory while processing messages with .. _Inbound Parse Webhook: https://sendgrid.com/docs/Classroom/Basics/Inbound_Parse_Webhook/setting_up_the_inbound_parse_webhook.html - - -.. _sendgrid-v3-upgrade: - -Upgrading to SendGrid's v3 API ------------------------------- - -Anymail v0.8 switched to SendGrid's preferred v3 send API. -(Earlier Anymail releases used their v2 API.) - -For many Anymail projects, this change will be entirely transparent. -(Anymail's whole reason for existence is abstracting ESP APIs, -so that your own code doesn't need to worry about the details.) - -There are three cases where SendGrid has changed features -that would require updates to your code: - -1. If you are using SendGrid's username/password auth (your settings - include :setting:`SENDGRID_USERNAME ` - and :setting:`SENDGRID_PASSWORD `), - you must switch to an API key. - See :setting:`SENDGRID_API_KEY `. - - (If you are already using a SendGrid API key with v2, it should - work just fine with v3.) - -2. If you are using Anymail's - :attr:`~anymail.message.AnymailMessage.esp_extra` attribute - to supply API-specific parameters, the format has changed. - - Search your code for "esp_extra" (e.g., `git grep esp_extra`) - to determine whether this affects you. (Anymail's - `"merge_field_format"` is unchanged, so if that's the only - thing you have in esp_extra, no changes are needed.) - - The new API format is considerably simpler and more logical. - See :ref:`sendgrid-esp-extra` below for examples of the - new format and a link to relevant SendGrid docs. - - Anymail will raise an error if it detects an attempt to use - the v2-only `"x-smtpapi"` settings in esp_extra when sending. - -3. If you send messages with multiple Reply-To addresses, SendGrid - no longer supports this. (Multiple reply emails in a single - message are not common.) - - Anymail will raise an error if you attempt to send a message with - multiple Reply-To emails. (You can suppress the error with - :setting:`ANYMAIL_IGNORE_UNSUPPORTED_FEATURES`, which will - ignore all but the first reply address.) - - -As an alternative, Anymail (for the time being) still includes -a copy of the SendGrid v2 backend. See :ref:`sendgrid-v2-backend` -below if you'd prefer to stay on the older SendGrid API. - - -.. _sendgrid-v2-backend: - -Legacy v2 API support ---------------------- - -.. versionchanged:: 0.8 - -Anymail v0.8 switched to SendGrid's v3 Web API in its primary SendGrid -email backend. SendGrid `encourages`_ all users to migrate to their v3 API. - -For Anymail users who still need it, a legacy backend that calls SendGrid's -earlier `Web API v2 Mail Send`_ remains available. Be aware that v2 support -is considered deprecated and may be removed in a future Anymail release. - -.. _encourages: - https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html -.. _Web API v2 Mail Send: - https://sendgrid.com/docs/API_Reference/Web_API/mail.html - - -To use Anymail's SendGrid v2 backend, edit your settings.py: - - .. code-block:: python - - EMAIL_BACKEND = "anymail.backends.sendgrid_v2.EmailBackend" - ANYMAIL = { - "SENDGRID_API_KEY": "", - } - -The same :setting:`SENDGRID_API_KEY ` will work -with either Anymail's v2 or v3 SendGrid backend. - -Nearly all of the documentation above for Anymail's v3 SendGrid backend -also applies to the v2 backend, with the following changes: - -.. setting:: ANYMAIL_SENDGRID_USERNAME -.. setting:: ANYMAIL_SENDGRID_PASSWORD - -.. rubric:: Username/password auth (SendGrid v2 only) - -SendGrid v2 allows a username/password instead of an API key -(though SendGrid encourages API keys for all new installations). -If you must use username/password auth, set: - - .. code-block:: python - - EMAIL_BACKEND = "anymail.backends.sendgrid_v2.EmailBackend" - ANYMAIL = { - "SENDGRID_USERNAME": "", - "SENDGRID_PASSWORD": "", - # And leave out "SENDGRID_API_KEY" - } - -This is **not** the username/password that you use to log into SendGrid's -dashboard. Create credentials specifically for sending mail in the -`SendGrid credentials settings`_. - -Either username/password or :setting:`SENDGRID_API_KEY ` -are required (but not both). - -Anymail will also look for ``SENDGRID_USERNAME`` and ``SENDGRID_PASSWORD`` at the -root of the settings file if neither ``ANYMAIL["SENDGRID_USERNAME"]`` -nor ``ANYMAIL_SENDGRID_USERNAME`` is set. - -.. _SendGrid credentials settings: https://app.sendgrid.com/settings/credentials - - -.. rubric:: Duplicate attachment filenames (SendGrid v2 limitation) - -Anymail is not capable of communicating multiple attachments with -the same filename to the SendGrid v2 API. (This also applies to multiple -attachments with *no* filename, though not to inline images.) - -If you are sending multiple attachments on a single message, -make sure each one has a unique, non-empty filename. - - -.. rubric:: Message bodies with ESP templates (SendGrid v2 quirk) - -Anymail's SendGrid v2 backend will convert empty text and HTML bodies to single spaces whenever -:attr:`~anymail.message.AnymailMessage.template_id` is set, to ensure the -plaintext and HTML from your template are present in your outgoing email. -This works around a `limitation in SendGrid's template rendering`_. - -.. _limitation in SendGrid's template rendering: - https://sendgrid.com/docs/API_Reference/Web_API_v3/Transactional_Templates/smtpapi.html#-Text-or-HTML-Templates - - -.. rubric:: Multiple Reply-To addresses (SendGrid v2 only) - -Unlike SendGrid's v3 API, Anymail is able to support multiple -Reply-To addresses with their v2 API. - - -.. rubric:: esp_extra with SendGrid v2 - -Anymail's :attr:`~anymail.message.AnymailMessage.esp_extra` attribute -is merged directly with the API parameters, so the format varies -between SendGrid's v2 and v3 APIs. With the v2 API, most interesting -settings appear beneath `'x-smtpapi'`. Example: - - .. code-block:: python - - message.esp_extra = { - 'x-smtpapi': { # for SendGrid v2 API - "asm_group": 1, # Assign SendGrid unsubscribe group for this message - "asm_groups_to_display": [1, 2, 3], - "filters": { - "subscriptiontrack": { # Insert SendGrid subscription management links - "settings": { - "text/html": "If you would like to unsubscribe <% click here %>.", - "text/plain": "If you would like to unsubscribe click here: <% %>.", - "enable": 1 - } - } - } - } - } - -The value of :attr:`esp_extra` should be a `dict` of parameters for SendGrid's -`v2 mail.send API`_. Any keys in the dict will override Anymail's normal values -for that parameter, except that `'x-smtpapi'` will be merged. - -.. _v2 mail.send API: - https://sendgrid.com/docs/API_Reference/Web_API/mail.html#-send diff --git a/tests/test_sendgrid_backend.py b/tests/test_sendgrid_backend.py index dc7ec69..218ccaa 100644 --- a/tests/test_sendgrid_backend.py +++ b/tests/test_sendgrid_backend.py @@ -650,7 +650,10 @@ class SendGridBackendDisallowsV2Tests(SimpleTestCase, AnymailTestMixin): @override_settings(ANYMAIL={'SENDGRID_USERNAME': 'sg_username', 'SENDGRID_PASSWORD': 'sg_password'}) def test_user_pass_auth(self): """Make sure v2-only USERNAME/PASSWORD auth raises error""" - with self.assertRaisesRegex(AnymailConfigurationError, r'\bsendgrid_v2\.EmailBackend\b'): + with self.assertRaisesMessage( + AnymailConfigurationError, + "SendGrid v3 API doesn't support username/password auth; Please change to API key." + ): mail.send_mail('Subject', 'Message', 'from@example.com', ['to@example.com']) @override_settings(ANYMAIL={'SENDGRID_API_KEY': 'test_api_key'}) @@ -658,5 +661,9 @@ class SendGridBackendDisallowsV2Tests(SimpleTestCase, AnymailTestMixin): """x-smtpapi in the esp_extra indicates a desire to use the v2 api""" message = mail.EmailMessage('Subject', 'Body', 'from@example.com', ['to@example.com']) message.esp_extra = {'x-smtpapi': {'asm_group_id': 1}} - with self.assertRaisesRegex(AnymailConfigurationError, r'\bsendgrid_v2\.EmailBackend\b'): + with self.assertRaisesMessage( + AnymailConfigurationError, + "You are attempting to use SendGrid v2 API-style x-smtpapi params with the SendGrid v3 API." + " Please update your `esp_extra` to the new API." + ): message.send() diff --git a/tests/test_sendgrid_v2_backend.py b/tests/test_sendgrid_v2_backend.py deleted file mode 100644 index 385b98e..0000000 --- a/tests/test_sendgrid_v2_backend.py +++ /dev/null @@ -1,630 +0,0 @@ -# -*- coding: utf-8 -*- - -import json -from calendar import timegm -from datetime import date, datetime -from decimal import Decimal -from email.mime.base import MIMEBase -from email.mime.image import MIMEImage - -import six -from django.core import mail -from django.core.exceptions import ImproperlyConfigured -from django.test import SimpleTestCase -from django.test.utils import override_settings -from django.utils.timezone import get_fixed_timezone, override as override_current_timezone - -from anymail.exceptions import AnymailAPIError, AnymailSerializationError, AnymailUnsupportedFeature, AnymailWarning -from anymail.message import attach_inline_image_file - -from .mock_requests_backend import RequestsBackendMockAPITestCase, SessionSharingTestCasesMixin -from .utils import sample_image_content, sample_image_path, SAMPLE_IMAGE_FILENAME, AnymailTestMixin - -# noinspection PyUnresolvedReferences -longtype = int if six.PY3 else long # NOQA: F821 - - -@override_settings(EMAIL_BACKEND='anymail.backends.sendgrid_v2.EmailBackend', - ANYMAIL={'SENDGRID_API_KEY': 'test_api_key'}) -class SendGridBackendMockAPITestCase(RequestsBackendMockAPITestCase): - DEFAULT_RAW_RESPONSE = b"""{ - "message": "success" - }""" - - def setUp(self): - super(SendGridBackendMockAPITestCase, self).setUp() - # Simple message useful for many tests - self.message = mail.EmailMultiAlternatives('Subject', 'Text Body', 'from@example.com', ['to@example.com']) - - def get_smtpapi(self): - """Returns the x-smtpapi data passed to the mock requests call""" - data = self.get_api_call_data() - return json.loads(data["x-smtpapi"]) - - -class SendGridBackendStandardEmailTests(SendGridBackendMockAPITestCase): - """Test backend support for Django standard email features""" - - def test_send_mail(self): - """Test basic API for simple send""" - mail.send_mail('Subject here', 'Here is the message.', - 'from@sender.example.com', ['to@example.com'], fail_silently=False) - self.assert_esp_called('/api/mail.send.json') - http_headers = self.get_api_call_headers() - self.assertEqual(http_headers["Authorization"], "Bearer test_api_key") - - query = self.get_api_call_params(required=False) - if query: - self.assertNotIn('api_user', query) - self.assertNotIn('api_key', query) - - data = self.get_api_call_data() - self.assertEqual(data['subject'], "Subject here") - self.assertEqual(data['text'], "Here is the message.") - self.assertEqual(data['from'], "from@sender.example.com") - self.assertEqual(data['to'], ["to@example.com"]) - # make sure the backend assigned the anymail_id to unique_args for event tracking and notification - smtpapi = self.get_smtpapi() - self.assertUUIDIsValid(smtpapi['unique_args']['anymail_id']) - - @override_settings(ANYMAIL={'SENDGRID_USERNAME': 'sg_username', 'SENDGRID_PASSWORD': 'sg_password'}) - def test_user_pass_auth(self): - """Make sure alternative USERNAME/PASSWORD auth works""" - mail.send_mail('Subject here', 'Here is the message.', - 'from@sender.example.com', ['to@example.com'], fail_silently=False) - self.assert_esp_called('/api/mail.send.json') - query = self.get_api_call_params() - self.assertEqual(query['api_user'], 'sg_username') - self.assertEqual(query['api_key'], 'sg_password') - http_headers = self.get_api_call_headers(required=False) - if http_headers: - self.assertNotIn('Authorization', http_headers) - - def test_name_addr(self): - """Make sure RFC2822 name-addr format (with display-name) is allowed - - (Test both sender and recipient addresses) - """ - msg = mail.EmailMessage( - 'Subject', 'Message', 'From Name ', - ['Recipient #1 ', 'to2@example.com'], - cc=['Carbon Copy ', 'cc2@example.com'], - bcc=['Blind Copy ', 'bcc2@example.com']) - msg.send() - data = self.get_api_call_data() - self.assertEqual(data['from'], "from@example.com") - self.assertEqual(data['fromname'], "From Name") - self.assertEqual(data['to'], ['to1@example.com', 'to2@example.com']) - self.assertEqual(data['toname'], ['Recipient #1', ' ']) # note space -- SendGrid balks on '' - self.assertEqual(data['cc'], ['cc1@example.com', 'cc2@example.com']) - self.assertEqual(data['ccname'], ['Carbon Copy', ' ']) - self.assertEqual(data['bcc'], ['bcc1@example.com', 'bcc2@example.com']) - self.assertEqual(data['bccname'], ['Blind Copy', ' ']) - - 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', - 'Message-ID': ''}) # should override backend msgid - email.send() - data = self.get_api_call_data() - self.assertEqual(data['subject'], "Subject") - self.assertEqual(data['text'], "Body goes here") - self.assertEqual(data['from'], "from@example.com") - self.assertEqual(data['to'], ['to1@example.com', 'to2@example.com']) - self.assertEqual(data['toname'], [' ', 'Also To']) - self.assertEqual(data['bcc'], ['bcc1@example.com', 'bcc2@example.com']) - self.assertEqual(data['bccname'], [' ', 'Also BCC']) - self.assertEqual(data['cc'], ['cc1@example.com', 'cc2@example.com']) - self.assertEqual(data['ccname'], [' ', 'Also CC']) - self.assertJSONEqual(data['headers'], { - 'Message-ID': '', - 'Reply-To': 'another@example.com', - 'X-MyHeader': 'my value', - }) - # make sure anymail_id also added to unique_args - smtpapi_json = json.loads(data['x-smtpapi']) - self.assertUUIDIsValid(smtpapi_json['unique_args']['anymail_id']) - - 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['text'], text_content) - self.assertEqual(data['html'], html_content) - # Don't accidentally send the html part as an attachment: - files = self.get_api_call_files(required=False) - self.assertFalse(files) - - def test_html_only_message(self): - html_content = '

This is an important message.

' - email = mail.EmailMessage('Subject', html_content, 'from@example.com', ['to@example.com']) - email.content_subtype = "html" # Main content is now text/html - email.send() - data = self.get_api_call_data() - self.assertNotIn('text', data) - self.assertEqual(data['html'], html_content) - - def test_extra_headers(self): - self.message.extra_headers = {'X-Custom': 'string', 'X-Num': 123, 'X-Long': longtype(123)} - self.message.send() - data = self.get_api_call_data() - headers = json.loads(data['headers']) - self.assertEqual(headers['X-Custom'], 'string') - self.assertEqual(headers['X-Num'], '123') # number converted to string (per SendGrid requirement) - self.assertEqual(headers['X-Long'], '123') # number converted to string (per SendGrid requirement) - - def test_extra_headers_serialization_error(self): - self.message.extra_headers = {'X-Custom': Decimal(12.5)} - with self.assertRaisesMessage(AnymailSerializationError, "Decimal"): - self.message.send() - - def test_reply_to(self): - email = mail.EmailMessage('Subject', 'Body goes here', 'from@example.com', ['to1@example.com'], - reply_to=['reply@example.com', 'Other '], - headers={'X-Other': 'Keep'}) - email.send() - data = self.get_api_call_data() - self.assertNotIn('replyto', data) # don't use SendGrid's replyto (it's broken); just use headers - headers = json.loads(data['headers']) - self.assertEqual(headers['Reply-To'], 'reply@example.com, Other ') - self.assertEqual(headers['X-Other'], 'Keep') # don't lose other headers - - def test_attachments(self): - text_content = "* Item one\n* Item two\n* Item three" - self.message.attach(filename="test.txt", content=text_content, mimetype="text/plain") - - # Should guess mimetype if not provided... - png_content = b"PNG\xb4 pretend this is the contents of a png file" - self.message.attach(filename="test.png", content=png_content) - - # Should work with a MIMEBase object (also tests no filename)... - pdf_content = b"PDF\xb4 pretend this is valid pdf data" - mimeattachment = MIMEBase('application', 'pdf') - mimeattachment.set_payload(pdf_content) - self.message.attach(mimeattachment) - - self.message.send() - files = self.get_api_call_files() - self.assertEqual(files, { - 'files[test.txt]': ('test.txt', text_content, 'text/plain'), - 'files[test.png]': ('test.png', png_content, 'image/png'), # type inferred from filename - 'files[]': ('', pdf_content, 'application/pdf'), # no filename - }) - - def test_attachment_name_conflicts(self): - # It's not clear how to (or whether) supply multiple attachments with - # the same name to SendGrid's API. Anymail treats this case as unsupported. - self.message.attach('foo.txt', 'content', 'text/plain') - self.message.attach('bar.txt', 'content', 'text/plain') - self.message.attach('foo.txt', 'different content', 'text/plain') - with self.assertRaisesMessage(AnymailUnsupportedFeature, - "multiple attachments with the same filename") as cm: - self.message.send() - self.assertIn('foo.txt', str(cm.exception)) # say which filename - - def test_unnamed_attachment_conflicts(self): - # Same as previous test, but with None/empty filenames - self.message.attach(None, 'content', 'text/plain') - self.message.attach('', 'different content', 'text/plain') - with self.assertRaisesMessage(AnymailUnsupportedFeature, "multiple unnamed attachments"): - self.message.send() - - def test_unicode_attachment_correctly_decoded(self): - self.message.attach(u"Une pièce jointe.html", u'

\u2019

', mimetype='text/html') - self.message.send() - files = self.get_api_call_files() - self.assertEqual(files[u'files[Une pièce jointe.html]'], - (u'Une pièce jointe.html', u'

\u2019

', 'text/html')) - - def test_embedded_images(self): - image_filename = SAMPLE_IMAGE_FILENAME - image_path = sample_image_path(image_filename) - image_data = sample_image_content(image_filename) - - cid = attach_inline_image_file(self.message, image_path) # Read from a png file - html_content = '

This has an inline image.

' % cid - self.message.attach_alternative(html_content, "text/html") - - self.message.send() - data = self.get_api_call_data() - self.assertEqual(data['html'], html_content) - - files = self.get_api_call_files() - self.assertEqual(files, { - 'files[%s]' % image_filename: (image_filename, image_data, "image/png"), - }) - self.assertEqual(data['content[%s]' % image_filename], cid) - - def test_attached_images(self): - image_filename = SAMPLE_IMAGE_FILENAME - image_path = sample_image_path(image_filename) - image_data = sample_image_content(image_filename) - - self.message.attach_file(image_path) # option 1: attach as a file - - image = MIMEImage(image_data) # option 2: construct the MIMEImage and attach it directly - self.message.attach(image) - - self.message.send() - files = self.get_api_call_files() - self.assertEqual(files, { - 'files[%s]' % image_filename: (image_filename, image_data, "image/png"), # the named one - 'files[]': ('', image_data, "image/png"), # the unnamed one - }) - - def test_multiple_html_alternatives(self): - # Multiple alternatives not allowed - self.message.attach_alternative("

First html is OK

", "text/html") - self.message.attach_alternative("

But not second html

", "text/html") - with self.assertRaises(AnymailUnsupportedFeature): - self.message.send() - - def test_html_alternative(self): - # Only html alternatives allowed - self.message.attach_alternative("{'not': 'allowed'}", "application/json") - with self.assertRaises(AnymailUnsupportedFeature): - self.message.send() - - def test_alternatives_fail_silently(self): - # Make sure fail_silently is respected - self.message.attach_alternative("{'not': 'allowed'}", "application/json") - sent = self.message.send(fail_silently=True) - self.assert_esp_not_called("API should not be called when send fails silently") - self.assertEqual(sent, 0) - - def test_suppress_empty_address_lists(self): - """Empty to, cc, bcc, and reply_to shouldn't generate empty headers""" - self.message.send() - data = self.get_api_call_data() - self.assertNotIn('cc', data) - self.assertNotIn('ccname', data) - self.assertNotIn('bcc', data) - self.assertNotIn('bccname', data) - self.assertNotIn('headers', data) - - # Test empty `to` -- but send requires at least one recipient somewhere (like cc) - self.message.to = [] - self.message.cc = ['cc@example.com'] - self.message.send() - data = self.get_api_call_data() - self.assertNotIn('to', data) - self.assertNotIn('toname', data) - - def test_api_failure(self): - self.set_mock_response(status_code=400) - with self.assertRaisesMessage(AnymailAPIError, "SendGrid API response 400"): - mail.send_mail('Subject', 'Body', 'from@example.com', ['to@example.com']) - - # Make sure fail_silently is respected - self.set_mock_response(status_code=400) - sent = mail.send_mail('Subject', 'Body', 'from@example.com', ['to@example.com'], fail_silently=True) - self.assertEqual(sent, 0) - - def test_api_error_includes_details(self): - """AnymailAPIError should include ESP's error message""" - # JSON error response: - error_response = b"""{ - "message": "error", - "errors": [ - "Helpful explanation from SendGrid", - "and more" - ] - }""" - self.set_mock_response(status_code=200, raw=error_response) - with self.assertRaisesRegex(AnymailAPIError, - r"\bHelpful explanation from SendGrid\b.*and more\b"): - self.message.send() - - # Non-JSON error response: - self.set_mock_response(status_code=500, raw=b"Ack! Bad proxy!") - with self.assertRaisesMessage(AnymailAPIError, "Ack! Bad proxy!"): - self.message.send() - - # No content in the error response: - self.set_mock_response(status_code=502, raw=None) - with self.assertRaises(AnymailAPIError): - self.message.send() - - -class SendGridBackendAnymailFeatureTests(SendGridBackendMockAPITestCase): - """Test backend support for Anymail added features""" - - def test_envelope_sender(self): - # SendGrid does not have a way to change envelope sender. - self.message.envelope_sender = "anything@bounces.example.com" - with self.assertRaisesMessage(AnymailUnsupportedFeature, 'envelope_sender'): - self.message.send() - - def test_metadata(self): - # Note: SendGrid doesn't handle complex types in metadata - self.message.metadata = {'user_id': "12345", 'items': 6} - self.message.send() - smtpapi = self.get_smtpapi() - smtpapi['unique_args'].pop('anymail_id', None) # remove anymail_id we added for tracking - self.assertEqual(smtpapi['unique_args'], {'user_id': "12345", 'items': 6}) - - def test_send_at(self): - utc_plus_6 = get_fixed_timezone(6 * 60) - utc_minus_8 = get_fixed_timezone(-8 * 60) - - with override_current_timezone(utc_plus_6): - # Timezone-aware datetime converted to UTC: - self.message.send_at = datetime(2016, 3, 4, 5, 6, 7, tzinfo=utc_minus_8) - self.message.send() - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['send_at'], timegm((2016, 3, 4, 13, 6, 7))) # 05:06 UTC-8 == 13:06 UTC - - # Timezone-naive datetime assumed to be Django current_timezone - self.message.send_at = datetime(2022, 10, 11, 12, 13, 14, 567) # microseconds should get stripped - self.message.send() - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['send_at'], timegm((2022, 10, 11, 6, 13, 14))) # 12:13 UTC+6 == 06:13 UTC - - # Date-only treated as midnight in current timezone - self.message.send_at = date(2022, 10, 22) - self.message.send() - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['send_at'], timegm((2022, 10, 21, 18, 0, 0))) # 00:00 UTC+6 == 18:00-1d UTC - - # POSIX timestamp - self.message.send_at = 1651820889 # 2022-05-06 07:08:09 UTC - self.message.send() - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['send_at'], 1651820889) - - def test_tags(self): - self.message.tags = ["receipt", "repeat-user"] - self.message.send() - smtpapi = self.get_smtpapi() - self.assertCountEqual(smtpapi['category'], ["receipt", "repeat-user"]) - - def test_tracking(self): - # Test one way... - self.message.track_clicks = False - self.message.track_opens = True - self.message.send() - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['filters']['clicktrack'], {'settings': {'enable': 0}}) - self.assertEqual(smtpapi['filters']['opentrack'], {'settings': {'enable': 1}}) - - # ...and the opposite way - self.message.track_clicks = True - self.message.track_opens = False - self.message.send() - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['filters']['clicktrack'], {'settings': {'enable': 1}}) - self.assertEqual(smtpapi['filters']['opentrack'], {'settings': {'enable': 0}}) - - def test_template_id(self): - self.message.attach_alternative("HTML Body", "text/html") - self.message.template_id = "5997fcf6-2b9f-484d-acd5-7e9a99f0dc1f" - self.message.send() - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['filters']['templates'], { - 'settings': {'enable': 1, - 'template_id': "5997fcf6-2b9f-484d-acd5-7e9a99f0dc1f"} - }) - data = self.get_api_call_data() - self.assertEqual(data['text'], "Text Body") - self.assertEqual(data['html'], "HTML Body") - - def test_template_id_with_empty_body(self): - # Text and html must be present (and non-empty-string), or the corresponding - # part will not render from the template. Make sure we fill in strings: - message = mail.EmailMessage(from_email='from@example.com', to=['to@example.com']) - message.template_id = "5997fcf6-2b9f-484d-acd5-7e9a99f0dc1f" - message.send() - data = self.get_api_call_data() - self.assertEqual(data['text'], " ") # single space is sufficient - self.assertEqual(data['html'], " ") - - def test_merge_data(self): - self.message.from_email = 'from@example.com' - self.message.to = ['alice@example.com', 'Bob '] - # SendGrid template_id is not required to use merge. - # You can just supply template content as the message (e.g.): - self.message.body = "Hi :name. Welcome to :group at :site." - self.message.merge_data = { - # You must either include merge field delimiters in the keys (':name' rather than just 'name') - # as shown here, or use one of the merge_field_format options shown in the test cases below - 'alice@example.com': {':name': "Alice", ':group': "Developers"}, - 'bob@example.com': {':name': "Bob"}, # and leave :group undefined - } - self.message.merge_global_data = { - ':group': "Users", - ':site': "ExampleCo", - } - self.message.send() - - data = self.get_api_call_data() - smtpapi = self.get_smtpapi() - # For batch send, smtpapi['to'] gets real recipient list; - # normal 'to' is not used (but must be valid, so we substitute the from_email): - self.assertEqual(data['to'], ['from@example.com']) - self.assertEqual(data['toname'], [' ']) # empty string if no name in from_email - self.assertEqual(smtpapi['to'], ['alice@example.com', 'Bob ']) - # smtpapi['sub'] values should be in to-list order: - self.assertEqual(smtpapi['sub'], { - ':name': ["Alice", "Bob"], - ':group': ["Developers", ":group"], # missing value gets replaced with var name... - }) - self.assertEqual(smtpapi['section'], { - ':group': "Users", # ... which SG should then try to resolve from here - ':site': "ExampleCo", - }) - - @override_settings(ANYMAIL_SENDGRID_MERGE_FIELD_FORMAT=":{}") # :field as shown in SG examples - def test_merge_field_format_setting(self): - # Provide merge field delimiters in settings.py - self.message.to = ['alice@example.com', 'Bob '] - self.message.merge_data = { - 'alice@example.com': {'name': "Alice", 'group': "Developers"}, - 'bob@example.com': {'name': "Bob"}, # and leave group undefined - } - self.message.merge_global_data = {'site': "ExampleCo"} - self.message.send() - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['sub'], { - ':name': ["Alice", "Bob"], - ':group': ["Developers", ":group"] # substitutes formatted field name if missing for recipient - }) - self.assertEqual(smtpapi['section'], {':site': "ExampleCo"}) - - def test_merge_field_format_esp_extra(self): - # Provide merge field delimiters for an individual message - self.message.to = ['alice@example.com', 'Bob '] - self.message.merge_data = { - 'alice@example.com': {'name': "Alice", 'group': "Developers"}, - 'bob@example.com': {'name': "Bob"}, # and leave group undefined - } - self.message.merge_global_data = {'site': "ExampleCo"} - self.message.esp_extra = {'merge_field_format': '*|{}|*'} # match Mandrill/MailChimp delimiters - self.message.send() - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['sub'], { - '*|name|*': ["Alice", "Bob"], - '*|group|*': ["Developers", '*|group|*'] # substitutes formatted field name if missing for recipient - }) - self.assertEqual(smtpapi['section'], {'*|site|*': "ExampleCo"}) - # Make sure our esp_extra merge_field_format doesn't get sent to SendGrid API: - data = self.get_api_call_data() - self.assertNotIn('merge_field_format', data) - - def test_warn_if_no_merge_field_delimiters(self): - self.message.to = ['alice@example.com'] - self.message.merge_data = { - 'alice@example.com': {'name': "Alice", 'group': "Developers"}, - } - with self.assertWarnsRegex(AnymailWarning, r'SENDGRID_MERGE_FIELD_FORMAT'): - self.message.send() - - @override_settings(ANYMAIL_SENDGRID_GENERATE_MESSAGE_ID=False) # else we force unique_args - def test_default_omits_options(self): - """Make sure by default we don't send any ESP-specific options. - - Options not specified by the caller should be omitted entirely from - the API call (*not* sent as False or empty). This ensures - that your ESP account settings apply by default. - """ - self.message.send() - data = self.get_api_call_data() - self.assertNotIn('x-smtpapi', data) - - def test_esp_extra(self): - self.message.tags = ["tag"] - self.message.track_clicks = True - self.message.esp_extra = { - 'x-smtpapi': { - # Most SendMail options go in the 'x-smtpapi' block... - 'asm_group_id': 1, - 'filters': { - # If you add a filter, you must supply all required settings for it. - 'subscriptiontrack': { - 'settings': { - 'enable': 1, - 'replace': '[unsubscribe_url]', - }, - }, - }, - }, - 'newthing': "some param not supported by Anymail", - } - self.message.send() - # Additional send params: - data = self.get_api_call_data() - self.assertEqual(data['newthing'], "some param not supported by Anymail") - # Should merge x-smtpapi, and merge filters within x-smtpapi - smtpapi = self.get_smtpapi() - self.assertEqual(smtpapi['category'], ["tag"]) - self.assertEqual(smtpapi['asm_group_id'], 1) - self.assertEqual(smtpapi['filters']['subscriptiontrack'], - {'settings': {'enable': 1, 'replace': '[unsubscribe_url]'}}) # esp_extra merged - self.assertEqual(smtpapi['filters']['clicktrack'], - {'settings': {'enable': 1}}) # Anymail message option preserved - - # noinspection PyUnresolvedReferences - def test_send_attaches_anymail_status(self): - """ The anymail_status should be attached to the message when it is sent """ - # the DEFAULT_RAW_RESPONSE above is the *only* success response SendGrid returns, - # so no need to override it here - msg = mail.EmailMessage('Subject', 'Message', 'from@example.com', ['to1@example.com'],) - sent = msg.send() - self.assertEqual(sent, 1) - self.assertEqual(msg.anymail_status.status, {'queued'}) - self.assertUUIDIsValid(msg.anymail_status.message_id) - self.assertEqual(msg.anymail_status.recipients['to1@example.com'].status, 'queued') - self.assertEqual(msg.anymail_status.recipients['to1@example.com'].message_id, - msg.anymail_status.message_id) - self.assertEqual(msg.anymail_status.esp_response.content, self.DEFAULT_RAW_RESPONSE) - - # noinspection PyUnresolvedReferences - def test_send_failed_anymail_status(self): - """ If the send fails, anymail_status should contain initial values""" - self.set_mock_response(status_code=500) - sent = self.message.send(fail_silently=True) - self.assertEqual(sent, 0) - self.assertIsNone(self.message.anymail_status.status) - self.assertIsNone(self.message.anymail_status.message_id) - self.assertEqual(self.message.anymail_status.recipients, {}) - self.assertIsNone(self.message.anymail_status.esp_response) - - # noinspection PyUnresolvedReferences - def test_send_unparsable_response(self): - """If the send succeeds, but a non-JSON API response, should raise an API exception""" - mock_response = self.set_mock_response(status_code=200, - raw=b"yikes, this isn't a real response") - with self.assertRaises(AnymailAPIError): - self.message.send() - self.assertIsNone(self.message.anymail_status.status) - self.assertIsNone(self.message.anymail_status.message_id) - self.assertEqual(self.message.anymail_status.recipients, {}) - self.assertEqual(self.message.anymail_status.esp_response, mock_response) - - def test_json_serialization_errors(self): - """Try to provide more information about non-json-serializable data""" - self.message.metadata = {'total': Decimal('19.99')} - with self.assertRaises(AnymailSerializationError) as cm: - self.message.send() - print(self.get_api_call_data()) - err = cm.exception - self.assertIsInstance(err, TypeError) # compatibility with json.dumps - self.assertIn("Don't know how to send this data to SendGrid", str(err)) # our added context - self.assertRegex(str(err), r"Decimal.*is not JSON serializable") # original message - - -class SendGridBackendRecipientsRefusedTests(SendGridBackendMockAPITestCase): - """Should raise AnymailRecipientsRefused when *all* recipients are rejected or invalid""" - - # SendGrid doesn't check email bounce or complaint lists at time of send -- - # it always just queues the message. You'll need to listen for the "rejected" - # and "failed" events to detect refused recipients. - - pass - - -class SendGridBackendSessionSharingTestCase(SessionSharingTestCasesMixin, SendGridBackendMockAPITestCase): - """Requests session sharing tests""" - pass # tests are defined in the mixin - - -@override_settings(EMAIL_BACKEND="anymail.backends.sendgrid_v2.EmailBackend") -class SendGridBackendImproperlyConfiguredTests(SimpleTestCase, AnymailTestMixin): - """Test ESP backend without required settings in place""" - - def test_missing_auth(self): - with self.assertRaises(ImproperlyConfigured) as cm: - mail.send_mail('Subject', 'Message', 'from@example.com', ['to@example.com']) - errmsg = str(cm.exception) - # Make sure the exception mentions all the auth keys: - self.assertRegex(errmsg, r'\bSENDGRID_API_KEY\b') - self.assertRegex(errmsg, r'\bSENDGRID_USERNAME\b') - self.assertRegex(errmsg, r'\bSENDGRID_PASSWORD\b') diff --git a/tests/test_sendgrid_v2_integration.py b/tests/test_sendgrid_v2_integration.py deleted file mode 100644 index 2215875..0000000 --- a/tests/test_sendgrid_v2_integration.py +++ /dev/null @@ -1,146 +0,0 @@ -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, RUN_LIVE_TESTS - -# 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(RUN_LIVE_TESTS, "RUN_LIVE_TESTS disabled in this environment") -@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_v2.EmailBackend") -class SendGridBackendIntegrationTests(SimpleTestCase, AnymailTestMixin): - """SendGrid v2 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 v2 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.assertUUIDIsValid(message_id) # Anymail generates a UUID tracking id - 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(RUN_LIVE_TESTS, "RUN_LIVE_TESTS disabled in this environment") -@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_v2.EmailBackend") -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))