This repository was archived by the owner on Mar 31, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 173
Expand file tree
/
Copy pathtest_hmac_key.py
More file actions
457 lines (384 loc) · 16.3 KB
/
test_hmac_key.py
File metadata and controls
457 lines (384 loc) · 16.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
# Copyright 2019 Google LLC
#
# 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.
import unittest
import mock
from google.cloud.storage.retry import DEFAULT_RETRY
from google.cloud.storage.retry import DEFAULT_RETRY_IF_ETAG_IN_JSON
from google.cloud.storage._helpers import _NOW
from google.cloud.storage._helpers import _UTC
class TestHMACKeyMetadata(unittest.TestCase):
@staticmethod
def _get_default_timeout():
from google.cloud.storage.constants import _DEFAULT_TIMEOUT
return _DEFAULT_TIMEOUT
@staticmethod
def _get_target_class():
from google.cloud.storage.hmac_key import HMACKeyMetadata
return HMACKeyMetadata
def _make_one(self, client=None, *args, **kw):
if client is None:
client = _Client()
return self._get_target_class()(client, *args, **kw)
def test_ctor_defaults(self):
client = object()
metadata = self._make_one(client)
self.assertIs(metadata._client, client)
self.assertEqual(metadata._properties, {})
self.assertIsNone(metadata.access_id)
self.assertIsNone(metadata.etag)
self.assertIsNone(metadata.id)
self.assertIsNone(metadata.project)
self.assertIsNone(metadata.service_account_email)
self.assertIsNone(metadata.state)
self.assertIsNone(metadata.time_created)
self.assertIsNone(metadata.updated)
def test_ctor_explicit(self):
OTHER_PROJECT = "other-project-456"
ACCESS_ID = "access-id-123456789"
USER_PROJECT = "billed-project"
client = _Client()
metadata = self._make_one(
client,
access_id=ACCESS_ID,
project_id=OTHER_PROJECT,
user_project=USER_PROJECT,
)
self.assertIs(metadata._client, client)
expected = {"accessId": ACCESS_ID, "projectId": OTHER_PROJECT}
self.assertEqual(metadata._properties, expected)
self.assertEqual(metadata.access_id, ACCESS_ID)
self.assertEqual(metadata.user_project, USER_PROJECT)
self.assertIsNone(metadata.etag)
self.assertIsNone(metadata.id)
self.assertEqual(metadata.project, OTHER_PROJECT)
self.assertIsNone(metadata.service_account_email)
self.assertIsNone(metadata.state)
self.assertIsNone(metadata.time_created)
self.assertIsNone(metadata.updated)
def test___eq___other_type(self):
metadata = self._make_one()
for bogus in (None, "bogus", 123, 456.78, [], (), {}, set()):
self.assertNotEqual(metadata, bogus)
def test___eq___mismatched_client(self):
metadata = self._make_one()
other_client = _Client(project="other-project-456")
other = self._make_one(other_client)
self.assertNotEqual(metadata, other)
def test___eq___mismatched_access_id(self):
metadata = self._make_one()
metadata._properties["accessId"] = "ABC123"
other = self._make_one(metadata._client)
metadata._properties["accessId"] = "DEF456"
self.assertNotEqual(metadata, other)
def test___eq___hit(self):
metadata = self._make_one()
metadata._properties["accessId"] = "ABC123"
other = self._make_one(metadata._client)
other._properties["accessId"] = metadata.access_id
self.assertEqual(metadata, other)
def test___hash__(self):
client = _Client()
metadata = self._make_one(client)
metadata._properties["accessId"] = "ABC123"
self.assertIsInstance(hash(metadata), int)
other = self._make_one(client)
metadata._properties["accessId"] = "DEF456"
self.assertNotEqual(hash(metadata), hash(other))
def test_access_id_getter(self):
metadata = self._make_one()
expected = "ACCESS-ID"
metadata._properties["accessId"] = expected
self.assertEqual(metadata.access_id, expected)
def test_etag_getter(self):
metadata = self._make_one()
expected = "ETAG"
metadata._properties["etag"] = expected
self.assertEqual(metadata.etag, expected)
def test_id_getter(self):
metadata = self._make_one()
expected = "ID"
metadata._properties["id"] = expected
self.assertEqual(metadata.id, expected)
def test_project_getter(self):
metadata = self._make_one()
expected = "PROJECT-ID"
metadata._properties["projectId"] = expected
self.assertEqual(metadata.project, expected)
def test_service_account_email_getter(self):
metadata = self._make_one()
expected = "service_account@example.com"
metadata._properties["serviceAccountEmail"] = expected
self.assertEqual(metadata.service_account_email, expected)
def test_state_getter(self):
metadata = self._make_one()
expected = "STATE"
metadata._properties["state"] = expected
self.assertEqual(metadata.state, expected)
def test_state_setter_invalid_state(self):
metadata = self._make_one()
expected = "INVALID"
metadata.state = expected
# Test that invalid states are allowed without client side validation.
# Fall back to server side validation and errors.
self.assertEqual(metadata.state, expected)
self.assertEqual(metadata._properties["state"], expected)
def test_state_setter_inactive(self):
metadata = self._make_one()
metadata._properties["state"] = "ACTIVE"
expected = "INACTIVE"
metadata.state = expected
self.assertEqual(metadata.state, expected)
self.assertEqual(metadata._properties["state"], expected)
def test_state_setter_active(self):
metadata = self._make_one()
metadata._properties["state"] = "INACTIVE"
expected = "ACTIVE"
metadata.state = expected
self.assertEqual(metadata.state, expected)
self.assertEqual(metadata._properties["state"], expected)
def test_time_created_getter(self):
metadata = self._make_one()
now = _NOW()
now_stamp = f"{now.isoformat()}Z"
metadata._properties["timeCreated"] = now_stamp
self.assertEqual(metadata.time_created, now.replace(tzinfo=_UTC))
def test_updated_getter(self):
metadata = self._make_one()
now = _NOW()
now_stamp = f"{now.isoformat()}Z"
metadata._properties["updated"] = now_stamp
self.assertEqual(metadata.updated, now.replace(tzinfo=_UTC))
def test_path_wo_access_id(self):
metadata = self._make_one()
with self.assertRaises(ValueError):
metadata.path
def test_path_w_access_id_wo_project(self):
access_id = "ACCESS-ID"
client = _Client()
metadata = self._make_one()
metadata._properties["accessId"] = access_id
expected_path = f"/projects/{client.DEFAULT_PROJECT}/hmacKeys/{access_id}"
self.assertEqual(metadata.path, expected_path)
def test_path_w_access_id_w_explicit_project(self):
access_id = "ACCESS-ID"
project = "OTHER-PROJECT"
metadata = self._make_one()
metadata._properties["accessId"] = access_id
metadata._properties["projectId"] = project
expected_path = f"/projects/{project}/hmacKeys/{access_id}"
self.assertEqual(metadata.path, expected_path)
def test_exists_miss_w_defaults(self):
from google.cloud.exceptions import NotFound
access_id = "ACCESS-ID"
project = "PROJECT"
client = mock.Mock(spec=["_get_resource", "project"])
client._get_resource.side_effect = NotFound("testing")
client.project = project
metadata = self._make_one(client)
metadata._properties["accessId"] = access_id
self.assertFalse(metadata.exists())
expected_path = f"/projects/{project}/hmacKeys/{access_id}"
expected_query_params = {}
client._get_resource.assert_called_once_with(
expected_path,
query_params=expected_query_params,
timeout=self._get_default_timeout(),
retry=DEFAULT_RETRY,
)
def test_exists_hit_w_explicit_w_user_project(self):
project = "PROJECT-ID"
access_id = "ACCESS-ID"
user_project = "billed-project"
email = "service-account@example.com"
resource = {
"kind": "storage#hmacKeyMetadata",
"accessId": access_id,
"serviceAccountEmail": email,
}
timeout = 42
retry = mock.Mock(spec=[])
client = mock.Mock(spec=["_get_resource"])
client._get_resource.return_value = resource
metadata = self._make_one(client, user_project=user_project)
metadata._properties["accessId"] = access_id
metadata._properties["projectId"] = project
self.assertTrue(metadata.exists(timeout=timeout, retry=retry))
expected_path = f"/projects/{project}/hmacKeys/{access_id}"
expected_query_params = {"userProject": user_project}
client._get_resource.assert_called_once_with(
expected_path,
query_params=expected_query_params,
timeout=timeout,
retry=retry,
)
def test_reload_miss_w_defaults(self):
from google.cloud.exceptions import NotFound
access_id = "ACCESS-ID"
project = "PROJECT"
client = mock.Mock(spec=["_get_resource", "project"])
client._get_resource.side_effect = NotFound("testing")
client.project = project
metadata = self._make_one(client)
metadata._properties["accessId"] = access_id
with self.assertRaises(NotFound):
metadata.reload()
expected_path = f"/projects/{project}/hmacKeys/{access_id}"
expected_query_params = {}
client._get_resource.assert_called_once_with(
expected_path,
query_params=expected_query_params,
timeout=self._get_default_timeout(),
retry=DEFAULT_RETRY,
)
def test_reload_hit_w_project_set(self):
project = "PROJECT-ID"
access_id = "ACCESS-ID"
user_project = "billed-project"
email = "service-account@example.com"
resource = {
"kind": "storage#hmacKeyMetadata",
"accessId": access_id,
"serviceAccountEmail": email,
}
timeout = 42
retry = mock.Mock(spec=[])
client = mock.Mock(spec=["_get_resource"])
client._get_resource.return_value = resource
metadata = self._make_one(client, user_project=user_project)
metadata._properties["accessId"] = access_id
metadata._properties["projectId"] = project
metadata.reload(timeout=timeout, retry=retry)
self.assertEqual(metadata._properties, resource)
expected_path = f"/projects/{project}/hmacKeys/{access_id}"
expected_query_params = {"userProject": user_project}
client._get_resource.assert_called_once_with(
expected_path,
query_params=expected_query_params,
timeout=timeout,
retry=retry,
)
def test_update_miss_no_project_set_w_defaults(self):
from google.cloud.exceptions import NotFound
project = "PROJECT"
access_id = "ACCESS-ID"
client = mock.Mock(spec=["_put_resource", "project"])
client._put_resource.side_effect = NotFound("testing")
client.project = project
metadata = self._make_one(client)
metadata._properties["accessId"] = access_id
metadata.state = "INACTIVE"
with self.assertRaises(NotFound):
metadata.update()
expected_path = f"/projects/{project}/hmacKeys/{access_id}"
expected_data = {"state": "INACTIVE"}
expected_query_params = {}
client._put_resource.assert_called_once_with(
expected_path,
expected_data,
query_params=expected_query_params,
timeout=self._get_default_timeout(),
retry=DEFAULT_RETRY_IF_ETAG_IN_JSON,
)
def test_update_hit_w_project_set_w_timeout_w_retry(self):
project = "PROJECT-ID"
access_id = "ACCESS-ID"
user_project = "billed-project"
email = "service-account@example.com"
resource = {
"kind": "storage#hmacKeyMetadata",
"accessId": access_id,
"serviceAccountEmail": email,
"state": "ACTIVE",
}
client = mock.Mock(spec=["_put_resource"])
client._put_resource.return_value = resource
metadata = self._make_one(client, user_project=user_project)
metadata._properties["accessId"] = access_id
metadata._properties["projectId"] = project
metadata.state = "ACTIVE"
timeout = 42
retry = mock.Mock(spec=[])
metadata.update(timeout=42, retry=retry)
self.assertEqual(metadata._properties, resource)
expected_path = f"/projects/{project}/hmacKeys/{access_id}"
expected_data = {"state": "ACTIVE"}
expected_query_params = {"userProject": user_project}
client._put_resource.assert_called_once_with(
expected_path,
expected_data,
query_params=expected_query_params,
timeout=timeout,
retry=retry,
)
def test_delete_not_inactive(self):
client = mock.Mock(spec=["_delete_resource", "project"])
client.project = "PROJECT"
metadata = self._make_one(client)
for state in ("ACTIVE", "DELETED"):
metadata._properties["state"] = state
with self.assertRaises(ValueError):
metadata.delete()
client._delete_resource.assert_not_called()
def test_delete_miss_no_project_set_w_defaults(self):
from google.cloud.exceptions import NotFound
access_id = "ACCESS-ID"
client = mock.Mock(spec=["_delete_resource", "project"])
client._delete_resource.side_effect = NotFound("testing")
client.project = "PROJECT"
metadata = self._make_one(client)
metadata._properties["accessId"] = access_id
metadata.state = "INACTIVE"
with self.assertRaises(NotFound):
metadata.delete()
expected_path = f"/projects/{client.project}/hmacKeys/{access_id}"
expected_query_params = {}
client._delete_resource.assert_called_once_with(
expected_path,
query_params=expected_query_params,
timeout=self._get_default_timeout(),
retry=DEFAULT_RETRY,
)
def test_delete_hit_w_project_set_w_explicit_timeout_retry(self):
project = "PROJECT-ID"
access_id = "ACCESS-ID"
user_project = "billed-project"
client = mock.Mock(spec=["_delete_resource", "project"])
client.project = "CLIENT-PROJECT"
client._delete_resource.return_value = {}
metadata = self._make_one(client, user_project=user_project)
metadata._properties["accessId"] = access_id
metadata._properties["projectId"] = project
metadata.state = "INACTIVE"
timeout = 42
retry = mock.Mock(spec=[])
metadata.delete(timeout=timeout, retry=retry)
expected_path = f"/projects/{project}/hmacKeys/{access_id}"
expected_query_params = {"userProject": user_project}
client._delete_resource.assert_called_once_with(
expected_path,
query_params=expected_query_params,
timeout=timeout,
retry=retry,
)
class _Client(object):
DEFAULT_PROJECT = "project-123"
def __init__(self, connection=None, project=DEFAULT_PROJECT):
self._connection = connection
self.project = project
def __eq__(self, other):
if not isinstance(other, self.__class__): # pragma: NO COVER
return NotImplemented
return self._connection == other._connection and self.project == other.project
def __hash__(self):
return hash(self._connection) + hash(self.project)