mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 03:41:05 -05:00
SendGrid: merge 'filters' in esp_extra
Previously, setting esp_extra['x-smtpapi']['filters'] would override the entire filters setting, potentially undoing other Anymail options that use SendGrid filters (like track_opens). Now, 'filters' is special-cased, and merged with any other Anymail filter options. (We don't do a fully deep merge, because otherwise there would be no way to use esp_extra to *clear* Anymail settings.)
This commit is contained in:
@@ -423,18 +423,35 @@ class SendGridBackendAnymailFeatureTests(SendGridBackendMockAPITestCase):
|
||||
|
||||
def test_esp_extra(self):
|
||||
self.message.tags = ["tag"]
|
||||
self.message.track_clicks = True
|
||||
self.message.esp_extra = {
|
||||
'x-smtpapi': {'asm_group_id': 1},
|
||||
'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
|
||||
# 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):
|
||||
|
||||
@@ -1,10 +1,8 @@
|
||||
# Anymail test utils
|
||||
import sys
|
||||
import unittest
|
||||
|
||||
import os
|
||||
import re
|
||||
import six
|
||||
import warnings
|
||||
from base64 import b64decode
|
||||
from contextlib import contextmanager
|
||||
@@ -60,19 +58,23 @@ class AnymailTestMixin:
|
||||
finally:
|
||||
warnings.resetwarnings()
|
||||
|
||||
# Plus these methods added below:
|
||||
# assertCountEqual
|
||||
# assertRaisesRegex
|
||||
# assertRegex
|
||||
def assertCountEqual(self, *args, **kwargs):
|
||||
try:
|
||||
return super(AnymailTestMixin, self).assertCountEqual(*args, **kwargs)
|
||||
except TypeError:
|
||||
return self.assertItemsEqual(*args, **kwargs) # Python 2
|
||||
|
||||
# Add the Python 3 TestCase assertions, if they're not already there.
|
||||
# (The six implementations cause infinite recursion if installed on
|
||||
# a py3 TestCase.)
|
||||
for method in ('assertCountEqual', 'assertRaisesRegex', 'assertRegex'):
|
||||
try:
|
||||
getattr(unittest.TestCase, method)
|
||||
except AttributeError:
|
||||
setattr(AnymailTestMixin, method, getattr(six, method))
|
||||
def assertRaisesRegex(self, *args, **kwargs):
|
||||
try:
|
||||
return super(AnymailTestMixin, self).assertRaisesRegex(*args, **kwargs)
|
||||
except TypeError:
|
||||
return self.assertRaisesRegexp(*args, **kwargs) # Python 2
|
||||
|
||||
def assertRegex(self, *args, **kwargs):
|
||||
try:
|
||||
return super(AnymailTestMixin, self).assertRegex(*args, **kwargs)
|
||||
except TypeError:
|
||||
return self.assertRegexpMatches(*args, **kwargs) # Python 2
|
||||
|
||||
|
||||
# Backported from python 3.5
|
||||
|
||||
Reference in New Issue
Block a user