Skip to content
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

Jump to bottom

docker_container: fix check mode for container creation #42380

Merged
merged 3 commits into from
Aug 28, 2018
Merged

docker_container: fix check mode for container creation #42380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
df60532
Create copy of HostConfig object before adding it to results.
felixfontein Jul 5, 2018
6c3acc8
Create general sanitize function in docker_common. Using it for all r…
felixfontein Jul 6, 2018
09338f8
Make Python 2.6 compatible.
felixfontein Jul 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 18 additions & 0 deletions lib/ansible/module_utils/docker_common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,24 @@ class APIError(Exception):
pass


def sanitize_result(data):
"""Sanitize data object for return to Ansible.

When the data object contains types such as docker.types.containers.HostConfig,
Ansible will fail when these are returned via exit_json or fail_json.
HostConfig is derived from dict, but its constructor requires additional
arguments. This function sanitizes data structures by recursively converting
everything derived from dict to dict and everything derived from list (and tuple)
to a list.
"""
if isinstance(data, dict):
return dict((k, sanitize_result(v)) for k, v in data.items())
elif isinstance(data, (list, tuple)):
return [sanitize_result(v) for v in data]
else:
return data


class DockerBaseClass(object):

def __init__(self):
Expand Down
6 changes: 3 additions & 3 deletions lib/ansible/modules/cloud/docker/docker_container.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,7 +607,7 @@
import shlex

from ansible.module_utils.basic import human_to_bytes
from ansible.module_utils.docker_common import HAS_DOCKER_PY_2, HAS_DOCKER_PY_3, AnsibleDockerClient, DockerBaseClass
from ansible.module_utils.docker_common import HAS_DOCKER_PY_2, HAS_DOCKER_PY_3, AnsibleDockerClient, DockerBaseClass, sanitize_result
from ansible.module_utils.six import string_types

try:
Expand Down Expand Up @@ -1780,7 +1780,7 @@ def absent(self):
self.container_remove(container.Id)

def fail(self, msg, **kwargs):
self.client.module.fail_json(msg=msg, **kwargs)
self.client.module.fail_json(msg=msg, **sanitize_result(kwargs))

def _output_logs(self, msg):
self.client.module.log(msg=msg)
Expand Down Expand Up @@ -2095,7 +2095,7 @@ def main():
client.module.fail_json(msg="'auto_remove' is not compatible with the 'docker-py' Python package. It requires the newer 'docker' Python package.")

cm = ContainerManager(client)
client.module.exit_json(**cm.results)
client.module.exit_json(**sanitize_result(cm.results))


if __name__ == '__main__':
Expand Down