FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix: add request timeout for MDS requests by sai-sunder-s · Pull Request #1699 · googleapis/google-auth-library-python · GitHub

This repository was archived by the owner on Mar 6, 2026. It is now read-only.
/ google-auth-library-python Public archive

fix: add request timeout for MDS requests #1699

Merged
sai-sunder-s merged 4 commits into from
Mar 28, 2025
Conversation 1 Commits 4 Checks 0 Files changed
Merged

fix: add request timeout for MDS requests #1699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
897d983
fix: add request timeout for MDS requests
sai-sunder-s Mar 21, 2025
1107dc0
add seconds
sai-sunder-s Mar 21, 2025
f360bc6
revert secret update
sai-sunder-s Mar 28, 2025
0ec6666
update secret
sai-sunder-s Mar 28, 2025
File filter

Filter by extension

Filter by extension .enc  (1) .py  (2) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
6 changes: 5 additions & 1 deletion google/auth/compute_engine/_metadata.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ def get(
retry_count=5,
headers=None,
return_none_for_not_found_error=False,
timeout=_METADATA_DEFAULT_TIMEOUT,
):
"""Fetch a resource from the metadata server.

Expand All @@ -178,6 +179,7 @@ def get(
headers (Optional[Mapping[str, str]]): Headers for the request.
return_none_for_not_found_error (Optional[bool]): If True, returns None
for 404 error instead of throwing an exception.
timeout (int): How long to wait, in seconds for the metadata server to respond.

Returns:
Union[Mapping, str]: If the metadata server returns JSON, a mapping of
Expand All @@ -204,7 +206,9 @@ def get(
failure_reason = None
for attempt in backoff:
try:
response = request(url=url, method="GET", headers=headers_to_use)
response = request(
url=url, method="GET", headers=headers_to_use, timeout=timeout
)
if response.status in transport.DEFAULT_RETRYABLE_STATUS_CODES:
_LOGGER.warning(
"Compute Engine Metadata server unavailable on "
Expand Down
Binary file modified system_tests/secrets.tar.enc
Show comments
View file
Open in desktop
Binary file not shown.
26 changes: 26 additions & 0 deletions tests/compute_engine/test__metadata.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ def test_get_success_json():
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert result[key] == value

Expand All @@ -192,6 +193,7 @@ def test_get_success_json_content_type_charset():
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert result[key] == value

Expand All @@ -211,6 +213,7 @@ def test_get_success_retry(mock_sleep):
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert request.call_count == 2
assert result[key] == value
Expand All @@ -226,6 +229,7 @@ def test_get_success_text():
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert result == data

Expand All @@ -241,6 +245,7 @@ def test_get_success_params():
method="GET",
url=_metadata._METADATA_ROOT + PATH + "?recursive=true",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert result == data

Expand All @@ -255,6 +260,7 @@ def test_get_success_recursive_and_params():
method="GET",
url=_metadata._METADATA_ROOT + PATH + "?recursive=true",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert result == data

Expand All @@ -269,6 +275,7 @@ def test_get_success_recursive():
method="GET",
url=_metadata._METADATA_ROOT + PATH + "?recursive=true",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert result == data

Expand All @@ -290,6 +297,7 @@ def test_get_success_custom_root_new_variable():
method="GET",
url="http://{}/computeMetadata/v1/{}".format(fake_root, PATH),
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)


Expand All @@ -310,6 +318,7 @@ def test_get_success_custom_root_old_variable():
method="GET",
url="http://{}/computeMetadata/v1/{}".format(fake_root, PATH),
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)


Expand All @@ -326,6 +335,7 @@ def test_get_failure(mock_sleep):
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)


Expand All @@ -338,6 +348,7 @@ def test_get_return_none_for_not_found_error():
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)


Expand All @@ -357,6 +368,7 @@ def test_get_failure_connection_failed(mock_sleep):
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert request.call_count == 5

Expand All @@ -375,6 +387,7 @@ def test_get_too_many_requests_retryable_error_failure():
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert request.call_count == 5

Expand All @@ -391,6 +404,7 @@ def test_get_failure_bad_json():
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)


Expand All @@ -404,6 +418,7 @@ def test_get_project_id():
method="GET",
url=_metadata._METADATA_ROOT + "project/project-id",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert project_id == project

Expand All @@ -419,6 +434,7 @@ def test_get_universe_domain_success():
method="GET",
url=_metadata._METADATA_ROOT + "universe/universe-domain",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert universe_domain == "fake_universe_domain"

Expand All @@ -432,6 +448,7 @@ def test_get_universe_domain_success_empty_response():
method="GET",
url=_metadata._METADATA_ROOT + "universe/universe-domain",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert universe_domain == "googleapis.com"

Expand All @@ -447,6 +464,7 @@ def test_get_universe_domain_not_found():
method="GET",
url=_metadata._METADATA_ROOT + "universe/universe-domain",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert universe_domain == "googleapis.com"

Expand All @@ -467,6 +485,7 @@ def test_get_universe_domain_retryable_error_failure():
method="GET",
url=_metadata._METADATA_ROOT + "universe/universe-domain",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert request.call_count == 5

Expand Down Expand Up @@ -509,11 +528,13 @@ def request(self, *args, **kwargs):
method="GET",
url=_metadata._METADATA_ROOT + "universe/universe-domain",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
request_ok.assert_called_once_with(
method="GET",
url=_metadata._METADATA_ROOT + "universe/universe-domain",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)

assert universe_domain == "fake_universe_domain"
Expand All @@ -533,6 +554,7 @@ def test_get_universe_domain_other_error():
method="GET",
url=_metadata._METADATA_ROOT + "universe/universe-domain",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)


Expand All @@ -557,6 +579,7 @@ def test_get_service_account_token(utcnow, mock_metrics_header_value):
"metadata-flavor": "Google",
"x-goog-api-client": ACCESS_TOKEN_REQUEST_METRICS_HEADER_VALUE,
},
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert token == "token"
assert expiry == utcnow() + datetime.timedelta(seconds=ttl)
Expand All @@ -583,6 +606,7 @@ def test_get_service_account_token_with_scopes_list(utcnow, mock_metrics_header_
"metadata-flavor": "Google",
"x-goog-api-client": ACCESS_TOKEN_REQUEST_METRICS_HEADER_VALUE,
},
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert token == "token"
assert expiry == utcnow() + datetime.timedelta(seconds=ttl)
Expand Down Expand Up @@ -611,6 +635,7 @@ def test_get_service_account_token_with_scopes_string(
"metadata-flavor": "Google",
"x-goog-api-client": ACCESS_TOKEN_REQUEST_METRICS_HEADER_VALUE,
},
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)
assert token == "token"
assert expiry == utcnow() + datetime.timedelta(seconds=ttl)
Expand All @@ -628,6 +653,7 @@ def test_get_service_account_info():
method="GET",
url=_metadata._METADATA_ROOT + PATH + "/?recursive=true",
headers=_metadata._METADATA_HEADERS,
timeout=_metadata._METADATA_DEFAULT_TIMEOUT,
)

assert info[key] == value
Back | FazBrowse Home | New Git URL