Skip to content

Commit be4c06c

Browse files
committed
Merge pull request #1652 from tseaver/1648-rename-test_iam_permissions-check_iam_permissions
Rename 'Topic.test_iam_permissions' -> 'check_iam_permissions.'
2 parents dbb22a7 + bb94726 commit be4c06c

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

docs/pubsub-usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Test permissions allowed by the current IAM policy on a topic:
102102
>>> from gcloud.pubsub.iam import OWNER_ROLE, WRITER_ROLE, READER_ROLE
103103
>>> client = pubsub.Client()
104104
>>> topic = client.topic('topic_name')
105-
>>> allowed = topic.test_iam_permissions(
105+
>>> allowed = topic.check_iam_permissions(
106106
... [READER_ROLE, WRITER_ROLE, OWNER_ROLE]) # API request
107107
>>> allowed == [READER_ROLE, WRITER_ROLE]
108108
True
@@ -353,7 +353,7 @@ Test permissions allowed by the current IAM policy on a subscription:
353353
>>> client = pubsub.Client()
354354
>>> topic = client.topic('topic_name')
355355
>>> subscription = topic.subscription('subscription_name')
356-
>>> allowed = subscription.test_iam_permissions(
356+
>>> allowed = subscription.check_iam_permissions(
357357
... [READER_ROLE, WRITER_ROLE, OWNER_ROLE]) # API request
358358
>>> allowed == [READER_ROLE, WRITER_ROLE]
359359
True

gcloud/pubsub/subscription.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,8 +309,8 @@ def set_iam_policy(self, policy, client=None):
309309
method='POST', path=path, data=resource)
310310
return Policy.from_api_repr(resp)
311311

312-
def test_iam_permissions(self, permissions, client=None):
313-
"""Permissions allowed for the current user by the effective IAM policy.
312+
def check_iam_permissions(self, permissions, client=None):
313+
"""Verify permissions allowed for the current user.
314314
315315
See:
316316
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/testIamPermissions

gcloud/pubsub/test_subscription.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ def test_set_iam_policy_w_alternate_client(self):
641641
self.assertEqual(req['path'], '/%s' % PATH)
642642
self.assertEqual(req['data'], {})
643643

644-
def test_test_iam_permissions_w_bound_client(self):
644+
def test_check_iam_permissions_w_bound_client(self):
645645
PROJECT = 'PROJECT'
646646
TOPIC_NAME = 'topic_name'
647647
SUB_NAME = 'sub_name'
@@ -659,7 +659,7 @@ def test_test_iam_permissions_w_bound_client(self):
659659
topic = _Topic(TOPIC_NAME, client=CLIENT)
660660
subscription = self._makeOne(SUB_NAME, topic)
661661

662-
allowed = subscription.test_iam_permissions(ROLES)
662+
allowed = subscription.check_iam_permissions(ROLES)
663663

664664
self.assertEqual(allowed, ROLES[:-1])
665665
self.assertEqual(len(conn._requested), 1)
@@ -668,7 +668,7 @@ def test_test_iam_permissions_w_bound_client(self):
668668
self.assertEqual(req['path'], '/%s' % PATH)
669669
self.assertEqual(req['data'], REQUESTED)
670670

671-
def test_test_iam_permissions_w_alternate_client(self):
671+
def test_check_iam_permissions_w_alternate_client(self):
672672
PROJECT = 'PROJECT'
673673
TOPIC_NAME = 'topic_name'
674674
SUB_NAME = 'sub_name'
@@ -686,7 +686,7 @@ def test_test_iam_permissions_w_alternate_client(self):
686686
topic = _Topic(TOPIC_NAME, client=CLIENT1)
687687
subscription = self._makeOne(SUB_NAME, topic)
688688

689-
allowed = subscription.test_iam_permissions(ROLES, client=CLIENT2)
689+
allowed = subscription.check_iam_permissions(ROLES, client=CLIENT2)
690690

691691
self.assertEqual(len(allowed), 0)
692692
self.assertEqual(len(conn1._requested), 0)

gcloud/pubsub/test_topic.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ def test_set_iam_policy_w_alternate_client(self):
601601
self.assertEqual(req['path'], '/%s' % PATH)
602602
self.assertEqual(req['data'], {})
603603

604-
def test_test_iam_permissions_w_bound_client(self):
604+
def test_check_iam_permissions_w_bound_client(self):
605605
from gcloud.pubsub.iam import OWNER_ROLE, WRITER_ROLE, READER_ROLE
606606
TOPIC_NAME = 'topic_name'
607607
PROJECT = 'PROJECT'
@@ -618,7 +618,7 @@ def test_test_iam_permissions_w_bound_client(self):
618618
CLIENT = _Client(project=PROJECT, connection=conn)
619619
topic = self._makeOne(TOPIC_NAME, client=CLIENT)
620620

621-
allowed = topic.test_iam_permissions(ROLES)
621+
allowed = topic.check_iam_permissions(ROLES)
622622

623623
self.assertEqual(allowed, ROLES[:-1])
624624
self.assertEqual(len(conn._requested), 1)
@@ -627,7 +627,7 @@ def test_test_iam_permissions_w_bound_client(self):
627627
self.assertEqual(req['path'], '/%s' % PATH)
628628
self.assertEqual(req['data'], REQUESTED)
629629

630-
def test_test_iam_permissions_w_alternate_client(self):
630+
def test_check_iam_permissions_w_alternate_client(self):
631631
from gcloud.pubsub.iam import OWNER_ROLE, WRITER_ROLE, READER_ROLE
632632
TOPIC_NAME = 'topic_name'
633633
PROJECT = 'PROJECT'
@@ -644,7 +644,7 @@ def test_test_iam_permissions_w_alternate_client(self):
644644
CLIENT2 = _Client(project=PROJECT, connection=conn2)
645645
topic = self._makeOne(TOPIC_NAME, client=CLIENT1)
646646

647-
allowed = topic.test_iam_permissions(ROLES, client=CLIENT2)
647+
allowed = topic.check_iam_permissions(ROLES, client=CLIENT2)
648648

649649
self.assertEqual(len(allowed), 0)
650650
self.assertEqual(len(conn1._requested), 0)

gcloud/pubsub/topic.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,8 +303,8 @@ def set_iam_policy(self, policy, client=None):
303303
method='POST', path=path, data=resource)
304304
return Policy.from_api_repr(resp)
305305

306-
def test_iam_permissions(self, permissions, client=None):
307-
"""Permissions allowed for the current user by the effective IAM policy.
306+
def check_iam_permissions(self, permissions, client=None):
307+
"""Verify permissions allowed for the current user.
308308
309309
See:
310310
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/testIamPermissions

0 commit comments

Comments
 (0)