File: test_mailjet_webhooks.py

package info (click to toggle)
django-anymail 13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 2,480 kB
  • sloc: python: 27,832; makefile: 132; javascript: 33; sh: 9
file content (358 lines) | stat: -rw-r--r-- 13,436 bytes parent folder | download | duplicates (2)
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
import json
from datetime import datetime, timezone
from unittest.mock import ANY

from django.test import tag

from anymail.signals import AnymailTrackingEvent
from anymail.webhooks.mailjet import MailjetTrackingWebhookView

from .webhook_cases import WebhookBasicAuthTestCase, WebhookTestCase


@tag("mailjet")
class MailjetWebhookSecurityTestCase(WebhookBasicAuthTestCase):
    def call_webhook(self):
        return self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps([]),
        )

    # Actual tests are in WebhookBasicAuthTestCase


@tag("mailjet")
class MailjetDeliveryTestCase(WebhookTestCase):
    def test_sent_event(self):
        # Mailjet's "sent" event indicates receiving MTA has accepted message;
        # Anymail calls this "delivered"
        raw_events = [
            {
                "event": "sent",
                "time": 1498093527,
                "MessageID": 12345678901234567,
                "email": "recipient@example.com",
                "mj_campaign_id": 1234567890,
                "mj_contact_id": 9876543210,
                "customcampaign": "tag1",
                "mj_message_id": "12345678901234567",
                "smtp_reply": "sent (250 2.0.0 OK 1498093527 a67bc12345def.22 - gsmtp)",
                "Payload": '{"meta1": "simple string", "meta2": 2}',
            }
        ]
        response = self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps(raw_events),
        )
        self.assertEqual(response.status_code, 200)
        kwargs = self.assert_handler_called_once_with(
            self.tracking_handler,
            sender=MailjetTrackingWebhookView,
            event=ANY,
            esp_name="Mailjet",
        )
        event = kwargs["event"]
        self.assertIsInstance(event, AnymailTrackingEvent)
        self.assertEqual(event.event_type, "delivered")
        self.assertEqual(
            event.timestamp, datetime(2017, 6, 22, 1, 5, 27, tzinfo=timezone.utc)
        )
        self.assertEqual(event.esp_event, raw_events[0])
        self.assertEqual(
            event.mta_response,
            "sent (250 2.0.0 OK 1498093527 a67bc12345def.22 - gsmtp)",
        )
        # message_id converted to str (matching backend status):
        self.assertEqual(event.message_id, "12345678901234567")
        self.assertEqual(event.recipient, "recipient@example.com")
        self.assertEqual(event.tags, ["tag1"])
        self.assertEqual(event.metadata, {"meta1": "simple string", "meta2": 2})

    def test_open_event(self):
        raw_events = [
            {
                "event": "open",
                "time": 1498093527,
                "MessageID": 12345678901234567,
                "email": "recipient@example.com",
                "mj_campaign_id": 1234567890,
                "mj_contact_id": 9876543210,
                "customcampaign": "",
                "ip": "192.168.100.100",
                "geo": "US",
                "agent": "Mozilla/5.0 (via ggpht.com GoogleImageProxy)",
                "Payload": "",
            }
        ]
        response = self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps(raw_events),
        )
        self.assertEqual(response.status_code, 200)
        kwargs = self.assert_handler_called_once_with(
            self.tracking_handler,
            sender=MailjetTrackingWebhookView,
            event=ANY,
            esp_name="Mailjet",
        )
        event = kwargs["event"]
        self.assertEqual(event.event_type, "opened")
        self.assertEqual(event.message_id, "12345678901234567")
        self.assertEqual(event.recipient, "recipient@example.com")
        self.assertEqual(
            event.user_agent, "Mozilla/5.0 (via ggpht.com GoogleImageProxy)"
        )
        self.assertEqual(event.tags, [])
        self.assertEqual(event.metadata, {})

    def test_click_event(self):
        raw_events = [
            {
                "event": "open",
                "time": 1498093527,
                "MessageID": 12345678901234567,
                "email": "recipient@example.com",
                "mj_campaign_id": 1234567890,
                "mj_contact_id": 9876543210,
                "customcampaign": "",
                "url": "http://example.com",
                "ip": "192.168.100.100",
                "geo": "US",
                "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5)"
                " Chrome/58.0.3029.110",
            }
        ]
        response = self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps(raw_events),
        )
        self.assertEqual(response.status_code, 200)
        kwargs = self.assert_handler_called_once_with(
            self.tracking_handler,
            sender=MailjetTrackingWebhookView,
            event=ANY,
            esp_name="Mailjet",
        )
        event = kwargs["event"]
        self.assertEqual(event.event_type, "opened")
        self.assertEqual(event.message_id, "12345678901234567")
        self.assertEqual(event.recipient, "recipient@example.com")
        self.assertEqual(
            event.user_agent,
            "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) Chrome/58.0.3029.110",
        )
        self.assertEqual(event.click_url, "http://example.com")
        self.assertEqual(event.tags, [])
        self.assertEqual(event.metadata, {})

    def test_bounce_event(self):
        raw_events = [
            {
                "event": "bounce",
                "time": 1498093527,
                "MessageID": 12345678901234567,
                "email": "invalid@invalid",
                "mj_campaign_id": 1234567890,
                "mj_contact_id": 9876543210,
                "customcampaign": "",
                "blocked": True,
                "hard_bounce": True,
                "error_related_to": "domain",
                "error": "invalid domain",
            }
        ]
        response = self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps(raw_events),
        )
        self.assertEqual(response.status_code, 200)
        kwargs = self.assert_handler_called_once_with(
            self.tracking_handler,
            sender=MailjetTrackingWebhookView,
            event=ANY,
            esp_name="Mailjet",
        )
        event = kwargs["event"]
        self.assertEqual(event.event_type, "bounced")
        self.assertEqual(event.message_id, "12345678901234567")
        self.assertEqual(event.recipient, "invalid@invalid")
        self.assertEqual(event.reject_reason, "bounced")
        self.assertEqual(event.mta_response, None)

    def test_blocked_event(self):
        raw_events = [
            {
                "event": "blocked",
                "time": 1498093527,
                "MessageID": 12345678901234567,
                "email": "bad@example.com",
                "mj_campaign_id": 0,
                "mj_contact_id": 9876543210,
                "customcampaign": "",
                "error_related_to": "domain",
                "error": "typofix",
            }
        ]
        response = self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps(raw_events),
        )
        self.assertEqual(response.status_code, 200)
        kwargs = self.assert_handler_called_once_with(
            self.tracking_handler,
            sender=MailjetTrackingWebhookView,
            event=ANY,
            esp_name="Mailjet",
        )
        event = kwargs["event"]
        self.assertEqual(event.event_type, "rejected")
        self.assertEqual(event.message_id, "12345678901234567")
        self.assertEqual(event.recipient, "bad@example.com")
        self.assertEqual(event.reject_reason, "invalid")
        self.assertEqual(event.mta_response, None)

    def test_spam_event(self):
        raw_events = [
            {
                "event": "spam",
                "time": 1498093527,
                "MessageID": 12345678901234567,
                "email": "spam@example.com",
                "mj_campaign_id": 1234567890,
                "mj_contact_id": 9876543210,
                "customcampaign": "",
                "source": "greylisted",
            }
        ]
        response = self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps(raw_events),
        )
        self.assertEqual(response.status_code, 200)
        kwargs = self.assert_handler_called_once_with(
            self.tracking_handler,
            sender=MailjetTrackingWebhookView,
            event=ANY,
            esp_name="Mailjet",
        )
        event = kwargs["event"]
        self.assertEqual(event.event_type, "complained")
        self.assertEqual(event.message_id, "12345678901234567")
        self.assertEqual(event.recipient, "spam@example.com")

    def test_unsub_event(self):
        raw_events = [
            {
                "event": "unsub",
                "time": 1498093527,
                "MessageID": 12345678901234567,
                "email": "recipient@example.com",
                "mj_campaign_id": 1234567890,
                "mj_contact_id": 9876543210,
                "customcampaign": "",
                "mj_list_id": 0,
                "ip": "127.0.0.4",
                "geo": "",
                "agent": "List-Unsubscribe",
            }
        ]
        response = self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps(raw_events),
        )
        self.assertEqual(response.status_code, 200)
        kwargs = self.assert_handler_called_once_with(
            self.tracking_handler,
            sender=MailjetTrackingWebhookView,
            event=ANY,
            esp_name="Mailjet",
        )
        event = kwargs["event"]
        self.assertEqual(event.event_type, "unsubscribed")
        self.assertEqual(event.message_id, "12345678901234567")
        self.assertEqual(event.recipient, "recipient@example.com")

    def test_bounced_greylist_event(self):
        # greylist "bounce" should be reported as "deferred" (will be retried later)
        raw_events = [
            {
                "event": "bounce",
                "time": 1498093527,
                "MessageID": 12345678901234567,
                "email": "protected@example.com",
                "mj_campaign_id": 1234567890,
                "mj_contact_id": 9876543210,
                "customcampaign": "",
                "blocked": True,
                "hard_bounce": False,
                "error_related_to": "domain",
                "error": "greylisted",
            }
        ]
        response = self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps(raw_events),
        )
        self.assertEqual(response.status_code, 200)
        kwargs = self.assert_handler_called_once_with(
            self.tracking_handler,
            sender=MailjetTrackingWebhookView,
            event=ANY,
            esp_name="Mailjet",
        )
        event = kwargs["event"]
        self.assertEqual(event.event_type, "deferred")
        self.assertEqual(event.message_id, "12345678901234567")
        self.assertEqual(event.recipient, "protected@example.com")
        self.assertEqual(event.reject_reason, "other")

    def test_non_grouped_event(self):
        # If you don't enable "group events" on a webhook, Mailjet sends a single bare
        # event (not a list of one event, despite what the docs say).
        raw_event = {
            "event": "sent",
            "time": 1498093527,
            "MessageID": 12345678901234567,
            "email": "recipient@example.com",
            "mj_campaign_id": 1234567890,
            "mj_contact_id": 9876543210,
            "customcampaign": "",
            "mj_message_id": "12345678901234567",
            "smtp_reply": "sent (250 2.0.0 OK 1498093527 a67bc12345def.22 - gsmtp)",
            "Payload": "",
        }
        response = self.client.post(
            "/anymail/mailjet/tracking/",
            content_type="application/json",
            data=json.dumps(raw_event),
        )
        self.assertEqual(response.status_code, 200)
        kwargs = self.assert_handler_called_once_with(
            self.tracking_handler,
            sender=MailjetTrackingWebhookView,
            event=ANY,
            esp_name="Mailjet",
        )
        event = kwargs["event"]
        self.assertIsInstance(event, AnymailTrackingEvent)
        self.assertEqual(event.event_type, "delivered")
        self.assertEqual(
            event.timestamp, datetime(2017, 6, 22, 1, 5, 27, tzinfo=timezone.utc)
        )
        self.assertEqual(event.esp_event, raw_event)
        self.assertEqual(
            event.mta_response,
            "sent (250 2.0.0 OK 1498093527 a67bc12345def.22 - gsmtp)",
        )
        # message_id converted to str (matching backend status)
        self.assertEqual(event.message_id, "12345678901234567")
        self.assertEqual(event.recipient, "recipient@example.com")