1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
import pytest
from unittest import mock
from django.conf import settings
from django.core.mail import send_mail
from django.core.mail import send_mass_mail
from django.core.mail import EmailMultiAlternatives
from django.utils.functional import empty
from sparkpost import EU_API, US_API
from sparkpost.django.email_backend import SparkPostEmailBackend
from sparkpost.django.exceptions import UnsupportedContent
from sparkpost.transmissions import Transmissions
API_KEY = 'API_Key'
def reconfigure_settings(**new_settings):
old_settings = settings._wrapped
settings._wrapped = empty
settings.configure(default_settings=old_settings, **new_settings)
reconfigure_settings(
DEBUG=True,
EMAIL_BACKEND='sparkpost.django.email_backend.SparkPostEmailBackend',
SPARKPOST_API_KEY=API_KEY
)
def get_params(overrides=None):
if overrides is None:
overrides = {}
defaults = {
'subject': 'test subject',
'message': 'test body',
'from_email': 'from@example.com',
'recipient_list': ['to@example.com'],
}
params = defaults.copy()
params.update(overrides)
return params
def mailer(params):
return send_mail(**params)
def test_password_retrieval():
backend = SparkPostEmailBackend()
assert backend.client.api_key == API_KEY
def test_default_base_uri_retrieval():
backend = SparkPostEmailBackend()
assert backend.client.base_uri.startswith('https://' + US_API)
def test_eu_base_uri_retrieval():
reconfigure_settings(SPARKPOST_BASE_URI=EU_API)
backend = SparkPostEmailBackend()
assert backend.client.base_uri.startswith('https://' + EU_API)
def test_fail_silently():
# should not raise
with mock.patch.object(Transmissions, 'send') as mock_send:
mock_send.side_effect = Exception('i should not be raised')
mailer(get_params({'fail_silently': True}))
# should raise
with mock.patch.object(Transmissions, 'send') as mock_send:
mock_send.side_effect = Exception('i should be raised')
with pytest.raises(Exception):
mailer(get_params())
def test_successful_sending():
with mock.patch.object(Transmissions, 'send') as mock_send:
mock_send.return_value = {'total_accepted_recipients': 1,
'total_rejected_recipients': 2}
result = mailer(get_params({
'recipient_list': ['to1@example.com', 'to2@example.com'],
'fail_silently': True
}))
assert result == 1
with mock.patch.object(Transmissions, 'send') as mock_send:
mock_send.return_value = {'total_accepted_recipients': 10,
'total_rejected_recipients': 2}
result = mailer(
get_params(
{'recipient_list': ['to1@example.com', 'to2@example.com'],
'fail_silently': True
}
))
assert result == 10
def test_send_number_of_emails_correctly():
with mock.patch.object(Transmissions, 'send') as mock_send:
mailer(get_params({
'recipient_list': ['to1@example.com', 'to2@example.com'],
'fail_silently': True
}))
assert mock_send.call_count == 1
with mock.patch.object(Transmissions, 'send') as mock_send:
message1 = ('message 1 subject', 'message 1 body', 'from@example.com',
['to1@example.com'])
message2 = ('message 2 subject', 'message 2 body', 'from@example.com',
['to2@example.com'])
message3 = ('message 3 subject', 'message 3 body', 'from@example.com',
['to3@example.com'])
send_mass_mail((message1, message2, message3), fail_silently=False)
assert mock_send.call_count == 3
def test_params():
recipients = ['to1@example.com', 'to2@example.com']
with mock.patch.object(Transmissions, 'send'):
mailer(get_params(
{'recipient_list': recipients,
'fail_silently': True
}
))
Transmissions.send.assert_called_with(recipients=recipients,
text='test body',
from_email='from@example.com',
subject='test subject'
)
def test_content_types():
def new_send(**kwargs):
assert kwargs['text'] == 'hello there'
assert kwargs['html'] == '<p>Hello There</p>'
return {
'total_accepted_recipients': 0,
'total_rejected_recipients': 0
}
with mock.patch.object(Transmissions, 'send') as mock_send:
mock_send.side_effect = new_send
send_mail(
'test subject',
'hello there',
'from@example.com',
['to@example.com'],
html_message='<p>Hello There</p>'
)
def test_send_plain_mail_after_html_mail():
SPARKPOST_OPTIONS = {
'track_opens': False,
'track_clicks': False,
'transactional': True,
}
reconfigure_settings(SPARKPOST_OPTIONS=SPARKPOST_OPTIONS)
def new_send(**kwargs):
assert kwargs['text'] == 'hello there'
assert kwargs['html'] == '<p>Hello There</p>'
return {
'total_accepted_recipients': 0,
'total_rejected_recipients': 0
}
def new_send_text_only(**kwargs):
assert kwargs['text'] == 'hello there again in text only'
assert "html" not in kwargs
return {
'total_accepted_recipients': 0,
'total_rejected_recipients': 0
}
with mock.patch.object(Transmissions, 'send') as mock_send:
mock_send.side_effect = new_send
send_mail(
'test subject',
'hello there',
'from@example.com',
['to@example.com'],
html_message='<p>Hello There</p>'
)
mock_send.side_effect = new_send_text_only
send_mail(
'test subject 2',
'hello there again in text only',
'from@example.com',
['to@example.com'],
)
def test_unsupported_content_types():
params = get_params()
with pytest.raises(UnsupportedContent):
mail = EmailMultiAlternatives(
params['subject'],
'plain text',
params['from_email'],
params['recipient_list'])
mail.attach_alternative('<ppp>non-plain content</ppp>', 'text/alien')
mail.send()
def test_settings_options():
SPARKPOST_OPTIONS = {
'track_opens': False,
'track_clicks': False,
'transactional': True,
}
reconfigure_settings(SPARKPOST_OPTIONS=SPARKPOST_OPTIONS)
with mock.patch.object(Transmissions, 'send'):
mailer(get_params())
expected_kargs = get_params().copy()
expected_kargs["text"] = expected_kargs["message"]
expected_kargs["recipients"] = expected_kargs["recipient_list"]
del expected_kargs["message"]
del expected_kargs["recipient_list"]
expected_kargs.update(SPARKPOST_OPTIONS)
Transmissions.send.assert_called_with(**expected_kargs)
|
