ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2025-12-16 11:58:43 +00:00
Code Packages Projects Releases Wiki Activity

docker_image_build: work around strange behavior of docker buildx build when --output is provided (#1006)

Browse Source 
* Work around strange behavior of docker buildx build when --output is provided.

* Adjust tests.

* Allow to pass multiple image names; correctly quote --output values.

* Return executed command.

* Adjust tests.
This commit is contained in:
Felix Fontein 2024-12-14 21:32:33 +01:00 committed by GitHub
parent 2e7b4e4605
commit 8616e7f6f2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 140 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
changelogs/fragments/1006-docker-image-build-outputs.yml Normal file
View File

@ -0,0 +1,10 @@
bugfixes:
- "docker_image_build - work around bug resp. very unexpected behavior in Docker buildx that overwrites
all image names in ``--output`` parameters if ``--tag`` is provided, which the module did by default
in the past. The module now only supplies ``--tag`` if ``outputs`` is empty. If ``outputs`` has entries,
it will add an additional entry with ``type=image`` if no entry of ``type=image`` contains the image name
specified by the ``name`` and ``tag`` options
(https://github.com/ansible-collections/community.docker/issues/1001, https://github.com/ansible-collections/community.docker/pull/1006)."
minor_changes:
- "docker_image_build - ``outputs[].name`` can now be a list of strings (https://github.com/ansible-collections/community.docker/pull/1006)."
- "docker_image_build - the executed command is now returned in the ``command`` return value in case of success and some errors (https://github.com/ansible-collections/community.docker/pull/1006)."

72
plugins/modules/docker_image_build.py
View File

@ -175,6 +175,11 @@ options:
be created, which can cause the basic idempotency this module offers to not work.
- Providing an empty list to this option is equivalent to not specifying it at all.
The default behavior is a single entry with O(outputs[].type=image).
- B(Note) that since community.docker 4.2.0, an entry for O(name)/O(tag) is added if O(outputs)
has at least one entry and no entry has type O(outputs[].type=image) and includes O(name)/O(tag)
in O(outputs[].name). This is because the module would otherwise pass C(--tag name:image) to
the buildx plugin, which for some reason overwrites all images in O(outputs) by the C(name:image)
provided in O(name)/O(tag).
type: list
elements: dict
version_added: 3.10.0
@ -224,10 +229,12 @@ options:
type: str
name:
description:
- Name under which the image is stored under.
- Name(s) under which the image is stored under.
- If not provided, O(name) and O(tag) will be used.
- Optional for O(outputs[].type=image).
type: str
- This can be a list of strings since community.docker 4.2.0.
type: list
elements: str
push:
description:
- Whether to push the built image to a registry.
@ -268,6 +275,13 @@ image:
returned: success
type: dict
sample: {}
command:
description: The command executed.
returned: success and for some failures
type: list
elements: str
version_added: 4.2.0
'''
import base64
@ -311,6 +325,12 @@ def dict_to_list(dictionary, concat='='):
return ['%s%s%s' % (k, concat, v) for k, v in sorted(dictionary.items())]
def _quote_csv(input):
if input.strip() == input and all(i not in input for i in '",\r\n'):
return input
return '"{0}"'.format(input.replace('"', '""'))
class ImageBuilder(DockerBaseClass):
def __init__(self, client):
super(ImageBuilder, self).__init__()
@ -373,6 +393,31 @@ class ImageBuilder(DockerBaseClass):
if is_image_name_id(self.tag):
self.fail('Image name must not contain a digest, but have a tag')
if self.outputs:
found = False
name_tag = '%s:%s' % (self.name, self.tag)
for output in self.outputs:
if output['type'] == 'image':
if not output['name']:
# Since we no longer pass --tag if --output is provided, we need to set this manually
output['name'] = [name_tag]
if output['name'] and name_tag in output['name']:
found = True
if not found:
self.outputs.append({
'type': 'image',
'name': [name_tag],
'push': False,
})
if LooseVersion(buildx_version) < LooseVersion('0.13.0'):
self.fail(
"The output does not include an image with name {name_tag}, and the Docker"
" buildx plugin has version {version} which only supports one output.".format(
name_tag=name_tag,
version=buildx_version,
),
)
def fail(self, msg, **kwargs):
self.client.fail(msg, **kwargs)
@ -382,6 +427,7 @@ class ImageBuilder(DockerBaseClass):
def add_args(self, args):
environ_update = {}
if not self.outputs:
args.extend(['--tag', '%s:%s' % (self.name, self.tag)])
if self.dockerfile:
args.extend(['--file', os.path.join(self.path, self.dockerfile)])
@ -427,26 +473,27 @@ class ImageBuilder(DockerBaseClass):
args.extend(['--secret', 'id={id},type=env,env={env}'.format(id=secret['id'], env=env_name)])
if self.outputs:
for output in self.outputs:
subargs = []
if output['type'] == 'local':
args.extend(['--output', 'type=local,dest={dest}'.format(dest=output['dest'])])
subargs.extend(['type=local', 'dest={dest}'.format(dest=output['dest'])])
if output['type'] == 'tar':
args.extend(['--output', 'type=tar,dest={dest}'.format(dest=output['dest'])])
subargs.extend(['type=tar', 'dest={dest}'.format(dest=output['dest'])])
if output['type'] == 'oci':
args.extend(['--output', 'type=oci,dest={dest}'.format(dest=output['dest'])])
subargs.extend(['type=oci', 'dest={dest}'.format(dest=output['dest'])])
if output['type'] == 'docker':
subargs = ['type=docker']
subargs.append('type=docker')
if output['dest'] is not None:
subargs.append('dest={dest}'.format(dest=output['dest']))
if output['context'] is not None:
subargs.append('context={context}'.format(context=output['context']))
args.extend(['--output', ','.join(subargs)])
if output['type'] == 'image':
subargs = ['type=image']
subargs.append('type=image')
if output['name'] is not None:
subargs.append('name={name}'.format(name=output['name']))
subargs.append('name={name}'.format(name=','.join(output['name'])))
if output['push']:
subargs.append('push=true')
args.extend(['--output', ','.join(subargs)])
if subargs:
args.extend(['--output', ','.join(_quote_csv(subarg) for subarg in subargs)])
return environ_update
def build_image(self):
@ -468,10 +515,11 @@ class ImageBuilder(DockerBaseClass):
args.extend(['--', self.path])
rc, stdout, stderr = self.client.call_cli(*args, environ_update=environ_update)
if rc != 0:
self.fail('Building %s:%s failed' % (self.name, self.tag), stdout=to_native(stdout), stderr=to_native(stderr))
self.fail('Building %s:%s failed' % (self.name, self.tag), stdout=to_native(stdout), stderr=to_native(stderr), command=args)
results['stdout'] = to_native(stdout)
results['stderr'] = to_native(stderr)
results['image'] = self.client.find_image(self.name, self.tag) or {}
results['command'] = args
return results
@ -520,7 +568,7 @@ def main():
type=dict(type='str', choices=['local', 'tar', 'oci', 'docker', 'image'], required=True),
dest=dict(type='path'),
context=dict(type='str'),
name=dict(type='str'),
name=dict(type='list', elements='str'),
push=dict(type='bool', default=False),
),
required_if=[

17
tests/integration/targets/docker_image_build/tasks/tests/options.yml
View File

@ -243,6 +243,8 @@
## outputs #########################################################
####################################################################
- when: buildx_version is version('0.13.0', '>=')
block:
- name: Make sure the image is not there
docker_image_remove:
name: "{{ iname }}"
@ -261,9 +263,12 @@
outputs:
- type: tar
dest: "{{ remote_tmp_dir }}/container.tar"
ignore_errors: true
register: outputs_1
- name: cleanup (should not be changed)
- when: outputs_1 is not failed
block:
- name: cleanup (should be changed)
docker_image_remove:
name: "{{ iname }}"
register: outputs_1_cleanup
@ -284,6 +289,12 @@
- assert:
that:
- outputs_1 is changed
- outputs_1.image | length == 0
- outputs_1_cleanup is not changed
- outputs_1.image | length > 0
- outputs_1_cleanup is changed
- outputs_1_stat.stat.exists
- when: outputs_1 is failed
assert:
that:
- >-
'ERROR: multiple outputs currently unsupported by the current BuildKit daemon' in outputs_1.stderr

21
tests/unit/plugins/modules/test_docker_image_build.py Normal file
View File

@ -0,0 +1,21 @@
# Copyright 2024 Felix Fontein <felix@fontein.de>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import pytest
from ansible_collections.community.docker.plugins.modules.docker_image_build import _quote_csv
@pytest.mark.parametrize("input, expected", [
('', ''),
(' ', '" "'),
(',', '","'),
('"', '""""'),
('\rhello, "hi" !\n', '"\rhello, ""hi"" !\n"'),
])
def test__quote_csv(input, expected):
assert _quote_csv(input) == expected