Add unit tests for the async function, change deprecate message and address other review comments

Author: yvonnep165

firebase_admin/_messaging_encoder.py

@@ -39,18 +39,18 @@ class Message:
         apns: An instance of ``messaging.ApnsConfig`` (optional).
         fcm_options: An instance of ``messaging.FCMOptions`` (optional).
         fid: The Firebase installation ID of an FCM registered app instance to which the
-            message should be sent (optional)
+            message should be sent (optional).
         token: Deprecated. Use ``fid`` instead.
         topic: Name of the FCM topic to which the message should be sent (optional). Topic name
             may contain the ``/topics/`` prefix.
         condition: The FCM condition to which the message should be sent (optional).
     """
 
     def __init__(self, data=None, notification=None, android=None, webpush=None, apns=None,
-                 fcm_options=None, fid=None, token=None, topic=None, condition=None):
+                 fcm_options=None, token=None, topic=None, condition=None, fid=None):
         if token is not None:
             warnings.warn(
-                "Deprecated. Use 'fid' instead.",
+                "Message.token is deprecated. Use fid instead.",
                 DeprecationWarning,
                 stacklevel=2
             )
@@ -73,7 +73,7 @@ class MulticastMessage:
     """A message that can be sent to multiple tokens or fids via Firebase Cloud Messaging.
 
     Args:
-        fids: A list of Firebase Installation IDs of targeted app instances (optional)
+        fids: A list of Firebase Installation IDs of targeted app instances (optional).
         tokens: Deprecated. Use ``fids`` instead (optional).
         data: A dictionary of data fields (optional). All keys and values in the dictionary must be
             strings.
@@ -88,7 +88,7 @@ def __init__(
             webpush=None, apns=None, fcm_options=None):
         if tokens is not None:
             warnings.warn(
-                "Deprecated. Use 'fids' instead.",
+                "MulticastMessage.tokens is deprecated. Use fids instead.",
                 DeprecationWarning,
                 stacklevel=2
             )

tests/test_messaging.py

@@ -157,11 +157,13 @@ def test_fids_type(self):
         assert len(message.fids) == 500
 
     def test_tokens_deprecation_warning(self):
-        with pytest.deprecated_call():
+        msg = 'MulticastMessage.tokens is deprecated. Use fids instead.'
+        with pytest.warns(DeprecationWarning, match=msg):
             messaging.MulticastMessage(tokens=['token'])
 
     def test_tokens_deprecation_warning_positional(self):
-        with pytest.deprecated_call():
+        msg = 'MulticastMessage.tokens is deprecated. Use fids instead.'
+        with pytest.warns(DeprecationWarning, match=msg):
             messaging.MulticastMessage(['token'])
 
 
@@ -220,7 +222,8 @@ def test_empty_message(self):
         check_encoding(messaging.Message(condition='value'), {'condition': 'value'})
 
     def test_token_deprecation_warning(self):
-        with pytest.deprecated_call():
+        msg = 'Message.token is deprecated. Use fid instead.'
+        with pytest.warns(DeprecationWarning, match=msg):
             messaging.Message(token='value')
 
     @pytest.mark.parametrize('data', NON_DICT_ARGS)
@@ -2287,6 +2290,48 @@ def test_send_each_for_multicast_fids(self):
         assert all(r.success for r in batch_response.responses)
         assert not any(r.exception for r in batch_response.responses)
 
+    @respx.mock
+    @pytest.mark.asyncio
+    async def test_send_each_for_multicast_async(self):
+        responses = [
+            respx.MockResponse(200, http_version='HTTP/2', json={'name': 'message-id1'}),
+            respx.MockResponse(200, http_version='HTTP/2', json={'name': 'message-id2'}),
+        ]
+        msg = messaging.MulticastMessage(tokens=['foo1', 'foo2'])
+        route = respx.request(
+            method='POST',
+            url='https://fcm.googleapis.com/v1/projects/explicit-project-id/messages:send'
+        )
+        route.side_effect = responses
+        batch_response = await messaging.send_each_for_multicast_async(msg, dry_run=True)
+        assert batch_response.success_count == 2
+        assert batch_response.failure_count == 0
+        assert len(batch_response.responses) == 2
+        assert [r.message_id for r in batch_response.responses] == ['message-id1', 'message-id2']
+        assert all(r.success for r in batch_response.responses)
+        assert not any(r.exception for r in batch_response.responses)
+
+    @respx.mock
+    @pytest.mark.asyncio
+    async def test_send_each_for_multicast_async_fids(self):
+        responses = [
+            respx.MockResponse(200, http_version='HTTP/2', json={'name': 'message-id1'}),
+            respx.MockResponse(200, http_version='HTTP/2', json={'name': 'message-id2'}),
+        ]
+        msg = messaging.MulticastMessage(fids=['foo1', 'foo2'])
+        route = respx.request(
+            method='POST',
+            url='https://fcm.googleapis.com/v1/projects/explicit-project-id/messages:send'
+        )
+        route.side_effect = responses
+        batch_response = await messaging.send_each_for_multicast_async(msg, dry_run=True)
+        assert batch_response.success_count == 2
+        assert batch_response.failure_count == 0
+        assert len(batch_response.responses) == 2
+        assert [r.message_id for r in batch_response.responses] == ['message-id1', 'message-id2']
+        assert all(r.success for r in batch_response.responses)
+        assert not any(r.exception for r in batch_response.responses)
+
     @pytest.mark.parametrize('status', HTTP_ERROR_CODES)
     def test_send_each_for_multicast_detailed_error(self, status):
         success_payload = json.dumps({'name': 'message-id'})