forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpubsub_snippets.py
More file actions
461 lines (355 loc) · 14.2 KB
/
pubsub_snippets.py
File metadata and controls
461 lines (355 loc) · 14.2 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
# Copyright 2016 Google Inc.
#
# 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.
"""Testable usage examples for Google Cloud Pubsub API wrapper
Each example function takes a ``client`` argument (which must be an instance
of :class:`google.cloud.pubsub.client.Client`) and uses it to perform a task
with the API.
To facilitate running the examples as system tests, each example is also passed
a ``to_delete`` list; the function adds to the list any objects created which
need to be deleted during teardown.
"""
import time
from google.cloud.pubsub.client import Client
def snippet(func):
"""Mark ``func`` as a snippet example function."""
func._snippet = True
return func
def _millis():
return time.time() * 1000
@snippet
def client_list_topics(client, to_delete): # pylint: disable=unused-argument
"""List topics for a project."""
def do_something_with(sub): # pylint: disable=unused-argument
pass
# [START client_list_topics]
for topic in client.list_topics(): # API request(s)
do_something_with(topic)
# [END client_list_topics]
@snippet
def client_list_subscriptions(client,
to_delete): # pylint: disable=unused-argument
"""List all subscriptions for a project."""
def do_something_with(sub): # pylint: disable=unused-argument
pass
# [START client_list_subscriptions]
for subscription in client.list_subscriptions(): # API request(s)
do_something_with(subscription)
# [END client_list_subscriptions]
@snippet
def topic_create(client, to_delete):
"""Create a topic."""
TOPIC_NAME = 'topic_create-%d' % (_millis(),)
# [START topic_create]
topic = client.topic(TOPIC_NAME)
topic.create() # API request
# [END topic_create]
to_delete.append(topic)
@snippet
def topic_exists(client, to_delete):
"""Test existence of a topic."""
TOPIC_NAME = 'topic_exists-%d' % (_millis(),)
topic = client.topic(TOPIC_NAME)
to_delete.append(topic)
# [START topic_exists]
assert not topic.exists() # API request
topic.create() # API request
assert topic.exists() # API request
# [END topic_exists]
@snippet
def topic_delete(client, to_delete): # pylint: disable=unused-argument
"""Delete a topic."""
TOPIC_NAME = 'topic_delete-%d' % (_millis(),)
topic = client.topic(TOPIC_NAME)
topic.create() # API request
# [START topic_delete]
assert topic.exists() # API request
topic.delete()
assert not topic.exists() # API request
# [END topic_delete]
@snippet
def topic_iam_policy(client, to_delete):
"""Fetch / set a topic's IAM policy."""
TOPIC_NAME = 'topic_iam_policy-%d' % (_millis(),)
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
# [START topic_get_iam_policy]
policy = topic.get_iam_policy() # API request
# [END topic_get_iam_policy]
assert len(policy.viewers) == 0
assert len(policy.editors) == 0
assert len(policy.owners) == 0
# [START topic_set_iam_policy]
ALL_USERS = policy.all_users()
policy.viewers.add(ALL_USERS)
LOGS_GROUP = policy.group('cloud-logs@google.com')
policy.editors.add(LOGS_GROUP)
new_policy = topic.set_iam_policy(policy) # API request
# [END topic_set_iam_policy]
assert ALL_USERS in new_policy.viewers
assert LOGS_GROUP in new_policy.editors
# @snippet # Disabled due to #1687
def topic_check_iam_permissions(client, to_delete):
"""Check topic IAM permissions."""
TOPIC_NAME = 'topic_check_iam_permissions-%d' % (_millis(),)
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
# [START topic_check_iam_permissions]
from google.cloud.pubsub.iam import OWNER_ROLE, EDITOR_ROLE, VIEWER_ROLE
TO_CHECK = [OWNER_ROLE, EDITOR_ROLE, VIEWER_ROLE]
ALLOWED = topic.check_iam_permissions(TO_CHECK)
assert set(ALLOWED) == set(TO_CHECK)
# [END topic_check_iam_permissions]
@snippet
def topic_publish_messages(client, to_delete):
"""Publish messages to a topic."""
TOPIC_NAME = 'topic_publish_messages-%d' % (_millis(),)
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
# [START topic_publish_simple_message]
topic.publish(b'This is the message payload') # API request
# [END topic_publish_simple_message]
# [START topic_publish_message_with_attrs]
topic.publish(b'Another message payload', extra='EXTRA') # API request
# [END topic_publish_message_with_attrs]
@snippet
def topic_subscription(client, to_delete):
"""Create subscriptions to a topic."""
TOPIC_NAME = 'topic_subscription-%d' % (_millis(),)
SUB_DEFAULTS = 'topic_subscription-defaults-%d' % (_millis(),)
SUB_ACK90 = 'topic_subscription-ack90-%d' % (_millis(),)
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
# [START topic_subscription_defaults]
sub_defaults = topic.subscription(SUB_DEFAULTS)
# [END topic_subscription_defaults]
sub_defaults.create() # API request
to_delete.append(sub_defaults)
expected_names = set()
expected_names.add(sub_defaults.full_name)
# [START topic_subscription_ack90]
sub_ack90 = topic.subscription(SUB_ACK90, ack_deadline=90)
# [END topic_subscription_ack90]
sub_ack90.create() # API request
to_delete.append(sub_ack90)
expected_names.add(sub_ack90.full_name)
sub_names = set()
def do_something_with(sub):
sub_names.add(sub.full_name)
# [START topic_list_subscriptions]
for subscription in topic.list_subscriptions(): # API request(s)
do_something_with(subscription)
# [END topic_list_subscriptions]
assert sub_names.issuperset(expected_names)
# @snippet: disabled, because push-mode requires a validated endpoint URL
def topic_subscription_push(client, to_delete):
"""Create subscriptions to a topic."""
TOPIC_NAME = 'topic_subscription_push-%d' % (_millis(),)
SUB_PUSH = 'topic_subscription_push-sub-%d' % (_millis(),)
PUSH_URL = 'https://api.example.com/push-endpoint'
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
# [START topic_subscription_push]
subscription = topic.subscription(SUB_PUSH, push_endpoint=PUSH_URL)
subscription.create() # API request
# [END topic_subscription_push]
# [START subscription_push_pull]
subscription.modify_push_configuration(push_endpoint=None) # API request
# [END subscription_push_pull]
# [START subscription_pull_push]
subscription.modify_push_configuration(
push_endpoint=PUSH_URL) # API request
# [END subscription_pull_push]
@snippet
def subscription_lifecycle(client, to_delete):
"""Test lifecycle of a subscription."""
TOPIC_NAME = 'subscription_lifecycle-%d' % (_millis(),)
SUB_NAME = 'subscription_lifecycle-defaults-%d' % (_millis(),)
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
# [START subscription_create]
subscription = topic.subscription(SUB_NAME)
subscription.create() # API request
# [END subscription_create]
# [START subscription_exists]
assert subscription.exists() # API request
# [END subscription_exists]
# [START subscription_reload]
subscription.reload() # API request
# [END subscription_reload]
# [START subscription_delete]
subscription.delete() # API request
# [END subscription_delete]
@snippet
def subscription_pull(client, to_delete):
"""Pull messges from a subscribed topic."""
TOPIC_NAME = 'subscription_pull-%d' % (_millis(),)
SUB_NAME = 'subscription_pull-defaults-%d' % (_millis(),)
PAYLOAD1 = b'PAYLOAD1'
PAYLOAD2 = b'PAYLOAD2'
EXTRA = 'EXTRA'
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
subscription = topic.subscription(SUB_NAME)
subscription.create()
to_delete.append(subscription)
# [START subscription_pull_return_immediately]
pulled = subscription.pull(return_immediately=True)
# [END subscription_pull_return_immediately]
assert len(pulled) == 0, "unexpected message"
topic.publish(PAYLOAD1)
topic.publish(PAYLOAD2, extra=EXTRA)
time.sleep(1) # eventually-consistent
# [START subscription_pull]
pulled = subscription.pull(max_messages=2)
# [END subscription_pull]
assert len(pulled) == 2, "eventual consistency"
# [START subscription_modify_ack_deadline]
for ack_id, _ in pulled:
subscription.modify_ack_deadline(ack_id, 90) # API request
# [END subscription_modify_ack_deadline]
payloads = []
extras = []
def do_something_with(message): # pylint: disable=unused-argument
payloads.append(message.data)
if message.attributes:
extras.append(message.attributes)
class ApplicationException(Exception):
pass
def log_exception(_):
pass
# [START subscription_acknowledge]
for ack_id, message in pulled:
try:
do_something_with(message)
except ApplicationException as e:
log_exception(e)
else:
subscription.acknowledge([ack_id])
# [END subscription_acknowledge]
assert set(payloads) == set([PAYLOAD1, PAYLOAD2]), 'payloads: %s' % (
(payloads,))
assert extras == [{'extra': EXTRA}], 'extras: %s' % (
(extras,))
@snippet
def subscription_pull_w_autoack(client, to_delete):
"""Pull messges from a topic, auto-acknowldging them"""
TOPIC_NAME = 'subscription_pull_autoack-%d' % (_millis(),)
SUB_NAME = 'subscription_pull_autoack-defaults-%d' % (_millis(),)
PAYLOAD1 = b'PAYLOAD1'
PAYLOAD2 = b'PAYLOAD2'
EXTRA = 'EXTRA'
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
subscription = topic.subscription(SUB_NAME)
subscription.create()
to_delete.append(subscription)
# [START topic_batch]
with topic.batch() as batch:
batch.publish(PAYLOAD1)
batch.publish(PAYLOAD2, extra=EXTRA)
# [END topic_batch]
time.sleep(1) # eventually-consistent
payloads = []
extras = []
def do_something_with(message): # pylint: disable=unused-argument
payloads.append(message.data)
if message.attributes:
extras.append(message.attributes)
# [START subscription_pull_autoack]
from google.cloud.pubsub.subscription import AutoAck
with AutoAck(subscription, max_messages=10) as ack:
for ack_id, message in list(ack.items()):
try:
do_something_with(message)
except Exception: # pylint: disable=broad-except
del ack[ack_id]
# [END subscription_pull_autoack]
assert set(payloads) == set(PAYLOAD1, PAYLOAD1), "eventual consistency"
assert extras == [{'extra': EXTRA}], "eventual consistency"
@snippet
def subscription_iam_policy(client, to_delete):
"""Fetch / set a subscription's IAM policy."""
TOPIC_NAME = 'subscription_iam_policy-%d' % (_millis(),)
SUB_NAME = 'subscription_iam_policy-defaults-%d' % (_millis(),)
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
subscription = topic.subscription(SUB_NAME)
subscription.create()
to_delete.append(subscription)
# [START subscription_get_iam_policy]
policy = subscription.get_iam_policy() # API request
# [END subscription_get_iam_policy]
assert len(policy.viewers) == 0
assert len(policy.editors) == 0
assert len(policy.owners) == 0
# [START subscription_set_iam_policy]
ALL_USERS = policy.all_users()
policy.viewers.add(ALL_USERS)
LOGS_GROUP = policy.group('cloud-logs@google.com')
policy.editors.add(LOGS_GROUP)
new_policy = subscription.set_iam_policy(policy) # API request
# [END subscription_set_iam_policy]
assert ALL_USERS in new_policy.viewers
assert LOGS_GROUP in new_policy.editors
# @snippet # Disabled due to #1687
def subscription_check_iam_permissions(client, to_delete):
"""Check subscription IAM permissions."""
TOPIC_NAME = 'subscription_check_iam_permissions-%d' % (_millis(),)
SUB_NAME = 'subscription_check_iam_permissions-defaults-%d' % (_millis(),)
topic = client.topic(TOPIC_NAME)
topic.create()
to_delete.append(topic)
subscription = topic.subscription(SUB_NAME)
subscription.create()
to_delete.append(subscription)
# [START subscription_check_iam_permissions]
from google.cloud.pubsub.iam import OWNER_ROLE, EDITOR_ROLE, VIEWER_ROLE
TO_CHECK = [OWNER_ROLE, EDITOR_ROLE, VIEWER_ROLE]
ALLOWED = subscription.check_iam_permissions(TO_CHECK)
assert set(ALLOWED) == set(TO_CHECK)
# [END subscription_check_iam_permissions]
def _line_no(func):
code = getattr(func, '__code__', None) or getattr(func, 'func_code')
return code.co_firstlineno
def _find_examples():
funcs = [obj for obj in globals().values()
if getattr(obj, '_snippet', False)]
for func in sorted(funcs, key=_line_no):
yield func
def _name_and_doc(func):
return func.__name__, func.__doc__
def main():
client = Client()
for example in _find_examples():
to_delete = []
print('%-25s: %s' % _name_and_doc(example))
try:
example(client, to_delete)
except AssertionError as e:
print(' FAIL: %s' % (e,))
except Exception as e: # pylint: disable=broad-except
print(' ERROR: %r' % (e,))
for item in to_delete:
item.delete()
if __name__ == '__main__':
main()