test: Fallback to external mock for AsyncMock

AsyncMock is not included in unittest.mock under Python 3.7, so we must
fallback to the external mock requirement for that Python version. Only
install it for that version.

Keep this as a separate commit so it can be reverted when 3.7 isn't
supported anymore.

Author: s-t-e-v-e-n-k

noxfile.py

@@ -124,6 +124,7 @@ def default(session, install_grpc=True, prerelease=False, install_async_rest=Fal
 
     session.install(
         "dataclasses",
+        "mock; python_version=='3.7'",
         "pytest",
         "pytest-cov",
         "pytest-xdist",
@@ -280,6 +281,7 @@ def mypy(session):
         "types-requests",
         "types-protobuf",
         "types-dataclasses",
+        "types-mock; python_version=='3.7'",
     )
     session.run("mypy", "google", "tests")
 

tests/asyncio/gapic/test_method_async.py

@@ -15,6 +15,10 @@
 import datetime
 from unittest import mock
 
+try:
+    from unittest.mock import AsyncMock
+except ImportError:
+    from mock import AsyncMock
 import pytest
 
 try:
@@ -256,7 +260,7 @@ async def test_wrap_method_with_overriding_timeout_as_a_number():
 
 @pytest.mark.asyncio
 async def test_wrap_method_without_wrap_errors():
-    fake_call = mock.AsyncMock()
+    fake_call = AsyncMock()
 
     wrapped_method = gapic_v1.method_async.wrap_method(fake_call, kind="rest")
     with mock.patch("google.api_core.grpc_helpers_async.wrap_errors") as method:

tests/asyncio/retry/test_retry_unary_async.py

@@ -16,6 +16,10 @@
 import re
 from unittest import mock
 
+try:
+    from unittest.mock import AsyncMock
+except ImportError:
+    from mock import AsyncMock
 import pytest
 
 from google.api_core import exceptions
@@ -168,7 +172,7 @@ def if_exception_type(exc):
     @pytest.mark.asyncio
     async def test___call___and_execute_success(self, sleep):
         retry_ = retry_async.AsyncRetry()
-        target = mock.AsyncMock(spec=["__call__"], return_value=42)
+        target = AsyncMock(spec=["__call__"], return_value=42)
         # __name__ is needed by functools.partial.
         target.__name__ = "target"
 
@@ -190,7 +194,7 @@ async def test___call___and_execute_retry(self, sleep, uniform):
             predicate=retry_async.if_exception_type(ValueError)
         )
 
-        target = mock.AsyncMock(spec=["__call__"], side_effect=[ValueError(), 42])
+        target = AsyncMock(spec=["__call__"], side_effect=[ValueError(), 42])
         # __name__ is needed by functools.partial.
         target.__name__ = "target"
 
@@ -220,7 +224,7 @@ async def test___call___and_execute_retry_hitting_timeout(self, sleep, uniform):
 
         monotonic_patcher = mock.patch("time.monotonic", return_value=0)
 
-        target = mock.AsyncMock(spec=["__call__"], side_effect=[ValueError()] * 10)
+        target = AsyncMock(spec=["__call__"], side_effect=[ValueError()] * 10)
         # __name__ is needed by functools.partial.
         target.__name__ = "target"
 
@@ -270,7 +274,7 @@ async def test___init___without_retry_executed(self, sleep):
         # check the proper creation of the class
         assert retry_._on_error is _some_function
 
-        target = mock.AsyncMock(spec=["__call__"], side_effect=[42])
+        target = AsyncMock(spec=["__call__"], side_effect=[42])
         # __name__ is needed by functools.partial.
         target.__name__ = "target"
 
@@ -295,7 +299,7 @@ async def test___init___when_retry_is_executed(self, sleep, uniform):
         # check the proper creation of the class
         assert retry_._on_error is _some_function
 
-        target = mock.AsyncMock(
+        target = AsyncMock(
             spec=["__call__"], side_effect=[ValueError(), ValueError(), 42]
         )
         # __name__ is needed by functools.partial.

tests/asyncio/test_grpc_helpers_async.py

@@ -14,6 +14,10 @@
 
 from unittest import mock
 
+try:
+    from unittest.mock import AsyncMock
+except ImportError:
+    from mock import AsyncMock
 import pytest  # noqa: I202
 
 try:
@@ -50,7 +54,7 @@ def trailing_metadata(self):
 @pytest.mark.asyncio
 async def test_wrap_unary_errors():
     grpc_error = RpcErrorImpl(grpc.StatusCode.INVALID_ARGUMENT)
-    callable_ = mock.AsyncMock(spec=["__call__"], side_effect=grpc_error)
+    callable_ = AsyncMock(spec=["__call__"], side_effect=grpc_error)
 
     wrapped_callable = grpc_helpers_async._wrap_unary_errors(callable_)
 
@@ -170,7 +174,7 @@ async def test_wrap_stream_errors_stream_stream():
 async def test_wrap_stream_errors_raised():
     grpc_error = RpcErrorImpl(grpc.StatusCode.INVALID_ARGUMENT)
     mock_call = mock.Mock(aio.StreamStreamCall, autospec=True)
-    mock_call.wait_for_connection = mock.AsyncMock(side_effect=[grpc_error])
+    mock_call.wait_for_connection = AsyncMock(side_effect=[grpc_error])
     multicallable = mock.Mock(return_value=mock_call)
 
     wrapped_callable = grpc_helpers_async._wrap_stream_errors(
@@ -187,7 +191,7 @@ async def test_wrap_stream_errors_read():
     grpc_error = RpcErrorImpl(grpc.StatusCode.INVALID_ARGUMENT)
 
     mock_call = mock.Mock(aio.StreamStreamCall, autospec=True)
-    mock_call.read = mock.AsyncMock(side_effect=grpc_error)
+    mock_call.read = AsyncMock(side_effect=grpc_error)
     multicallable = mock.Mock(return_value=mock_call)
 
     wrapped_callable = grpc_helpers_async._wrap_stream_errors(
@@ -209,7 +213,7 @@ async def test_wrap_stream_errors_aiter():
 
     mock_call = mock.Mock(aio.StreamStreamCall, autospec=True)
     mocked_aiter = mock.Mock(spec=["__anext__"])
-    mocked_aiter.__anext__ = mock.AsyncMock(
+    mocked_aiter.__anext__ = AsyncMock(
         side_effect=[mock.sentinel.response, grpc_error]
     )
     mock_call.__aiter__ = mock.Mock(return_value=mocked_aiter)
@@ -232,7 +236,7 @@ async def test_wrap_stream_errors_aiter_non_rpc_error():
 
     mock_call = mock.Mock(aio.StreamStreamCall, autospec=True)
     mocked_aiter = mock.Mock(spec=["__anext__"])
-    mocked_aiter.__anext__ = mock.AsyncMock(
+    mocked_aiter.__anext__ = AsyncMock(
         side_effect=[mock.sentinel.response, non_grpc_error]
     )
     mock_call.__aiter__ = mock.Mock(return_value=mocked_aiter)
@@ -267,8 +271,8 @@ async def test_wrap_stream_errors_write():
     grpc_error = RpcErrorImpl(grpc.StatusCode.INVALID_ARGUMENT)
 
     mock_call = mock.Mock(aio.StreamStreamCall, autospec=True)
-    mock_call.write = mock.AsyncMock(side_effect=[None, grpc_error])
-    mock_call.done_writing = mock.AsyncMock(side_effect=[None, grpc_error])
+    mock_call.write = AsyncMock(side_effect=[None, grpc_error])
+    mock_call.done_writing = AsyncMock(side_effect=[None, grpc_error])
     multicallable = mock.Mock(return_value=mock_call)
 
     wrapped_callable = grpc_helpers_async._wrap_stream_errors(

tests/asyncio/test_operation_async.py

@@ -15,6 +15,10 @@
 
 from unittest import mock
 
+try:
+    from unittest.mock import AsyncMock
+except ImportError:
+    from mock import AsyncMock
 import pytest
 
 try:
@@ -55,9 +59,9 @@ def make_operation_future(client_operations_responses=None):
     if client_operations_responses is None:
         client_operations_responses = [make_operation_proto()]
 
-    refresh = mock.AsyncMock(spec=["__call__"], side_effect=client_operations_responses)
+    refresh = AsyncMock(spec=["__call__"], side_effect=client_operations_responses)
     refresh.responses = client_operations_responses
-    cancel = mock.AsyncMock(spec=["__call__"])
+    cancel = AsyncMock(spec=["__call__"])
     operation_future = operation_async.AsyncOperation(
         client_operations_responses[0],
         refresh,

tests/asyncio/test_page_iterator_async.py

@@ -15,6 +15,10 @@
 import inspect
 from unittest import mock
 
+try:
+    from unittest.mock import AsyncMock
+except ImportError:
+    from mock import AsyncMock
 import pytest
 
 from google.api_core import page_iterator_async
@@ -58,7 +62,7 @@ async def test_anext(self):
         )
 
         async_iterator = PageAsyncIteratorImpl(None, None)
-        async_iterator._next_page = mock.AsyncMock(side_effect=[page_1, page_2, None])
+        async_iterator._next_page = AsyncMock(side_effect=[page_1, page_2, None])
 
         # Consume items and check the state of the async_iterator.
         assert async_iterator.num_results == 0
@@ -98,7 +102,7 @@ async def test__page_aiter_increment(self):
         page = page_iterator_async.Page(
             iterator, ("item",), page_iterator_async._item_to_value_identity
         )
-        iterator._next_page = mock.AsyncMock(side_effect=[page, None])
+        iterator._next_page = AsyncMock(side_effect=[page, None])
 
         assert iterator.num_results == 0
 
@@ -136,7 +140,7 @@ async def test__items_aiter(self):
         )
 
         iterator = PageAsyncIteratorImpl(None, None)
-        iterator._next_page = mock.AsyncMock(side_effect=[page1, page2, None])
+        iterator._next_page = AsyncMock(side_effect=[page1, page2, None])
 
         items_aiter = iterator._items_aiter()
 
@@ -159,7 +163,7 @@ async def test__items_aiter(self):
     @pytest.mark.asyncio
     async def test___aiter__(self):
         async_iterator = PageAsyncIteratorImpl(None, None)
-        async_iterator._next_page = mock.AsyncMock(side_effect=[(1, 2), (3,), None])
+        async_iterator._next_page = AsyncMock(side_effect=[(1, 2), (3,), None])
 
         assert not async_iterator._started
 
@@ -248,7 +252,7 @@ async def test_iterate(self):
         response1 = mock.Mock(items=["a", "b"], next_page_token="1")
         response2 = mock.Mock(items=["c"], next_page_token="2")
         response3 = mock.Mock(items=["d"], next_page_token="")
-        method = mock.AsyncMock(side_effect=[response1, response2, response3])
+        method = AsyncMock(side_effect=[response1, response2, response3])
         iterator = page_iterator_async.AsyncGRPCIterator(
             mock.sentinel.client, method, request, "items"
         )
@@ -271,7 +275,7 @@ async def test_iterate_with_max_results(self):
         response1 = mock.Mock(items=["a", "b"], next_page_token="1")
         response2 = mock.Mock(items=["c"], next_page_token="2")
         response3 = mock.Mock(items=["d"], next_page_token="")
-        method = mock.AsyncMock(side_effect=[response1, response2, response3])
+        method = AsyncMock(side_effect=[response1, response2, response3])
         iterator = page_iterator_async.AsyncGRPCIterator(
             mock.sentinel.client, method, request, "items", max_results=3
         )

tests/asyncio/test_rest_streaming_async.py

@@ -22,6 +22,10 @@
 from typing import List, AsyncIterator
 from unittest import mock
 
+try:
+    from unittest.mock import AsyncMock
+except ImportError:
+    from mock import AsyncMock
 import pytest  # noqa: I202
 
 import proto
@@ -303,7 +307,7 @@ async def test_next_not_array(response_type):
 @pytest.mark.parametrize("response_type", [EchoResponse, httpbody_pb2.HttpBody])
 async def test_cancel(response_type):
     with mock.patch.object(
-        ResponseMock, "close", new_callable=mock.AsyncMock
+        ResponseMock, "close", new_callable=AsyncMock
     ) as mock_method:
         resp = ResponseMock(responses=[], response_cls=response_type)
         itr = rest_streaming_async.AsyncResponseIterator(resp, response_type)
@@ -315,7 +319,7 @@ async def test_cancel(response_type):
 @pytest.mark.parametrize("response_type", [EchoResponse, httpbody_pb2.HttpBody])
 async def test_iterator_as_context_manager(response_type):
     with mock.patch.object(
-        ResponseMock, "close", new_callable=mock.AsyncMock
+        ResponseMock, "close", new_callable=AsyncMock
     ) as mock_method:
         resp = ResponseMock(responses=[], response_cls=response_type)
         async with rest_streaming_async.AsyncResponseIterator(resp, response_type):

tests/unit/retry/test_retry_unary.py

@@ -16,6 +16,10 @@
 import re
 from unittest import mock
 
+try:
+    from unittest.mock import AsyncMock
+except ImportError:
+    from mock import AsyncMock
 import pytest
 
 from google.api_core import exceptions
@@ -102,7 +106,7 @@ def test_retry_target_non_retryable_error(utcnow, sleep):
 @pytest.mark.asyncio
 async def test_retry_target_warning_for_retry(utcnow, sleep):
     predicate = retry.if_exception_type(ValueError)
-    target = mock.AsyncMock(spec=["__call__"])
+    target = AsyncMock(spec=["__call__"])
 
     with pytest.warns(Warning) as exc_info:
         # Note: predicate is just a filler and doesn't affect the test