-
Notifications
You must be signed in to change notification settings - Fork 201
/
subscriber_test.py
435 lines (321 loc) · 13.5 KB
/
subscriber_test.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
# Copyright 2016 Google Inc. All Rights Reserved.
#
# 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 os
import sys
import uuid
import backoff
from flaky import flaky
from google.api_core.exceptions import InternalServerError
from google.api_core.exceptions import NotFound
from google.api_core.exceptions import Unknown
from google.cloud import pubsub_v1
import pytest
import subscriber
UUID = uuid.uuid4().hex
PY_VERSION = f"{sys.version_info.major}.{sys.version_info.minor}"
PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"]
TOPIC = f"subscription-test-topic-{PY_VERSION}-{UUID}"
DEAD_LETTER_TOPIC = f"subscription-test-dead-letter-topic-{PY_VERSION}-{UUID}"
SUBSCRIPTION_ADMIN = f"subscription-test-subscription-admin-{PY_VERSION}-{UUID}"
SUBSCRIPTION_ASYNC = f"subscription-test-subscription-async-{PY_VERSION}-{UUID}"
SUBSCRIPTION_SYNC = f"subscription-test-subscription-sync-{PY_VERSION}-{UUID}"
SUBSCRIPTION_DLQ = f"subscription-test-subscription-dlq-{PY_VERSION}-{UUID}"
ENDPOINT = f"https://{PROJECT_ID}.appspot.com/push"
NEW_ENDPOINT = f"https://{PROJECT_ID}.appspot.com/push2"
DEFAULT_MAX_DELIVERY_ATTEMPTS = 5
UPDATED_MAX_DELIVERY_ATTEMPTS = 20
@pytest.fixture(scope="module")
def publisher_client():
yield pubsub_v1.PublisherClient()
@pytest.fixture(scope="module")
def topic(publisher_client):
topic_path = publisher_client.topic_path(PROJECT_ID, TOPIC)
try:
topic = publisher_client.get_topic(request={"topic": topic_path})
except: # noqa
topic = publisher_client.create_topic(request={"name": topic_path})
yield topic.name
publisher_client.delete_topic(request={"topic": topic.name})
@pytest.fixture(scope="module")
def dead_letter_topic(publisher_client):
topic_path = publisher_client.topic_path(PROJECT_ID, DEAD_LETTER_TOPIC)
try:
dead_letter_topic = publisher_client.get_topic(request={"topic": topic_path})
except NotFound:
dead_letter_topic = publisher_client.create_topic(request={"name": topic_path})
yield dead_letter_topic.name
publisher_client.delete_topic(request={"topic": dead_letter_topic.name})
@pytest.fixture(scope="module")
def subscriber_client():
subscriber_client = pubsub_v1.SubscriberClient()
yield subscriber_client
subscriber_client.close()
@pytest.fixture(scope="module")
def subscription_admin(subscriber_client, topic):
subscription_path = subscriber_client.subscription_path(
PROJECT_ID, SUBSCRIPTION_ADMIN
)
try:
subscription = subscriber_client.get_subscription(
request={"subscription": subscription_path}
)
except NotFound:
subscription = subscriber_client.create_subscription(
request={"name": subscription_path, "topic": topic}
)
yield subscription.name
@pytest.fixture(scope="module")
def subscription_sync(subscriber_client, topic):
subscription_path = subscriber_client.subscription_path(
PROJECT_ID, SUBSCRIPTION_SYNC
)
try:
subscription = subscriber_client.get_subscription(
request={"subscription": subscription_path}
)
except NotFound:
subscription = subscriber_client.create_subscription(
request={"name": subscription_path, "topic": topic}
)
yield subscription.name
@backoff.on_exception(backoff.expo, Unknown, max_time=300)
def delete_subscription():
try:
subscriber_client.delete_subscription(request={"subscription": subscription.name})
except NotFound:
print("When Unknown error happens, the server might have"
" successfully deleted the subscription under the cover, so"
" we ignore NotFound")
delete_subscription()
@pytest.fixture(scope="module")
def subscription_async(subscriber_client, topic):
subscription_path = subscriber_client.subscription_path(
PROJECT_ID, SUBSCRIPTION_ASYNC
)
try:
subscription = subscriber_client.get_subscription(
request={"subscription": subscription_path}
)
except NotFound:
subscription = subscriber_client.create_subscription(
request={"name": subscription_path, "topic": topic}
)
yield subscription.name
subscriber_client.delete_subscription(request={"subscription": subscription.name})
@pytest.fixture(scope="module")
def subscription_dlq(subscriber_client, topic, dead_letter_topic):
from google.cloud.pubsub_v1.types import DeadLetterPolicy
subscription_path = subscriber_client.subscription_path(
PROJECT_ID, SUBSCRIPTION_DLQ
)
try:
subscription = subscriber_client.get_subscription(
request={"subscription": subscription_path}
)
except NotFound:
request = {
"name": subscription_path,
"topic": topic,
"dead_letter_policy": DeadLetterPolicy(
dead_letter_topic=dead_letter_topic, max_delivery_attempts=10
),
}
subscription = subscriber_client.create_subscription(request)
yield subscription.name
subscriber_client.delete_subscription(request={"subscription": subscription.name})
def _publish_messages(publisher_client, topic, message_num=5, **attrs):
for n in range(message_num):
data = f"message {n}".encode("utf-8")
publish_future = publisher_client.publish(topic, data, **attrs)
publish_future.result()
def test_list_in_topic(subscription_admin, capsys):
@backoff.on_exception(backoff.expo, AssertionError, max_time=60)
def eventually_consistent_test():
subscriber.list_subscriptions_in_topic(PROJECT_ID, TOPIC)
out, _ = capsys.readouterr()
assert subscription_admin in out
eventually_consistent_test()
def test_list_in_project(subscription_admin, capsys):
@backoff.on_exception(backoff.expo, AssertionError, max_time=60)
def eventually_consistent_test():
subscriber.list_subscriptions_in_project(PROJECT_ID)
out, _ = capsys.readouterr()
assert subscription_admin in out
eventually_consistent_test()
def test_create(subscriber_client, subscription_admin, capsys):
subscription_path = subscriber_client.subscription_path(
PROJECT_ID, SUBSCRIPTION_ADMIN
)
try:
subscriber_client.delete_subscription(
request={"subscription": subscription_path}
)
except NotFound:
pass
subscriber.create_subscription(PROJECT_ID, TOPIC, SUBSCRIPTION_ADMIN)
out, _ = capsys.readouterr()
assert f"{subscription_admin}" in out
def test_create_subscription_with_dead_letter_policy(
subscriber_client, subscription_dlq, dead_letter_topic, capsys
):
try:
subscriber_client.delete_subscription(
request={"subscription": subscription_dlq}
)
except NotFound:
pass
subscriber.create_subscription_with_dead_letter_topic(
PROJECT_ID, TOPIC, SUBSCRIPTION_DLQ, DEAD_LETTER_TOPIC
)
out, _ = capsys.readouterr()
assert f"Subscription created: {subscription_dlq}" in out
assert f"It will forward dead letter messages to: {dead_letter_topic}" in out
assert f"After {DEFAULT_MAX_DELIVERY_ATTEMPTS} delivery attempts." in out
@flaky(max_runs=3, min_passes=1)
def test_receive_with_delivery_attempts(
publisher_client, topic, dead_letter_topic, subscription_dlq, capsys
):
# The dlq subscription raises 404 before it's ready.
# We keep retrying up to 10 minutes for mitigating the flakiness.
@backoff.on_exception(backoff.expo, (Unknown, NotFound), max_time=120)
def run_sample():
_publish_messages(publisher_client, topic)
subscriber.receive_messages_with_delivery_attempts(PROJECT_ID, SUBSCRIPTION_DLQ, 90)
run_sample()
out, _ = capsys.readouterr()
assert f"Listening for messages on {subscription_dlq}.." in out
assert "With delivery attempts: " in out
@flaky(max_runs=3, min_passes=1)
def test_update_dead_letter_policy(subscription_dlq, dead_letter_topic, capsys):
# We saw internal server error that suggests to retry.
@backoff.on_exception(backoff.expo, (Unknown, InternalServerError), max_time=60)
def run_sample():
subscriber.update_subscription_with_dead_letter_policy(
PROJECT_ID,
TOPIC,
SUBSCRIPTION_DLQ,
DEAD_LETTER_TOPIC,
UPDATED_MAX_DELIVERY_ATTEMPTS,
)
run_sample()
out, _ = capsys.readouterr()
assert dead_letter_topic in out
assert subscription_dlq in out
assert f"max_delivery_attempts: {UPDATED_MAX_DELIVERY_ATTEMPTS}" in out
@flaky(max_runs=3, min_passes=1)
def test_remove_dead_letter_policy(subscription_dlq, capsys):
subscription_after_update = subscriber.remove_dead_letter_policy(
PROJECT_ID, TOPIC, SUBSCRIPTION_DLQ
)
out, _ = capsys.readouterr()
assert subscription_dlq in out
assert subscription_after_update.dead_letter_policy.dead_letter_topic == ""
def test_create_subscription_with_ordering(
subscriber_client, subscription_admin, capsys
):
subscription_path = subscriber_client.subscription_path(
PROJECT_ID, SUBSCRIPTION_ADMIN
)
try:
subscriber_client.delete_subscription(
request={"subscription": subscription_path}
)
except NotFound:
pass
subscriber.create_subscription_with_ordering(PROJECT_ID, TOPIC, SUBSCRIPTION_ADMIN)
out, _ = capsys.readouterr()
assert "Created subscription with ordering" in out
assert f"{subscription_admin}" in out
assert "enable_message_ordering: true" in out
def test_create_push(subscriber_client, subscription_admin, capsys):
# The scope of `subscription_path` is limited to this function.
subscription_path = subscriber_client.subscription_path(
PROJECT_ID, SUBSCRIPTION_ADMIN
)
try:
subscriber_client.delete_subscription(
request={"subscription": subscription_path}
)
except NotFound:
pass
subscriber.create_push_subscription(PROJECT_ID, TOPIC, SUBSCRIPTION_ADMIN, ENDPOINT)
out, _ = capsys.readouterr()
assert f"{subscription_admin}" in out
def test_update(subscription_admin, capsys):
subscriber.update_push_subscription(
PROJECT_ID, TOPIC, SUBSCRIPTION_ADMIN, NEW_ENDPOINT
)
out, _ = capsys.readouterr()
assert "Subscription updated" in out
assert f"{subscription_admin}" in out
def test_delete(subscriber_client, subscription_admin):
subscriber.delete_subscription(PROJECT_ID, SUBSCRIPTION_ADMIN)
@backoff.on_exception(backoff.expo, AssertionError, max_time=60)
def eventually_consistent_test():
with pytest.raises(Exception):
subscriber_client.get_subscription(
request={"subscription": subscription_admin}
)
eventually_consistent_test()
def test_receive(publisher_client, topic, subscription_async, capsys):
_publish_messages(publisher_client, topic)
subscriber.receive_messages(PROJECT_ID, SUBSCRIPTION_ASYNC, 5)
out, _ = capsys.readouterr()
assert "Listening" in out
assert subscription_async in out
assert "message" in out
def test_receive_with_custom_attributes(
publisher_client, topic, subscription_async, capsys
):
_publish_messages(publisher_client, topic, origin="python-sample")
subscriber.receive_messages_with_custom_attributes(
PROJECT_ID, SUBSCRIPTION_ASYNC, 5
)
out, _ = capsys.readouterr()
assert subscription_async in out
assert "message" in out
assert "origin" in out
assert "python-sample" in out
def test_receive_with_flow_control(publisher_client, topic, subscription_async, capsys):
_publish_messages(publisher_client, topic)
subscriber.receive_messages_with_flow_control(PROJECT_ID, SUBSCRIPTION_ASYNC, 5)
out, _ = capsys.readouterr()
assert "Listening" in out
assert subscription_async in out
assert "message" in out
def test_listen_for_errors(publisher_client, topic, subscription_async, capsys):
_publish_messages(publisher_client, topic)
subscriber.listen_for_errors(PROJECT_ID, SUBSCRIPTION_ASYNC, 5)
out, _ = capsys.readouterr()
assert subscription_async in out
assert "threw an exception" in out
def test_receive_synchronously(publisher_client, topic, subscription_sync, capsys):
_publish_messages(publisher_client, topic)
subscriber.synchronous_pull(PROJECT_ID, SUBSCRIPTION_SYNC)
out, _ = capsys.readouterr()
assert "Received" in out
assert f"{subscription_sync}" in out
def test_receive_synchronously_with_lease(
publisher_client, topic, subscription_sync, capsys
):
@backoff.on_exception(backoff.expo, Unknown, max_time=300)
def run_sample():
_publish_messages(publisher_client, topic, message_num=3)
subscriber.synchronous_pull_with_lease_management(PROJECT_ID, SUBSCRIPTION_SYNC)
run_sample()
out, _ = capsys.readouterr()
# Sometimes the subscriber only gets 1 or 2 messages and test fails.
# I think it's ok to consider those cases as passing.
assert "Received and acknowledged" in out
assert f"messages from {subscription_sync}." in out