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

Store policy bindings as sets, not frozensets. (#3308) · googleapis/google-cloud-python@1633962 · GitHub

/ google-cloud-python Public

Commit 1633962

Browse files
tseaver
authored and
lukesneeringer
committed
Store policy bindings as sets, not frozensets. (#3308)
The legacy accessors still return frozensets, as they cannot safely be mutated in plcae.
1 parent 331e616 commit 1633962

4 files changed

Lines changed: 60 additions & 55 deletions

File tree

‎core/google/cloud/iam.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def __getitem__(self, key):
7171
return self._bindings[key]
7272

7373
def __setitem__(self, key, value):
74-
self._bindings[key] = frozenset(value)
74+
self._bindings[key] = set(value)
7575

7676
def __delitem__(self, key):
7777
del self._bindings[key]
@@ -91,7 +91,7 @@ def owners(self, value):
9191
warnings.warn(
9292
_ASSIGNMENT_DEPRECATED_MSG.format('owners', OWNER_ROLE),
9393
DeprecationWarning)
94-
self._bindings[OWNER_ROLE] = list(value)
94+
self[OWNER_ROLE] = value
9595

9696
@property
9797
def editors(self):
@@ -108,7 +108,7 @@ def editors(self, value):
108108
warnings.warn(
109109
_ASSIGNMENT_DEPRECATED_MSG.format('editors', EDITOR_ROLE),
110110
DeprecationWarning)
111-
self._bindings[EDITOR_ROLE] = list(value)
111+
self[EDITOR_ROLE] = value
112112

113113
@property
114114
def viewers(self):
@@ -125,7 +125,7 @@ def viewers(self, value):
125125
warnings.warn(
126126
_ASSIGNMENT_DEPRECATED_MSG.format('viewers', VIEWER_ROLE),
127127
DeprecationWarning)
128-
self._bindings[VIEWER_ROLE] = list(value)
128+
self[VIEWER_ROLE] = value
129129

130130
@staticmethod
131131
def user(email):
@@ -209,7 +209,7 @@ def from_api_repr(cls, resource):
209209
for binding in resource.get('bindings', ()):
210210
role = binding['role']
211211
members = sorted(binding['members'])
212-
policy._bindings[role] = members
212+
policy[role] = members
213213
return policy
214214

215215
def to_api_repr(self):

‎core/tests/unit/test_iam.py‎

Lines changed: 35 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -27,27 +27,26 @@ def _make_one(self, *args, **kw):
2727
return self._get_target_class()(*args, **kw)
2828

2929
def test_ctor_defaults(self):
30+
empty = frozenset()
3031
policy = self._make_one()
3132
self.assertIsNone(policy.etag)
3233
self.assertIsNone(policy.version)
33-
self.assertIsInstance(policy.owners, frozenset)
34-
self.assertEqual(list(policy.owners), [])
35-
self.assertIsInstance(policy.editors, frozenset)
36-
self.assertEqual(list(policy.editors), [])
37-
self.assertIsInstance(policy.viewers, frozenset)
38-
self.assertEqual(list(policy.viewers), [])
34+
self.assertEqual(policy.owners, empty)
35+
self.assertEqual(policy.editors, empty)
36+
self.assertEqual(policy.viewers, empty)
3937
self.assertEqual(len(policy), 0)
4038
self.assertEqual(dict(policy), {})
4139

4240
def test_ctor_explicit(self):
4341
VERSION = 17
4442
ETAG = 'ETAG'
43+
empty = frozenset()
4544
policy = self._make_one(ETAG, VERSION)
4645
self.assertEqual(policy.etag, ETAG)
4746
self.assertEqual(policy.version, VERSION)
48-
self.assertEqual(list(policy.owners), [])
49-
self.assertEqual(list(policy.editors), [])
50-
self.assertEqual(list(policy.viewers), [])
47+
self.assertEqual(policy.owners, empty)
48+
self.assertEqual(policy.editors, empty)
49+
self.assertEqual(policy.viewers, empty)
5150
self.assertEqual(len(policy), 0)
5251
self.assertEqual(dict(policy), {})
5352

@@ -58,7 +57,7 @@ def test___getitem___miss(self):
5857

5958
def test___setitem__(self):
6059
USER = 'user:phred@example.com'
61-
PRINCIPALS = frozenset([USER])
60+
PRINCIPALS = set([USER])
6261
policy = self._make_one()
6362
policy['rolename'] = [USER]
6463
self.assertEqual(policy['rolename'], PRINCIPALS)
@@ -80,54 +79,59 @@ def test___delitem___miss(self):
8079
def test_owners_getter(self):
8180
from google.cloud.iam import OWNER_ROLE
8281
MEMBER = 'user:phred@example.com'
82+
expected = frozenset([MEMBER])
8383
policy = self._make_one()
8484
policy[OWNER_ROLE] = [MEMBER]
85-
self.assertIsInstance(policy.owners, frozenset)
86-
self.assertEqual(list(policy.owners), [MEMBER])
85+
self.assertEqual(policy.owners, expected)
8786

8887
def test_owners_setter(self):
8988
import warnings
9089
from google.cloud.iam import OWNER_ROLE
9190
MEMBER = 'user:phred@example.com'
91+
expected = set([MEMBER])
9292
policy = self._make_one()
9393
with warnings.catch_warnings():
94+
warnings.simplefilter('always')
9495
policy.owners = [MEMBER]
95-
self.assertEqual(list(policy[OWNER_ROLE]), [MEMBER])
96+
self.assertEqual(policy[OWNER_ROLE], expected)
9697

9798
def test_editors_getter(self):
9899
from google.cloud.iam import EDITOR_ROLE
99100
MEMBER = 'user:phred@example.com'
101+
expected = frozenset([MEMBER])
100102
policy = self._make_one()
101103
policy[EDITOR_ROLE] = [MEMBER]
102-
self.assertIsInstance(policy.editors, frozenset)
103-
self.assertEqual(list(policy.editors), [MEMBER])
104+
self.assertEqual(policy.editors, expected)
104105

105106
def test_editors_setter(self):
106107
import warnings
107108
from google.cloud.iam import EDITOR_ROLE
108109
MEMBER = 'user:phred@example.com'
110+
expected = set([MEMBER])
109111
policy = self._make_one()
110112
with warnings.catch_warnings():
113+
warnings.simplefilter('always')
111114
policy.editors = [MEMBER]
112-
self.assertEqual(list(policy[EDITOR_ROLE]), [MEMBER])
115+
self.assertEqual(policy[EDITOR_ROLE], expected)
113116

114117
def test_viewers_getter(self):
115118
from google.cloud.iam import VIEWER_ROLE
116119
MEMBER = 'user:phred@example.com'
120+
expected = frozenset([MEMBER])
117121
policy = self._make_one()
118122
policy[VIEWER_ROLE] = [MEMBER]
119-
self.assertIsInstance(policy.viewers, frozenset)
120-
self.assertEqual(list(policy.viewers), [MEMBER])
123+
self.assertEqual(policy.viewers, expected)
121124

122125
def test_viewers_setter(self):
123126
import warnings
124127
from google.cloud.iam import VIEWER_ROLE
125128
MEMBER = 'user:phred@example.com'
129+
expected = set([MEMBER])
126130
policy = self._make_one()
127131
with warnings.catch_warnings():
128132
warnings.simplefilter('always')
129133
policy.viewers = [MEMBER]
130-
self.assertEqual(list(policy[VIEWER_ROLE]), [MEMBER])
134+
self.assertEqual(policy[VIEWER_ROLE], expected)
131135

132136
def test_user(self):
133137
EMAIL = 'phred@example.com'
@@ -162,16 +166,17 @@ def test_authenticated_users(self):
162166
self.assertEqual(policy.authenticated_users(), 'allAuthenticatedUsers')
163167

164168
def test_from_api_repr_only_etag(self):
169+
empty = frozenset()
165170
RESOURCE = {
166171
'etag': 'ACAB',
167172
}
168173
klass = self._get_target_class()
169174
policy = klass.from_api_repr(RESOURCE)
170175
self.assertEqual(policy.etag, 'ACAB')
171176
self.assertIsNone(policy.version)
172-
self.assertEqual(list(policy.owners), [])
173-
self.assertEqual(list(policy.editors), [])
174-
self.assertEqual(list(policy.viewers), [])
177+
self.assertEqual(policy.owners, empty)
178+
self.assertEqual(policy.editors, empty)
179+
self.assertEqual(policy.viewers, empty)
175180
self.assertEqual(dict(policy), {})
176181

177182
def test_from_api_repr_complete(self):
@@ -196,18 +201,19 @@ def test_from_api_repr_complete(self):
196201
{'role': VIEWER_ROLE, 'members': [VIEWER1, VIEWER2]},
197202
],
198203
}
204+
empty = frozenset()
199205
klass = self._get_target_class()
200206
policy = klass.from_api_repr(RESOURCE)
201207
self.assertEqual(policy.etag, 'DEADBEEF')
202208
self.assertEqual(policy.version, 17)
203-
self.assertEqual(sorted(policy.owners), [OWNER1, OWNER2])
204-
self.assertEqual(sorted(policy.editors), [EDITOR1, EDITOR2])
205-
self.assertEqual(sorted(policy.viewers), [VIEWER1, VIEWER2])
209+
self.assertEqual(policy.owners, frozenset([OWNER1, OWNER2]))
210+
self.assertEqual(policy.editors, frozenset([EDITOR1, EDITOR2]))
211+
self.assertEqual(policy.viewers, frozenset([VIEWER1, VIEWER2]))
206212
self.assertEqual(
207213
dict(policy), {
208-
OWNER_ROLE: [OWNER1, OWNER2],
209-
EDITOR_ROLE: [EDITOR1, EDITOR2],
210-
VIEWER_ROLE: [VIEWER1, VIEWER2],
214+
OWNER_ROLE: set([OWNER1, OWNER2]),
215+
EDITOR_ROLE: set([EDITOR1, EDITOR2]),
216+
VIEWER_ROLE: set([VIEWER1, VIEWER2]),
211217
})
212218

213219
def test_from_api_repr_unknown_role(self):
@@ -224,7 +230,7 @@ def test_from_api_repr_unknown_role(self):
224230
policy = klass.from_api_repr(RESOURCE)
225231
self.assertEqual(policy.etag, 'DEADBEEF')
226232
self.assertEqual(policy.version, 17)
227-
self.assertEqual(dict(policy), {'unknown': [GROUP, USER]})
233+
self.assertEqual(dict(policy), {'unknown': set([GROUP, USER])})
228234

229235
def test_to_api_repr_defaults(self):
230236
policy = self._make_one()

‎pubsub/google/cloud/pubsub/iam.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ def publishers(self, value):
121121
_ASSIGNMENT_DEPRECATED_MSG.format(
122122
'publishers', PUBSUB_PUBLISHER_ROLE),
123123
DeprecationWarning)
124-
self._bindings[PUBSUB_PUBLISHER_ROLE] = list(value)
124+
self[PUBSUB_PUBLISHER_ROLE] = value
125125

126126
@property
127127
def subscribers(self):
@@ -135,4 +135,4 @@ def subscribers(self, value):
135135
_ASSIGNMENT_DEPRECATED_MSG.format(
136136
'subscribers', PUBSUB_SUBSCRIBER_ROLE),
137137
DeprecationWarning)
138-
self._bindings[PUBSUB_SUBSCRIBER_ROLE] = list(value)
138+
self[PUBSUB_SUBSCRIBER_ROLE] = value

‎pubsub/tests/unit/test_iam.py‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,56 +27,55 @@ def _make_one(self, *args, **kw):
2727
return self._get_target_class()(*args, **kw)
2828

2929
def test_ctor_defaults(self):
30+
empty = frozenset()
3031
policy = self._make_one()
3132
self.assertIsNone(policy.etag)
3233
self.assertIsNone(policy.version)
33-
self.assertIsInstance(policy.owners, frozenset)
34-
self.assertEqual(list(policy.owners), [])
35-
self.assertIsInstance(policy.editors, frozenset)
36-
self.assertEqual(list(policy.editors), [])
37-
self.assertIsInstance(policy.viewers, frozenset)
38-
self.assertEqual(list(policy.viewers), [])
39-
self.assertIsInstance(policy.publishers, frozenset)
40-
self.assertEqual(list(policy.publishers), [])
41-
self.assertIsInstance(policy.subscribers, frozenset)
42-
self.assertEqual(list(policy.subscribers), [])
34+
self.assertEqual(policy.owners, empty)
35+
self.assertEqual(policy.editors, empty)
36+
self.assertEqual(policy.viewers, empty)
37+
self.assertEqual(policy.publishers, empty)
38+
self.assertEqual(policy.subscribers, empty)
4339

4440
def test_ctor_explicit(self):
4541
VERSION = 17
4642
ETAG = 'ETAG'
43+
empty = frozenset()
4744
policy = self._make_one(ETAG, VERSION)
4845
self.assertEqual(policy.etag, ETAG)
4946
self.assertEqual(policy.version, VERSION)
50-
self.assertEqual(list(policy.owners), [])
51-
self.assertEqual(list(policy.editors), [])
52-
self.assertEqual(list(policy.viewers), [])
53-
self.assertEqual(list(policy.publishers), [])
54-
self.assertEqual(list(policy.subscribers), [])
47+
self.assertEqual(policy.owners, empty)
48+
self.assertEqual(policy.editors, empty)
49+
self.assertEqual(policy.viewers, empty)
50+
self.assertEqual(policy.publishers, empty)
51+
self.assertEqual(policy.subscribers, empty)
5552

5653
def test_publishers_setter(self):
5754
import warnings
5855
from google.cloud.pubsub.iam import (
5956
PUBSUB_PUBLISHER_ROLE,
6057
)
6158
PUBLISHER = 'user:phred@example.com'
59+
expected = set([PUBLISHER])
6260
policy = self._make_one()
6361
with warnings.catch_warnings():
6462
policy.publishers = [PUBLISHER]
6563

66-
self.assertEqual(sorted(policy.publishers), [PUBLISHER])
64+
self.assertEqual(policy.publishers, frozenset(expected))
6765
self.assertEqual(
68-
dict(policy), {PUBSUB_PUBLISHER_ROLE: [PUBLISHER]})
66+
dict(policy), {PUBSUB_PUBLISHER_ROLE: expected})
6967

7068
def test_subscribers_setter(self):
7169
import warnings
7270
from google.cloud.pubsub.iam import (
7371
PUBSUB_SUBSCRIBER_ROLE,
7472
)
7573
SUBSCRIBER = 'serviceAccount:1234-abcdef@service.example.com'
74+
expected = set([SUBSCRIBER])
7675
policy = self._make_one()
7776
with warnings.catch_warnings():
7877
policy.subscribers = [SUBSCRIBER]
7978

80-
self.assertEqual(sorted(policy.subscribers), [SUBSCRIBER])
79+
self.assertEqual(policy.subscribers, frozenset(expected))
8180
self.assertEqual(
82-
dict(policy), {PUBSUB_SUBSCRIBER_ROLE: [SUBSCRIBER]})
81+
dict(policy), {PUBSUB_SUBSCRIBER_ROLE: expected})

0 commit comments

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