Skip to content
This repository was archived by the owner on Mar 6, 2026. It is now read-only.

chore: improve error message in _metadata.py #1652

Merged
harkamaljot merged 7 commits into from
Jan 17, 2025
Merged

chore: improve error message in _metadata.py #1652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
242ffde
improve error message
harkamaljot Dec 12, 2024
afa43bb
log last error response
harkamaljot Jan 15, 2025
8a3b576
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jan 15, 2025
72124b9
update secret
harkamaljot Jan 16, 2025
dde86ee
update test case to make sure failure reason is included
harkamaljot Jan 16, 2025
9f7452b
update test
harkamaljot Jan 16, 2025
f638d84
update secret
harkamaljot Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions google/auth/compute_engine/_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ def get(
url = _helpers.update_query(base_url, query_params)

backoff = ExponentialBackoff(total_attempts=retry_count)

failure_reason = None
for attempt in backoff:
try:
response = request(url=url, method="GET", headers=headers_to_use)
Expand All @@ -213,6 +213,11 @@ def get(
retry_count,
response.status,
)
failure_reason = (
response.data.decode("utf-8")
if hasattr(response.data, "decode")
else response.data
)
continue
else:
break
Expand All @@ -225,10 +230,13 @@ def get(
retry_count,
e,
)
failure_reason = e
else:
raise exceptions.TransportError(
"Failed to retrieve {} from the Google Compute Engine "
"metadata service. Compute Engine Metadata server unavailable".format(url)
"metadata service. Compute Engine Metadata server unavailable due to {}".format(
url, failure_reason
)
)

content = _helpers.from_bytes(response.data)
Expand Down
Binary file modified system_tests/secrets.tar.enc
View file
Open in desktop
Binary file not shown.
24 changes: 22 additions & 2 deletions tests/compute_engine/test__metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,12 +344,32 @@ def test_get_return_none_for_not_found_error():
@mock.patch("time.sleep", return_value=None)
def test_get_failure_connection_failed(mock_sleep):
request = make_request("")
request.side_effect = exceptions.TransportError()
request.side_effect = exceptions.TransportError("failure message")

with pytest.raises(exceptions.TransportError) as excinfo:
_metadata.get(request, PATH)

assert excinfo.match(r"Compute Engine Metadata server unavailable")
assert excinfo.match(
r"Compute Engine Metadata server unavailable due to failure message"
)

request.assert_called_with(
method="GET",
url=_metadata._METADATA_ROOT + PATH,
headers=_metadata._METADATA_HEADERS,
)
assert request.call_count == 5


def test_get_too_many_requests_retryable_error_failure():
request = make_request("too many requests", status=http_client.TOO_MANY_REQUESTS)

with pytest.raises(exceptions.TransportError) as excinfo:
_metadata.get(request, PATH)

assert excinfo.match(
r"Compute Engine Metadata server unavailable due to too many requests"
)

request.assert_called_with(
method="GET",
Expand Down