forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsystem.py
More file actions
575 lines (459 loc) · 20.3 KB
/
system.py
File metadata and controls
575 lines (459 loc) · 20.3 KB
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
# Copyright 2017, Google LLC 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.
from __future__ import absolute_import
import datetime
import itertools
import operator as op
import threading
import time
import mock
import pytest
import six
import google.auth
from google.cloud import pubsub_v1
from google.cloud.pubsub_v1 import exceptions
from google.cloud.pubsub_v1 import futures
from google.cloud.pubsub_v1 import types
from test_utils.system import unique_resource_id
@pytest.fixture(scope=u"module")
def project():
_, default_project = google.auth.default()
yield default_project
@pytest.fixture(scope=u"module")
def publisher():
yield pubsub_v1.PublisherClient()
@pytest.fixture(scope=u"module")
def subscriber():
yield pubsub_v1.SubscriberClient()
@pytest.fixture
def topic_path(project, publisher):
topic_name = "t" + unique_resource_id("-")
yield publisher.topic_path(project, topic_name)
@pytest.fixture
def subscription_path(project, subscriber):
sub_name = "s" + unique_resource_id("-")
yield subscriber.subscription_path(project, sub_name)
@pytest.fixture
def cleanup():
registry = []
yield registry
# Perform all clean up.
for to_call, argument in registry:
to_call(argument)
def test_publish_messages(publisher, topic_path, cleanup):
futures = []
# Make sure the topic gets deleted.
cleanup.append((publisher.delete_topic, topic_path))
publisher.create_topic(topic_path)
for index in six.moves.range(500):
futures.append(
publisher.publish(
topic_path,
b"The hail in Wales falls mainly on the snails.",
num=str(index),
)
)
for future in futures:
result = future.result()
assert isinstance(result, six.string_types)
def test_subscribe_to_messages(
publisher, topic_path, subscriber, subscription_path, cleanup
):
# Make sure the topic and subscription get deleted.
cleanup.append((publisher.delete_topic, topic_path))
cleanup.append((subscriber.delete_subscription, subscription_path))
# Create a topic.
publisher.create_topic(topic_path)
# Subscribe to the topic. This must happen before the messages
# are published.
subscriber.create_subscription(subscription_path, topic_path)
# Publish some messages.
futures = [
publisher.publish(topic_path, b"Wooooo! The claaaaaw!", num=str(index))
for index in six.moves.range(50)
]
# Make sure the publish completes.
for future in futures:
future.result()
# Actually open the subscription and hold it open for a few seconds.
# The callback should process the message numbers to prove
# that we got everything at least once.
callback = AckCallback()
future = subscriber.subscribe(subscription_path, callback)
for second in six.moves.range(10):
time.sleep(1)
# The callback should have fired at least fifty times, but it
# may take some time.
if callback.calls >= 50:
return
# Okay, we took too long; fail out.
assert callback.calls >= 50
future.cancel()
def test_subscribe_to_messages_async_callbacks(
publisher, topic_path, subscriber, subscription_path, cleanup
):
# Make sure the topic and subscription get deleted.
cleanup.append((publisher.delete_topic, topic_path))
cleanup.append((subscriber.delete_subscription, subscription_path))
# Create a topic.
publisher.create_topic(topic_path)
# Subscribe to the topic. This must happen before the messages
# are published.
subscriber.create_subscription(subscription_path, topic_path)
# Publish some messages.
futures = [
publisher.publish(topic_path, b"Wooooo! The claaaaaw!", num=str(index))
for index in six.moves.range(2)
]
# Make sure the publish completes.
for future in futures:
future.result()
# We want to make sure that the callback was called asynchronously. So
# track when each call happened and make sure below.
callback = TimesCallback(2)
# Actually open the subscription and hold it open for a few seconds.
future = subscriber.subscribe(subscription_path, callback)
for second in six.moves.range(5):
time.sleep(4)
# The callback should have fired at least two times, but it may
# take some time.
if callback.calls >= 2:
first, last = sorted(callback.call_times[:2])
diff = last - first
# "Ensure" the first two callbacks were executed asynchronously
# (sequentially would have resulted in a difference of 2+
# seconds).
assert diff.days == 0
assert diff.seconds < callback.sleep_time
# Okay, we took too long; fail out.
assert callback.calls >= 2
future.cancel()
def test_creating_subscriptions_with_non_default_settings(
publisher, subscriber, project, topic_path, subscription_path, cleanup
):
# Make sure the topic and subscription get deleted.
cleanup.append((publisher.delete_topic, topic_path))
cleanup.append((subscriber.delete_subscription, subscription_path))
# create a topic and a subscription, customize the latter's policy
publisher.create_topic(topic_path)
msg_retention_duration = {"seconds": 911}
expiration_policy = {"ttl": {"seconds": 90210}}
new_subscription = subscriber.create_subscription(
subscription_path,
topic_path,
ack_deadline_seconds=30,
retain_acked_messages=True,
message_retention_duration=msg_retention_duration,
expiration_policy=expiration_policy,
)
# fetch the subscription and check its settings
project_path = subscriber.project_path(project)
subscriptions = subscriber.list_subscriptions(project_path)
subscriptions = [sub for sub in subscriptions if sub.topic == topic_path]
assert len(subscriptions) == 1
subscription = subscriptions[0]
assert subscription == new_subscription
assert subscription.ack_deadline_seconds == 30
assert subscription.retain_acked_messages
assert subscription.message_retention_duration.seconds == 911
assert subscription.expiration_policy.ttl.seconds == 90210
def test_listing_project_topics(publisher, project, cleanup):
topic_paths = [
publisher.topic_path(project, "topic-{}".format(i) + unique_resource_id("."))
for i in range(1, 4)
]
for topic in topic_paths:
cleanup.append((publisher.delete_topic, topic))
publisher.create_topic(topic)
project_path = publisher.project_path(project)
project_topics = publisher.list_topics(project_path)
project_topics = set(t.name for t in project_topics)
# there might be other topics in the project, thus do a "is subset" check
assert set(topic_paths) <= project_topics
def test_listing_project_subscriptions(publisher, subscriber, project, cleanup):
# create topics
topic_paths = [
publisher.topic_path(project, "topic-1" + unique_resource_id(".")),
publisher.topic_path(project, "topic-2" + unique_resource_id(".")),
]
for topic in topic_paths:
cleanup.append((publisher.delete_topic, topic))
publisher.create_topic(topic)
# create subscriptions
subscription_paths = [
subscriber.subscription_path(
project, "sub-{}".format(i) + unique_resource_id(".")
)
for i in range(1, 4)
]
for i, subscription in enumerate(subscription_paths):
topic = topic_paths[i % 2]
cleanup.append((subscriber.delete_subscription, subscription))
subscriber.create_subscription(subscription, topic)
# retrieve subscriptions and check that the list matches the expected
project_path = subscriber.project_path(project)
subscriptions = subscriber.list_subscriptions(project_path)
subscriptions = set(s.name for s in subscriptions)
# there might be other subscriptions in the project, thus do a "is subset" check
assert set(subscription_paths) <= subscriptions
def test_listing_topic_subscriptions(publisher, subscriber, project, cleanup):
# create topics
topic_paths = [
publisher.topic_path(project, "topic-1" + unique_resource_id(".")),
publisher.topic_path(project, "topic-2" + unique_resource_id(".")),
]
for topic in topic_paths:
cleanup.append((publisher.delete_topic, topic))
publisher.create_topic(topic)
# create subscriptions
subscription_paths = [
subscriber.subscription_path(
project, "sub-{}".format(i) + unique_resource_id(".")
)
for i in range(1, 4)
]
for i, subscription in enumerate(subscription_paths):
topic = topic_paths[i % 2]
cleanup.append((subscriber.delete_subscription, subscription))
subscriber.create_subscription(subscription, topic)
# retrieve subscriptions and check that the list matches the expected
subscriptions = publisher.list_topic_subscriptions(topic_paths[0])
subscriptions = set(subscriptions)
assert subscriptions == {subscription_paths[0], subscription_paths[2]}
def test_managing_topic_iam_policy(publisher, topic_path, cleanup):
cleanup.append((publisher.delete_topic, topic_path))
# create a topic and customize its policy
publisher.create_topic(topic_path)
topic_policy = publisher.get_iam_policy(topic_path)
topic_policy.bindings.add(role="roles/pubsub.editor", members=["domain:google.com"])
topic_policy.bindings.add(
role="roles/pubsub.viewer", members=["group:cloud-logs@google.com"]
)
new_policy = publisher.set_iam_policy(topic_path, topic_policy)
# fetch the topic policy again and check its values
topic_policy = publisher.get_iam_policy(topic_path)
assert topic_policy.bindings == new_policy.bindings
assert len(topic_policy.bindings) == 2
bindings = sorted(topic_policy.bindings, key=op.attrgetter("role"))
assert bindings[0].role == "roles/pubsub.editor"
assert bindings[0].members == ["domain:google.com"]
assert bindings[1].role == "roles/pubsub.viewer"
assert bindings[1].members == ["group:cloud-logs@google.com"]
def test_managing_subscription_iam_policy(
publisher, subscriber, topic_path, subscription_path, cleanup
):
# Make sure the topic and subscription get deleted.
cleanup.append((publisher.delete_topic, topic_path))
cleanup.append((subscriber.delete_subscription, subscription_path))
# create a topic and a subscription, customize the latter's policy
publisher.create_topic(topic_path)
subscriber.create_subscription(subscription_path, topic_path)
sub_policy = subscriber.get_iam_policy(subscription_path)
sub_policy.bindings.add(role="roles/pubsub.editor", members=["domain:google.com"])
sub_policy.bindings.add(
role="roles/pubsub.viewer", members=["group:cloud-logs@google.com"]
)
new_policy = subscriber.set_iam_policy(subscription_path, sub_policy)
# fetch the subscription policy again and check its values
sub_policy = subscriber.get_iam_policy(subscription_path)
assert sub_policy.bindings == new_policy.bindings
assert len(sub_policy.bindings) == 2
bindings = sorted(sub_policy.bindings, key=op.attrgetter("role"))
assert bindings[0].role == "roles/pubsub.editor"
assert bindings[0].members == ["domain:google.com"]
assert bindings[1].role == "roles/pubsub.viewer"
assert bindings[1].members == ["group:cloud-logs@google.com"]
class TestStreamingPull(object):
def test_streaming_pull_callback_error_propagation(
self, publisher, topic_path, subscriber, subscription_path, cleanup
):
# Make sure the topic and subscription get deleted.
cleanup.append((publisher.delete_topic, topic_path))
cleanup.append((subscriber.delete_subscription, subscription_path))
# create a topic and subscribe to it
publisher.create_topic(topic_path)
subscriber.create_subscription(subscription_path, topic_path)
# publish a messages and wait until published
future = publisher.publish(topic_path, b"hello!")
future.result(timeout=30)
# Now subscribe to the topic and verify that an error in the callback
# is propagated through the streaming pull future.
class CallbackError(Exception):
pass
callback = mock.Mock(side_effect=CallbackError)
future = subscriber.subscribe(subscription_path, callback)
with pytest.raises(CallbackError):
future.result(timeout=30)
@pytest.mark.xfail(
reason="The default stream ACK deadline is static and received messages "
"exceeding FlowControl.max_messages are currently not lease managed."
)
def test_streaming_pull_ack_deadline(
self, publisher, subscriber, project, topic_path, subscription_path, cleanup
):
# Make sure the topic and subscription get deleted.
cleanup.append((publisher.delete_topic, topic_path))
cleanup.append((subscriber.delete_subscription, subscription_path))
# Create a topic and a subscription, then subscribe to the topic. This
# must happen before the messages are published.
publisher.create_topic(topic_path)
# Subscribe to the topic. This must happen before the messages
# are published.
subscriber.create_subscription(
subscription_path, topic_path, ack_deadline_seconds=240
)
# publish some messages and wait for completion
self._publish_messages(publisher, topic_path, batch_sizes=[2])
# subscribe to the topic
callback = StreamingPullCallback(
processing_time=70, # more than the default stream ACK deadline (60s)
resolve_at_msg_count=3, # one more than the published messages count
)
flow_control = types.FlowControl(max_messages=1)
subscription_future = subscriber.subscribe(
subscription_path, callback, flow_control=flow_control
)
# We expect to process the first two messages in 2 * 70 seconds, and
# any duplicate message that is re-sent by the backend in additional
# 70 seconds, totalling 210 seconds (+ overhead) --> if there have been
# no duplicates in 240 seconds, we can reasonably assume that there
# won't be any.
try:
callback.done_future.result(timeout=240)
except exceptions.TimeoutError:
# future timed out, because we received no excessive messages
assert sorted(callback.seen_message_ids) == [1, 2]
else:
pytest.fail(
"Expected to receive 2 messages, but got at least {}.".format(
len(callback.seen_message_ids)
)
)
finally:
subscription_future.cancel()
def test_streaming_pull_max_messages(
self, publisher, topic_path, subscriber, subscription_path, cleanup
):
# Make sure the topic and subscription get deleted.
cleanup.append((publisher.delete_topic, topic_path))
cleanup.append((subscriber.delete_subscription, subscription_path))
# create a topic and subscribe to it
publisher.create_topic(topic_path)
subscriber.create_subscription(subscription_path, topic_path)
batch_sizes = (7, 4, 8, 2, 10, 1, 3, 8, 6, 1) # total: 50
self._publish_messages(publisher, topic_path, batch_sizes=batch_sizes)
# now subscribe and do the main part, check for max pending messages
total_messages = sum(batch_sizes)
flow_control = types.FlowControl(max_messages=5)
callback = StreamingPullCallback(
processing_time=1, resolve_at_msg_count=total_messages
)
subscription_future = subscriber.subscribe(
subscription_path, callback, flow_control=flow_control
)
# Expected time to process all messages in ideal case:
# (total_messages / FlowControl.max_messages) * processing_time
#
# With total=50, max messages=5, and processing_time=1 this amounts to
# 10 seconds (+ overhead), thus a full minute should be more than enough
# for the processing to complete. If not, fail the test with a timeout.
try:
callback.done_future.result(timeout=60)
except exceptions.TimeoutError:
pytest.fail(
"Timeout: receiving/processing streamed messages took too long."
)
# The callback future gets resolved once total_messages have been processed,
# but we want to wait for just a little bit longer to possibly catch cases
# when the callback gets invoked *more* than total_messages times.
time.sleep(3)
try:
# All messages should have been processed exactly once, and no more
# than max_messages simultaneously at any time.
assert callback.completed_calls == total_messages
assert sorted(callback.seen_message_ids) == list(
range(1, total_messages + 1)
)
assert callback.max_pending_ack <= flow_control.max_messages
finally:
subscription_future.cancel() # trigger clean shutdown
def _publish_messages(self, publisher, topic_path, batch_sizes):
"""Publish ``count`` messages in batches and wait until completion."""
publish_futures = []
msg_counter = itertools.count(start=1)
for batch_size in batch_sizes:
msg_batch = self._make_messages(count=batch_size)
for msg in msg_batch:
future = publisher.publish(
topic_path, msg, seq_num=str(next(msg_counter))
)
publish_futures.append(future)
time.sleep(0.1)
# wait untill all messages have been successfully published
for future in publish_futures:
future.result(timeout=30)
def _make_messages(self, count):
messages = [
u"message {}/{}".format(i, count).encode("utf-8")
for i in range(1, count + 1)
]
return messages
class AckCallback(object):
def __init__(self):
self.calls = 0
self.lock = threading.Lock()
def __call__(self, message):
message.ack()
# Only increment the number of calls **after** finishing.
with self.lock:
self.calls += 1
class TimesCallback(object):
def __init__(self, sleep_time):
self.sleep_time = sleep_time
self.calls = 0
self.call_times = []
self.lock = threading.Lock()
def __call__(self, message):
now = datetime.datetime.now()
time.sleep(self.sleep_time)
message.ack()
# Only increment the number of calls **after** finishing.
with self.lock:
# list.append() is thread-safe, but we still wait until
# ``calls`` is incremented to do it.
self.call_times.append(now)
self.calls += 1
class StreamingPullCallback(object):
def __init__(self, processing_time, resolve_at_msg_count):
self._lock = threading.Lock()
self._processing_time = processing_time
self._pending_ack = 0
self.max_pending_ack = 0
self.completed_calls = 0
self.seen_message_ids = []
self._resolve_at_msg_count = resolve_at_msg_count
self.done_future = futures.Future()
def __call__(self, message):
with self._lock:
self._pending_ack += 1
self.max_pending_ack = max(self.max_pending_ack, self._pending_ack)
self.seen_message_ids.append(int(message.attributes["seq_num"]))
time.sleep(self._processing_time)
with self._lock:
self._pending_ack -= 1
message.ack()
self.completed_calls += 1
if self.completed_calls >= self._resolve_at_msg_count:
if not self.done_future.done():
self.done_future.set_result(None)