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
|
# Copyright 2017 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import datetime
try:
from unittest import mock
from unittest.mock import AsyncMock # pragma: NO COVER # noqa: F401
except ImportError: # pragma: NO COVER
import mock # type: ignore
import pytest
try:
from grpc import aio, Compression
except ImportError:
pytest.skip("No GRPC", allow_module_level=True)
from google.api_core import exceptions
from google.api_core import gapic_v1
from google.api_core import grpc_helpers_async
from google.api_core import retry_async
from google.api_core import timeout
def _utcnow_monotonic():
current_time = datetime.datetime.min
delta = datetime.timedelta(seconds=0.5)
while True:
yield current_time
current_time += delta
@pytest.mark.asyncio
async def test_wrap_method_basic():
fake_call = grpc_helpers_async.FakeUnaryUnaryCall(42)
method = mock.Mock(spec=aio.UnaryUnaryMultiCallable, return_value=fake_call)
wrapped_method = gapic_v1.method_async.wrap_method(method)
result = await wrapped_method(1, 2, meep="moop")
assert result == 42
method.assert_called_once_with(1, 2, meep="moop", metadata=mock.ANY)
# Check that the default client info was specified in the metadata.
metadata = method.call_args[1]["metadata"]
assert len(metadata) == 1
client_info = gapic_v1.client_info.DEFAULT_CLIENT_INFO
user_agent_metadata = client_info.to_grpc_metadata()
assert user_agent_metadata in metadata
@pytest.mark.asyncio
async def test_wrap_method_with_no_client_info():
fake_call = grpc_helpers_async.FakeUnaryUnaryCall()
method = mock.Mock(spec=aio.UnaryUnaryMultiCallable, return_value=fake_call)
wrapped_method = gapic_v1.method_async.wrap_method(method, client_info=None)
await wrapped_method(1, 2, meep="moop")
method.assert_called_once_with(1, 2, meep="moop")
@pytest.mark.asyncio
async def test_wrap_method_with_custom_client_info():
client_info = gapic_v1.client_info.ClientInfo(
python_version=1,
grpc_version=2,
api_core_version=3,
gapic_version=4,
client_library_version=5,
protobuf_runtime_version=6,
)
fake_call = grpc_helpers_async.FakeUnaryUnaryCall()
method = mock.Mock(spec=aio.UnaryUnaryMultiCallable, return_value=fake_call)
wrapped_method = gapic_v1.method_async.wrap_method(method, client_info=client_info)
await wrapped_method(1, 2, meep="moop")
method.assert_called_once_with(1, 2, meep="moop", metadata=mock.ANY)
# Check that the custom client info was specified in the metadata.
metadata = method.call_args[1]["metadata"]
assert client_info.to_grpc_metadata() in metadata
@pytest.mark.asyncio
async def test_wrap_method_with_no_compression():
fake_call = grpc_helpers_async.FakeUnaryUnaryCall()
method = mock.Mock(spec=aio.UnaryUnaryMultiCallable, return_value=fake_call)
wrapped_method = gapic_v1.method_async.wrap_method(method)
await wrapped_method(1, 2, meep="moop", compression=None)
method.assert_called_once_with(1, 2, meep="moop", metadata=mock.ANY)
@pytest.mark.asyncio
async def test_wrap_method_with_custom_compression():
compression = Compression.Gzip
fake_call = grpc_helpers_async.FakeUnaryUnaryCall()
method = mock.Mock(spec=aio.UnaryUnaryMultiCallable, return_value=fake_call)
wrapped_method = gapic_v1.method_async.wrap_method(
method, default_compression=compression
)
await wrapped_method(1, 2, meep="moop", compression=Compression.Deflate)
method.assert_called_once_with(
1, 2, meep="moop", metadata=mock.ANY, compression=Compression.Deflate
)
@pytest.mark.asyncio
async def test_invoke_wrapped_method_with_metadata():
fake_call = grpc_helpers_async.FakeUnaryUnaryCall()
method = mock.Mock(spec=aio.UnaryUnaryMultiCallable, return_value=fake_call)
wrapped_method = gapic_v1.method_async.wrap_method(method)
await wrapped_method(mock.sentinel.request, metadata=[("a", "b")])
method.assert_called_once_with(mock.sentinel.request, metadata=mock.ANY)
metadata = method.call_args[1]["metadata"]
# Metadata should have two items: the client info metadata and our custom
# metadata.
assert len(metadata) == 2
assert ("a", "b") in metadata
@pytest.mark.asyncio
async def test_invoke_wrapped_method_with_metadata_as_none():
fake_call = grpc_helpers_async.FakeUnaryUnaryCall()
method = mock.Mock(spec=aio.UnaryUnaryMultiCallable, return_value=fake_call)
wrapped_method = gapic_v1.method_async.wrap_method(method)
await wrapped_method(mock.sentinel.request, metadata=None)
method.assert_called_once_with(mock.sentinel.request, metadata=mock.ANY)
metadata = method.call_args[1]["metadata"]
# Metadata should have just one items: the client info metadata.
assert len(metadata) == 1
@mock.patch("asyncio.sleep")
@pytest.mark.asyncio
async def test_wrap_method_with_default_retry_timeout_and_compression(unused_sleep):
fake_call = grpc_helpers_async.FakeUnaryUnaryCall(42)
method = mock.Mock(
spec=aio.UnaryUnaryMultiCallable,
side_effect=[exceptions.InternalServerError(None), fake_call],
)
default_retry = retry_async.AsyncRetry()
default_timeout = timeout.ConstantTimeout(60)
default_compression = Compression.Gzip
wrapped_method = gapic_v1.method_async.wrap_method(
method, default_retry, default_timeout, default_compression
)
result = await wrapped_method()
assert result == 42
assert method.call_count == 2
method.assert_called_with(
timeout=60, compression=default_compression, metadata=mock.ANY
)
@mock.patch("asyncio.sleep")
@pytest.mark.asyncio
async def test_wrap_method_with_default_retry_and_timeout_using_sentinel(unused_sleep):
fake_call = grpc_helpers_async.FakeUnaryUnaryCall(42)
method = mock.Mock(
spec=aio.UnaryUnaryMultiCallable,
side_effect=[exceptions.InternalServerError(None), fake_call],
)
default_retry = retry_async.AsyncRetry()
default_timeout = timeout.ConstantTimeout(60)
default_compression = Compression.Gzip
wrapped_method = gapic_v1.method_async.wrap_method(
method, default_retry, default_timeout, default_compression
)
result = await wrapped_method(
retry=gapic_v1.method_async.DEFAULT,
timeout=gapic_v1.method_async.DEFAULT,
compression=gapic_v1.method_async.DEFAULT,
)
assert result == 42
assert method.call_count == 2
method.assert_called_with(
timeout=60, compression=Compression.Gzip, metadata=mock.ANY
)
@mock.patch("asyncio.sleep")
@pytest.mark.asyncio
async def test_wrap_method_with_overriding_retry_timeout_and_compression(unused_sleep):
fake_call = grpc_helpers_async.FakeUnaryUnaryCall(42)
method = mock.Mock(
spec=aio.UnaryUnaryMultiCallable,
side_effect=[exceptions.NotFound(None), fake_call],
)
default_retry = retry_async.AsyncRetry()
default_timeout = timeout.ConstantTimeout(60)
default_compression = Compression.Gzip
wrapped_method = gapic_v1.method_async.wrap_method(
method, default_retry, default_timeout, default_compression
)
result = await wrapped_method(
retry=retry_async.AsyncRetry(
retry_async.if_exception_type(exceptions.NotFound)
),
timeout=timeout.ConstantTimeout(22),
compression=Compression.Deflate,
)
assert result == 42
assert method.call_count == 2
method.assert_called_with(
timeout=22, compression=Compression.Deflate, metadata=mock.ANY
)
@pytest.mark.asyncio
async def test_wrap_method_with_overriding_timeout_as_a_number():
fake_call = grpc_helpers_async.FakeUnaryUnaryCall(42)
method = mock.Mock(spec=aio.UnaryUnaryMultiCallable, return_value=fake_call)
default_retry = retry_async.AsyncRetry()
default_timeout = timeout.ConstantTimeout(60)
wrapped_method = gapic_v1.method_async.wrap_method(
method, default_retry, default_timeout
)
result = await wrapped_method(timeout=22)
assert result == 42
method.assert_called_once_with(timeout=22, metadata=mock.ANY)
@pytest.mark.asyncio
async def test_wrap_method_without_wrap_errors():
fake_call = mock.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:
await wrapped_method()
method.assert_not_called()
|
