forked from googleapis/python-bigtable
/
test_client.py
576 lines (463 loc) · 21.7 KB
/
test_client.py
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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
# Copyright 2015 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 ._testing import _make_credentials
class Test__create_gapic_client(unittest.TestCase):
def _invoke_client_factory(self, client_class, **kw):
from google.cloud.bigtable.client import _create_gapic_client
return _create_gapic_client(client_class, **kw)
def test_wo_emulator(self):
client_class = mock.Mock()
credentials = _make_credentials()
client = _Client(credentials)
client_info = client._client_info = mock.Mock()
transport = mock.Mock()
result = self._invoke_client_factory(client_class, transport=transport)(client)
self.assertIs(result, client_class.return_value)
client_class.assert_called_once_with(
credentials=None,
client_info=client_info,
client_options=None,
transport=transport,
)
def test_wo_emulator_w_client_options(self):
client_class = mock.Mock()
credentials = _make_credentials()
client = _Client(credentials)
client_info = client._client_info = mock.Mock()
client_options = mock.Mock()
transport = mock.Mock()
result = self._invoke_client_factory(
client_class, client_options=client_options, transport=transport
)(client)
self.assertIs(result, client_class.return_value)
client_class.assert_called_once_with(
credentials=None,
client_info=client_info,
client_options=client_options,
transport=transport,
)
def test_w_emulator(self):
client_class = mock.Mock()
emulator_host = emulator_channel = object()
credentials = _make_credentials()
client = _Client(
credentials, emulator_host=emulator_host, emulator_channel=emulator_channel
)
client_info = client._client_info = mock.Mock()
result = self._invoke_client_factory(client_class)(client)
self.assertIs(result, client_class.return_value)
client_class.assert_called_once_with(
channel=client._emulator_channel, client_info=client_info
)
class _Client(object):
def __init__(self, credentials, emulator_host=None, emulator_channel=None):
self._credentials = credentials
self._emulator_host = emulator_host
self._emulator_channel = emulator_channel
class TestClient(unittest.TestCase):
PROJECT = "PROJECT"
INSTANCE_ID = "instance-id"
DISPLAY_NAME = "display-name"
USER_AGENT = "you-sir-age-int"
@staticmethod
def _get_target_class():
from google.cloud.bigtable.client import Client
return Client
def _make_one(self, *args, **kwargs):
return self._get_target_class()(*args, **kwargs)
def test_constructor_defaults(self):
from google.cloud.bigtable.client import _CLIENT_INFO
from google.cloud.bigtable.client import DATA_SCOPE
credentials = _make_credentials()
with mock.patch("google.auth.default") as mocked:
mocked.return_value = credentials, self.PROJECT
client = self._make_one()
self.assertEqual(client.project, self.PROJECT)
self.assertIs(client._credentials, credentials.with_scopes.return_value)
self.assertFalse(client._read_only)
self.assertFalse(client._admin)
self.assertIs(client._client_info, _CLIENT_INFO)
self.assertIsNone(client._channel)
self.assertIsNone(client._emulator_host)
self.assertIsNone(client._emulator_channel)
self.assertEqual(client.SCOPE, (DATA_SCOPE,))
def test_constructor_explicit(self):
import warnings
from google.cloud.bigtable.client import ADMIN_SCOPE
from google.cloud.bigtable.client import DATA_SCOPE
credentials = _make_credentials()
client_info = mock.Mock()
with warnings.catch_warnings(record=True) as warned:
client = self._make_one(
project=self.PROJECT,
credentials=credentials,
read_only=False,
admin=True,
client_info=client_info,
channel=mock.sentinel.channel,
)
self.assertEqual(len(warned), 1)
self.assertEqual(client.project, self.PROJECT)
self.assertIs(client._credentials, credentials.with_scopes.return_value)
self.assertFalse(client._read_only)
self.assertTrue(client._admin)
self.assertIs(client._client_info, client_info)
self.assertIs(client._channel, mock.sentinel.channel)
self.assertEqual(client.SCOPE, (DATA_SCOPE, ADMIN_SCOPE))
def test_constructor_both_admin_and_read_only(self):
credentials = _make_credentials()
with self.assertRaises(ValueError):
self._make_one(
project=self.PROJECT,
credentials=credentials,
admin=True,
read_only=True,
)
def test_constructor_with_emulator_host(self):
from google.cloud.environment_vars import BIGTABLE_EMULATOR
credentials = _make_credentials()
emulator_host = "localhost:8081"
with mock.patch("os.getenv") as getenv:
getenv.return_value = emulator_host
with mock.patch("grpc.insecure_channel") as factory:
getenv.return_value = emulator_host
client = self._make_one(project=self.PROJECT, credentials=credentials)
self.assertEqual(client._emulator_host, emulator_host)
self.assertIs(client._emulator_channel, factory.return_value)
factory.assert_called_once_with(
target=emulator_host,
options={
"grpc.keepalive_time_ms": 30000,
"grpc.keepalive_timeout_ms": 10000,
}.items(),
)
getenv.assert_called_once_with(BIGTABLE_EMULATOR)
def test__get_scopes_default(self):
from google.cloud.bigtable.client import DATA_SCOPE
client = self._make_one(project=self.PROJECT, credentials=_make_credentials())
self.assertEqual(client._get_scopes(), (DATA_SCOPE,))
def test__get_scopes_admin(self):
from google.cloud.bigtable.client import ADMIN_SCOPE
from google.cloud.bigtable.client import DATA_SCOPE
client = self._make_one(
project=self.PROJECT, credentials=_make_credentials(), admin=True
)
expected_scopes = (DATA_SCOPE, ADMIN_SCOPE)
self.assertEqual(client._get_scopes(), expected_scopes)
def test__get_scopes_read_only(self):
from google.cloud.bigtable.client import READ_ONLY_SCOPE
client = self._make_one(
project=self.PROJECT, credentials=_make_credentials(), read_only=True
)
self.assertEqual(client._get_scopes(), (READ_ONLY_SCOPE,))
def test_project_path_property(self):
credentials = _make_credentials()
project = "PROJECT"
client = self._make_one(project=project, credentials=credentials, admin=True)
project_name = "projects/" + project
self.assertEqual(client.project_path, project_name)
def test_table_data_client_not_initialized(self):
from google.cloud.bigtable.client import _CLIENT_INFO
from google.cloud.bigtable_v2 import BigtableClient
credentials = _make_credentials()
client = self._make_one(project=self.PROJECT, credentials=credentials)
table_data_client = client.table_data_client
self.assertIsInstance(table_data_client, BigtableClient)
self.assertIs(table_data_client._client_info, _CLIENT_INFO)
self.assertIs(client._table_data_client, table_data_client)
def test_table_data_client_not_initialized_w_client_info(self):
from google.cloud.bigtable_v2 import BigtableClient
credentials = _make_credentials()
client_info = mock.Mock()
client = self._make_one(
project=self.PROJECT, credentials=credentials, client_info=client_info
)
table_data_client = client.table_data_client
self.assertIsInstance(table_data_client, BigtableClient)
self.assertIs(table_data_client._client_info, client_info)
self.assertIs(client._table_data_client, table_data_client)
def test_table_data_client_not_initialized_w_client_options(self):
from google.api_core.client_options import ClientOptions
credentials = _make_credentials()
client_options = ClientOptions(
quota_project_id="QUOTA-PROJECT", api_endpoint="xyz"
)
client = self._make_one(
project=self.PROJECT, credentials=credentials, client_options=client_options
)
patch = mock.patch("google.cloud.bigtable_v2.BigtableClient")
with patch as mocked:
table_data_client = client.table_data_client
self.assertIs(table_data_client, mocked.return_value)
self.assertIs(client._table_data_client, table_data_client)
mocked.assert_called_once_with(
client_info=client._client_info,
credentials=None,
transport=mock.ANY,
client_options=client_options,
)
def test_table_data_client_initialized(self):
credentials = _make_credentials()
client = self._make_one(
project=self.PROJECT, credentials=credentials, admin=True
)
already = client._table_data_client = object()
self.assertIs(client.table_data_client, already)
def test_table_admin_client_not_initialized_no_admin_flag(self):
credentials = _make_credentials()
client = self._make_one(project=self.PROJECT, credentials=credentials)
with self.assertRaises(ValueError):
client.table_admin_client()
def test_table_admin_client_not_initialized_w_admin_flag(self):
from google.cloud.bigtable.client import _CLIENT_INFO
from google.cloud.bigtable_admin_v2 import BigtableTableAdminClient
credentials = _make_credentials()
client = self._make_one(
project=self.PROJECT, credentials=credentials, admin=True
)
table_admin_client = client.table_admin_client
self.assertIsInstance(table_admin_client, BigtableTableAdminClient)
self.assertIs(table_admin_client._client_info, _CLIENT_INFO)
self.assertIs(client._table_admin_client, table_admin_client)
def test_table_admin_client_not_initialized_w_client_info(self):
from google.cloud.bigtable_admin_v2 import BigtableTableAdminClient
credentials = _make_credentials()
client_info = mock.Mock()
client = self._make_one(
project=self.PROJECT,
credentials=credentials,
admin=True,
client_info=client_info,
)
table_admin_client = client.table_admin_client
self.assertIsInstance(table_admin_client, BigtableTableAdminClient)
self.assertIs(table_admin_client._client_info, client_info)
self.assertIs(client._table_admin_client, table_admin_client)
def test_table_admin_client_not_initialized_w_client_options(self):
credentials = _make_credentials()
admin_client_options = mock.Mock()
client = self._make_one(
project=self.PROJECT,
credentials=credentials,
admin=True,
admin_client_options=admin_client_options,
)
client._create_gapic_client_channel = mock.Mock()
patch = mock.patch("google.cloud.bigtable_admin_v2.BigtableTableAdminClient")
with patch as mocked:
table_admin_client = client.table_admin_client
self.assertIs(table_admin_client, mocked.return_value)
self.assertIs(client._table_admin_client, table_admin_client)
mocked.assert_called_once_with(
client_info=client._client_info,
credentials=None,
transport=mock.ANY,
client_options=admin_client_options,
)
def test_table_admin_client_initialized(self):
credentials = _make_credentials()
client = self._make_one(
project=self.PROJECT, credentials=credentials, admin=True
)
already = client._table_admin_client = object()
self.assertIs(client.table_admin_client, already)
def test_instance_admin_client_not_initialized_no_admin_flag(self):
credentials = _make_credentials()
client = self._make_one(project=self.PROJECT, credentials=credentials)
with self.assertRaises(ValueError):
client.instance_admin_client()
def test_instance_admin_client_not_initialized_w_admin_flag(self):
from google.cloud.bigtable.client import _CLIENT_INFO
from google.cloud.bigtable_admin_v2 import BigtableInstanceAdminClient
credentials = _make_credentials()
client = self._make_one(
project=self.PROJECT, credentials=credentials, admin=True
)
instance_admin_client = client.instance_admin_client
self.assertIsInstance(instance_admin_client, BigtableInstanceAdminClient)
self.assertIs(instance_admin_client._client_info, _CLIENT_INFO)
self.assertIs(client._instance_admin_client, instance_admin_client)
def test_instance_admin_client_not_initialized_w_client_info(self):
from google.cloud.bigtable_admin_v2 import BigtableInstanceAdminClient
credentials = _make_credentials()
client_info = mock.Mock()
client = self._make_one(
project=self.PROJECT,
credentials=credentials,
admin=True,
client_info=client_info,
)
instance_admin_client = client.instance_admin_client
self.assertIsInstance(instance_admin_client, BigtableInstanceAdminClient)
self.assertIs(instance_admin_client._client_info, client_info)
self.assertIs(client._instance_admin_client, instance_admin_client)
def test_instance_admin_client_not_initialized_w_client_options(self):
credentials = _make_credentials()
admin_client_options = mock.Mock()
client = self._make_one(
project=self.PROJECT,
credentials=credentials,
admin=True,
admin_client_options=admin_client_options,
)
client._create_gapic_client_channel = mock.Mock()
patch = mock.patch("google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient")
with patch as mocked:
instance_admin_client = client.instance_admin_client
self.assertIs(instance_admin_client, mocked.return_value)
self.assertIs(client._instance_admin_client, instance_admin_client)
mocked.assert_called_once_with(
client_info=client._client_info,
credentials=None,
transport=mock.ANY,
client_options=admin_client_options,
)
def test_instance_admin_client_initialized(self):
credentials = _make_credentials()
client = self._make_one(
project=self.PROJECT, credentials=credentials, admin=True
)
already = client._instance_admin_client = object()
self.assertIs(client.instance_admin_client, already)
def test_instance_factory_defaults(self):
from google.cloud.bigtable.instance import Instance
PROJECT = "PROJECT"
INSTANCE_ID = "instance-id"
credentials = _make_credentials()
client = self._make_one(project=PROJECT, credentials=credentials)
instance = client.instance(INSTANCE_ID)
self.assertIsInstance(instance, Instance)
self.assertEqual(instance.instance_id, INSTANCE_ID)
self.assertEqual(instance.display_name, INSTANCE_ID)
self.assertIsNone(instance.type_)
self.assertIsNone(instance.labels)
self.assertIs(instance._client, client)
def test_instance_factory_non_defaults(self):
from google.cloud.bigtable.instance import Instance
from google.cloud.bigtable import enums
PROJECT = "PROJECT"
INSTANCE_ID = "instance-id"
DISPLAY_NAME = "display-name"
instance_type = enums.Instance.Type.DEVELOPMENT
labels = {"foo": "bar"}
credentials = _make_credentials()
client = self._make_one(project=PROJECT, credentials=credentials)
instance = client.instance(
INSTANCE_ID,
display_name=DISPLAY_NAME,
instance_type=instance_type,
labels=labels,
)
self.assertIsInstance(instance, Instance)
self.assertEqual(instance.instance_id, INSTANCE_ID)
self.assertEqual(instance.display_name, DISPLAY_NAME)
self.assertEqual(instance.type_, instance_type)
self.assertEqual(instance.labels, labels)
self.assertIs(instance._client, client)
def test_list_instances(self):
from google.cloud.bigtable_admin_v2.proto import instance_pb2 as data_v2_pb2
from google.cloud.bigtable_admin_v2.proto import (
bigtable_instance_admin_pb2 as messages_v2_pb2,
)
from google.cloud.bigtable_admin_v2.gapic import bigtable_instance_admin_client
from google.cloud.bigtable.instance import Instance
FAILED_LOCATION = "FAILED"
INSTANCE_ID1 = "instance-id1"
INSTANCE_ID2 = "instance-id2"
INSTANCE_NAME1 = "projects/" + self.PROJECT + "/instances/" + INSTANCE_ID1
INSTANCE_NAME2 = "projects/" + self.PROJECT + "/instances/" + INSTANCE_ID2
credentials = _make_credentials()
api = bigtable_instance_admin_client.BigtableInstanceAdminClient(mock.Mock())
client = self._make_one(
project=self.PROJECT, credentials=credentials, admin=True
)
# Create response_pb
response_pb = messages_v2_pb2.ListInstancesResponse(
failed_locations=[FAILED_LOCATION],
instances=[
data_v2_pb2.Instance(name=INSTANCE_NAME1, display_name=INSTANCE_NAME1),
data_v2_pb2.Instance(name=INSTANCE_NAME2, display_name=INSTANCE_NAME2),
],
)
# Patch the stub used by the API method.
client._instance_admin_client = api
bigtable_instance_stub = client.instance_admin_client.transport
bigtable_instance_stub.list_instances.side_effect = [response_pb]
# Perform the method and check the result.
instances, failed_locations = client.list_instances()
instance_1, instance_2 = instances
self.assertIsInstance(instance_1, Instance)
self.assertEqual(instance_1.name, INSTANCE_NAME1)
self.assertTrue(instance_1._client is client)
self.assertIsInstance(instance_2, Instance)
self.assertEqual(instance_2.name, INSTANCE_NAME2)
self.assertTrue(instance_2._client is client)
self.assertEqual(failed_locations, [FAILED_LOCATION])
def test_list_clusters(self):
from google.cloud.bigtable_admin_v2.gapic import bigtable_instance_admin_client
from google.cloud.bigtable_admin_v2.proto import (
bigtable_instance_admin_pb2 as messages_v2_pb2,
)
from google.cloud.bigtable_admin_v2.proto import instance_pb2 as data_v2_pb2
from google.cloud.bigtable.instance import Cluster
instance_api = bigtable_instance_admin_client.BigtableInstanceAdminClient(
mock.Mock()
)
credentials = _make_credentials()
client = self._make_one(
project=self.PROJECT, credentials=credentials, admin=True
)
INSTANCE_ID1 = "instance-id1"
INSTANCE_ID2 = "instance-id2"
failed_location = "FAILED"
cluster_id1 = "{}-cluster".format(INSTANCE_ID1)
cluster_id2 = "{}-cluster-1".format(INSTANCE_ID2)
cluster_id3 = "{}-cluster-2".format(INSTANCE_ID2)
cluster_name1 = client.instance_admin_client.cluster_path(
self.PROJECT, INSTANCE_ID1, cluster_id1
)
cluster_name2 = client.instance_admin_client.cluster_path(
self.PROJECT, INSTANCE_ID2, cluster_id2
)
cluster_name3 = client.instance_admin_client.cluster_path(
self.PROJECT, INSTANCE_ID2, cluster_id3
)
# Create response_pb
response_pb = messages_v2_pb2.ListClustersResponse(
failed_locations=[failed_location],
clusters=[
data_v2_pb2.Cluster(name=cluster_name1),
data_v2_pb2.Cluster(name=cluster_name2),
data_v2_pb2.Cluster(name=cluster_name3),
],
)
# Patch the stub used by the API method.
client._instance_admin_client = instance_api
instance_stub = client._instance_admin_client.transport
instance_stub.list_clusters.side_effect = [response_pb]
# Perform the method and check the result.
clusters, failed_locations = client.list_clusters()
cluster_1, cluster_2, cluster_3 = clusters
self.assertIsInstance(cluster_1, Cluster)
self.assertEqual(cluster_1.name, cluster_name1)
self.assertEqual(cluster_1._instance.instance_id, INSTANCE_ID1)
self.assertIsInstance(cluster_2, Cluster)
self.assertEqual(cluster_2.name, cluster_name2)
self.assertEqual(cluster_2._instance.instance_id, INSTANCE_ID2)
self.assertIsInstance(cluster_3, Cluster)
self.assertEqual(cluster_3.name, cluster_name3)
self.assertEqual(cluster_3._instance.instance_id, INSTANCE_ID2)
self.assertEqual(failed_locations, [failed_location])