Skip to content

[PR #1035/511cfe52 backport][stable-3] Improve error handling #1036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 31, 2025
Merged

[PR #1035/511cfe52 backport][stable-3] Improve error handling #1036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions changelogs/fragments/1034-error-msg.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
bugfixes:
- "vendored Docker SDK for Python - do not assume that ``KeyError`` is always for ``ApiVersion`` when querying version fails
(https://github.com/ansible-collections/community.docker/issues/1033, https://github.com/ansible-collections/community.docker/pull/1034)."
11 changes: 9 additions & 2 deletions plugins/module_utils/_api/api/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,15 +202,22 @@ def __init__(self, base_url=None, version=None,

def _retrieve_server_version(self):
try:
return self.version(api_version=False)["ApiVersion"]
version_result = self.version(api_version=False)
except Exception as e:
raise DockerException(
'Error while fetching server API version: {0}'.format(e)
)

try:
return version_result["ApiVersion"]
except KeyError:
raise DockerException(
'Invalid response from docker daemon: key "ApiVersion"'
' is missing.'
)
except Exception as e:
raise DockerException(
'Error while fetching server API version: {0}'.format(e)
'Error while fetching server API version: {0}. Response seems to be broken.'.format(e)
)

def _set_request_timeout(self, kwargs):
Expand Down
Loading