forked from googleapis/google-auth-library-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest__default.py
More file actions
1464 lines (1145 loc) · 52.8 KB
/
Copy pathtest__default.py
File metadata and controls
1464 lines (1145 loc) · 52.8 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
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2016 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 json
import os
from unittest import mock
import warnings
import pytest # type: ignore
from google.auth import _default
from google.auth import api_key
from google.auth import app_engine
from google.auth import aws
from google.auth import compute_engine
from google.auth import credentials
from google.auth import environment_vars
from google.auth import exceptions
from google.auth import external_account
from google.auth import external_account_authorized_user
from google.auth import identity_pool
from google.auth import impersonated_credentials
from google.auth import pluggable
from google.oauth2 import gdch_credentials
from google.oauth2 import service_account
import google.oauth2.credentials
DATA_DIR = os.path.join(os.path.dirname(__file__), "data")
AUTHORIZED_USER_FILE = os.path.join(DATA_DIR, "authorized_user.json")
with open(AUTHORIZED_USER_FILE) as fh:
AUTHORIZED_USER_FILE_DATA = json.load(fh)
AUTHORIZED_USER_CLOUD_SDK_FILE = os.path.join(
DATA_DIR, "authorized_user_cloud_sdk.json"
)
AUTHORIZED_USER_CLOUD_SDK_WITH_QUOTA_PROJECT_ID_FILE = os.path.join(
DATA_DIR, "authorized_user_cloud_sdk_with_quota_project_id.json"
)
SERVICE_ACCOUNT_FILE = os.path.join(DATA_DIR, "service_account.json")
CLIENT_SECRETS_FILE = os.path.join(DATA_DIR, "client_secrets.json")
GDCH_SERVICE_ACCOUNT_FILE = os.path.join(DATA_DIR, "gdch_service_account.json")
with open(SERVICE_ACCOUNT_FILE) as fh:
SERVICE_ACCOUNT_FILE_DATA = json.load(fh)
SUBJECT_TOKEN_TEXT_FILE = os.path.join(DATA_DIR, "external_subject_token.txt")
TOKEN_URL = "https://sts.googleapis.com/v1/token"
AUDIENCE = "//iam.googleapis.com/projects/123456/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID"
WORKFORCE_AUDIENCE = (
"//iam.googleapis.com/locations/global/workforcePools/POOL_ID/providers/PROVIDER_ID"
)
WORKFORCE_POOL_USER_PROJECT = "WORKFORCE_POOL_USER_PROJECT_NUMBER"
REGION_URL = "http://169.254.169.254/latest/meta-data/placement/availability-zone"
SECURITY_CREDS_URL = "http://169.254.169.254/latest/meta-data/iam/security-credentials"
CRED_VERIFICATION_URL = (
"https://sts.{region}.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15"
)
IDENTITY_POOL_DATA = {
"type": "external_account",
"audience": AUDIENCE,
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt",
"token_url": TOKEN_URL,
"credential_source": {"file": SUBJECT_TOKEN_TEXT_FILE},
}
PLUGGABLE_DATA = {
"type": "external_account",
"audience": AUDIENCE,
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt",
"token_url": TOKEN_URL,
"credential_source": {"executable": {"command": "command"}},
}
AWS_DATA = {
"type": "external_account",
"audience": AUDIENCE,
"subject_token_type": "urn:ietf:params:aws:token-type:aws4_request",
"token_url": TOKEN_URL,
"credential_source": {
"environment_id": "aws1",
"region_url": REGION_URL,
"url": SECURITY_CREDS_URL,
"regional_cred_verification_url": CRED_VERIFICATION_URL,
},
}
SERVICE_ACCOUNT_IMPERSONATION_URL = (
"https://us-east1-iamcredentials.googleapis.com/v1/projects/-"
+ "/serviceAccounts/{}:generateAccessToken".format(SERVICE_ACCOUNT_EMAIL)
)
IMPERSONATED_IDENTITY_POOL_DATA = {
"type": "external_account",
"audience": AUDIENCE,
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt",
"token_url": TOKEN_URL,
"credential_source": {"file": SUBJECT_TOKEN_TEXT_FILE},
"service_account_impersonation_url": SERVICE_ACCOUNT_IMPERSONATION_URL,
}
IMPERSONATED_AWS_DATA = {
"type": "external_account",
"audience": AUDIENCE,
"subject_token_type": "urn:ietf:params:aws:token-type:aws4_request",
"token_url": TOKEN_URL,
"credential_source": {
"environment_id": "aws1",
"region_url": REGION_URL,
"url": SECURITY_CREDS_URL,
"regional_cred_verification_url": CRED_VERIFICATION_URL,
},
"service_account_impersonation_url": SERVICE_ACCOUNT_IMPERSONATION_URL,
}
IDENTITY_POOL_WORKFORCE_DATA = {
"type": "external_account",
"audience": WORKFORCE_AUDIENCE,
"subject_token_type": "urn:ietf:params:oauth:token-type:id_token",
"token_url": TOKEN_URL,
"credential_source": {"file": SUBJECT_TOKEN_TEXT_FILE},
"workforce_pool_user_project": WORKFORCE_POOL_USER_PROJECT,
}
IMPERSONATED_IDENTITY_POOL_WORKFORCE_DATA = {
"type": "external_account",
"audience": WORKFORCE_AUDIENCE,
"subject_token_type": "urn:ietf:params:oauth:token-type:id_token",
"token_url": TOKEN_URL,
"credential_source": {"file": SUBJECT_TOKEN_TEXT_FILE},
"service_account_impersonation_url": SERVICE_ACCOUNT_IMPERSONATION_URL,
"workforce_pool_user_project": WORKFORCE_POOL_USER_PROJECT,
}
IMPERSONATED_SERVICE_ACCOUNT_AUTHORIZED_USER_SOURCE_FILE = os.path.join(
DATA_DIR, "impersonated_service_account_authorized_user_source.json"
)
IMPERSONATED_SERVICE_ACCOUNT_WITH_QUOTA_PROJECT_FILE = os.path.join(
DATA_DIR, "impersonated_service_account_with_quota_project.json"
)
IMPERSONATED_SERVICE_ACCOUNT_SERVICE_ACCOUNT_SOURCE_FILE = os.path.join(
DATA_DIR, "impersonated_service_account_service_account_source.json"
)
IMPERSONATED_SERVICE_ACCOUNT_EXTERNAL_ACCOUNT_AUTHORIZED_USER_SOURCE_FILE = (
os.path.join(
DATA_DIR,
"impersonated_service_account_external_account_authorized_user_source.json",
)
)
EXTERNAL_ACCOUNT_AUTHORIZED_USER_FILE = os.path.join(
DATA_DIR, "external_account_authorized_user.json"
)
EXTERNAL_ACCOUNT_AUTHORIZED_USER_NON_GDU_FILE = os.path.join(
DATA_DIR, "external_account_authorized_user_non_gdu.json"
)
MOCK_CREDENTIALS = mock.Mock(spec=credentials.CredentialsWithQuotaProject)
MOCK_CREDENTIALS.with_quota_project.return_value = MOCK_CREDENTIALS
def get_project_id_side_effect(self, request=None):
# If no scopes are set, this will always return None.
if not self.scopes:
return None
return mock.sentinel.project_id
LOAD_FILE_PATCH = mock.patch(
"google.auth._default.load_credentials_from_file",
return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id),
autospec=True,
)
EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH = mock.patch.object(
external_account.Credentials,
"get_project_id",
side_effect=get_project_id_side_effect,
autospec=True,
)
def test_load_credentials_from_missing_file():
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file("")
assert excinfo.match(r"not found")
def test_load_credentials_from_dict_non_dict_object():
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_dict("")
assert excinfo.match(r"dict type was expected")
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_dict(None)
assert excinfo.match(r"dict type was expected")
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_dict(1)
assert excinfo.match(r"dict type was expected")
def test_load_credentials_from_dict_authorized_user():
credentials, project_id = _default.load_credentials_from_dict(
AUTHORIZED_USER_FILE_DATA
)
assert isinstance(credentials, google.oauth2.credentials.Credentials)
assert project_id is None
def test_load_credentials_from_file_invalid_json(tmpdir):
jsonfile = tmpdir.join("invalid.json")
jsonfile.write("{")
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file(str(jsonfile))
assert excinfo.match(r"not a valid json file")
def test_load_credentials_from_file_invalid_type(tmpdir):
jsonfile = tmpdir.join("invalid.json")
jsonfile.write(json.dumps({"type": "not-a-real-type"}))
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file(str(jsonfile))
assert excinfo.match(r"does not have a valid type")
def test_load_credentials_from_file_authorized_user():
credentials, project_id = _default.load_credentials_from_file(AUTHORIZED_USER_FILE)
assert isinstance(credentials, google.oauth2.credentials.Credentials)
assert project_id is None
def test_load_credentials_from_file_no_type(tmpdir):
# use the client_secrets.json, which is valid json but not a
# loadable credentials type
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file(CLIENT_SECRETS_FILE)
assert excinfo.match(r"does not have a valid type")
assert excinfo.match(r"Type is None")
def test_load_credentials_from_file_authorized_user_bad_format(tmpdir):
filename = tmpdir.join("authorized_user_bad.json")
filename.write(json.dumps({"type": "authorized_user"}))
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file(str(filename))
assert excinfo.match(r"Failed to load authorized user")
assert excinfo.match(r"missing fields")
def test_load_credentials_from_file_authorized_user_cloud_sdk():
with pytest.warns(UserWarning, match="Cloud SDK"):
credentials, project_id = _default.load_credentials_from_file(
AUTHORIZED_USER_CLOUD_SDK_FILE
)
assert isinstance(credentials, google.oauth2.credentials.Credentials)
assert project_id is None
# No warning if the json file has quota project id.
credentials, project_id = _default.load_credentials_from_file(
AUTHORIZED_USER_CLOUD_SDK_WITH_QUOTA_PROJECT_ID_FILE
)
assert isinstance(credentials, google.oauth2.credentials.Credentials)
assert project_id is None
def test_load_credentials_from_file_authorized_user_cloud_sdk_with_scopes():
with pytest.warns(UserWarning, match="Cloud SDK"):
credentials, project_id = _default.load_credentials_from_file(
AUTHORIZED_USER_CLOUD_SDK_FILE,
scopes=["https://www.google.com/calendar/feeds"],
)
assert isinstance(credentials, google.oauth2.credentials.Credentials)
assert project_id is None
assert credentials.scopes == ["https://www.google.com/calendar/feeds"]
def test_load_credentials_from_file_authorized_user_cloud_sdk_with_quota_project():
credentials, project_id = _default.load_credentials_from_file(
AUTHORIZED_USER_CLOUD_SDK_FILE, quota_project_id="project-foo"
)
assert isinstance(credentials, google.oauth2.credentials.Credentials)
assert project_id is None
assert credentials.quota_project_id == "project-foo"
def test_load_credentials_from_file_service_account():
credentials, project_id = _default.load_credentials_from_file(SERVICE_ACCOUNT_FILE)
assert isinstance(credentials, service_account.Credentials)
assert project_id == SERVICE_ACCOUNT_FILE_DATA["project_id"]
def test_load_credentials_from_file_service_account_with_scopes():
credentials, project_id = _default.load_credentials_from_file(
SERVICE_ACCOUNT_FILE, scopes=["https://www.google.com/calendar/feeds"]
)
assert isinstance(credentials, service_account.Credentials)
assert project_id == SERVICE_ACCOUNT_FILE_DATA["project_id"]
assert credentials.scopes == ["https://www.google.com/calendar/feeds"]
def test_load_credentials_from_file_service_account_with_quota_project():
credentials, project_id = _default.load_credentials_from_file(
SERVICE_ACCOUNT_FILE, quota_project_id="project-foo"
)
assert isinstance(credentials, service_account.Credentials)
assert project_id == SERVICE_ACCOUNT_FILE_DATA["project_id"]
assert credentials.quota_project_id == "project-foo"
def test_load_credentials_from_file_service_account_bad_format(tmpdir):
filename = tmpdir.join("serivce_account_bad.json")
filename.write(json.dumps({"type": "service_account"}))
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file(str(filename))
assert excinfo.match(r"Failed to load service account")
assert excinfo.match(r"missing fields")
def test_load_credentials_from_file_impersonated_with_authorized_user_source():
credentials, project_id = _default.load_credentials_from_file(
IMPERSONATED_SERVICE_ACCOUNT_AUTHORIZED_USER_SOURCE_FILE
)
assert isinstance(credentials, impersonated_credentials.Credentials)
assert isinstance(
credentials._source_credentials, google.oauth2.credentials.Credentials
)
assert not credentials._quota_project_id
assert not credentials._target_scopes
assert project_id is None
def test_load_credentials_from_file_impersonated_with_quota_project():
credentials, _ = _default.load_credentials_from_file(
IMPERSONATED_SERVICE_ACCOUNT_WITH_QUOTA_PROJECT_FILE
)
assert isinstance(credentials, impersonated_credentials.Credentials)
assert credentials._quota_project_id == "quota_project"
def test_load_credentials_from_file_impersonated_with_service_account_source():
credentials, _ = _default.load_credentials_from_file(
IMPERSONATED_SERVICE_ACCOUNT_SERVICE_ACCOUNT_SOURCE_FILE
)
assert isinstance(credentials, impersonated_credentials.Credentials)
assert isinstance(credentials._source_credentials, service_account.Credentials)
assert not credentials._quota_project_id
def test_load_credentials_from_file_impersonated_with_external_account_authorized_user_source():
credentials, _ = _default.load_credentials_from_file(
IMPERSONATED_SERVICE_ACCOUNT_EXTERNAL_ACCOUNT_AUTHORIZED_USER_SOURCE_FILE
)
assert isinstance(credentials, impersonated_credentials.Credentials)
assert isinstance(
credentials._source_credentials, external_account_authorized_user.Credentials
)
assert not credentials._quota_project_id
def test_load_credentials_from_file_impersonated_passing_quota_project():
credentials, _ = _default.load_credentials_from_file(
IMPERSONATED_SERVICE_ACCOUNT_SERVICE_ACCOUNT_SOURCE_FILE,
quota_project_id="new_quota_project",
)
assert credentials._quota_project_id == "new_quota_project"
def test_load_credentials_from_file_impersonated_passing_scopes():
credentials, _ = _default.load_credentials_from_file(
IMPERSONATED_SERVICE_ACCOUNT_SERVICE_ACCOUNT_SOURCE_FILE,
scopes=["scope1", "scope2"],
)
assert credentials._target_scopes == ["scope1", "scope2"]
def test_load_credentials_from_file_impersonated_wrong_target_principal(tmpdir):
with open(IMPERSONATED_SERVICE_ACCOUNT_AUTHORIZED_USER_SOURCE_FILE) as fh:
impersonated_credentials_info = json.load(fh)
impersonated_credentials_info[
"service_account_impersonation_url"
] = "something_wrong"
jsonfile = tmpdir.join("invalid.json")
jsonfile.write(json.dumps(impersonated_credentials_info))
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file(str(jsonfile))
assert excinfo.match(r"Cannot extract target principal")
def test_load_credentials_from_file_impersonated_wrong_source_type(tmpdir):
with open(IMPERSONATED_SERVICE_ACCOUNT_AUTHORIZED_USER_SOURCE_FILE) as fh:
impersonated_credentials_info = json.load(fh)
impersonated_credentials_info["source_credentials"]["type"] = "external_account"
jsonfile = tmpdir.join("invalid.json")
jsonfile.write(json.dumps(impersonated_credentials_info))
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file(str(jsonfile))
assert excinfo.match(r"source credential of type external_account is not supported")
@EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH
def test_load_credentials_from_file_external_account_identity_pool(
get_project_id, tmpdir
):
config_file = tmpdir.join("config.json")
config_file.write(json.dumps(IDENTITY_POOL_DATA))
credentials, project_id = _default.load_credentials_from_file(str(config_file))
assert isinstance(credentials, identity_pool.Credentials)
# Since no scopes are specified, the project ID cannot be determined.
assert project_id is None
assert get_project_id.called
@EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH
def test_load_credentials_from_file_external_account_aws(get_project_id, tmpdir):
config_file = tmpdir.join("config.json")
config_file.write(json.dumps(AWS_DATA))
credentials, project_id = _default.load_credentials_from_file(str(config_file))
assert isinstance(credentials, aws.Credentials)
# Since no scopes are specified, the project ID cannot be determined.
assert project_id is None
assert get_project_id.called
@EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH
def test_load_credentials_from_file_external_account_identity_pool_impersonated(
get_project_id, tmpdir
):
config_file = tmpdir.join("config.json")
config_file.write(json.dumps(IMPERSONATED_IDENTITY_POOL_DATA))
credentials, project_id = _default.load_credentials_from_file(str(config_file))
assert isinstance(credentials, identity_pool.Credentials)
assert not credentials.is_user
assert not credentials.is_workforce_pool
# Since no scopes are specified, the project ID cannot be determined.
assert project_id is None
assert get_project_id.called
@EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH
def test_load_credentials_from_file_external_account_aws_impersonated(
get_project_id, tmpdir
):
config_file = tmpdir.join("config.json")
config_file.write(json.dumps(IMPERSONATED_AWS_DATA))
credentials, project_id = _default.load_credentials_from_file(str(config_file))
assert isinstance(credentials, aws.Credentials)
assert not credentials.is_user
assert not credentials.is_workforce_pool
# Since no scopes are specified, the project ID cannot be determined.
assert project_id is None
assert get_project_id.called
@EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH
def test_load_credentials_from_file_external_account_workforce(get_project_id, tmpdir):
config_file = tmpdir.join("config.json")
config_file.write(json.dumps(IDENTITY_POOL_WORKFORCE_DATA))
credentials, project_id = _default.load_credentials_from_file(str(config_file))
assert isinstance(credentials, identity_pool.Credentials)
assert credentials.is_user
assert credentials.is_workforce_pool
# Since no scopes are specified, the project ID cannot be determined.
assert project_id is None
assert get_project_id.called
@EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH
def test_load_credentials_from_file_external_account_workforce_impersonated(
get_project_id, tmpdir
):
config_file = tmpdir.join("config.json")
config_file.write(json.dumps(IMPERSONATED_IDENTITY_POOL_WORKFORCE_DATA))
credentials, project_id = _default.load_credentials_from_file(str(config_file))
assert isinstance(credentials, identity_pool.Credentials)
assert not credentials.is_user
assert credentials.is_workforce_pool
# Since no scopes are specified, the project ID cannot be determined.
assert project_id is None
assert get_project_id.called
@EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH
def test_load_credentials_from_file_external_account_with_user_and_default_scopes(
get_project_id, tmpdir
):
config_file = tmpdir.join("config.json")
config_file.write(json.dumps(IDENTITY_POOL_DATA))
credentials, project_id = _default.load_credentials_from_file(
str(config_file),
scopes=["https://www.google.com/calendar/feeds"],
default_scopes=["https://www.googleapis.com/auth/cloud-platform"],
)
assert isinstance(credentials, identity_pool.Credentials)
# Since scopes are specified, the project ID can be determined.
assert project_id is mock.sentinel.project_id
assert credentials.scopes == ["https://www.google.com/calendar/feeds"]
assert credentials.default_scopes == [
"https://www.googleapis.com/auth/cloud-platform"
]
@EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH
def test_load_credentials_from_file_external_account_with_quota_project(
get_project_id, tmpdir
):
config_file = tmpdir.join("config.json")
config_file.write(json.dumps(IDENTITY_POOL_DATA))
credentials, project_id = _default.load_credentials_from_file(
str(config_file), quota_project_id="project-foo"
)
assert isinstance(credentials, identity_pool.Credentials)
# Since no scopes are specified, the project ID cannot be determined.
assert project_id is None
assert credentials.quota_project_id == "project-foo"
def test_load_credentials_from_file_external_account_bad_format(tmpdir):
filename = tmpdir.join("external_account_bad.json")
filename.write(json.dumps({"type": "external_account"}))
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file(str(filename))
assert excinfo.match(
"Failed to load external account credentials from {}".format(str(filename))
)
@EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH
def test_load_credentials_from_file_external_account_explicit_request(
get_project_id, tmpdir
):
config_file = tmpdir.join("config.json")
config_file.write(json.dumps(IDENTITY_POOL_DATA))
credentials, project_id = _default.load_credentials_from_file(
str(config_file),
request=mock.sentinel.request,
scopes=["https://www.googleapis.com/auth/cloud-platform"],
)
assert isinstance(credentials, identity_pool.Credentials)
# Since scopes are specified, the project ID can be determined.
assert project_id is mock.sentinel.project_id
get_project_id.assert_called_with(credentials, request=mock.sentinel.request)
@mock.patch.dict(os.environ, {}, clear=True)
def test__get_explicit_environ_credentials_no_env():
assert _default._get_explicit_environ_credentials() == (None, None)
def test_load_credentials_from_file_external_account_authorized_user():
credentials, project_id = _default.load_credentials_from_file(
EXTERNAL_ACCOUNT_AUTHORIZED_USER_FILE, request=mock.sentinel.request
)
assert isinstance(credentials, external_account_authorized_user.Credentials)
assert project_id is None
def test_load_credentials_from_file_external_account_authorized_user_non_gdu():
credentials, _ = _default.load_credentials_from_file(
EXTERNAL_ACCOUNT_AUTHORIZED_USER_NON_GDU_FILE, request=mock.sentinel.request
)
assert isinstance(credentials, external_account_authorized_user.Credentials)
assert credentials.universe_domain == "fake_universe_domain"
def test_load_credentials_from_file_external_account_authorized_user_bad_format(tmpdir):
filename = tmpdir.join("external_account_authorized_user_bad.json")
filename.write(json.dumps({"type": "external_account_authorized_user"}))
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default.load_credentials_from_file(str(filename))
assert excinfo.match(
"Failed to load external account authorized user credentials from {}".format(
str(filename)
)
)
@pytest.mark.parametrize("quota_project_id", [None, "project-foo"])
@LOAD_FILE_PATCH
def test__get_explicit_environ_credentials(load, quota_project_id, monkeypatch):
monkeypatch.setenv(environment_vars.CREDENTIALS, "filename")
credentials, project_id = _default._get_explicit_environ_credentials(
quota_project_id=quota_project_id
)
assert credentials is MOCK_CREDENTIALS
assert project_id is mock.sentinel.project_id
load.assert_called_with("filename", quota_project_id=quota_project_id)
@LOAD_FILE_PATCH
def test__get_explicit_environ_credentials_no_project_id(load, monkeypatch):
load.return_value = MOCK_CREDENTIALS, None
monkeypatch.setenv(environment_vars.CREDENTIALS, "filename")
credentials, project_id = _default._get_explicit_environ_credentials()
assert credentials is MOCK_CREDENTIALS
assert project_id is None
@pytest.mark.parametrize("quota_project_id", [None, "project-foo"])
@mock.patch(
"google.auth._cloud_sdk.get_application_default_credentials_path", autospec=True
)
@mock.patch("google.auth._default._get_gcloud_sdk_credentials", autospec=True)
def test__get_explicit_environ_credentials_fallback_to_gcloud(
get_gcloud_creds, get_adc_path, quota_project_id, monkeypatch
):
# Set explicit credentials path to cloud sdk credentials path.
get_adc_path.return_value = "filename"
monkeypatch.setenv(environment_vars.CREDENTIALS, "filename")
_default._get_explicit_environ_credentials(quota_project_id=quota_project_id)
# Check we fall back to cloud sdk flow since explicit credentials path is
# cloud sdk credentials path
get_gcloud_creds.assert_called_with(quota_project_id=quota_project_id)
@pytest.mark.parametrize("quota_project_id", [None, "project-foo"])
@LOAD_FILE_PATCH
@mock.patch(
"google.auth._cloud_sdk.get_application_default_credentials_path", autospec=True
)
def test__get_gcloud_sdk_credentials(get_adc_path, load, quota_project_id):
get_adc_path.return_value = SERVICE_ACCOUNT_FILE
credentials, project_id = _default._get_gcloud_sdk_credentials(
quota_project_id=quota_project_id
)
assert credentials is MOCK_CREDENTIALS
assert project_id is mock.sentinel.project_id
load.assert_called_with(SERVICE_ACCOUNT_FILE, quota_project_id=quota_project_id)
@mock.patch(
"google.auth._cloud_sdk.get_application_default_credentials_path", autospec=True
)
def test__get_gcloud_sdk_credentials_non_existent(get_adc_path, tmpdir):
non_existent = tmpdir.join("non-existent")
get_adc_path.return_value = str(non_existent)
credentials, project_id = _default._get_gcloud_sdk_credentials()
assert credentials is None
assert project_id is None
@mock.patch(
"google.auth._cloud_sdk.get_project_id",
return_value=mock.sentinel.project_id,
autospec=True,
)
@mock.patch("os.path.isfile", return_value=True, autospec=True)
@LOAD_FILE_PATCH
def test__get_gcloud_sdk_credentials_project_id(load, unused_isfile, get_project_id):
# Don't return a project ID from load file, make the function check
# the Cloud SDK project.
load.return_value = MOCK_CREDENTIALS, None
credentials, project_id = _default._get_gcloud_sdk_credentials()
assert credentials == MOCK_CREDENTIALS
assert project_id == mock.sentinel.project_id
assert get_project_id.called
@mock.patch("google.auth._cloud_sdk.get_project_id", return_value=None, autospec=True)
@mock.patch("os.path.isfile", return_value=True)
@LOAD_FILE_PATCH
def test__get_gcloud_sdk_credentials_no_project_id(load, unused_isfile, get_project_id):
# Don't return a project ID from load file, make the function check
# the Cloud SDK project.
load.return_value = MOCK_CREDENTIALS, None
credentials, project_id = _default._get_gcloud_sdk_credentials()
assert credentials == MOCK_CREDENTIALS
assert project_id is None
assert get_project_id.called
def test__get_gdch_service_account_credentials_invalid_format_version():
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
_default._get_gdch_service_account_credentials(
"file_name", {"format_version": "2"}
)
assert excinfo.match("Failed to load GDCH service account credentials")
def test_get_api_key_credentials():
creds = _default.get_api_key_credentials("api_key")
assert isinstance(creds, api_key.Credentials)
assert creds.token == "api_key"
class _AppIdentityModule(object):
"""The interface of the App Idenity app engine module.
See https://cloud.google.com/appengine/docs/standard/python/refdocs\
/google.appengine.api.app_identity.app_identity
"""
def get_application_id(self):
raise NotImplementedError()
@pytest.fixture
def app_identity(monkeypatch):
"""Mocks the app_identity module for google.auth.app_engine."""
app_identity_module = mock.create_autospec(_AppIdentityModule, instance=True)
monkeypatch.setattr(app_engine, "app_identity", app_identity_module)
yield app_identity_module
@mock.patch.dict(os.environ)
def test__get_gae_credentials_gen1(app_identity):
os.environ[environment_vars.LEGACY_APPENGINE_RUNTIME] = "python27"
app_identity.get_application_id.return_value = mock.sentinel.project
credentials, project_id = _default._get_gae_credentials()
assert isinstance(credentials, app_engine.Credentials)
assert project_id == mock.sentinel.project
@mock.patch.dict(os.environ)
def test__get_gae_credentials_gen2():
os.environ["GAE_RUNTIME"] = "python37"
credentials, project_id = _default._get_gae_credentials()
assert credentials is None
assert project_id is None
@mock.patch.dict(os.environ)
def test__get_gae_credentials_gen2_backwards_compat():
# compat helpers may copy GAE_RUNTIME to APPENGINE_RUNTIME
# for backwards compatibility with code that relies on it
os.environ[environment_vars.LEGACY_APPENGINE_RUNTIME] = "python37"
os.environ["GAE_RUNTIME"] = "python37"
credentials, project_id = _default._get_gae_credentials()
assert credentials is None
assert project_id is None
def test__get_gae_credentials_env_unset():
assert environment_vars.LEGACY_APPENGINE_RUNTIME not in os.environ
assert "GAE_RUNTIME" not in os.environ
credentials, project_id = _default._get_gae_credentials()
assert credentials is None
assert project_id is None
@mock.patch.dict(os.environ)
def test__get_gae_credentials_no_app_engine():
# test both with and without LEGACY_APPENGINE_RUNTIME setting
assert environment_vars.LEGACY_APPENGINE_RUNTIME not in os.environ
import sys
with mock.patch.dict(sys.modules, {"google.auth.app_engine": None}):
credentials, project_id = _default._get_gae_credentials()
assert credentials is None
assert project_id is None
os.environ[environment_vars.LEGACY_APPENGINE_RUNTIME] = "python27"
credentials, project_id = _default._get_gae_credentials()
assert credentials is None
assert project_id is None
@mock.patch.dict(os.environ)
@mock.patch.object(app_engine, "app_identity", new=None)
def test__get_gae_credentials_no_apis():
# test both with and without LEGACY_APPENGINE_RUNTIME setting
assert environment_vars.LEGACY_APPENGINE_RUNTIME not in os.environ
credentials, project_id = _default._get_gae_credentials()
assert credentials is None
assert project_id is None
os.environ[environment_vars.LEGACY_APPENGINE_RUNTIME] = "python27"
credentials, project_id = _default._get_gae_credentials()
assert credentials is None
assert project_id is None
@mock.patch(
"google.auth.compute_engine._metadata.is_on_gce", return_value=True, autospec=True
)
@mock.patch(
"google.auth.compute_engine._metadata.get_project_id",
return_value="example-project",
autospec=True,
)
def test__get_gce_credentials(unused_get, unused_ping):
credentials, project_id = _default._get_gce_credentials()
assert isinstance(credentials, compute_engine.Credentials)
assert project_id == "example-project"
@mock.patch(
"google.auth.compute_engine._metadata.is_on_gce", return_value=False, autospec=True
)
def test__get_gce_credentials_no_ping(unused_ping):
credentials, project_id = _default._get_gce_credentials()
assert credentials is None
assert project_id is None
@mock.patch(
"google.auth.compute_engine._metadata.is_on_gce", return_value=True, autospec=True
)
@mock.patch(
"google.auth.compute_engine._metadata.get_project_id",
side_effect=exceptions.TransportError(),
autospec=True,
)
def test__get_gce_credentials_no_project_id(unused_get, unused_ping):
credentials, project_id = _default._get_gce_credentials()
assert isinstance(credentials, compute_engine.Credentials)
assert project_id is None
def test__get_gce_credentials_no_compute_engine():
import sys
with mock.patch.dict("sys.modules"):
sys.modules["google.auth.compute_engine"] = None
credentials, project_id = _default._get_gce_credentials()
assert credentials is None
assert project_id is None
@mock.patch(
"google.auth.compute_engine._metadata.is_on_gce", return_value=False, autospec=True
)
def test__get_gce_credentials_explicit_request(ping):
_default._get_gce_credentials(mock.sentinel.request)
ping.assert_called_with(request=mock.sentinel.request)
@mock.patch(
"google.auth._default._get_explicit_environ_credentials",
return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id),
autospec=True,
)
def test_default_early_out(unused_get):
assert _default.default() == (MOCK_CREDENTIALS, mock.sentinel.project_id)
@mock.patch(
"google.auth._default.load_credentials_from_file",
return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id),
autospec=True,
)
def test_default_cred_file_path_env_var(unused_load_cred, monkeypatch):
monkeypatch.setenv(environment_vars.CREDENTIALS, "/path/to/file")
cred, _ = _default.default()
assert (
cred._cred_file_path
== "/path/to/file file via the GOOGLE_APPLICATION_CREDENTIALS environment variable"
)
@mock.patch("os.path.isfile", return_value=True, autospec=True)
@mock.patch(
"google.auth._cloud_sdk.get_application_default_credentials_path",
return_value="/path/to/adc/file",
autospec=True,
)
@mock.patch(
"google.auth._default.load_credentials_from_file",
return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id),
autospec=True,
)
def test_default_cred_file_path_gcloud(
unused_load_cred, unused_get_adc_file, unused_isfile
):
cred, _ = _default.default()
assert cred._cred_file_path == "/path/to/adc/file"
@mock.patch(
"google.auth._default._get_explicit_environ_credentials",
return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id),
autospec=True,
)
def test_default_explict_project_id(unused_get, monkeypatch):
monkeypatch.setenv(environment_vars.PROJECT, "explicit-env")
assert _default.default() == (MOCK_CREDENTIALS, "explicit-env")
@mock.patch(
"google.auth._default._get_explicit_environ_credentials",
return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id),
autospec=True,
)
def test_default_explict_legacy_project_id(unused_get, monkeypatch):
monkeypatch.setenv(environment_vars.LEGACY_PROJECT, "explicit-env")
assert _default.default() == (MOCK_CREDENTIALS, "explicit-env")
@mock.patch("logging.Logger.warning", autospec=True)
@mock.patch(
"google.auth._default._get_explicit_environ_credentials",
return_value=(MOCK_CREDENTIALS, None),
autospec=True,
)
@mock.patch(
"google.auth._default._get_gcloud_sdk_credentials",
return_value=(MOCK_CREDENTIALS, None),
autospec=True,
)
@mock.patch(
"google.auth._default._get_gae_credentials",
return_value=(MOCK_CREDENTIALS, None),
autospec=True,
)
@mock.patch(
"google.auth._default._get_gce_credentials",
return_value=(MOCK_CREDENTIALS, None),
autospec=True,
)
def test_default_without_project_id(
unused_gce, unused_gae, unused_sdk, unused_explicit, logger_warning
):
assert _default.default() == (MOCK_CREDENTIALS, None)
logger_warning.assert_called_with(mock.ANY, mock.ANY, mock.ANY)
@mock.patch(
"google.auth._default._get_explicit_environ_credentials",
return_value=(None, None),
autospec=True,
)
@mock.patch(
"google.auth._default._get_gcloud_sdk_credentials",
return_value=(None, None),
autospec=True,
)
@mock.patch(
"google.auth._default._get_gae_credentials",
return_value=(None, None),
autospec=True,
)
@mock.patch(
"google.auth._default._get_gce_credentials",
return_value=(None, None),
autospec=True,