forked from googleads/google-ads-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclient_test.py
More file actions
643 lines (579 loc) · 25 KB
/
client_test.py
File metadata and controls
643 lines (579 loc) · 25 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
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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
# Copyright 2018 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
#
# https://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.
"""Tests for the Google Ads API client library."""
import enum
from importlib import import_module
from inspect import getmembers, isclass
import mock
import os
from pyfakefs.fake_filesystem_unittest import TestCase as FileTestCase
import yaml
from google.protobuf.internal.enum_type_wrapper import EnumTypeWrapper
from google.ads.google_ads import client as Client
latest_version = Client._DEFAULT_VERSION
valid_versions = Client._VALID_API_VERSIONS
services_path = "google.ads.google_ads.{}.proto.services".format(latest_version)
services = import_module(services_path)
class GoogleAdsClientTest(FileTestCase):
"""Tests for the google.ads.googleads.client.GoogleAdsClient class."""
def _create_test_client(self, endpoint=None):
with mock.patch.object(
Client.oauth2, "get_installed_app_credentials"
) as mock_credentials:
mock_credentials_instance = mock_credentials.return_value
mock_credentials_instance.refresh_token = self.refresh_token
mock_credentials_instance.client_id = self.client_id
mock_credentials_instance.client_secret = self.client_secret
client = Client.GoogleAdsClient(
mock_credentials_instance,
self.developer_token,
endpoint=endpoint,
)
return client
def setUp(self):
self.setUpPyfakefs()
self.developer_token = "abc123"
self.client_id = "client_id_123456789"
self.client_secret = "client_secret_987654321"
self.refresh_token = "refresh"
self.login_customer_id = "1234567890"
self.path_to_private_key_file = "/test/path/to/config.json"
self.linked_customer_id = "0984320943"
def test_get_client_kwargs_login_customer_id(self):
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
"login_customer_id": self.login_customer_id,
"linked_customer_id": self.linked_customer_id,
}
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
):
result = Client.GoogleAdsClient._get_client_kwargs(config)
self.assertEqual(
result,
{
"credentials": mock_credentials_instance,
"developer_token": self.developer_token,
"endpoint": None,
"login_customer_id": self.login_customer_id,
"logging_config": None,
"linked_customer_id": self.linked_customer_id,
},
)
def test_get_client_kwargs_linked_customer_id(self):
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
"linked_customer_id": self.linked_customer_id,
}
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
):
result = Client.GoogleAdsClient._get_client_kwargs(config)
self.assertEqual(
result,
{
"credentials": mock_credentials_instance,
"developer_token": self.developer_token,
"endpoint": None,
"login_customer_id": None,
"logging_config": None,
"linked_customer_id": self.linked_customer_id,
},
)
def test_get_client_kwargs_login_customer_id_as_none(self):
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
"login_customer_id": None,
}
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
):
result = Client.GoogleAdsClient._get_client_kwargs(config)
self.assertEqual(
result,
{
"credentials": mock_credentials_instance,
"developer_token": self.developer_token,
"endpoint": None,
"login_customer_id": None,
"logging_config": None,
"linked_customer_id": None,
},
)
def test_get_client_kwargs_linked_customer_id_as_none(self):
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
"linked_customer_id": None,
}
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
):
result = Client.GoogleAdsClient._get_client_kwargs(config)
self.assertEqual(
result,
{
"credentials": mock_credentials_instance,
"developer_token": self.developer_token,
"endpoint": None,
"linked_customer_id": None,
"logging_config": None,
"login_customer_id": None,
},
)
def test_get_client_kwargs(self):
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
}
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
):
result = Client.GoogleAdsClient._get_client_kwargs(config)
self.assertEqual(
result,
{
"credentials": mock_credentials_instance,
"developer_token": self.developer_token,
"endpoint": None,
"login_customer_id": None,
"logging_config": None,
"linked_customer_id": None,
},
)
def test_get_client_kwargs_custom_endpoint(self):
endpoint = "alt.endpoint.com"
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
"endpoint": endpoint,
}
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
):
result = Client.GoogleAdsClient._get_client_kwargs(config)
self.assertEqual(
result,
{
"credentials": mock_credentials_instance,
"developer_token": self.developer_token,
"endpoint": endpoint,
"login_customer_id": None,
"logging_config": None,
"linked_customer_id": None,
},
)
def test_load_from_dict(self):
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
}
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.GoogleAdsClient, "__init__", return_value=None
) as mock_client_init, mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
) as mock_credentials:
Client.GoogleAdsClient.load_from_dict(config)
mock_client_init.assert_called_once_with(
credentials=mock_credentials_instance,
developer_token=self.developer_token,
endpoint=None,
login_customer_id=None,
logging_config=None,
linked_customer_id=None,
)
def test_load_from_storage(self):
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
}
file_path = os.path.join(os.path.expanduser("~"), "google-ads.yaml")
self.fs.create_file(file_path, contents=yaml.safe_dump(config))
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.GoogleAdsClient, "__init__", return_value=None
) as mock_client_init, mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
) as mock_credentials:
Client.GoogleAdsClient.load_from_storage()
mock_credentials.assert_called_once_with(
config.get("client_id"),
config.get("client_secret"),
config.get("refresh_token"),
)
mock_client_init.assert_called_once_with(
credentials=mock_credentials_instance,
developer_token=self.developer_token,
endpoint=None,
login_customer_id=None,
logging_config=None,
linked_customer_id=None,
)
def test_load_from_storage_login_cid_int(self):
login_cid = 1234567890
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
"login_customer_id": login_cid,
}
file_path = os.path.join(os.path.expanduser("~"), "google-ads.yaml")
self.fs.create_file(file_path, contents=yaml.safe_dump(config))
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.GoogleAdsClient, "__init__", return_value=None
) as mock_client_init, mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
) as mock_credentials:
Client.GoogleAdsClient.load_from_storage()
mock_credentials.assert_called_once_with(
config.get("client_id"),
config.get("client_secret"),
config.get("refresh_token"),
)
mock_client_init.assert_called_once_with(
credentials=mock_credentials_instance,
developer_token=self.developer_token,
endpoint=None,
login_customer_id=str(login_cid),
logging_config=None,
linked_customer_id=None,
)
def test_load_from_storage_custom_path(self):
config = {
"developer_token": self.developer_token,
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
}
file_path = "test/google-ads.yaml"
self.fs.create_file(file_path, contents=yaml.safe_dump(config))
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.GoogleAdsClient, "__init__", return_value=None
) as mock_client_init, mock.patch.object(
Client.oauth2,
"get_installed_app_credentials",
return_value=mock_credentials_instance,
):
Client.GoogleAdsClient.load_from_storage(path=file_path)
mock_client_init.assert_called_once_with(
credentials=mock_credentials_instance,
developer_token=self.developer_token,
endpoint=None,
login_customer_id=None,
logging_config=None,
linked_customer_id=None,
)
def test_load_from_storage_file_not_found(self):
wrong_file_path = "test/wrong-google-ads.yaml"
self.assertRaises(
IOError,
Client.GoogleAdsClient.load_from_storage,
path=wrong_file_path,
)
def test_load_from_storage_required_config_missing(self):
config = {
"client_id": self.client_id,
"client_secret": self.client_secret,
"refresh_token": self.refresh_token,
}
file_path = "test/google-ads.yaml"
self.fs.create_file(file_path, contents=yaml.safe_dump(config))
self.assertRaises(
ValueError, Client.GoogleAdsClient.load_from_storage, path=file_path
)
def test_load_from_storage_service_account_config(self):
config = {
"developer_token": self.developer_token,
"json_key_file_path": self.path_to_private_key_file,
"impersonated_email": self.delegated_account,
}
file_path = os.path.join(os.path.expanduser("~"), "google-ads.yaml")
self.fs.create_file(file_path, contents=yaml.safe_dump(config))
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.GoogleAdsClient, "__init__", return_value=None
) as mock_client_init, mock.patch.object(
Client.oauth2,
"get_service_account_credentials",
return_value=mock_credentials_instance,
) as mock_credentials:
Client.GoogleAdsClient.load_from_storage()
mock_credentials.assert_called_once_with(
config.get("json_key_file_path"),
config.get("impersonated_email"),
)
mock_client_init.assert_called_once_with(
credentials=mock_credentials_instance,
developer_token=self.developer_token,
endpoint=None,
login_customer_id=None,
logging_config=None,
linked_customer_id=None,
)
def test_load_from_storage_service_account_no_delegated_account(self):
config = {
"developer_token": self.developer_token,
"path_to_private_key_file": self.path_to_private_key_file,
}
file_path = os.path.join(os.path.expanduser("~"), "google-ads.yaml")
self.fs.create_file(file_path, contents=yaml.safe_dump(config))
mock_credentials_instance = mock.Mock()
with mock.patch.object(
Client.GoogleAdsClient, "__init__", return_value=None
), mock.patch.object(
Client.oauth2,
"get_service_account_credentials",
return_value=mock_credentials_instance,
):
self.assertRaises(
ValueError, Client.GoogleAdsClient.load_from_storage
)
def test_get_service(self):
# Retrieve service names for all defined service clients.
for ver in valid_versions:
services_path = "google.ads.google_ads.%s" % ver
service_names = [
"%s%s" % (name.rsplit("ServiceClient")[0], "Service")
for name in dir(import_module(services_path))
if "ServiceClient" in name
]
client = self._create_test_client()
# Iterate through retrieval of all service clients by name.
for service_name in service_names:
client.get_service(service_name, version=ver)
def test_get_service_custom_endpoint(self):
service_name = "GoogleAdsService"
service_module_base = "google_ads_service"
grpc_transport_class_name = "%sGrpcTransport" % service_name
grpc_transport_module_name = "%s_grpc_transport" % service_module_base
transport_create_channel_path = (
"google.ads.google_ads.%s.services.transports.%s.%s.create_channel"
% (
Client._DEFAULT_VERSION,
grpc_transport_module_name,
grpc_transport_class_name,
)
)
endpoint = "alt.endpoint.com"
client = self._create_test_client(endpoint=endpoint)
# The GRPC transport's create_channel method is what allows the
# GoogleAdsClient to specify a custom endpoint. Here we mock the
# create_channel method in order to verify that it was given the
# endpoint specified by the client.
with mock.patch(transport_create_channel_path) as mock_create_channel:
# A new channel is created during initialization of the service
# client.
client.get_service(service_name)
mock_create_channel.assert_called_once_with(
address=endpoint,
credentials=client.credentials,
options=Client._GRPC_CHANNEL_OPTIONS,
)
def test_get_service_not_found(self):
client = self._create_test_client()
self.assertRaises(ValueError, client.get_service, "BadService")
def test_get_service_invalid_version(self):
client = self._create_test_client()
self.assertRaises(
ValueError,
client.get_service,
"GoogleAdsService",
version="bad_version",
)
def test_get_service_with_version(self):
client = self._create_test_client()
try:
client.get_service("GoogleAdsService", version=latest_version)
except Exception:
self.fail("get_service with a valid version raised an error")
# XXX: deferred test for fixing lazy loading
# def test_get_service_with_interceptor(self):
# client = self._create_test_client()
#
# class Interceptor:
# pass
#
# interceptor = Interceptor()
#
# with mock.patch.object(
# Client,
# 'intercept_channel'
# ) as mock_intercept_channel:
# client.get_service('GoogleAdsService', interceptors=[interceptor])
# first_interceptor = mock_intercept_channel.call_args[0][1]
# self.assertEqual(first_interceptor, interceptor)
#
def test_get_type(self):
for ver in valid_versions:
# Retrieve names for all types defined in pb2 files.
type_path = f"google.ads.google_ads.{ver}.types"
type_names = import_module(type_path).__all__
# Iterate through retrieval of all types by name.
for name in type_names:
if name.lower().endswith("pb2"):
continue
Client.GoogleAdsClient.get_type(name, version=ver)
def test_get_type_not_found(self):
self.assertRaises(
ValueError, Client.GoogleAdsClient.get_type, "BadType"
)
def test_get_type_invalid_version(self):
self.assertRaises(
ValueError,
Client.GoogleAdsClient.get_type,
"GoogleAdsFailure",
version="bad_version",
)
def test_init_no_logging_config(self):
"""Should call logging.config.dictConfig if logging config exists."""
with mock.patch(
"logging.config.dictConfig"
) as mock_dictConfig, mock.patch.object(
Client.oauth2, "get_installed_app_credentials"
) as mock_credentials:
mock_credentials_instance = mock_credentials.return_value
mock_credentials_instance.refresh_token = self.refresh_token
mock_credentials_instance.client_id = self.client_id
mock_credentials_instance.client_secret = self.client_secret
Client.GoogleAdsClient(
mock_credentials_instance, self.developer_token
)
mock_dictConfig.assert_not_called()
def test_init_with_logging_config(self):
"""Configured LoggingInterceptor should call logging.dictConfig."""
config = {"test": True}
with mock.patch(
"logging.config.dictConfig"
) as mock_dictConfig, mock.patch.object(
Client.oauth2, "get_installed_app_credentials"
) as mock_credentials:
mock_credentials_instance = mock_credentials.return_value
mock_credentials_instance.refresh_token = self.refresh_token
mock_credentials_instance.client_id = self.client_id
mock_credentials_instance.client_secret = self.client_secret
Client.GoogleAdsClient(
mock_credentials_instance,
self.developer_token,
logging_config=config,
)
mock_dictConfig.assert_called_once_with(config)
def test_service_client_dot_enums_property(self):
"""Ensures that services expose Enums via an "enums" attribute.
This tests the 'service.enum' property for a service in every version
of the API, which implicitly tests the 'services/enums.py' file, which
exposes the enums used by the property. It loops over each member of
'service.enum' and compares it to the raw enum 'pb2' file found by
calling 'client.get_type' with the enum's name.
"""
client = self._create_test_client()
for ver in valid_versions:
service = client.get_service("GoogleAdsService", version=ver)
self.assertTrue(
hasattr(service, "enums"),
"GoogleAdsService in "
f'{ver} does not have an "enums" attribute.',
)
def is_enum_wrapper(member):
"""Determines whether the given memberect is an enum wrapper."""
# in newer API versions we can identify an enum wrapper as
# having no attributes because their attributes are generated
# dynamically when accessed.
if not getmembers(member):
return True
# in older API versions we can identify an enum wrapper as being
# a class where at least one member is an instance of
# enum.EnumMeta.
elif isclass(member) and getmembers(
member, lambda name: isinstance(name, enum.EnumMeta)
):
return True
return False
def is_enum(member):
"""Determines whether the given memberect is an enum."""
# Enums inherit from the base class EnumTypeWrapper, not to be
# confused with the enum wrappers mentioned elsewhere in this
# test, which are classes defined in the Ads API containing
# Enums.
return isinstance(member, EnumTypeWrapper)
# every enum in the API should be accessible on a service client
# instance, for example service.enums.DeviceEnum.Device.MOBILE. Here
# we loop over all the members of service.enums, filtering for enum
# wrappers.
for member in getmembers(service.enums, is_enum_wrapper):
enum_wrapper_name = member[0]
# we retrieve the raw enum class to make sure its inner enum
# object is accessible on the service.enums.EnumWrapper path.
raw_enum = client.get_type(enum_wrapper_name, version=ver)
# enum wrappers have at most one enum attribute so we loop over
# all attributes filtering for the one that is an enum and
# exposing its __name__ in the loop.
for enum_name, _ in getmembers(raw_enum, is_enum):
# if enum_wrapper_name is DeviceEnum and enum_name is
# Device we assert that service.enums.DeviceEnum.Device is
# valid.
self.assertTrue(
hasattr(
getattr(service.enums, enum_wrapper_name), enum_name
),
f'Expected enum wrapper "{enum_wrapper_name}" to '
f'contain enum class "{enum_name}"',
)