C.J. Collier | 37141e4 | 2020-02-13 13:49:49 -0800 | [diff] [blame] | 1 | # Copyright 2016 Google LLC |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | # you may not use this file except in compliance with the License. |
| 5 | # You may obtain a copy of the License at |
| 6 | # |
| 7 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | # See the License for the specific language governing permissions and |
| 13 | # limitations under the License. |
| 14 | |
| 15 | import json |
| 16 | import os |
| 17 | |
| 18 | import mock |
| 19 | import pytest |
| 20 | |
| 21 | from google.auth import _default |
Jon Wayne Parrott | 2148fde | 2016-10-24 13:44:25 -0700 | [diff] [blame] | 22 | from google.auth import app_engine |
bojeil-google | d4d7f38 | 2021-02-16 12:33:20 -0800 | [diff] [blame] | 23 | from google.auth import aws |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 24 | from google.auth import compute_engine |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 25 | from google.auth import credentials |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 26 | from google.auth import environment_vars |
| 27 | from google.auth import exceptions |
bojeil-google | d4d7f38 | 2021-02-16 12:33:20 -0800 | [diff] [blame] | 28 | from google.auth import external_account |
| 29 | from google.auth import identity_pool |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 30 | from google.oauth2 import service_account |
| 31 | import google.oauth2.credentials |
| 32 | |
| 33 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 34 | DATA_DIR = os.path.join(os.path.dirname(__file__), "data") |
| 35 | AUTHORIZED_USER_FILE = os.path.join(DATA_DIR, "authorized_user.json") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 36 | |
| 37 | with open(AUTHORIZED_USER_FILE) as fh: |
| 38 | AUTHORIZED_USER_FILE_DATA = json.load(fh) |
| 39 | |
Thea Flowers | a8d9348 | 2018-05-31 14:52:06 -0700 | [diff] [blame] | 40 | AUTHORIZED_USER_CLOUD_SDK_FILE = os.path.join( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 41 | DATA_DIR, "authorized_user_cloud_sdk.json" |
| 42 | ) |
Thea Flowers | a8d9348 | 2018-05-31 14:52:06 -0700 | [diff] [blame] | 43 | |
arithmetic1728 | f30b45a | 2020-06-17 23:36:04 -0700 | [diff] [blame] | 44 | AUTHORIZED_USER_CLOUD_SDK_WITH_QUOTA_PROJECT_ID_FILE = os.path.join( |
| 45 | DATA_DIR, "authorized_user_cloud_sdk_with_quota_project_id.json" |
| 46 | ) |
| 47 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 48 | SERVICE_ACCOUNT_FILE = os.path.join(DATA_DIR, "service_account.json") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 49 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 50 | CLIENT_SECRETS_FILE = os.path.join(DATA_DIR, "client_secrets.json") |
| 51 | |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 52 | with open(SERVICE_ACCOUNT_FILE) as fh: |
| 53 | SERVICE_ACCOUNT_FILE_DATA = json.load(fh) |
| 54 | |
bojeil-google | d4d7f38 | 2021-02-16 12:33:20 -0800 | [diff] [blame] | 55 | SUBJECT_TOKEN_TEXT_FILE = os.path.join(DATA_DIR, "external_subject_token.txt") |
| 56 | TOKEN_URL = "https://sts.googleapis.com/v1/token" |
| 57 | AUDIENCE = "//iam.googleapis.com/projects/123456/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID" |
| 58 | REGION_URL = "http://169.254.169.254/latest/meta-data/placement/availability-zone" |
| 59 | SECURITY_CREDS_URL = "http://169.254.169.254/latest/meta-data/iam/security-credentials" |
| 60 | CRED_VERIFICATION_URL = ( |
| 61 | "https://sts.{region}.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15" |
| 62 | ) |
| 63 | IDENTITY_POOL_DATA = { |
| 64 | "type": "external_account", |
| 65 | "audience": AUDIENCE, |
| 66 | "subject_token_type": "urn:ietf:params:oauth:token-type:jwt", |
| 67 | "token_url": TOKEN_URL, |
| 68 | "credential_source": {"file": SUBJECT_TOKEN_TEXT_FILE}, |
| 69 | } |
| 70 | AWS_DATA = { |
| 71 | "type": "external_account", |
| 72 | "audience": AUDIENCE, |
| 73 | "subject_token_type": "urn:ietf:params:aws:token-type:aws4_request", |
| 74 | "token_url": TOKEN_URL, |
| 75 | "credential_source": { |
| 76 | "environment_id": "aws1", |
| 77 | "region_url": REGION_URL, |
| 78 | "url": SECURITY_CREDS_URL, |
| 79 | "regional_cred_verification_url": CRED_VERIFICATION_URL, |
| 80 | }, |
| 81 | } |
| 82 | |
Bu Sun Kim | 41599ae | 2020-09-02 12:55:42 -0600 | [diff] [blame] | 83 | MOCK_CREDENTIALS = mock.Mock(spec=credentials.CredentialsWithQuotaProject) |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 84 | MOCK_CREDENTIALS.with_quota_project.return_value = MOCK_CREDENTIALS |
| 85 | |
bojeil-google | d4d7f38 | 2021-02-16 12:33:20 -0800 | [diff] [blame] | 86 | |
| 87 | def get_project_id_side_effect(self, request=None): |
| 88 | # If no scopes are set, this will always return None. |
| 89 | if not self.scopes: |
| 90 | return None |
| 91 | return mock.sentinel.project_id |
| 92 | |
| 93 | |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 94 | LOAD_FILE_PATCH = mock.patch( |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 95 | "google.auth._default.load_credentials_from_file", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 96 | return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 97 | autospec=True, |
| 98 | ) |
bojeil-google | d4d7f38 | 2021-02-16 12:33:20 -0800 | [diff] [blame] | 99 | EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH = mock.patch.object( |
| 100 | external_account.Credentials, |
| 101 | "get_project_id", |
| 102 | side_effect=get_project_id_side_effect, |
| 103 | autospec=True, |
| 104 | ) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 105 | |
| 106 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 107 | def test_load_credentials_from_missing_file(): |
weitaiting | 6e86c93 | 2017-08-12 03:26:59 +0800 | [diff] [blame] | 108 | with pytest.raises(exceptions.DefaultCredentialsError) as excinfo: |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 109 | _default.load_credentials_from_file("") |
weitaiting | 6e86c93 | 2017-08-12 03:26:59 +0800 | [diff] [blame] | 110 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 111 | assert excinfo.match(r"not found") |
weitaiting | 6e86c93 | 2017-08-12 03:26:59 +0800 | [diff] [blame] | 112 | |
| 113 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 114 | def test_load_credentials_from_file_invalid_json(tmpdir): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 115 | jsonfile = tmpdir.join("invalid.json") |
| 116 | jsonfile.write("{") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 117 | |
| 118 | with pytest.raises(exceptions.DefaultCredentialsError) as excinfo: |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 119 | _default.load_credentials_from_file(str(jsonfile)) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 120 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 121 | assert excinfo.match(r"not a valid json file") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 122 | |
| 123 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 124 | def test_load_credentials_from_file_invalid_type(tmpdir): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 125 | jsonfile = tmpdir.join("invalid.json") |
| 126 | jsonfile.write(json.dumps({"type": "not-a-real-type"})) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 127 | |
| 128 | with pytest.raises(exceptions.DefaultCredentialsError) as excinfo: |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 129 | _default.load_credentials_from_file(str(jsonfile)) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 130 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 131 | assert excinfo.match(r"does not have a valid type") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 132 | |
| 133 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 134 | def test_load_credentials_from_file_authorized_user(): |
| 135 | credentials, project_id = _default.load_credentials_from_file(AUTHORIZED_USER_FILE) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 136 | assert isinstance(credentials, google.oauth2.credentials.Credentials) |
| 137 | assert project_id is None |
| 138 | |
| 139 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 140 | def test_load_credentials_from_file_no_type(tmpdir): |
| 141 | # use the client_secrets.json, which is valid json but not a |
| 142 | # loadable credentials type |
| 143 | with pytest.raises(exceptions.DefaultCredentialsError) as excinfo: |
| 144 | _default.load_credentials_from_file(CLIENT_SECRETS_FILE) |
| 145 | |
| 146 | assert excinfo.match(r"does not have a valid type") |
| 147 | assert excinfo.match(r"Type is None") |
| 148 | |
| 149 | |
| 150 | def test_load_credentials_from_file_authorized_user_bad_format(tmpdir): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 151 | filename = tmpdir.join("authorized_user_bad.json") |
| 152 | filename.write(json.dumps({"type": "authorized_user"})) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 153 | |
| 154 | with pytest.raises(exceptions.DefaultCredentialsError) as excinfo: |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 155 | _default.load_credentials_from_file(str(filename)) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 156 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 157 | assert excinfo.match(r"Failed to load authorized user") |
| 158 | assert excinfo.match(r"missing fields") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 159 | |
| 160 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 161 | def test_load_credentials_from_file_authorized_user_cloud_sdk(): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 162 | with pytest.warns(UserWarning, match="Cloud SDK"): |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 163 | credentials, project_id = _default.load_credentials_from_file( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 164 | AUTHORIZED_USER_CLOUD_SDK_FILE |
| 165 | ) |
Thea Flowers | a8d9348 | 2018-05-31 14:52:06 -0700 | [diff] [blame] | 166 | assert isinstance(credentials, google.oauth2.credentials.Credentials) |
| 167 | assert project_id is None |
| 168 | |
arithmetic1728 | f30b45a | 2020-06-17 23:36:04 -0700 | [diff] [blame] | 169 | # No warning if the json file has quota project id. |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 170 | credentials, project_id = _default.load_credentials_from_file( |
arithmetic1728 | f30b45a | 2020-06-17 23:36:04 -0700 | [diff] [blame] | 171 | AUTHORIZED_USER_CLOUD_SDK_WITH_QUOTA_PROJECT_ID_FILE |
| 172 | ) |
| 173 | assert isinstance(credentials, google.oauth2.credentials.Credentials) |
| 174 | assert project_id is None |
| 175 | |
Thea Flowers | a8d9348 | 2018-05-31 14:52:06 -0700 | [diff] [blame] | 176 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 177 | def test_load_credentials_from_file_authorized_user_cloud_sdk_with_scopes(): |
| 178 | with pytest.warns(UserWarning, match="Cloud SDK"): |
| 179 | credentials, project_id = _default.load_credentials_from_file( |
| 180 | AUTHORIZED_USER_CLOUD_SDK_FILE, |
| 181 | scopes=["https://www.google.com/calendar/feeds"], |
| 182 | ) |
| 183 | assert isinstance(credentials, google.oauth2.credentials.Credentials) |
| 184 | assert project_id is None |
| 185 | assert credentials.scopes == ["https://www.google.com/calendar/feeds"] |
| 186 | |
| 187 | |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 188 | def test_load_credentials_from_file_authorized_user_cloud_sdk_with_quota_project(): |
| 189 | credentials, project_id = _default.load_credentials_from_file( |
| 190 | AUTHORIZED_USER_CLOUD_SDK_FILE, quota_project_id="project-foo" |
| 191 | ) |
| 192 | |
| 193 | assert isinstance(credentials, google.oauth2.credentials.Credentials) |
| 194 | assert project_id is None |
| 195 | assert credentials.quota_project_id == "project-foo" |
| 196 | |
| 197 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 198 | def test_load_credentials_from_file_service_account(): |
| 199 | credentials, project_id = _default.load_credentials_from_file(SERVICE_ACCOUNT_FILE) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 200 | assert isinstance(credentials, service_account.Credentials) |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 201 | assert project_id == SERVICE_ACCOUNT_FILE_DATA["project_id"] |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 202 | |
| 203 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 204 | def test_load_credentials_from_file_service_account_with_scopes(): |
| 205 | credentials, project_id = _default.load_credentials_from_file( |
| 206 | SERVICE_ACCOUNT_FILE, scopes=["https://www.google.com/calendar/feeds"] |
| 207 | ) |
| 208 | assert isinstance(credentials, service_account.Credentials) |
| 209 | assert project_id == SERVICE_ACCOUNT_FILE_DATA["project_id"] |
| 210 | assert credentials.scopes == ["https://www.google.com/calendar/feeds"] |
| 211 | |
| 212 | |
Bu Sun Kim | ab2be5d | 2020-07-15 16:49:27 -0700 | [diff] [blame] | 213 | def test_load_credentials_from_file_service_account_with_quota_project(): |
| 214 | credentials, project_id = _default.load_credentials_from_file( |
| 215 | SERVICE_ACCOUNT_FILE, quota_project_id="project-foo" |
| 216 | ) |
| 217 | assert isinstance(credentials, service_account.Credentials) |
| 218 | assert project_id == SERVICE_ACCOUNT_FILE_DATA["project_id"] |
| 219 | assert credentials.quota_project_id == "project-foo" |
| 220 | |
| 221 | |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 222 | def test_load_credentials_from_file_service_account_bad_format(tmpdir): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 223 | filename = tmpdir.join("serivce_account_bad.json") |
| 224 | filename.write(json.dumps({"type": "service_account"})) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 225 | |
| 226 | with pytest.raises(exceptions.DefaultCredentialsError) as excinfo: |
Bu Sun Kim | 15d5fa9 | 2020-06-18 14:05:40 -0700 | [diff] [blame] | 227 | _default.load_credentials_from_file(str(filename)) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 228 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 229 | assert excinfo.match(r"Failed to load service account") |
| 230 | assert excinfo.match(r"missing fields") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 231 | |
| 232 | |
bojeil-google | d4d7f38 | 2021-02-16 12:33:20 -0800 | [diff] [blame] | 233 | @EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH |
| 234 | def test_load_credentials_from_file_external_account_identity_pool( |
| 235 | get_project_id, tmpdir |
| 236 | ): |
| 237 | config_file = tmpdir.join("config.json") |
| 238 | config_file.write(json.dumps(IDENTITY_POOL_DATA)) |
| 239 | credentials, project_id = _default.load_credentials_from_file(str(config_file)) |
| 240 | |
| 241 | assert isinstance(credentials, identity_pool.Credentials) |
| 242 | # Since no scopes are specified, the project ID cannot be determined. |
| 243 | assert project_id is None |
| 244 | assert get_project_id.called |
| 245 | |
| 246 | |
| 247 | @EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH |
| 248 | def test_load_credentials_from_file_external_account_aws(get_project_id, tmpdir): |
| 249 | config_file = tmpdir.join("config.json") |
| 250 | config_file.write(json.dumps(AWS_DATA)) |
| 251 | credentials, project_id = _default.load_credentials_from_file(str(config_file)) |
| 252 | |
| 253 | assert isinstance(credentials, aws.Credentials) |
| 254 | # Since no scopes are specified, the project ID cannot be determined. |
| 255 | assert project_id is None |
| 256 | assert get_project_id.called |
| 257 | |
| 258 | |
| 259 | @EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH |
| 260 | def test_load_credentials_from_file_external_account_with_user_and_default_scopes( |
| 261 | get_project_id, tmpdir |
| 262 | ): |
| 263 | config_file = tmpdir.join("config.json") |
| 264 | config_file.write(json.dumps(IDENTITY_POOL_DATA)) |
| 265 | credentials, project_id = _default.load_credentials_from_file( |
| 266 | str(config_file), |
| 267 | scopes=["https://www.google.com/calendar/feeds"], |
| 268 | default_scopes=["https://www.googleapis.com/auth/cloud-platform"], |
| 269 | ) |
| 270 | |
| 271 | assert isinstance(credentials, identity_pool.Credentials) |
| 272 | # Since scopes are specified, the project ID can be determined. |
| 273 | assert project_id is mock.sentinel.project_id |
| 274 | assert credentials.scopes == ["https://www.google.com/calendar/feeds"] |
| 275 | assert credentials.default_scopes == [ |
| 276 | "https://www.googleapis.com/auth/cloud-platform" |
| 277 | ] |
| 278 | |
| 279 | |
| 280 | @EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH |
| 281 | def test_load_credentials_from_file_external_account_with_quota_project( |
| 282 | get_project_id, tmpdir |
| 283 | ): |
| 284 | config_file = tmpdir.join("config.json") |
| 285 | config_file.write(json.dumps(IDENTITY_POOL_DATA)) |
| 286 | credentials, project_id = _default.load_credentials_from_file( |
| 287 | str(config_file), quota_project_id="project-foo" |
| 288 | ) |
| 289 | |
| 290 | assert isinstance(credentials, identity_pool.Credentials) |
| 291 | # Since no scopes are specified, the project ID cannot be determined. |
| 292 | assert project_id is None |
| 293 | assert credentials.quota_project_id == "project-foo" |
| 294 | |
| 295 | |
| 296 | def test_load_credentials_from_file_external_account_bad_format(tmpdir): |
| 297 | filename = tmpdir.join("external_account_bad.json") |
| 298 | filename.write(json.dumps({"type": "external_account"})) |
| 299 | |
| 300 | with pytest.raises(exceptions.DefaultCredentialsError) as excinfo: |
| 301 | _default.load_credentials_from_file(str(filename)) |
| 302 | |
| 303 | assert excinfo.match( |
| 304 | "Failed to load external account credentials from {}".format(str(filename)) |
| 305 | ) |
| 306 | |
| 307 | |
| 308 | @EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH |
| 309 | def test_load_credentials_from_file_external_account_explicit_request( |
| 310 | get_project_id, tmpdir |
| 311 | ): |
| 312 | config_file = tmpdir.join("config.json") |
| 313 | config_file.write(json.dumps(IDENTITY_POOL_DATA)) |
| 314 | credentials, project_id = _default.load_credentials_from_file( |
| 315 | str(config_file), |
| 316 | request=mock.sentinel.request, |
| 317 | scopes=["https://www.googleapis.com/auth/cloud-platform"], |
| 318 | ) |
| 319 | |
| 320 | assert isinstance(credentials, identity_pool.Credentials) |
| 321 | # Since scopes are specified, the project ID can be determined. |
| 322 | assert project_id is mock.sentinel.project_id |
| 323 | get_project_id.assert_called_with(credentials, request=mock.sentinel.request) |
| 324 | |
| 325 | |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 326 | @mock.patch.dict(os.environ, {}, clear=True) |
| 327 | def test__get_explicit_environ_credentials_no_env(): |
| 328 | assert _default._get_explicit_environ_credentials() == (None, None) |
| 329 | |
| 330 | |
| 331 | @LOAD_FILE_PATCH |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 332 | def test__get_explicit_environ_credentials(load, monkeypatch): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 333 | monkeypatch.setenv(environment_vars.CREDENTIALS, "filename") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 334 | |
| 335 | credentials, project_id = _default._get_explicit_environ_credentials() |
| 336 | |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 337 | assert credentials is MOCK_CREDENTIALS |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 338 | assert project_id is mock.sentinel.project_id |
Bu Sun Kim | 9dc2d86 | 2021-02-11 12:53:26 -0700 | [diff] [blame] | 339 | load.assert_called_with("filename") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 340 | |
| 341 | |
| 342 | @LOAD_FILE_PATCH |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 343 | def test__get_explicit_environ_credentials_no_project_id(load, monkeypatch): |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 344 | load.return_value = MOCK_CREDENTIALS, None |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 345 | monkeypatch.setenv(environment_vars.CREDENTIALS, "filename") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 346 | |
| 347 | credentials, project_id = _default._get_explicit_environ_credentials() |
| 348 | |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 349 | assert credentials is MOCK_CREDENTIALS |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 350 | assert project_id is None |
| 351 | |
| 352 | |
| 353 | @LOAD_FILE_PATCH |
Jon Wayne Parrott | 8784b23 | 2016-11-10 12:53:55 -0800 | [diff] [blame] | 354 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 355 | "google.auth._cloud_sdk.get_application_default_credentials_path", autospec=True |
| 356 | ) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 357 | def test__get_gcloud_sdk_credentials(get_adc_path, load): |
| 358 | get_adc_path.return_value = SERVICE_ACCOUNT_FILE |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 359 | |
| 360 | credentials, project_id = _default._get_gcloud_sdk_credentials() |
| 361 | |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 362 | assert credentials is MOCK_CREDENTIALS |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 363 | assert project_id is mock.sentinel.project_id |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 364 | load.assert_called_with(SERVICE_ACCOUNT_FILE) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 365 | |
| 366 | |
Jon Wayne Parrott | 8784b23 | 2016-11-10 12:53:55 -0800 | [diff] [blame] | 367 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 368 | "google.auth._cloud_sdk.get_application_default_credentials_path", autospec=True |
| 369 | ) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 370 | def test__get_gcloud_sdk_credentials_non_existent(get_adc_path, tmpdir): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 371 | non_existent = tmpdir.join("non-existent") |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 372 | get_adc_path.return_value = str(non_existent) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 373 | |
| 374 | credentials, project_id = _default._get_gcloud_sdk_credentials() |
| 375 | |
| 376 | assert credentials is None |
| 377 | assert project_id is None |
| 378 | |
| 379 | |
| 380 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 381 | "google.auth._cloud_sdk.get_project_id", |
| 382 | return_value=mock.sentinel.project_id, |
| 383 | autospec=True, |
| 384 | ) |
| 385 | @mock.patch("os.path.isfile", return_value=True, autospec=True) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 386 | @LOAD_FILE_PATCH |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 387 | def test__get_gcloud_sdk_credentials_project_id(load, unused_isfile, get_project_id): |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 388 | # Don't return a project ID from load file, make the function check |
| 389 | # the Cloud SDK project. |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 390 | load.return_value = MOCK_CREDENTIALS, None |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 391 | |
| 392 | credentials, project_id = _default._get_gcloud_sdk_credentials() |
| 393 | |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 394 | assert credentials == MOCK_CREDENTIALS |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 395 | assert project_id == mock.sentinel.project_id |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 396 | assert get_project_id.called |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 397 | |
| 398 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 399 | @mock.patch("google.auth._cloud_sdk.get_project_id", return_value=None, autospec=True) |
| 400 | @mock.patch("os.path.isfile", return_value=True) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 401 | @LOAD_FILE_PATCH |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 402 | def test__get_gcloud_sdk_credentials_no_project_id(load, unused_isfile, get_project_id): |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 403 | # Don't return a project ID from load file, make the function check |
| 404 | # the Cloud SDK project. |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 405 | load.return_value = MOCK_CREDENTIALS, None |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 406 | |
| 407 | credentials, project_id = _default._get_gcloud_sdk_credentials() |
| 408 | |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 409 | assert credentials == MOCK_CREDENTIALS |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 410 | assert project_id is None |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 411 | assert get_project_id.called |
| 412 | |
| 413 | |
| 414 | class _AppIdentityModule(object): |
| 415 | """The interface of the App Idenity app engine module. |
| 416 | See https://cloud.google.com/appengine/docs/standard/python/refdocs\ |
| 417 | /google.appengine.api.app_identity.app_identity |
| 418 | """ |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 419 | |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 420 | def get_application_id(self): |
| 421 | raise NotImplementedError() |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 422 | |
| 423 | |
Jon Wayne Parrott | 2148fde | 2016-10-24 13:44:25 -0700 | [diff] [blame] | 424 | @pytest.fixture |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 425 | def app_identity(monkeypatch): |
Jon Wayne Parrott | 2148fde | 2016-10-24 13:44:25 -0700 | [diff] [blame] | 426 | """Mocks the app_identity module for google.auth.app_engine.""" |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 427 | app_identity_module = mock.create_autospec(_AppIdentityModule, instance=True) |
| 428 | monkeypatch.setattr(app_engine, "app_identity", app_identity_module) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 429 | yield app_identity_module |
Jon Wayne Parrott | 2148fde | 2016-10-24 13:44:25 -0700 | [diff] [blame] | 430 | |
| 431 | |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 432 | def test__get_gae_credentials(app_identity): |
| 433 | app_identity.get_application_id.return_value = mock.sentinel.project |
Jon Wayne Parrott | 2148fde | 2016-10-24 13:44:25 -0700 | [diff] [blame] | 434 | |
| 435 | credentials, project_id = _default._get_gae_credentials() |
| 436 | |
| 437 | assert isinstance(credentials, app_engine.Credentials) |
| 438 | assert project_id == mock.sentinel.project |
| 439 | |
| 440 | |
James Wilson | 6e0781b | 2018-12-20 20:38:52 -0500 | [diff] [blame] | 441 | def test__get_gae_credentials_no_app_engine(): |
| 442 | import sys |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 443 | |
| 444 | with mock.patch.dict("sys.modules"): |
| 445 | sys.modules["google.auth.app_engine"] = None |
James Wilson | 6e0781b | 2018-12-20 20:38:52 -0500 | [diff] [blame] | 446 | credentials, project_id = _default._get_gae_credentials() |
| 447 | assert credentials is None |
| 448 | assert project_id is None |
| 449 | |
| 450 | |
Jon Wayne Parrott | 2148fde | 2016-10-24 13:44:25 -0700 | [diff] [blame] | 451 | def test__get_gae_credentials_no_apis(): |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 452 | assert _default._get_gae_credentials() == (None, None) |
| 453 | |
| 454 | |
| 455 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 456 | "google.auth.compute_engine._metadata.ping", return_value=True, autospec=True |
| 457 | ) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 458 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 459 | "google.auth.compute_engine._metadata.get_project_id", |
| 460 | return_value="example-project", |
| 461 | autospec=True, |
| 462 | ) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 463 | def test__get_gce_credentials(unused_get, unused_ping): |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 464 | credentials, project_id = _default._get_gce_credentials() |
| 465 | |
| 466 | assert isinstance(credentials, compute_engine.Credentials) |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 467 | assert project_id == "example-project" |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 468 | |
| 469 | |
Jon Wayne Parrott | 8784b23 | 2016-11-10 12:53:55 -0800 | [diff] [blame] | 470 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 471 | "google.auth.compute_engine._metadata.ping", return_value=False, autospec=True |
| 472 | ) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 473 | def test__get_gce_credentials_no_ping(unused_ping): |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 474 | credentials, project_id = _default._get_gce_credentials() |
| 475 | |
| 476 | assert credentials is None |
| 477 | assert project_id is None |
| 478 | |
| 479 | |
| 480 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 481 | "google.auth.compute_engine._metadata.ping", return_value=True, autospec=True |
| 482 | ) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 483 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 484 | "google.auth.compute_engine._metadata.get_project_id", |
| 485 | side_effect=exceptions.TransportError(), |
| 486 | autospec=True, |
| 487 | ) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 488 | def test__get_gce_credentials_no_project_id(unused_get, unused_ping): |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 489 | credentials, project_id = _default._get_gce_credentials() |
| 490 | |
| 491 | assert isinstance(credentials, compute_engine.Credentials) |
| 492 | assert project_id is None |
| 493 | |
| 494 | |
James Wilson | 6e0781b | 2018-12-20 20:38:52 -0500 | [diff] [blame] | 495 | def test__get_gce_credentials_no_compute_engine(): |
| 496 | import sys |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 497 | |
| 498 | with mock.patch.dict("sys.modules"): |
| 499 | sys.modules["google.auth.compute_engine"] = None |
James Wilson | 6e0781b | 2018-12-20 20:38:52 -0500 | [diff] [blame] | 500 | credentials, project_id = _default._get_gce_credentials() |
| 501 | assert credentials is None |
| 502 | assert project_id is None |
| 503 | |
| 504 | |
Jon Wayne Parrott | 8784b23 | 2016-11-10 12:53:55 -0800 | [diff] [blame] | 505 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 506 | "google.auth.compute_engine._metadata.ping", return_value=False, autospec=True |
| 507 | ) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 508 | def test__get_gce_credentials_explicit_request(ping): |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 509 | _default._get_gce_credentials(mock.sentinel.request) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 510 | ping.assert_called_with(request=mock.sentinel.request) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 511 | |
| 512 | |
| 513 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 514 | "google.auth._default._get_explicit_environ_credentials", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 515 | return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 516 | autospec=True, |
| 517 | ) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 518 | def test_default_early_out(unused_get): |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 519 | assert _default.default() == (MOCK_CREDENTIALS, mock.sentinel.project_id) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 520 | |
| 521 | |
| 522 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 523 | "google.auth._default._get_explicit_environ_credentials", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 524 | return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 525 | autospec=True, |
| 526 | ) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 527 | def test_default_explict_project_id(unused_get, monkeypatch): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 528 | monkeypatch.setenv(environment_vars.PROJECT, "explicit-env") |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 529 | assert _default.default() == (MOCK_CREDENTIALS, "explicit-env") |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 530 | |
| 531 | |
| 532 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 533 | "google.auth._default._get_explicit_environ_credentials", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 534 | return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 535 | autospec=True, |
| 536 | ) |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 537 | def test_default_explict_legacy_project_id(unused_get, monkeypatch): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 538 | monkeypatch.setenv(environment_vars.LEGACY_PROJECT, "explicit-env") |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 539 | assert _default.default() == (MOCK_CREDENTIALS, "explicit-env") |
Jon Wayne Parrott | ce37cba | 2016-11-07 16:41:42 -0800 | [diff] [blame] | 540 | |
| 541 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 542 | @mock.patch("logging.Logger.warning", autospec=True) |
Jon Wayne Parrott | ce37cba | 2016-11-07 16:41:42 -0800 | [diff] [blame] | 543 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 544 | "google.auth._default._get_explicit_environ_credentials", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 545 | return_value=(MOCK_CREDENTIALS, None), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 546 | autospec=True, |
| 547 | ) |
Jacob Hayes | 15af07b | 2017-12-13 14:09:47 -0600 | [diff] [blame] | 548 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 549 | "google.auth._default._get_gcloud_sdk_credentials", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 550 | return_value=(MOCK_CREDENTIALS, None), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 551 | autospec=True, |
| 552 | ) |
Jacob Hayes | 15af07b | 2017-12-13 14:09:47 -0600 | [diff] [blame] | 553 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 554 | "google.auth._default._get_gae_credentials", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 555 | return_value=(MOCK_CREDENTIALS, None), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 556 | autospec=True, |
| 557 | ) |
Jacob Hayes | 15af07b | 2017-12-13 14:09:47 -0600 | [diff] [blame] | 558 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 559 | "google.auth._default._get_gce_credentials", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 560 | return_value=(MOCK_CREDENTIALS, None), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 561 | autospec=True, |
| 562 | ) |
Jacob Hayes | 15af07b | 2017-12-13 14:09:47 -0600 | [diff] [blame] | 563 | def test_default_without_project_id( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 564 | unused_gce, unused_gae, unused_sdk, unused_explicit, logger_warning |
| 565 | ): |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 566 | assert _default.default() == (MOCK_CREDENTIALS, None) |
Jacob Hayes | 15af07b | 2017-12-13 14:09:47 -0600 | [diff] [blame] | 567 | logger_warning.assert_called_with(mock.ANY, mock.ANY, mock.ANY) |
| 568 | |
| 569 | |
| 570 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 571 | "google.auth._default._get_explicit_environ_credentials", |
| 572 | return_value=(None, None), |
| 573 | autospec=True, |
| 574 | ) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 575 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 576 | "google.auth._default._get_gcloud_sdk_credentials", |
| 577 | return_value=(None, None), |
| 578 | autospec=True, |
| 579 | ) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 580 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 581 | "google.auth._default._get_gae_credentials", |
| 582 | return_value=(None, None), |
| 583 | autospec=True, |
| 584 | ) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 585 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 586 | "google.auth._default._get_gce_credentials", |
| 587 | return_value=(None, None), |
| 588 | autospec=True, |
| 589 | ) |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 590 | def test_default_fail(unused_gce, unused_gae, unused_sdk, unused_explicit): |
| 591 | with pytest.raises(exceptions.DefaultCredentialsError): |
| 592 | assert _default.default() |
Jon Wayne Parrott | 8a7e506 | 2016-11-07 16:45:17 -0800 | [diff] [blame] | 593 | |
| 594 | |
| 595 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 596 | "google.auth._default._get_explicit_environ_credentials", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 597 | return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 598 | autospec=True, |
| 599 | ) |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 600 | @mock.patch( |
| 601 | "google.auth.credentials.with_scopes_if_required", |
| 602 | return_value=MOCK_CREDENTIALS, |
| 603 | autospec=True, |
| 604 | ) |
Jacob Hayes | 15af07b | 2017-12-13 14:09:47 -0600 | [diff] [blame] | 605 | def test_default_scoped(with_scopes, unused_get): |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 606 | scopes = ["one", "two"] |
Jon Wayne Parrott | 8a7e506 | 2016-11-07 16:45:17 -0800 | [diff] [blame] | 607 | |
| 608 | credentials, project_id = _default.default(scopes=scopes) |
| 609 | |
Jon Wayne Parrott | 78fec2c | 2017-06-30 10:25:08 -0700 | [diff] [blame] | 610 | assert credentials == with_scopes.return_value |
Jon Wayne Parrott | 8a7e506 | 2016-11-07 16:45:17 -0800 | [diff] [blame] | 611 | assert project_id == mock.sentinel.project_id |
Bu Sun Kim | bf5ce0c | 2021-02-01 15:17:49 -0700 | [diff] [blame] | 612 | with_scopes.assert_called_once_with(MOCK_CREDENTIALS, scopes, default_scopes=None) |
James Wilson | 6e0781b | 2018-12-20 20:38:52 -0500 | [diff] [blame] | 613 | |
| 614 | |
| 615 | @mock.patch( |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 616 | "google.auth._default._get_explicit_environ_credentials", |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 617 | return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id), |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 618 | autospec=True, |
| 619 | ) |
Bu Sun Kim | ab2be5d | 2020-07-15 16:49:27 -0700 | [diff] [blame] | 620 | def test_default_quota_project(with_quota_project): |
| 621 | credentials, project_id = _default.default(quota_project_id="project-foo") |
| 622 | |
| 623 | MOCK_CREDENTIALS.with_quota_project.assert_called_once_with("project-foo") |
| 624 | assert project_id == mock.sentinel.project_id |
| 625 | |
| 626 | |
| 627 | @mock.patch( |
| 628 | "google.auth._default._get_explicit_environ_credentials", |
| 629 | return_value=(MOCK_CREDENTIALS, mock.sentinel.project_id), |
| 630 | autospec=True, |
| 631 | ) |
James Wilson | 6e0781b | 2018-12-20 20:38:52 -0500 | [diff] [blame] | 632 | def test_default_no_app_engine_compute_engine_module(unused_get): |
| 633 | """ |
| 634 | google.auth.compute_engine and google.auth.app_engine are both optional |
| 635 | to allow not including them when using this package. This verifies |
| 636 | that default fails gracefully if these modules are absent |
| 637 | """ |
| 638 | import sys |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 639 | |
| 640 | with mock.patch.dict("sys.modules"): |
| 641 | sys.modules["google.auth.compute_engine"] = None |
| 642 | sys.modules["google.auth.app_engine"] = None |
Bu Sun Kim | 3dda7b2 | 2020-07-09 10:39:39 -0700 | [diff] [blame] | 643 | assert _default.default() == (MOCK_CREDENTIALS, mock.sentinel.project_id) |
bojeil-google | d4d7f38 | 2021-02-16 12:33:20 -0800 | [diff] [blame] | 644 | |
| 645 | |
| 646 | @EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH |
| 647 | def test_default_environ_external_credentials(get_project_id, monkeypatch, tmpdir): |
| 648 | config_file = tmpdir.join("config.json") |
| 649 | config_file.write(json.dumps(IDENTITY_POOL_DATA)) |
| 650 | monkeypatch.setenv(environment_vars.CREDENTIALS, str(config_file)) |
| 651 | |
| 652 | credentials, project_id = _default.default() |
| 653 | |
| 654 | assert isinstance(credentials, identity_pool.Credentials) |
| 655 | # Without scopes, project ID cannot be determined. |
| 656 | assert project_id is None |
| 657 | |
| 658 | |
| 659 | @EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH |
| 660 | def test_default_environ_external_credentials_with_user_and_default_scopes_and_quota_project_id( |
| 661 | get_project_id, monkeypatch, tmpdir |
| 662 | ): |
| 663 | config_file = tmpdir.join("config.json") |
| 664 | config_file.write(json.dumps(IDENTITY_POOL_DATA)) |
| 665 | monkeypatch.setenv(environment_vars.CREDENTIALS, str(config_file)) |
| 666 | |
| 667 | credentials, project_id = _default.default( |
| 668 | scopes=["https://www.google.com/calendar/feeds"], |
| 669 | default_scopes=["https://www.googleapis.com/auth/cloud-platform"], |
| 670 | quota_project_id="project-foo", |
| 671 | ) |
| 672 | |
| 673 | assert isinstance(credentials, identity_pool.Credentials) |
| 674 | assert project_id is mock.sentinel.project_id |
| 675 | assert credentials.quota_project_id == "project-foo" |
| 676 | assert credentials.scopes == ["https://www.google.com/calendar/feeds"] |
| 677 | assert credentials.default_scopes == [ |
| 678 | "https://www.googleapis.com/auth/cloud-platform" |
| 679 | ] |
| 680 | |
| 681 | |
| 682 | @EXTERNAL_ACCOUNT_GET_PROJECT_ID_PATCH |
| 683 | def test_default_environ_external_credentials_explicit_request_with_scopes( |
| 684 | get_project_id, monkeypatch, tmpdir |
| 685 | ): |
| 686 | config_file = tmpdir.join("config.json") |
| 687 | config_file.write(json.dumps(IDENTITY_POOL_DATA)) |
| 688 | monkeypatch.setenv(environment_vars.CREDENTIALS, str(config_file)) |
| 689 | |
| 690 | credentials, project_id = _default.default( |
| 691 | request=mock.sentinel.request, |
| 692 | scopes=["https://www.googleapis.com/auth/cloud-platform"], |
| 693 | ) |
| 694 | |
| 695 | assert isinstance(credentials, identity_pool.Credentials) |
| 696 | assert project_id is mock.sentinel.project_id |
| 697 | # default() will initialize new credentials via with_scopes_if_required |
| 698 | # and potentially with_quota_project. |
| 699 | # As a result the caller of get_project_id() will not match the returned |
| 700 | # credentials. |
| 701 | get_project_id.assert_called_with(mock.ANY, request=mock.sentinel.request) |
| 702 | |
| 703 | |
| 704 | def test_default_environ_external_credentials_bad_format(monkeypatch, tmpdir): |
| 705 | filename = tmpdir.join("external_account_bad.json") |
| 706 | filename.write(json.dumps({"type": "external_account"})) |
| 707 | monkeypatch.setenv(environment_vars.CREDENTIALS, str(filename)) |
| 708 | |
| 709 | with pytest.raises(exceptions.DefaultCredentialsError) as excinfo: |
| 710 | _default.default() |
| 711 | |
| 712 | assert excinfo.match( |
| 713 | "Failed to load external account credentials from {}".format(str(filename)) |
| 714 | ) |