ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

docker_container: make sure to_text() and to_native() are used instead of str() (#642)

Browse source 
* Make sure to_text() and to_native() are used instead of str().

* Add changelog.

* Quoting should stay.
This commit is contained in:
Felix Fontein 2020-07-13 20:59:29 +02:00 committed by GitHub
parent f62b8027e0
commit 8b92e0454d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/642-docker_container-python-2.yml Normal file
View file

@ -0,0 +1,2 @@
bugfixes:
- "docker_container - various error fixes in string handling for Python 2 to avoid crashes when non-ASCII characters are used in strings (https://github.com/ansible-collections/community.general/issues/640)."

71
plugins/modules/cloud/docker/docker_container.py
View file

@ -1104,6 +1104,9 @@ from distutils.version import LooseVersion
from time import sleep from time import sleep
from ansible.module_utils.common.text.formatters import human_to_bytes from ansible.module_utils.common.text.formatters import human_to_bytes
from ansible.module_utils.six import string_types
from ansible.module_utils._text import to_native, to_text
from ansible_collections.community.general.plugins.module_utils.docker.common import ( from ansible_collections.community.general.plugins.module_utils.docker.common import (
AnsibleDockerClient, AnsibleDockerClient,
DifferenceTracker, DifferenceTracker,
@ -1117,7 +1120,6 @@ from ansible_collections.community.general.plugins.module_utils.docker.common im
DOCKER_COMMON_ARGS, DOCKER_COMMON_ARGS,
RequestException, RequestException,
) )
from ansible.module_utils.six import string_types
try: try:
from docker import utils from docker import utils
@ -1311,7 +1313,7 @@ class TaskParameters(DockerBaseClass):
if self.groups: if self.groups:
# In case integers are passed as groups, we need to convert them to # In case integers are passed as groups, we need to convert them to
# strings as docker internally treats them as strings. # strings as docker internally treats them as strings.
self.groups = [str(g) for g in self.groups] self.groups = [to_text(g, errors='surrogate_or_strict') for g in self.groups]
for param_name in REQUIRES_CONVERSION_TO_BYTES: for param_name in REQUIRES_CONVERSION_TO_BYTES:
if client.module.params.get(param_name): if client.module.params.get(param_name):
@ -1343,7 +1345,7 @@ class TaskParameters(DockerBaseClass):
try: try:
self.healthcheck, self.disable_healthcheck = parse_healthcheck(self.healthcheck) self.healthcheck, self.disable_healthcheck = parse_healthcheck(self.healthcheck)
except ValueError as e: except ValueError as e:
self.fail(str(e)) self.fail(to_native(e))
self.exp_links = None self.exp_links = None
self.volume_binds = self._get_volume_binds(self.volumes) self.volume_binds = self._get_volume_binds(self.volumes)
@ -1370,12 +1372,12 @@ class TaskParameters(DockerBaseClass):
if self.entrypoint: if self.entrypoint:
# convert from list to str. # convert from list to str.
self.entrypoint = ' '.join([str(x) for x in self.entrypoint]) self.entrypoint = ' '.join([to_text(x, errors='surrogate_or_strict') for x in self.entrypoint])
if self.command: if self.command:
# convert from list to str # convert from list to str
if isinstance(self.command, list): if isinstance(self.command, list):
self.command = ' '.join([str(x) for x in self.command]) self.command = ' '.join([to_text(x, errors='surrogate_or_strict') for x in self.command])
self.mounts_opt, self.expected_mounts = self._process_mounts() self.mounts_opt, self.expected_mounts = self._process_mounts()
@ -1628,7 +1630,7 @@ class TaskParameters(DockerBaseClass):
binds = {} binds = {}
for port in self.published_ports: for port in self.published_ports:
parts = split_colon_ipv6(str(port), self.client) parts = split_colon_ipv6(to_text(port, errors='surrogate_or_strict'), self.client)
container_port = parts[-1] container_port = parts[-1]
protocol = '' protocol = ''
if '/' in container_port: if '/' in container_port:
@ -1704,7 +1706,7 @@ class TaskParameters(DockerBaseClass):
exposed = [] exposed = []
if self.exposed_ports: if self.exposed_ports:
for port in self.exposed_ports: for port in self.exposed_ports:
port = str(port).strip() port = to_text(port, errors='surrogate_or_strict').strip()
protocol = 'tcp' protocol = 'tcp'
match = re.search(r'(/.+$)', port) match = re.search(r'(/.+$)', port)
if match: if match:
@ -1798,9 +1800,10 @@ class TaskParameters(DockerBaseClass):
if not isinstance(v, string_types): if not isinstance(v, string_types):
self.client.module.warn( self.client.module.warn(
"Non-string value found for log_options option '%s'. The value is automatically converted to '%s'. " "Non-string value found for log_options option '%s'. The value is automatically converted to '%s'. "
"If this is not correct, or you want to avoid such warnings, please quote the value." % (k, str(v)) "If this is not correct, or you want to avoid such warnings, please quote the value." % (
k, to_text(v, errors='surrogate_or_strict'))
) )
v = str(v) v = to_text(v, errors='surrogate_or_strict')
self.log_options[k] = v self.log_options[k] = v
options['Config'][k] = v options['Config'][k] = v
@ -1834,13 +1837,13 @@ class TaskParameters(DockerBaseClass):
if self.env_file: if self.env_file:
parsed_env_file = utils.parse_env_file(self.env_file) parsed_env_file = utils.parse_env_file(self.env_file)
for name, value in parsed_env_file.items(): for name, value in parsed_env_file.items():
final_env[name] = str(value) final_env[name] = to_text(value, errors='surrogate_or_strict')
if self.env: if self.env:
for name, value in self.env.items(): for name, value in self.env.items():
if not isinstance(value, string_types): if not isinstance(value, string_types):
self.fail("Non-string value found for env option. Ambiguous env options must be " self.fail("Non-string value found for env option. Ambiguous env options must be "
"wrapped in quotes to avoid them being interpreted. Key: %s" % (name, )) "wrapped in quotes to avoid them being interpreted. Key: %s" % (name, ))
final_env[name] = str(value) final_env[name] = to_text(value, errors='surrogate_or_strict')
return final_env return final_env
def _get_network_id(self, network_name): def _get_network_id(self, network_name):
@ -1851,7 +1854,7 @@ class TaskParameters(DockerBaseClass):
network_id = network['Id'] network_id = network['Id']
break break
except Exception as exc: except Exception as exc:
self.fail("Error getting network id for %s - %s" % (network_name, str(exc))) self.fail("Error getting network id for %s - %s" % (network_name, to_native(exc)))
return network_id return network_id
def _process_mounts(self): def _process_mounts(self):
@ -2208,7 +2211,7 @@ class Container(DockerBaseClass):
if not minimal_version.get('supported', True): if not minimal_version.get('supported', True):
continue continue
compare = self.parameters.client.comparisons[self.parameters_map.get(key, key)] compare = self.parameters.client.comparisons[self.parameters_map.get(key, key)]
self.log('check differences %s %s vs %s (%s)' % (key, getattr(self.parameters, key), str(value), compare)) self.log('check differences %s %s vs %s (%s)' % (key, getattr(self.parameters, key), to_text(value, errors='surrogate_or_strict'), compare))
if getattr(self.parameters, key, None) is not None: if getattr(self.parameters, key, None) is not None:
match = self._compare(getattr(self.parameters, key), value, compare) match = self._compare(getattr(self.parameters, key), value, compare)
@ -2231,7 +2234,7 @@ class Container(DockerBaseClass):
else: else:
# We sort the list of dictionaries by using the sorted items of a dict as its key. # We sort the list of dictionaries by using the sorted items of a dict as its key.
def sort_key_fn(x): def sort_key_fn(x):
return sorted((a, str(b)) for a, b in x.items()) return sorted((a, to_text(b, errors='surrogate_or_strict')) for a, b in x.items())
if p is not None: if p is not None:
p = sorted(p, key=sort_key_fn) p = sorted(p, key=sort_key_fn)
if c is not None: if c is not None:
@ -2411,9 +2414,9 @@ class Container(DockerBaseClass):
elif isinstance(config[0], tuple): elif isinstance(config[0], tuple):
expected_bound_ports[container_port] = [] expected_bound_ports[container_port] = []
for host_ip, host_port in config: for host_ip, host_port in config:
expected_bound_ports[container_port].append({'HostIp': host_ip, 'HostPort': str(host_port)}) expected_bound_ports[container_port].append({'HostIp': host_ip, 'HostPort': to_text(host_port, errors='surrogate_or_strict')})
else: else:
expected_bound_ports[container_port] = [{'HostIp': config[0], 'HostPort': str(config[1])}] expected_bound_ports[container_port] = [{'HostIp': config[0], 'HostPort': to_text(config[1], errors='surrogate_or_strict')}]
return expected_bound_ports return expected_bound_ports
def _get_expected_links(self): def _get_expected_links(self):
@ -2523,7 +2526,7 @@ class Container(DockerBaseClass):
image_ports = [self._normalize_port(p) for p in image_exposed_ports.keys()] image_ports = [self._normalize_port(p) for p in image_exposed_ports.keys()]
param_ports = [] param_ports = []
if self.parameters.ports: if self.parameters.ports:
param_ports = [str(p[0]) + '/' + p[1] for p in self.parameters.ports] param_ports = [to_text(p[0], errors='surrogate_or_strict') + '/' + p[1] for p in self.parameters.ports]
result = list(set(image_ports + param_ports)) result = list(set(image_ports + param_ports))
self.log(result, pretty_print=True) self.log(result, pretty_print=True)
return result return result
@ -2547,7 +2550,7 @@ class Container(DockerBaseClass):
return None return None
result = dict() result = dict()
for key, value in config_sysctls.items(): for key, value in config_sysctls.items():
result[key] = str(value) result[key] = to_text(value, errors='surrogate_or_strict')
return result return result
def _get_expected_cmd(self): def _get_expected_cmd(self):
@ -2739,7 +2742,7 @@ class ContainerManager(DockerBaseClass):
self.client.unpause(container=container.Id) self.client.unpause(container=container.Id)
except Exception as exc: except Exception as exc:
self.fail("Error %s container %s: %s" % ( self.fail("Error %s container %s: %s" % (
"pausing" if self.parameters.paused else "unpausing", container.Id, str(exc) "pausing" if self.parameters.paused else "unpausing", container.Id, to_native(exc)
)) ))
container = self._get_container(container.Id) container = self._get_container(container.Id)
self.results['changed'] = True self.results['changed'] = True
@ -2861,7 +2864,7 @@ class ContainerManager(DockerBaseClass):
self.client.disconnect_container_from_network(container.Id, diff['parameter']['id']) self.client.disconnect_container_from_network(container.Id, diff['parameter']['id'])
except Exception as exc: except Exception as exc:
self.fail("Error disconnecting container from network %s - %s" % (diff['parameter']['name'], self.fail("Error disconnecting container from network %s - %s" % (diff['parameter']['name'],
str(exc))) to_native(exc)))
# connect to the network # connect to the network
params = dict() params = dict()
for para in ('ipv4_address', 'ipv6_address', 'links', 'aliases'): for para in ('ipv4_address', 'ipv6_address', 'links', 'aliases'):
@ -2874,7 +2877,7 @@ class ContainerManager(DockerBaseClass):
self.log(params, pretty_print=True) self.log(params, pretty_print=True)
self.client.connect_container_to_network(container.Id, diff['parameter']['id'], **params) self.client.connect_container_to_network(container.Id, diff['parameter']['id'], **params)
except Exception as exc: except Exception as exc:
self.fail("Error connecting container to network %s - %s" % (diff['parameter']['name'], str(exc))) self.fail("Error connecting container to network %s - %s" % (diff['parameter']['name'], to_native(exc)))
return self._get_container(container.Id) return self._get_container(container.Id)
def _purge_networks(self, container, networks): def _purge_networks(self, container, networks):
@ -2885,7 +2888,7 @@ class ContainerManager(DockerBaseClass):
self.client.disconnect_container_from_network(container.Id, network['name']) self.client.disconnect_container_from_network(container.Id, network['name'])
except Exception as exc: except Exception as exc:
self.fail("Error disconnecting container from network %s - %s" % (network['name'], self.fail("Error disconnecting container from network %s - %s" % (network['name'],
str(exc))) to_native(exc)))
return self._get_container(container.Id) return self._get_container(container.Id)
def container_create(self, image, create_parameters): def container_create(self, image, create_parameters):
@ -2900,7 +2903,7 @@ class ContainerManager(DockerBaseClass):
new_container = self.client.create_container(image, **create_parameters) new_container = self.client.create_container(image, **create_parameters)
self.client.report_warnings(new_container) self.client.report_warnings(new_container)
except Exception as exc: except Exception as exc:
self.fail("Error creating container: %s" % str(exc)) self.fail("Error creating container: %s" % to_native(exc))
return self._get_container(new_container['Id']) return self._get_container(new_container['Id'])
return new_container return new_container
@ -2912,7 +2915,7 @@ class ContainerManager(DockerBaseClass):
try: try:
self.client.start(container=container_id) self.client.start(container=container_id)
except Exception as exc: except Exception as exc:
self.fail("Error starting container %s: %s" % (container_id, str(exc))) self.fail("Error starting container %s: %s" % (container_id, to_native(exc)))
if self.parameters.detach is False: if self.parameters.detach is False:
if self.client.docker_py_version >= LooseVersion('3.0'): if self.client.docker_py_version >= LooseVersion('3.0'):
@ -2964,21 +2967,21 @@ class ContainerManager(DockerBaseClass):
# New docker daemon versions do not allow containers to be removed # New docker daemon versions do not allow containers to be removed
# if they are paused. Make sure we don't end up in an infinite loop. # if they are paused. Make sure we don't end up in an infinite loop.
if count == 3: if count == 3:
self.fail("Error removing container %s (tried to unpause three times): %s" % (container_id, str(exc))) self.fail("Error removing container %s (tried to unpause three times): %s" % (container_id, to_native(exc)))
count += 1 count += 1
# Unpause # Unpause
try: try:
self.client.unpause(container=container_id) self.client.unpause(container=container_id)
except Exception as exc2: except Exception as exc2:
self.fail("Error unpausing container %s for removal: %s" % (container_id, str(exc2))) self.fail("Error unpausing container %s for removal: %s" % (container_id, to_native(exc2)))
# Now try again # Now try again
continue continue
if 'removal of container ' in exc.explanation and ' is already in progress' in exc.explanation: if 'removal of container ' in exc.explanation and ' is already in progress' in exc.explanation:
pass pass
else: else:
self.fail("Error removing container %s: %s" % (container_id, str(exc))) self.fail("Error removing container %s: %s" % (container_id, to_native(exc)))
except Exception as exc: except Exception as exc:
self.fail("Error removing container %s: %s" % (container_id, str(exc))) self.fail("Error removing container %s: %s" % (container_id, to_native(exc)))
# We only loop when explicitly requested by 'continue' # We only loop when explicitly requested by 'continue'
break break
return response return response
@ -2994,7 +2997,7 @@ class ContainerManager(DockerBaseClass):
result = self.client.update_container(container_id, **update_parameters) result = self.client.update_container(container_id, **update_parameters)
self.client.report_warnings(result) self.client.report_warnings(result)
except Exception as exc: except Exception as exc:
self.fail("Error updating container %s: %s" % (container_id, str(exc))) self.fail("Error updating container %s: %s" % (container_id, to_native(exc)))
return self._get_container(container_id) return self._get_container(container_id)
def container_kill(self, container_id): def container_kill(self, container_id):
@ -3021,7 +3024,7 @@ class ContainerManager(DockerBaseClass):
else: else:
dummy = self.client.restart(container_id) dummy = self.client.restart(container_id)
except Exception as exc: except Exception as exc:
self.fail("Error restarting container %s: %s" % (container_id, str(exc))) self.fail("Error restarting container %s: %s" % (container_id, to_native(exc)))
return self._get_container(container_id) return self._get_container(container_id)
def container_stop(self, container_id): def container_stop(self, container_id):
@ -3044,18 +3047,18 @@ class ContainerManager(DockerBaseClass):
# New docker daemon versions do not allow containers to be removed # New docker daemon versions do not allow containers to be removed
# if they are paused. Make sure we don't end up in an infinite loop. # if they are paused. Make sure we don't end up in an infinite loop.
if count == 3: if count == 3:
self.fail("Error removing container %s (tried to unpause three times): %s" % (container_id, str(exc))) self.fail("Error removing container %s (tried to unpause three times): %s" % (container_id, to_native(exc)))
count += 1 count += 1
# Unpause # Unpause
try: try:
self.client.unpause(container=container_id) self.client.unpause(container=container_id)
except Exception as exc2: except Exception as exc2:
self.fail("Error unpausing container %s for removal: %s" % (container_id, str(exc2))) self.fail("Error unpausing container %s for removal: %s" % (container_id, to_native(exc2)))
# Now try again # Now try again
continue continue
self.fail("Error stopping container %s: %s" % (container_id, str(exc))) self.fail("Error stopping container %s: %s" % (container_id, to_native(exc)))
except Exception as exc: except Exception as exc:
self.fail("Error stopping container %s: %s" % (container_id, str(exc))) self.fail("Error stopping container %s: %s" % (container_id, to_native(exc)))
# We only loop when explicitly requested by 'continue' # We only loop when explicitly requested by 'continue'
break break
return response return response