FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Merge pull request #1644 from tseaver/pubsub-subscription-get_iam_policy · googleapis/google-cloud-python@c2c9cff · GitHub

/ google-cloud-python Public

Commit c2c9cff

Browse files
tseaver
committed
Merge pull request #1644 from tseaver/pubsub-subscription-get_iam_policy
Add 'Subscription.get_iam_policy' API wrapper.
2 parents 6d7172a + 21af14c commit c2c9cff

3 files changed

Lines changed: 109 additions & 0 deletions

File tree

‎docs/pubsub-usage.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,3 +311,21 @@ Fetch messages for a pull subscription without blocking (none pending):
311311
>>> messages = [recv[1] for recv in received]
312312
>>> [message.message_id for message in messages]
313313
[]
314+
315+
Fetch the IAM policy for a subscription
316+
317+
.. doctest::
318+
319+
>>> from gcloud import pubsub
320+
>>> client = pubsub.Client()
321+
>>> topic = client.topic('topic_name')
322+
>>> subscription = topic.subscription('subscription_name')
323+
>>> policy = subscription.get_iam_policy() # API request
324+
>>> policy.etag
325+
'DEADBEEF'
326+
>>> policy.owners
327+
['user:phred@example.com']
328+
>>> policy.writers
329+
['systemAccount:abc-1234@systemaccounts.example.com']
330+
>>> policy.readers
331+
['domain:example.com']

‎gcloud/pubsub/subscription.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
from gcloud.exceptions import NotFound
1818
from gcloud.pubsub._helpers import topic_name_from_path
19+
from gcloud.pubsub.iam import Policy
1920
from gcloud.pubsub.message import Message
2021

2122

@@ -263,3 +264,22 @@ def delete(self, client=None):
263264
"""
264265
client = self._require_client(client)
265266
client.connection.api_request(method='DELETE', path=self.path)
267+
268+
def get_iam_policy(self, client=None):
269+
"""Fetch the IAM policy for the subscription.
270+
271+
See:
272+
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/getIamPolicy
273+
274+
:type client: :class:`gcloud.pubsub.client.Client` or ``NoneType``
275+
:param client: the client to use. If not passed, falls back to the
276+
``client`` stored on the current subscription's topic.
277+
278+
:rtype: :class:`gcloud.pubsub.iam.Policy`
279+
:returns: policy created from the resource returned by the
280+
``getIamPolicy`` API request.
281+
"""
282+
client = self._require_client(client)
283+
path = '%s:getIamPolicy' % (self.path,)
284+
resp = client.connection.api_request(method='GET', path=path)
285+
return Policy.from_api_repr(resp)

‎gcloud/pubsub/test_subscription.py‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,77 @@ def test_delete_w_alternate_client(self):
484484
self.assertEqual(req['method'], 'DELETE')
485485
self.assertEqual(req['path'], '/%s' % SUB_PATH)
486486

487+
def test_get_iam_policy_w_bound_client(self):
488+
OWNER1 = 'user:phred@example.com'
489+
OWNER2 = 'group:cloud-logs@google.com'
490+
WRITER1 = 'domain:google.com'
491+
WRITER2 = 'user:phred@example.com'
492+
READER1 = 'serviceAccount:1234-abcdef@service.example.com'
493+
READER2 = 'user:phred@example.com'
494+
POLICY = {
495+
'etag': 'DEADBEEF',
496+
'version': 17,
497+
'bindings': [
498+
{'role': 'roles/owner', 'members': [OWNER1, OWNER2]},
499+
{'role': 'roles/writer', 'members': [WRITER1, WRITER2]},
500+
{'role': 'roles/reader', 'members': [READER1, READER2]},
501+
],
502+
}
503+
PROJECT = 'PROJECT'
504+
TOPIC_NAME = 'topic_name'
505+
SUB_NAME = 'sub_name'
506+
PATH = 'projects/%s/subscriptions/%s:getIamPolicy' % (
507+
PROJECT, SUB_NAME)
508+
509+
conn = _Connection(POLICY)
510+
CLIENT = _Client(project=PROJECT, connection=conn)
511+
topic = _Topic(TOPIC_NAME, client=CLIENT)
512+
subscription = self._makeOne(SUB_NAME, topic)
513+
514+
policy = subscription.get_iam_policy()
515+
516+
self.assertEqual(policy.etag, 'DEADBEEF')
517+
self.assertEqual(policy.version, 17)
518+
self.assertEqual(sorted(policy.owners), [OWNER2, OWNER1])
519+
self.assertEqual(sorted(policy.writers), [WRITER1, WRITER2])
520+
self.assertEqual(sorted(policy.readers), [READER1, READER2])
521+
522+
self.assertEqual(len(conn._requested), 1)
523+
req = conn._requested[0]
524+
self.assertEqual(req['method'], 'GET')
525+
self.assertEqual(req['path'], '/%s' % PATH)
526+
527+
def test_get_iam_policy_w_alternate_client(self):
528+
POLICY = {
529+
'etag': 'ACAB',
530+
}
531+
PROJECT = 'PROJECT'
532+
TOPIC_NAME = 'topic_name'
533+
SUB_NAME = 'sub_name'
534+
PATH = 'projects/%s/subscriptions/%s:getIamPolicy' % (
535+
PROJECT, SUB_NAME)
536+
537+
conn1 = _Connection()
538+
conn2 = _Connection(POLICY)
539+
CLIENT1 = _Client(project=PROJECT, connection=conn1)
540+
CLIENT2 = _Client(project=PROJECT, connection=conn2)
541+
topic = _Topic(TOPIC_NAME, client=CLIENT1)
542+
subscription = self._makeOne(SUB_NAME, topic)
543+
544+
policy = subscription.get_iam_policy(client=CLIENT2)
545+
546+
self.assertEqual(policy.etag, 'ACAB')
547+
self.assertEqual(policy.version, None)
548+
self.assertEqual(sorted(policy.owners), [])
549+
self.assertEqual(sorted(policy.writers), [])
550+
self.assertEqual(sorted(policy.readers), [])
551+
552+
self.assertEqual(len(conn1._requested), 0)
553+
self.assertEqual(len(conn2._requested), 1)
554+
req = conn2._requested[0]
555+
self.assertEqual(req['method'], 'GET')
556+
self.assertEqual(req['path'], '/%s' % PATH)
557+
487558

488559
class _Connection(object):
489560

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL