forked from jazzband/django-push-notifications
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_models.py
470 lines (386 loc) · 15.9 KB
/
test_models.py
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
from unittest import mock
from django.test import TestCase
from django.utils import timezone
from firebase_admin import messaging
from firebase_admin.exceptions import InvalidArgumentError
from firebase_admin.messaging import BatchResponse, Message, SendResponse
from push_notifications.gcm import dict_to_fcm_message, send_bulk_message
from push_notifications.models import APNSDevice, GCMDevice
from . import responses
class GCMModelTestCase(TestCase):
def _create_devices(self, devices):
for device in devices:
GCMDevice.objects.create(registration_id=device, cloud_message_type="GCM")
def _create_fcm_devices(self, devices):
for device in devices:
GCMDevice.objects.create(registration_id=device, cloud_message_type="FCM")
def test_can_save_gcm_device(self):
device = GCMDevice.objects.create(
registration_id="a valid registration id", cloud_message_type="GCM"
)
assert device.id is not None
assert device.date_created is not None
assert device.date_created.date() == timezone.now().date()
def test_can_create_save_device(self):
device = APNSDevice.objects.create(registration_id="a valid registration id")
assert device.id is not None
assert device.date_created is not None
assert device.date_created.date() == timezone.now().date()
def test_fcm_send_message(self):
device = GCMDevice.objects.create(registration_id="abc", cloud_message_type="FCM")
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS
) as p:
device.send_message("Hello world")
# one call
self.assertEqual(len(p.mock_calls), 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# only one message
messages = call[0][0]
self.assertEqual(len(messages), 1)
message = messages[0]
self.assertIsInstance(message, Message)
self.assertEqual(message.token, "abc")
self.assertEqual(message.android.notification.body, "Hello world")
def test_fcm_send_message_with_fcm_message(self):
device = GCMDevice.objects.create(registration_id="abc", cloud_message_type="FCM")
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS
) as p:
message_to_send = messaging.Message(
notification=messaging.Notification(
title='Hello world',
body='What a beautiful day.'
),
)
device.send_message(message_to_send)
# one call
self.assertEqual(len(p.mock_calls), 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# only one message
messages = call[0][0]
self.assertEqual(len(messages), 1)
message = messages[0]
self.assertIsInstance(message, Message)
self.assertEqual(message.token, "abc")
self.assertEqual(message.notification.body, "What a beautiful day.")
self.assertEqual(message.notification.title, "Hello world")
def test_fcm_send_message_extra_data(self):
device = GCMDevice.objects.create(registration_id="abc", cloud_message_type="FCM")
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS
) as p:
device.send_message("Hello world", extra={"foo": "bar"})
self.assertEqual(len(p.mock_calls), 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# only one message
messages = call[0][0]
self.assertEqual(len(messages), 1)
message = messages[0]
self.assertIsInstance(message, Message)
self.assertEqual(message.token, "abc")
self.assertEqual(message.android.notification.body, "Hello world")
self.assertEqual(message.data, {"foo": "bar"})
def test_fcm_send_message_extra_options(self):
device = GCMDevice.objects.create(registration_id="abc", cloud_message_type="FCM")
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS
) as p:
device.send_message("Hello world", collapse_key="test_key", foo="bar")
self.assertEqual(len(p.mock_calls), 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# only one message
messages = call[0][0]
self.assertEqual(len(messages), 1)
message = messages[0]
self.assertIsInstance(message, Message)
self.assertEqual(message.token, "abc")
self.assertEqual(message.android.notification.body, "Hello world")
self.assertEqual(message.android.collapse_key, "test_key")
self.assertFalse(message.data)
def test_fcm_send_message_extra_notification(self):
device = GCMDevice.objects.create(registration_id="abc", cloud_message_type="FCM")
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS
) as p:
device.send_message("Hello world", extra={"icon": "test_icon"}, title="test")
self.assertEqual(p.call_count, 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# only one message
messages = call[0][0]
self.assertEqual(len(messages), 1)
message = messages[0]
self.assertIsInstance(message, Message)
self.assertEqual(message.token, "abc")
self.assertEqual(message.android.notification.body, "Hello world")
self.assertEqual(message.android.notification.title, "test")
self.assertEqual(message.android.notification.icon, "test_icon")
self.assertFalse(message.data)
def test_fcm_send_message_extra_options_and_notification_and_data(self):
device = GCMDevice.objects.create(registration_id="abc", cloud_message_type="FCM")
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS
) as p:
device.send_message(
"Hello world",
extra={"foo": "bar", "icon": "test_icon"},
title="test",
collapse_key="test_key"
)
self.assertEqual(p.call_count, 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# only one message
messages = call[0][0]
self.assertEqual(len(messages), 1)
message = messages[0]
self.assertIsInstance(message, Message)
self.assertEqual(message.token, "abc")
self.assertEqual(message.android.collapse_key, "test_key")
self.assertEqual(message.android.notification.body, "Hello world")
self.assertEqual(message.android.notification.title, "test")
self.assertEqual(message.android.notification.icon, "test_icon")
self.assertEqual(message.data, {"foo": "bar"})
def test_fcm_send_message_to_multiple_devices(self):
self._create_fcm_devices(["abc", "abc1"])
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS_MULTIPLE
) as p:
GCMDevice.objects.all().send_message("Hello world")
self.assertEqual(p.call_count, 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# two messages
messages = call[0][0]
self.assertEqual(len(messages), 2)
message_one = messages[0]
message_two = messages[1]
self.assertIsInstance(message_one, Message)
self.assertIsInstance(message_two, Message)
self.assertEqual(message_one.token, "abc")
self.assertEqual(message_two.token, "abc1")
self.assertEqual(message_one.android.notification.body, "Hello world")
self.assertEqual(message_two.android.notification.body, "Hello world")
def test_fcm_send_message_to_multiple_devices_fcm_message(self):
self._create_fcm_devices(["abc", "abc1"])
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS_MULTIPLE
) as p:
message_to_send = messaging.Message(
notification=messaging.Notification(
title='Hello world',
body='What a beautiful day.'
),
)
GCMDevice.objects.all().send_message(message_to_send)
self.assertEqual(p.call_count, 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# two messages
messages = call[0][0]
self.assertEqual(len(messages), 2)
message_one = messages[0]
message_two = messages[1]
self.assertIsInstance(message_one, Message)
self.assertIsInstance(message_two, Message)
self.assertEqual(message_one.token, "abc")
self.assertEqual(message_two.token, "abc1")
self.assertEqual(message_one.notification.title, "Hello world")
self.assertEqual(message_one.notification.body, "What a beautiful day.")
self.assertEqual(message_two.notification.title, "Hello world")
self.assertEqual(message_two.notification.body, "What a beautiful day.")
def test_gcm_send_message_does_not_send(self):
device = GCMDevice.objects.create(registration_id="abc", cloud_message_type="GCM")
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS_MULTIPLE
) as p:
message_to_send = messaging.Message(
notification=messaging.Notification(
title='Hello world',
body='What a beautiful day.'
),
)
response = device.send_message(message_to_send)
self.assertIsNone(response)
self.assertEqual(p.call_count, 0)
def test_gcm_send_multiple_message_does_not_send(self):
self._create_devices(["abc", "abc1"])
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS_MULTIPLE
) as p:
message_to_send = messaging.Message(
notification=messaging.Notification(
title='Hello world',
body='What a beautiful day.'
),
)
response = GCMDevice.objects.all().send_message(message_to_send).responses
self.assertEqual(p.call_count, 0)
self.assertEqual(len(response), 0)
def test_fcm_send_message_active_devices(self):
GCMDevice.objects.create(registration_id="abc", active=True, cloud_message_type="FCM")
GCMDevice.objects.create(registration_id="xyz", active=False, cloud_message_type="FCM")
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS_MULTIPLE
) as p:
GCMDevice.objects.all().send_message("Hello world")
self.assertEqual(p.call_count, 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# only one message (one is inactive)
messages = call[0][0]
self.assertEqual(len(messages), 1)
message_one = messages[0]
self.assertIsInstance(message_one, Message)
self.assertEqual(message_one.token, "abc")
self.assertEqual(message_one.android.notification.body, "Hello world")
def test_fcm_send_message_collapse_to_multiple_devices(self):
self._create_fcm_devices(["abc", "abc1"])
with mock.patch(
"firebase_admin.messaging.send_all", return_value=responses.FCM_SUCCESS_MULTIPLE
) as p:
GCMDevice.objects.all().send_message("Hello world", collapse_key="test_key")
self.assertEqual(p.call_count, 1)
call = p.call_args
kwargs = call[1]
self.assertTrue("dry_run" in kwargs)
self.assertFalse(kwargs["dry_run"])
self.assertTrue("app" in kwargs)
self.assertIsNone(kwargs["app"])
# two messages
messages = call[0][0]
self.assertEqual(len(messages), 2)
message_one = messages[0]
message_two = messages[1]
self.assertIsInstance(message_one, Message)
self.assertIsInstance(message_two, Message)
self.assertEqual(message_one.token, "abc")
self.assertEqual(message_two.token, "abc1")
self.assertEqual(message_one.android.collapse_key, "test_key")
self.assertEqual(message_two.android.collapse_key, "test_key")
def test_fcm_send_message_to_single_device_with_error(self):
# these errors are device specific, device.active will be set false
devices = ["abc", "abc1", "abc2"]
self._create_fcm_devices(devices)
errors = [
messaging.UnregisteredError("error"),
messaging.SenderIdMismatchError("error"),
InvalidArgumentError("Invalid registration"),
]
for index, error in enumerate(errors):
return_value = BatchResponse(
[SendResponse(resp={"name": "..."}, exception=error)]
)
with mock.patch(
"firebase_admin.messaging.send_all", return_value=return_value
):
device = GCMDevice.objects.get(registration_id=devices[index])
device.send_message("Hello World!")
self.assertFalse(GCMDevice.objects.get(registration_id=devices[index]).active)
def test_fcm_send_message_to_single_device_with_error_mismatch(self):
device = GCMDevice.objects.create(registration_id="abc", cloud_message_type="FCM")
return_value = BatchResponse(
[SendResponse(resp={"name": "..."}, exception=OSError())]
)
with mock.patch(
"firebase_admin.messaging.send_all",
return_value=return_value
):
# these errors are not device specific, device is not deactivated
response = device.send_message("Hello World!")
self.assertTrue(GCMDevice.objects.get(registration_id="abc").active)
self.assertEqual(response.failure_count, 1)
def test_fcm_send_message_to_multiple_devices_with_error(self):
self._create_fcm_devices(["abc", "abc1", "abc2", "abc3"])
return_value = BatchResponse([
SendResponse(resp={"name": "..."}, exception=messaging.UnregisteredError("error")),
SendResponse(resp={"name": "..."}, exception=messaging.SenderIdMismatchError("error")),
SendResponse(resp={"name": "..."}, exception=OSError()),
SendResponse(resp={"name": "..."}, exception=InvalidArgumentError("Invalid registration")),
])
with mock.patch(
"firebase_admin.messaging.send_all", return_value=return_value
):
GCMDevice.objects.all().send_message("Hello World")
self.assertFalse(GCMDevice.objects.get(registration_id="abc").active)
self.assertFalse(GCMDevice.objects.get(registration_id="abc1").active)
self.assertTrue(GCMDevice.objects.get(registration_id="abc2").active)
self.assertFalse(GCMDevice.objects.get(registration_id="abc3").active)
def test_fcm_send_message_to_multiple_devices_with_error_b(self):
self._create_fcm_devices(["abc", "abc1", "abc2", "abc3"])
return_value = BatchResponse([
SendResponse(resp={"name": "..."}, exception=OSError()),
SendResponse(resp={"name": "..."}, exception=OSError()),
SendResponse(resp={"name": "..."}, exception=messaging.UnregisteredError("error")),
SendResponse(resp={"name": "..."}, exception=OSError()),
])
with mock.patch(
"firebase_admin.messaging.send_all", return_value=return_value
):
GCMDevice.objects.all().send_message("Hello World")
self.assertTrue(GCMDevice.objects.get(registration_id="abc").active)
self.assertTrue(GCMDevice.objects.get(registration_id="abc1").active)
self.assertFalse(GCMDevice.objects.get(registration_id="abc2").active)
self.assertTrue(GCMDevice.objects.get(registration_id="abc3").active)
def test_fcm_send_message_with_no_reg_ids(self):
self._create_fcm_devices(["abc", "abc1"])
with mock.patch(
"firebase_admin.messaging.send_all",
return_value=responses.FCM_SUCCESS_MULTIPLE
) as p:
GCMDevice.objects.filter(registration_id="xyz").send_message("Hello World")
p.assert_not_called()
with mock.patch(
"firebase_admin.messaging.send_all",
return_value=responses.FCM_SUCCESS_MULTIPLE
) as p:
reg_ids = [obj.registration_id for obj in GCMDevice.objects.all()]
message = dict_to_fcm_message({"message": "Hello World"})
send_bulk_message(reg_ids, message)
p.assert_called_once()
def test_can_save_wsn_device(self):
device = GCMDevice.objects.create(registration_id="a valid registration id")
self.assertIsNotNone(device.pk)
self.assertIsNotNone(device.date_created)
self.assertEqual(device.date_created.date(), timezone.now().date())