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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
|
# 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 datetime
import json
import os
import pickle
import sys
from unittest import mock
import pytest # type: ignore
from google.auth import _helpers
from google.auth import exceptions
from google.auth import transport
from google.auth.credentials import TokenState
from google.oauth2 import credentials
DATA_DIR = os.path.join(os.path.dirname(__file__), "..", "data")
AUTH_USER_JSON_FILE = os.path.join(DATA_DIR, "authorized_user.json")
with open(AUTH_USER_JSON_FILE, "r") as fh:
AUTH_USER_INFO = json.load(fh)
class TestCredentials(object):
TOKEN_URI = "https://example.com/oauth2/token"
REFRESH_TOKEN = "refresh_token"
RAPT_TOKEN = "rapt_token"
CLIENT_ID = "client_id"
CLIENT_SECRET = "client_secret"
@classmethod
def make_credentials(cls):
return credentials.Credentials(
token=None,
refresh_token=cls.REFRESH_TOKEN,
token_uri=cls.TOKEN_URI,
client_id=cls.CLIENT_ID,
client_secret=cls.CLIENT_SECRET,
rapt_token=cls.RAPT_TOKEN,
enable_reauth_refresh=True,
)
def test_init_with_set_scopes(self):
# Regression test for https://github.com/googleapis/google-auth-library-python/issues/1145
scopes_set = {"a", "b"}
creds = credentials.Credentials(token="token", scopes=scopes_set)
# Verify scopes are converted to a list
assert isinstance(creds.scopes, list)
assert set(creds.scopes) == scopes_set
# Verify internal storage is a list (ensure consistent mutability)
assert isinstance(creds._scopes, list)
# Verify consistency (property returns the same object)
assert creds.scopes is creds.scopes
# Verify modifications persist
creds.scopes.append("c")
assert "c" in creds.scopes
assert len(creds.scopes) == 3
# Verify to_json works
json_output = creds.to_json()
data = json.loads(json_output)
assert set(data["scopes"]) == {"a", "b", "c"}
def test_default_state(self):
credentials = self.make_credentials()
assert not credentials.valid
# Expiration hasn't been set yet
assert not credentials.expired
# Scopes aren't required for these credentials
assert not credentials.requires_scopes
assert credentials.token_state == TokenState.INVALID
# Test properties
assert credentials.refresh_token == self.REFRESH_TOKEN
assert credentials.token_uri == self.TOKEN_URI
assert credentials.client_id == self.CLIENT_ID
assert credentials.client_secret == self.CLIENT_SECRET
assert credentials.rapt_token == self.RAPT_TOKEN
assert credentials.refresh_handler is None
def test_get_cred_info(self):
credentials = self.make_credentials()
credentials._account = "fake-account"
assert not credentials.get_cred_info()
credentials._cred_file_path = "/path/to/file"
assert credentials.get_cred_info() == {
"credential_source": "/path/to/file",
"credential_type": "user credentials",
"principal": "fake-account",
}
def test_get_cred_info_no_account(self):
credentials = self.make_credentials()
assert not credentials.get_cred_info()
credentials._cred_file_path = "/path/to/file"
assert credentials.get_cred_info() == {
"credential_source": "/path/to/file",
"credential_type": "user credentials",
}
def test__make_copy_get_cred_info(self):
credentials = self.make_credentials()
credentials._cred_file_path = "/path/to/file"
cred_copy = credentials._make_copy()
assert cred_copy._cred_file_path == "/path/to/file"
def test_token_usage_metrics(self):
credentials = self.make_credentials()
credentials.token = "token"
credentials.expiry = None
headers = {}
credentials.before_request(mock.Mock(), None, None, headers)
assert headers["authorization"] == "Bearer token"
assert headers["x-goog-api-client"] == "cred-type/u"
def test_refresh_handler_setter_and_getter(self):
scopes = ["email", "profile"]
original_refresh_handler = mock.Mock(return_value=("ACCESS_TOKEN_1", None))
updated_refresh_handler = mock.Mock(return_value=("ACCESS_TOKEN_2", None))
creds = credentials.Credentials(
token=None,
refresh_token=None,
token_uri=None,
client_id=None,
client_secret=None,
rapt_token=None,
scopes=scopes,
default_scopes=None,
refresh_handler=original_refresh_handler,
)
assert creds.refresh_handler is original_refresh_handler
creds.refresh_handler = updated_refresh_handler
assert creds.refresh_handler is updated_refresh_handler
creds.refresh_handler = None
assert creds.refresh_handler is None
def test_invalid_refresh_handler(self):
scopes = ["email", "profile"]
with pytest.raises(TypeError) as excinfo:
credentials.Credentials(
token=None,
refresh_token=None,
token_uri=None,
client_id=None,
client_secret=None,
rapt_token=None,
scopes=scopes,
default_scopes=None,
refresh_handler=object(),
)
assert excinfo.match("The provided refresh_handler is not a callable or None.")
def test_refresh_with_non_default_universe_domain(self):
creds = credentials.Credentials(
token="token", universe_domain="dummy_universe.com"
)
with pytest.raises(exceptions.RefreshError) as excinfo:
creds.refresh(mock.Mock())
assert excinfo.match(
"refresh is only supported in the default googleapis.com universe domain"
)
@mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
@mock.patch(
"google.auth._helpers.utcnow",
return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
)
def test_refresh_success(self, unused_utcnow, refresh_grant):
token = "token"
new_rapt_token = "new_rapt_token"
expiry = _helpers.utcnow() + datetime.timedelta(seconds=500)
grant_response = {"id_token": mock.sentinel.id_token}
refresh_grant.return_value = (
# Access token
token,
# New refresh token
None,
# Expiry,
expiry,
# Extra data
grant_response,
# rapt_token
new_rapt_token,
)
request = mock.create_autospec(transport.Request)
credentials = self.make_credentials()
# Refresh credentials
credentials.refresh(request)
# Check jwt grant call.
refresh_grant.assert_called_with(
request,
self.TOKEN_URI,
self.REFRESH_TOKEN,
self.CLIENT_ID,
self.CLIENT_SECRET,
None,
self.RAPT_TOKEN,
True,
)
# Check that the credentials have the token and expiry
assert credentials.token == token
assert credentials.expiry == expiry
assert credentials.id_token == mock.sentinel.id_token
assert credentials.rapt_token == new_rapt_token
# Check that the credentials are valid (have a token and are not
# expired)
assert credentials.valid
def test_refresh_no_refresh_token(self):
request = mock.create_autospec(transport.Request)
credentials_ = credentials.Credentials(token=None, refresh_token=None)
with pytest.raises(exceptions.RefreshError, match="necessary fields"):
credentials_.refresh(request)
request.assert_not_called()
@mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
@mock.patch(
"google.auth._helpers.utcnow",
return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
)
def test_refresh_with_refresh_token_and_refresh_handler(
self, unused_utcnow, refresh_grant
):
token = "token"
new_rapt_token = "new_rapt_token"
expiry = _helpers.utcnow() + datetime.timedelta(seconds=500)
grant_response = {"id_token": mock.sentinel.id_token}
refresh_grant.return_value = (
# Access token
token,
# New refresh token
None,
# Expiry,
expiry,
# Extra data
grant_response,
# rapt_token
new_rapt_token,
)
refresh_handler = mock.Mock()
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=self.REFRESH_TOKEN,
token_uri=self.TOKEN_URI,
client_id=self.CLIENT_ID,
client_secret=self.CLIENT_SECRET,
rapt_token=self.RAPT_TOKEN,
refresh_handler=refresh_handler,
)
# Refresh credentials
creds.refresh(request)
# Check jwt grant call.
refresh_grant.assert_called_with(
request,
self.TOKEN_URI,
self.REFRESH_TOKEN,
self.CLIENT_ID,
self.CLIENT_SECRET,
None,
self.RAPT_TOKEN,
False,
)
# Check that the credentials have the token and expiry
assert creds.token == token
assert creds.expiry == expiry
assert creds.id_token == mock.sentinel.id_token
assert creds.rapt_token == new_rapt_token
# Check that the credentials are valid (have a token and are not
# expired)
assert creds.valid
# Assert refresh handler not called as the refresh token has
# higher priority.
refresh_handler.assert_not_called()
@mock.patch("google.auth._helpers.utcnow", return_value=datetime.datetime.min)
def test_refresh_with_refresh_handler_success_scopes(self, unused_utcnow):
expected_expiry = datetime.datetime.min + datetime.timedelta(seconds=2800)
refresh_handler = mock.Mock(return_value=("ACCESS_TOKEN", expected_expiry))
scopes = ["email", "profile"]
default_scopes = ["https://www.googleapis.com/auth/cloud-platform"]
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=None,
token_uri=None,
client_id=None,
client_secret=None,
rapt_token=None,
scopes=scopes,
default_scopes=default_scopes,
refresh_handler=refresh_handler,
)
creds.refresh(request)
assert creds.token == "ACCESS_TOKEN"
assert creds.expiry == expected_expiry
assert creds.valid
assert not creds.expired
# Confirm refresh handler called with the expected arguments.
refresh_handler.assert_called_with(request, scopes=scopes)
@mock.patch("google.auth._helpers.utcnow", return_value=datetime.datetime.min)
def test_refresh_with_refresh_handler_success_default_scopes(self, unused_utcnow):
expected_expiry = datetime.datetime.min + datetime.timedelta(seconds=2800)
original_refresh_handler = mock.Mock(
return_value=("UNUSED_TOKEN", expected_expiry)
)
refresh_handler = mock.Mock(return_value=("ACCESS_TOKEN", expected_expiry))
default_scopes = ["https://www.googleapis.com/auth/cloud-platform"]
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=None,
token_uri=None,
client_id=None,
client_secret=None,
rapt_token=None,
scopes=None,
default_scopes=default_scopes,
refresh_handler=original_refresh_handler,
)
# Test newly set refresh_handler is used instead of the original one.
creds.refresh_handler = refresh_handler
creds.refresh(request)
assert creds.token == "ACCESS_TOKEN"
assert creds.expiry == expected_expiry
assert creds.valid
assert not creds.expired
# default_scopes should be used since no developer provided scopes
# are provided.
refresh_handler.assert_called_with(request, scopes=default_scopes)
@mock.patch("google.auth._helpers.utcnow", return_value=datetime.datetime.min)
def test_refresh_with_refresh_handler_invalid_token(self, unused_utcnow):
expected_expiry = datetime.datetime.min + datetime.timedelta(seconds=2800)
# Simulate refresh handler does not return a valid token.
refresh_handler = mock.Mock(return_value=(None, expected_expiry))
scopes = ["email", "profile"]
default_scopes = ["https://www.googleapis.com/auth/cloud-platform"]
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=None,
token_uri=None,
client_id=None,
client_secret=None,
rapt_token=None,
scopes=scopes,
default_scopes=default_scopes,
refresh_handler=refresh_handler,
)
with pytest.raises(
exceptions.RefreshError, match="returned token is not a string"
):
creds.refresh(request)
assert creds.token is None
assert creds.expiry is None
assert not creds.valid
# Confirm refresh handler called with the expected arguments.
refresh_handler.assert_called_with(request, scopes=scopes)
def test_refresh_with_refresh_handler_invalid_expiry(self):
# Simulate refresh handler returns expiration time in an invalid unit.
refresh_handler = mock.Mock(return_value=("TOKEN", 2800))
scopes = ["email", "profile"]
default_scopes = ["https://www.googleapis.com/auth/cloud-platform"]
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=None,
token_uri=None,
client_id=None,
client_secret=None,
rapt_token=None,
scopes=scopes,
default_scopes=default_scopes,
refresh_handler=refresh_handler,
)
with pytest.raises(
exceptions.RefreshError, match="returned expiry is not a datetime object"
):
creds.refresh(request)
assert creds.token is None
assert creds.expiry is None
assert not creds.valid
# Confirm refresh handler called with the expected arguments.
refresh_handler.assert_called_with(request, scopes=scopes)
@mock.patch("google.auth._helpers.utcnow", return_value=datetime.datetime.min)
def test_refresh_with_refresh_handler_expired_token(self, unused_utcnow):
expected_expiry = datetime.datetime.min + _helpers.REFRESH_THRESHOLD
# Simulate refresh handler returns an expired token.
refresh_handler = mock.Mock(return_value=("TOKEN", expected_expiry))
scopes = ["email", "profile"]
default_scopes = ["https://www.googleapis.com/auth/cloud-platform"]
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=None,
token_uri=None,
client_id=None,
client_secret=None,
rapt_token=None,
scopes=scopes,
default_scopes=default_scopes,
refresh_handler=refresh_handler,
)
with pytest.raises(exceptions.RefreshError, match="already expired"):
creds.refresh(request)
assert creds.token is None
assert creds.expiry is None
assert not creds.valid
# Confirm refresh handler called with the expected arguments.
refresh_handler.assert_called_with(request, scopes=scopes)
@mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
@mock.patch(
"google.auth._helpers.utcnow",
return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
)
def test_credentials_with_scopes_requested_refresh_success(
self, unused_utcnow, refresh_grant
):
scopes = ["email", "profile"]
default_scopes = ["https://www.googleapis.com/auth/cloud-platform"]
token = "token"
new_rapt_token = "new_rapt_token"
expiry = _helpers.utcnow() + datetime.timedelta(seconds=500)
grant_response = {"id_token": mock.sentinel.id_token, "scope": "email profile"}
refresh_grant.return_value = (
# Access token
token,
# New refresh token
None,
# Expiry,
expiry,
# Extra data
grant_response,
# rapt token
new_rapt_token,
)
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=self.REFRESH_TOKEN,
token_uri=self.TOKEN_URI,
client_id=self.CLIENT_ID,
client_secret=self.CLIENT_SECRET,
scopes=scopes,
default_scopes=default_scopes,
rapt_token=self.RAPT_TOKEN,
enable_reauth_refresh=True,
)
# Refresh credentials
creds.refresh(request)
# Check jwt grant call.
refresh_grant.assert_called_with(
request,
self.TOKEN_URI,
self.REFRESH_TOKEN,
self.CLIENT_ID,
self.CLIENT_SECRET,
scopes,
self.RAPT_TOKEN,
True,
)
# Check that the credentials have the token and expiry
assert creds.token == token
assert creds.expiry == expiry
assert creds.id_token == mock.sentinel.id_token
assert creds.has_scopes(scopes)
assert creds.rapt_token == new_rapt_token
assert creds.granted_scopes == scopes
# Check that the credentials are valid (have a token and are not
# expired.)
assert creds.valid
@mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
@mock.patch(
"google.auth._helpers.utcnow",
return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
)
def test_credentials_with_only_default_scopes_requested(
self, unused_utcnow, refresh_grant
):
default_scopes = ["email", "profile"]
token = "token"
new_rapt_token = "new_rapt_token"
expiry = _helpers.utcnow() + datetime.timedelta(seconds=500)
grant_response = {"id_token": mock.sentinel.id_token, "scope": "email profile"}
refresh_grant.return_value = (
# Access token
token,
# New refresh token
None,
# Expiry,
expiry,
# Extra data
grant_response,
# rapt token
new_rapt_token,
)
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=self.REFRESH_TOKEN,
token_uri=self.TOKEN_URI,
client_id=self.CLIENT_ID,
client_secret=self.CLIENT_SECRET,
default_scopes=default_scopes,
rapt_token=self.RAPT_TOKEN,
enable_reauth_refresh=True,
)
# Refresh credentials
creds.refresh(request)
# Check jwt grant call.
refresh_grant.assert_called_with(
request,
self.TOKEN_URI,
self.REFRESH_TOKEN,
self.CLIENT_ID,
self.CLIENT_SECRET,
default_scopes,
self.RAPT_TOKEN,
True,
)
# Check that the credentials have the token and expiry
assert creds.token == token
assert creds.expiry == expiry
assert creds.id_token == mock.sentinel.id_token
assert creds.has_scopes(default_scopes)
assert creds.rapt_token == new_rapt_token
assert creds.granted_scopes == default_scopes
# Check that the credentials are valid (have a token and are not
# expired.)
assert creds.valid
@mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
@mock.patch(
"google.auth._helpers.utcnow",
return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
)
def test_credentials_with_scopes_returned_refresh_success(
self, unused_utcnow, refresh_grant
):
scopes = ["email", "profile"]
token = "token"
new_rapt_token = "new_rapt_token"
expiry = _helpers.utcnow() + datetime.timedelta(seconds=500)
grant_response = {"id_token": mock.sentinel.id_token, "scope": " ".join(scopes)}
refresh_grant.return_value = (
# Access token
token,
# New refresh token
None,
# Expiry,
expiry,
# Extra data
grant_response,
# rapt token
new_rapt_token,
)
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=self.REFRESH_TOKEN,
token_uri=self.TOKEN_URI,
client_id=self.CLIENT_ID,
client_secret=self.CLIENT_SECRET,
scopes=scopes,
rapt_token=self.RAPT_TOKEN,
enable_reauth_refresh=True,
)
# Refresh credentials
creds.refresh(request)
# Check jwt grant call.
refresh_grant.assert_called_with(
request,
self.TOKEN_URI,
self.REFRESH_TOKEN,
self.CLIENT_ID,
self.CLIENT_SECRET,
scopes,
self.RAPT_TOKEN,
True,
)
# Check that the credentials have the token and expiry
assert creds.token == token
assert creds.expiry == expiry
assert creds.id_token == mock.sentinel.id_token
assert creds.has_scopes(scopes)
assert creds.rapt_token == new_rapt_token
assert creds.granted_scopes == scopes
# Check that the credentials are valid (have a token and are not
# expired.)
assert creds.valid
@mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
@mock.patch(
"google.auth._helpers.utcnow",
return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
)
def test_credentials_with_only_default_scopes_requested_different_granted_scopes(
self, unused_utcnow, refresh_grant
):
default_scopes = ["email", "profile"]
token = "token"
new_rapt_token = "new_rapt_token"
expiry = _helpers.utcnow() + datetime.timedelta(seconds=500)
grant_response = {"id_token": mock.sentinel.id_token, "scope": "email"}
refresh_grant.return_value = (
# Access token
token,
# New refresh token
None,
# Expiry,
expiry,
# Extra data
grant_response,
# rapt token
new_rapt_token,
)
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=self.REFRESH_TOKEN,
token_uri=self.TOKEN_URI,
client_id=self.CLIENT_ID,
client_secret=self.CLIENT_SECRET,
default_scopes=default_scopes,
rapt_token=self.RAPT_TOKEN,
enable_reauth_refresh=True,
)
# Refresh credentials
creds.refresh(request)
# Check jwt grant call.
refresh_grant.assert_called_with(
request,
self.TOKEN_URI,
self.REFRESH_TOKEN,
self.CLIENT_ID,
self.CLIENT_SECRET,
default_scopes,
self.RAPT_TOKEN,
True,
)
# Check that the credentials have the token and expiry
assert creds.token == token
assert creds.expiry == expiry
assert creds.id_token == mock.sentinel.id_token
assert creds.has_scopes(default_scopes)
assert creds.rapt_token == new_rapt_token
assert creds.granted_scopes == ["email"]
# Check that the credentials are valid (have a token and are not
# expired.)
assert creds.valid
@mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
@mock.patch(
"google.auth._helpers.utcnow",
return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
)
def test_credentials_with_scopes_refresh_different_granted_scopes(
self, unused_utcnow, refresh_grant
):
scopes = ["email", "profile"]
scopes_returned = ["email"]
token = "token"
new_rapt_token = "new_rapt_token"
expiry = _helpers.utcnow() + datetime.timedelta(seconds=500)
grant_response = {
"id_token": mock.sentinel.id_token,
"scope": " ".join(scopes_returned),
}
refresh_grant.return_value = (
# Access token
token,
# New refresh token
None,
# Expiry,
expiry,
# Extra data
grant_response,
# rapt token
new_rapt_token,
)
request = mock.create_autospec(transport.Request)
creds = credentials.Credentials(
token=None,
refresh_token=self.REFRESH_TOKEN,
token_uri=self.TOKEN_URI,
client_id=self.CLIENT_ID,
client_secret=self.CLIENT_SECRET,
scopes=scopes,
rapt_token=self.RAPT_TOKEN,
enable_reauth_refresh=True,
)
# Refresh credentials
creds.refresh(request)
# Check jwt grant call.
refresh_grant.assert_called_with(
request,
self.TOKEN_URI,
self.REFRESH_TOKEN,
self.CLIENT_ID,
self.CLIENT_SECRET,
scopes,
self.RAPT_TOKEN,
True,
)
# Check that the credentials have the token and expiry
assert creds.token == token
assert creds.expiry == expiry
assert creds.id_token == mock.sentinel.id_token
assert creds.has_scopes(scopes)
assert creds.rapt_token == new_rapt_token
assert creds.granted_scopes == scopes_returned
# Check that the credentials are valid (have a token and are not
# expired.)
assert creds.valid
def test_apply_with_quota_project_id(self):
creds = credentials.Credentials(
token="token",
refresh_token=self.REFRESH_TOKEN,
token_uri=self.TOKEN_URI,
client_id=self.CLIENT_ID,
client_secret=self.CLIENT_SECRET,
quota_project_id="quota-project-123",
)
headers = {}
creds.apply(headers)
assert headers["x-goog-user-project"] == "quota-project-123"
assert "token" in headers["authorization"]
def test_apply_with_no_quota_project_id(self):
creds = credentials.Credentials(
token="token",
refresh_token=self.REFRESH_TOKEN,
token_uri=self.TOKEN_URI,
client_id=self.CLIENT_ID,
client_secret=self.CLIENT_SECRET,
)
headers = {}
creds.apply(headers)
assert "x-goog-user-project" not in headers
assert "token" in headers["authorization"]
def test_with_quota_project(self):
creds = credentials.Credentials(
token="token",
refresh_token=self.REFRESH_TOKEN,
token_uri=self.TOKEN_URI,
client_id=self.CLIENT_ID,
client_secret=self.CLIENT_SECRET,
quota_project_id="quota-project-123",
)
new_creds = creds.with_quota_project("new-project-456")
assert new_creds.quota_project_id == "new-project-456"
headers = {}
creds.apply(headers)
assert "x-goog-user-project" in headers
def test_with_universe_domain(self):
creds = credentials.Credentials(token="token")
assert creds.universe_domain == "googleapis.com"
new_creds = creds.with_universe_domain("dummy_universe.com")
assert new_creds.universe_domain == "dummy_universe.com"
def test_with_account(self):
creds = credentials.Credentials(token="token")
assert creds.account == ""
new_creds = creds.with_account("mock@example.com")
assert new_creds.account == "mock@example.com"
def test_with_token_uri(self):
info = AUTH_USER_INFO.copy()
creds = credentials.Credentials.from_authorized_user_info(info)
new_token_uri = "https://oauth2-eu.googleapis.com/token"
assert creds._token_uri == credentials._GOOGLE_OAUTH2_TOKEN_ENDPOINT
creds_with_new_token_uri = creds.with_token_uri(new_token_uri)
assert creds_with_new_token_uri._token_uri == new_token_uri
def test_from_authorized_user_info(self):
info = AUTH_USER_INFO.copy()
creds = credentials.Credentials.from_authorized_user_info(info)
assert creds.client_secret == info["client_secret"]
assert creds.client_id == info["client_id"]
assert creds.refresh_token == info["refresh_token"]
assert creds.token_uri == credentials._GOOGLE_OAUTH2_TOKEN_ENDPOINT
assert creds.scopes is None
scopes = ["email", "profile"]
creds = credentials.Credentials.from_authorized_user_info(info, scopes)
assert creds.client_secret == info["client_secret"]
assert creds.client_id == info["client_id"]
assert creds.refresh_token == info["refresh_token"]
assert creds.token_uri == credentials._GOOGLE_OAUTH2_TOKEN_ENDPOINT
assert creds.scopes == scopes
info["scopes"] = "email" # single non-array scope from file
creds = credentials.Credentials.from_authorized_user_info(info)
assert creds.scopes == [info["scopes"]]
info["scopes"] = ["email", "profile"] # array scope from file
creds = credentials.Credentials.from_authorized_user_info(info)
assert creds.scopes == info["scopes"]
expiry = datetime.datetime(2020, 8, 14, 15, 54, 1)
info["expiry"] = expiry.isoformat() + "Z"
creds = credentials.Credentials.from_authorized_user_info(info)
assert creds.expiry == expiry
assert creds.expired
def test_from_authorized_user_file(self):
info = AUTH_USER_INFO.copy()
creds = credentials.Credentials.from_authorized_user_file(AUTH_USER_JSON_FILE)
assert creds.client_secret == info["client_secret"]
assert creds.client_id == info["client_id"]
assert creds.refresh_token == info["refresh_token"]
assert creds.token_uri == credentials._GOOGLE_OAUTH2_TOKEN_ENDPOINT
assert creds.scopes is None
assert creds.rapt_token is None
scopes = ["email", "profile"]
creds = credentials.Credentials.from_authorized_user_file(
AUTH_USER_JSON_FILE, scopes
)
assert creds.client_secret == info["client_secret"]
assert creds.client_id == info["client_id"]
assert creds.refresh_token == info["refresh_token"]
assert creds.token_uri == credentials._GOOGLE_OAUTH2_TOKEN_ENDPOINT
assert creds.scopes == scopes
def test_from_authorized_user_file_with_rapt_token(self):
info = AUTH_USER_INFO.copy()
file_path = os.path.join(DATA_DIR, "authorized_user_with_rapt_token.json")
creds = credentials.Credentials.from_authorized_user_file(file_path)
assert creds.client_secret == info["client_secret"]
assert creds.client_id == info["client_id"]
assert creds.refresh_token == info["refresh_token"]
assert creds.token_uri == credentials._GOOGLE_OAUTH2_TOKEN_ENDPOINT
assert creds.scopes is None
assert creds.rapt_token == "rapt"
def test_to_json(self):
info = AUTH_USER_INFO.copy()
expiry = datetime.datetime(2020, 8, 14, 15, 54, 1)
info["expiry"] = expiry.isoformat() + "Z"
creds = credentials.Credentials.from_authorized_user_info(info)
assert creds.expiry == expiry
# Test with no `strip` arg
json_output = creds.to_json()
json_asdict = json.loads(json_output)
assert json_asdict.get("token") == creds.token
assert json_asdict.get("refresh_token") == creds.refresh_token
assert json_asdict.get("token_uri") == creds.token_uri
assert json_asdict.get("client_id") == creds.client_id
assert json_asdict.get("scopes") == creds.scopes
assert json_asdict.get("client_secret") == creds.client_secret
assert json_asdict.get("expiry") == info["expiry"]
assert json_asdict.get("universe_domain") == creds.universe_domain
assert json_asdict.get("account") == creds.account
# Test with a `strip` arg
json_output = creds.to_json(strip=["client_secret"])
json_asdict = json.loads(json_output)
assert json_asdict.get("token") == creds.token
assert json_asdict.get("refresh_token") == creds.refresh_token
assert json_asdict.get("token_uri") == creds.token_uri
assert json_asdict.get("client_id") == creds.client_id
assert json_asdict.get("scopes") == creds.scopes
assert json_asdict.get("client_secret") is None
# Test with no expiry
creds.expiry = None
json_output = creds.to_json()
json_asdict = json.loads(json_output)
assert json_asdict.get("expiry") is None
def test_pickle_and_unpickle(self):
creds = self.make_credentials()
unpickled = pickle.loads(pickle.dumps(creds))
# make sure attributes aren't lost during pickling
assert list(creds.__dict__).sort() == list(unpickled.__dict__).sort()
for attr in list(creds.__dict__):
# Worker should always be None
if attr == "_refresh_worker":
assert getattr(unpickled, attr) is None
else:
assert getattr(creds, attr) == getattr(unpickled, attr)
def test_pickle_and_unpickle_universe_domain(self):
# old version of auth lib doesn't have _universe_domain, so the pickled
# cred doesn't have such a field.
creds = self.make_credentials()
del creds._universe_domain
unpickled = pickle.loads(pickle.dumps(creds))
# make sure the unpickled cred sets _universe_domain to default.
assert unpickled.universe_domain == "googleapis.com"
def test_pickle_and_unpickle_with_refresh_handler(self):
expected_expiry = _helpers.utcnow() + datetime.timedelta(seconds=2800)
refresh_handler = mock.Mock(return_value=("TOKEN", expected_expiry))
creds = credentials.Credentials(
token=None,
refresh_token=None,
token_uri=None,
client_id=None,
client_secret=None,
rapt_token=None,
refresh_handler=refresh_handler,
)
unpickled = pickle.loads(pickle.dumps(creds))
# make sure attributes aren't lost during pickling
assert list(creds.__dict__).sort() == list(unpickled.__dict__).sort()
for attr in list(creds.__dict__):
# For the _refresh_handler property, the unpickled creds should be
# set to None.
if attr == "_refresh_handler" or attr == "_refresh_worker":
assert getattr(unpickled, attr) is None
else:
assert getattr(creds, attr) == getattr(unpickled, attr)
def test_pickle_with_missing_attribute(self):
creds = self.make_credentials()
# remove an optional attribute before pickling
# this mimics a pickle created with a previous class definition with
# fewer attributes
del creds.__dict__["_quota_project_id"]
del creds.__dict__["_refresh_handler"]
del creds.__dict__["_refresh_worker"]
unpickled = pickle.loads(pickle.dumps(creds))
# Attribute should be initialized by `__setstate__`
assert unpickled.quota_project_id is None
# pickles are not compatible across versions
@pytest.mark.skipif(
sys.version_info < (3, 5),
reason="pickle file can only be loaded with Python >= 3.5",
)
def test_unpickle_old_credentials_pickle(self):
# make sure a credentials file pickled with an older
# library version (google-auth==1.5.1) can be unpickled
with open(
os.path.join(DATA_DIR, "old_oauth_credentials_py3.pickle"), "rb"
) as f:
credentials = pickle.load(f)
assert credentials.quota_project_id is None
class TestUserAccessTokenCredentials(object):
def test_instance(self):
with pytest.warns(
UserWarning, match="UserAccessTokenCredentials is deprecated"
):
cred = credentials.UserAccessTokenCredentials()
assert cred._account is None
cred = cred.with_account("account")
assert cred._account == "account"
@mock.patch("google.auth._cloud_sdk.get_auth_access_token", autospec=True)
def test_refresh(self, get_auth_access_token):
with pytest.warns(
UserWarning, match="UserAccessTokenCredentials is deprecated"
):
get_auth_access_token.return_value = "access_token"
cred = credentials.UserAccessTokenCredentials()
cred.refresh(None)
assert cred.token == "access_token"
def test_with_quota_project(self):
with pytest.warns(
UserWarning, match="UserAccessTokenCredentials is deprecated"
):
cred = credentials.UserAccessTokenCredentials()
quota_project_cred = cred.with_quota_project("project-foo")
assert quota_project_cred._quota_project_id == "project-foo"
assert quota_project_cred._account == cred._account
@mock.patch(
"google.oauth2.credentials.UserAccessTokenCredentials.apply", autospec=True
)
@mock.patch(
"google.oauth2.credentials.UserAccessTokenCredentials.refresh", autospec=True
)
def test_before_request(self, refresh, apply):
with pytest.warns(
UserWarning, match="UserAccessTokenCredentials is deprecated"
):
cred = credentials.UserAccessTokenCredentials()
cred.before_request(mock.Mock(), "GET", "https://example.com", {})
refresh.assert_called()
apply.assert_called()
|