mirror of
https://github.com/ansible-collections/community.docker.git
synced 2026-09-13 11:24:31 +00:00
Add docker_image_pull module (#728)
* Add docker_image_pull module. * Support platform during idempotency check. * Add diff mode, extend tests. * Add image ID tests.
This commit is contained in:
Felix Fontein
GitHub
@@ -0,0 +1,198 @@
|
||||
---
|
||||
# Copyright (c) Ansible Project
|
||||
# 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
|
||||
|
||||
- name: Basic pull tests
|
||||
vars:
|
||||
image_name: "{{ docker_test_image_hello_world_platform }}"
|
||||
block:
|
||||
- name: Make sure image is not there
|
||||
docker_image:
|
||||
name: "{{ image_name }}"
|
||||
state: absent
|
||||
force_absent: true
|
||||
|
||||
- name: Pull image (check mode)
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: amd64
|
||||
register: present_1_check
|
||||
check_mode: true
|
||||
|
||||
- debug:
|
||||
var: present_1_check.diff
|
||||
|
||||
- name: Pull image
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: amd64
|
||||
register: present_1
|
||||
|
||||
- debug:
|
||||
var: present_1.diff
|
||||
|
||||
- name: Pull image (idempotent 1, check mode)
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: amd64
|
||||
pull: always
|
||||
register: present_2_check
|
||||
check_mode: true
|
||||
|
||||
- debug:
|
||||
var: present_2_check.diff
|
||||
|
||||
- name: Pull image (idempotent 1)
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: amd64
|
||||
pull: always
|
||||
register: present_2
|
||||
|
||||
- debug:
|
||||
var: present_2.diff
|
||||
|
||||
- name: Pull image (change, check mode)
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: arm64
|
||||
pull: always
|
||||
register: present_3_check
|
||||
check_mode: true
|
||||
|
||||
- debug:
|
||||
var: present_3_check.diff
|
||||
|
||||
- name: Pull image (change)
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: arm64
|
||||
pull: always
|
||||
register: present_3
|
||||
|
||||
- debug:
|
||||
var: present_3.diff
|
||||
|
||||
- name: Pull image (idempotent 2, check mode)
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: arm64
|
||||
pull: not_present
|
||||
register: present_4_check
|
||||
check_mode: true
|
||||
|
||||
- debug:
|
||||
var: present_4_check.diff
|
||||
|
||||
- name: Pull image (idempotent 2)
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: arm64
|
||||
pull: not_present
|
||||
register: present_4
|
||||
|
||||
- debug:
|
||||
var: present_4.diff
|
||||
|
||||
- name: Pull image (change, check mode)
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: amd64
|
||||
pull: not_present
|
||||
register: present_5_check
|
||||
check_mode: true
|
||||
|
||||
- debug:
|
||||
var: present_5_check.diff
|
||||
|
||||
- name: Pull image (change)
|
||||
docker_image_pull:
|
||||
name: "{{ image_name }}"
|
||||
platform: amd64
|
||||
pull: not_present
|
||||
register: present_5
|
||||
|
||||
- debug:
|
||||
var: present_5.diff
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- present_1_check is changed
|
||||
- present_1_check.actions | length == 1
|
||||
- present_1_check.actions[0] == 'Pulled image ' ~ image_name
|
||||
- present_1_check.diff.before.exists is false
|
||||
- present_1_check.diff.after.id == 'unknown'
|
||||
- present_1 is changed
|
||||
- present_1.actions | length == 1
|
||||
- present_1.actions[0] == 'Pulled image ' ~ image_name
|
||||
- present_1.diff.before.exists is false
|
||||
- present_1.diff.after.id is string
|
||||
- present_2_check is changed
|
||||
- present_2_check.actions | length == 1
|
||||
- present_2_check.actions[0] == 'Pulled image ' ~ image_name
|
||||
- present_2_check.diff.before.id == present_1.diff.after.id
|
||||
- present_2_check.diff.after.id == 'unknown'
|
||||
- present_2 is not changed
|
||||
- present_2.actions | length == 1
|
||||
- present_2.actions[0] == 'Pulled image ' ~ image_name
|
||||
- present_2.diff.before.id == present_1.diff.after.id
|
||||
- present_2.diff.after.id == present_1.diff.after.id
|
||||
- present_3_check is changed
|
||||
- present_3_check.actions | length == 1
|
||||
- present_3_check.actions[0] == 'Pulled image ' ~ image_name
|
||||
- present_3_check.diff.before.id == present_1.diff.after.id
|
||||
- present_3_check.diff.after.id == 'unknown'
|
||||
- present_3 is changed
|
||||
- present_3.actions | length == 1
|
||||
- present_3.actions[0] == 'Pulled image ' ~ image_name
|
||||
- present_3.diff.before.id == present_1.diff.after.id
|
||||
- present_3.diff.after.id != present_1.diff.after.id
|
||||
- present_3.diff.after.id is string
|
||||
- present_4_check is not changed
|
||||
- present_4_check.actions | length == 0
|
||||
- present_4_check.diff.before.id == present_3.diff.after.id
|
||||
- present_4_check.diff.after.id == present_3.diff.after.id
|
||||
- present_4 is not changed
|
||||
- present_4.actions | length == 0
|
||||
- present_4.diff.before.id == present_3.diff.after.id
|
||||
- present_4.diff.after.id == present_3.diff.after.id
|
||||
- present_5_check is changed
|
||||
- present_5_check.actions | length == 1
|
||||
- present_5_check.actions[0] == 'Pulled image ' ~ image_name
|
||||
- present_5_check.diff.before.id == present_3.diff.after.id
|
||||
- present_5_check.diff.after.id == 'unknown'
|
||||
- present_5 is changed
|
||||
- present_5.actions | length == 1
|
||||
- present_5.actions[0] == 'Pulled image ' ~ image_name
|
||||
- present_5.diff.before.id == present_3.diff.after.id
|
||||
- present_5.diff.after.id == present_1.diff.after.id
|
||||
|
||||
always:
|
||||
- name: cleanup
|
||||
docker_image:
|
||||
name: "{{ image_name }}"
|
||||
state: absent
|
||||
force_absent: true
|
||||
|
||||
- name: Pull image ID (must fail)
|
||||
docker_image_pull:
|
||||
name: "{{ present_1.image.Id }}"
|
||||
register: fail_1
|
||||
ignore_errors: true
|
||||
|
||||
- name: Pull invalid tag (must fail)
|
||||
docker_image_pull:
|
||||
name: "{{ docker_test_image_hello_world }}"
|
||||
tag: foo/bar
|
||||
register: fail_2
|
||||
ignore_errors: true
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- fail_1 is failed
|
||||
- >-
|
||||
'Cannot pull an image by ID' == fail_1.msg
|
||||
- fail_2 is failed
|
||||
- >-
|
||||
'"foo/bar" is not a valid docker tag!' == fail_2.msg
|
||||
@@ -0,0 +1,91 @@
|
||||
---
|
||||
# Copyright (c) Ansible Project
|
||||
# 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
|
||||
|
||||
- name: Image ID pull tests
|
||||
block:
|
||||
- name: Make sure images are not there
|
||||
docker_image:
|
||||
name: "{{ item }}"
|
||||
state: absent
|
||||
force_absent: true
|
||||
loop:
|
||||
- "sha256:{{ docker_test_image_digest_v1_image_id }}"
|
||||
- "sha256:{{ docker_test_image_digest_v2_image_id }}"
|
||||
|
||||
- name: Pull image 1
|
||||
docker_image_pull:
|
||||
name: "{{ docker_test_image_digest_base }}@sha256:{{ docker_test_image_digest_v1 }}"
|
||||
register: present_1
|
||||
diff: true
|
||||
|
||||
- name: Pull image 1 (idempotent, do pull)
|
||||
docker_image_pull:
|
||||
name: "{{ docker_test_image_digest_base }}@sha256:{{ docker_test_image_digest_v1 }}"
|
||||
pull: always
|
||||
register: present_2
|
||||
diff: true
|
||||
|
||||
- name: Pull image 1 (idempotent, do not pull)
|
||||
docker_image_pull:
|
||||
name: "{{ docker_test_image_digest_base }}@sha256:{{ docker_test_image_digest_v1 }}"
|
||||
pull: not_present
|
||||
register: present_3
|
||||
diff: true
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- present_1 is changed
|
||||
- present_1.actions | length == 1
|
||||
- present_1.actions[0] == 'Pulled image ' ~ docker_test_image_digest_base ~ ':sha256:' ~ docker_test_image_digest_v1
|
||||
- present_1.diff.before.exists is false
|
||||
- present_1.diff.after.id is string
|
||||
- present_2 is not changed
|
||||
- present_2.actions | length == 1
|
||||
- present_2.actions[0] == 'Pulled image ' ~ docker_test_image_digest_base ~ ':sha256:' ~ docker_test_image_digest_v1
|
||||
- present_2.diff.before.id == present_1.diff.after.id
|
||||
- present_2.diff.after.id == present_1.diff.after.id
|
||||
- present_3 is not changed
|
||||
- present_3.actions | length == 0
|
||||
- present_3.diff.before.id == present_1.diff.after.id
|
||||
- present_3.diff.after.id == present_1.diff.after.id
|
||||
|
||||
- name: Pull image 2 (check mode)
|
||||
docker_image_pull:
|
||||
name: "{{ docker_test_image_digest_base }}@sha256:{{ docker_test_image_digest_v2 }}"
|
||||
pull: always
|
||||
register: present_4
|
||||
diff: true
|
||||
check_mode: true
|
||||
|
||||
- name: Pull image 2
|
||||
docker_image_pull:
|
||||
name: "{{ docker_test_image_digest_base }}@sha256:{{ docker_test_image_digest_v2 }}"
|
||||
pull: always
|
||||
register: present_5
|
||||
diff: true
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- present_4 is changed
|
||||
- present_4.actions | length == 1
|
||||
- present_4.actions[0] == 'Pulled image ' ~ docker_test_image_digest_base ~ ':sha256:' ~ docker_test_image_digest_v2
|
||||
- present_4.diff.before.exists is false
|
||||
- present_4.diff.after.id == 'unknown'
|
||||
- present_5 is changed
|
||||
- present_5.actions | length == 1
|
||||
- present_5.actions[0] == 'Pulled image ' ~ docker_test_image_digest_base ~ ':sha256:' ~ docker_test_image_digest_v2
|
||||
- present_5.diff.before.exists is false
|
||||
- present_5.diff.after.id != present_1.diff.after.id
|
||||
- present_5.diff.after.id is string
|
||||
|
||||
always:
|
||||
- name: cleanup
|
||||
docker_image:
|
||||
name: "{{ item }}"
|
||||
state: absent
|
||||
force_absent: true
|
||||
loop:
|
||||
- "sha256:{{ docker_test_image_digest_v1_image_id }}"
|
||||
- "sha256:{{ docker_test_image_digest_v2_image_id }}"
|
||||
@@ -0,0 +1,125 @@
|
||||
---
|
||||
# Copyright (c) Ansible Project
|
||||
# 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
|
||||
|
||||
- name: Run registry tests only when registry is present
|
||||
when: registry_address is defined
|
||||
block:
|
||||
- name: Registering image name
|
||||
set_fact:
|
||||
iname: "{{ name_prefix ~ '-options' }}"
|
||||
|
||||
- name: Determining pushed image names
|
||||
set_fact:
|
||||
hello_world_image_base: "{{ registry_address }}/test/hello-world"
|
||||
|
||||
- name: Registering image name
|
||||
set_fact:
|
||||
inames: "{{ inames + [iname, hello_world_image_base ~ ':latest'] }}"
|
||||
|
||||
- name: Make sure image is not there
|
||||
docker_image:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
state: absent
|
||||
force_absent: true
|
||||
|
||||
- name: Make sure we have {{ docker_test_image_hello_world }}
|
||||
docker_image_pull:
|
||||
name: "{{ docker_test_image_hello_world }}"
|
||||
diff: true
|
||||
|
||||
- name: Push image to test registry
|
||||
docker_image:
|
||||
name: "{{ docker_test_image_hello_world }}"
|
||||
repository: "{{ hello_world_image_base }}:latest"
|
||||
push: true
|
||||
source: local
|
||||
|
||||
- name: Get facts of local image
|
||||
docker_image_info:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
register: facts_1
|
||||
|
||||
- name: Make sure image is not there
|
||||
docker_image:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
state: absent
|
||||
force_absent: true
|
||||
|
||||
- name: Get facts of local image (not there)
|
||||
docker_image_info:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
register: facts_2
|
||||
|
||||
- name: Pull image from test registry (check mode)
|
||||
docker_image_pull:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
register: pull_1_check
|
||||
diff: true
|
||||
check_mode: true
|
||||
|
||||
- name: Pull image from test registry
|
||||
docker_image_pull:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
register: pull_1
|
||||
diff: true
|
||||
|
||||
- name: Pull image from test registry (idempotency, not pulling, check mode)
|
||||
docker_image_pull:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
pull: not_present
|
||||
register: pull_2_check
|
||||
diff: true
|
||||
check_mode: true
|
||||
|
||||
- name: Pull image from test registry (idempotency, not pulling)
|
||||
docker_image_pull:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
pull: not_present
|
||||
register: pull_2
|
||||
diff: true
|
||||
|
||||
- name: Pull image from test registry (idempotency, pulling, check mode)
|
||||
docker_image_pull:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
pull: always
|
||||
register: pull_3_check
|
||||
diff: true
|
||||
check_mode: true
|
||||
|
||||
- name: Pull image from test registry (idempotency, pulling)
|
||||
docker_image_pull:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
pull: always
|
||||
register: pull_3
|
||||
diff: true
|
||||
|
||||
- name: Get facts of local image (present)
|
||||
docker_image_info:
|
||||
name: "{{ hello_world_image_base }}:latest"
|
||||
register: facts_3
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- pull_1_check is changed
|
||||
- pull_1_check.diff.before.exists is false
|
||||
- pull_1_check.diff.after.id == 'unknown'
|
||||
- pull_1 is changed
|
||||
- pull_1.diff.before.exists is false
|
||||
- pull_1.diff.after.id == facts_1.images[0].Id
|
||||
- pull_2_check is not changed
|
||||
- pull_2_check.diff.before.id == facts_1.images[0].Id
|
||||
- pull_2_check.diff.before == pull_2.diff.after
|
||||
- pull_2 is not changed
|
||||
- pull_2.diff.before.id == facts_1.images[0].Id
|
||||
- pull_2.diff.before == pull_2.diff.after
|
||||
- pull_3_check is changed
|
||||
- pull_3_check.diff.before.id == facts_1.images[0].Id
|
||||
- pull_3_check.diff.after.id == 'unknown'
|
||||
- pull_3 is not changed
|
||||
- pull_3.diff.before.id == facts_1.images[0].Id
|
||||
- pull_3.diff.before == pull_2.diff.after
|
||||
- facts_1.images | length == 1
|
||||
- facts_2.images | length == 0
|
||||
- facts_3.images | length == 1
|
||||
Reference in New Issue
Block a user