Add docker_compose_v2 module (#739)

* Add docker_compose_v2 module.

* Add note on compatibility.

* Parse more events.

Emit warnings (or things we assume are warnings), and report unparsable
messages to the user so they can report them to us.
This commit is contained in:
Felix Fontein
2024-01-03 08:05:08 +01:00
committed by GitHub
parent 762ce3e1cf
commit b774837183
26 changed files with 1264 additions and 2 deletions
@@ -0,0 +1,6 @@
# 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
azp/4
destructive
@@ -0,0 +1,10 @@
---
# 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
dependencies:
- setup_docker_cli_compose
# The Python dependencies are needed for the other modules
- setup_docker_python_deps
- setup_remote_tmp_dir
@@ -0,0 +1,48 @@
---
# 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
####################################################################
# WARNING: These are designed specifically for Ansible tests #
# and should not be used as examples of how to write Ansible roles #
####################################################################
# Create random name prefix (for services, ...)
- name: Create random container name prefix
set_fact:
name_prefix: "{{ 'ansible-docker-test-%0x' % ((2**32) | random) }}"
cnames: []
dnetworks: []
- debug:
msg: "Using name prefix {{ name_prefix }}"
# Run the tests
- block:
- command: docker compose --help
- include_tasks: run-test.yml
with_fileglob:
- "tests/*.yml"
loop_control:
loop_var: test_name
always:
- name: "Make sure all containers are removed"
docker_container:
name: "{{ item }}"
state: absent
force_kill: true
with_items: "{{ cnames }}"
diff: false
- name: "Make sure all networks are removed"
docker_network:
name: "{{ item }}"
state: absent
force: true
with_items: "{{ dnetworks }}"
diff: false
when: docker_has_compose and docker_compose_version is version('2.18.0', '>=')
@@ -0,0 +1,7 @@
---
# 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: "Loading tasks from {{ test_name }}"
include_tasks: "{{ test_name }}"
@@ -0,0 +1,265 @@
---
# 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: Set up project and container names
set_fact:
pname: "{{ name_prefix }}"
cname: "{{ name_prefix ~ '-hi' }}"
- name: Registering container name
set_fact:
cnames: "{{ cnames + [pname ~ '-' ~ cname ~ '-1'] }}"
dnetworks: "{{ dnetworks + [pname ~ '_default'] }}"
- name: Define services
set_fact:
project_src: "{{ remote_tmp_dir }}/{{ pname }}"
test_service: |
version: '3'
services:
{{ cname }}:
image: "{{ docker_test_image_alpine }}"
command: '/bin/sh -c "sleep 10m"'
stop_grace_period: 1s
test_service_mod: |
version: '3'
services:
{{ cname }}:
image: "{{ docker_test_image_alpine }}"
command: '/bin/sh -c "sleep 15m"'
stop_grace_period: 1s
- name: Create project directory
file:
path: '{{ project_src }}'
state: directory
####################################################################
## Present #########################################################
####################################################################
- name: Template default project file
copy:
dest: '{{ project_src }}/docker-compose.yml'
content: '{{ test_service }}'
- name: Present (check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
check_mode: true
register: present_1_check
- name: Present
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
register: present_1
- name: Present (idempotent check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
check_mode: true
register: present_2_check
- name: Present (idempotent)
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
register: present_2
- name: Template modified project file
copy:
dest: '{{ project_src }}/docker-compose.yml'
content: '{{ test_service_mod }}'
- name: Present (changed check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
check_mode: true
register: present_3_check
- name: Present (changed)
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
register: present_3
- assert:
that:
- present_1_check is changed
- present_1 is changed
- present_1.containers | length == 1
- present_1.containers[0].Name == pname ~ '-' ~ cname ~ '-1'
- present_1.containers[0].Image == docker_test_image_alpine
- present_1.images | length == 1
- present_1.images[0].ContainerName == pname ~ '-' ~ cname ~ '-1'
- present_1.images[0].Repository == (docker_test_image_alpine | split(':') | first)
- present_1.images[0].Tag == (docker_test_image_alpine | split(':') | last)
- present_2_check is not changed
- present_2 is not changed
- present_3_check is changed
- present_3 is changed
####################################################################
## Absent ##########################################################
####################################################################
- name: Absent (check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: absent
check_mode: true
register: absent_1_check
- name: Absent
docker_compose_v2:
project_src: '{{ project_src }}'
state: absent
register: absent_1
- name: Absent (idempotent check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: absent
check_mode: true
register: absent_2_check
- name: Absent (idempotent)
docker_compose_v2:
project_src: '{{ project_src }}'
state: absent
register: absent_2
- assert:
that:
- absent_1_check is changed
- absent_1 is changed
- absent_2_check is not changed
- absent_2 is not changed
####################################################################
## Stopping and starting ###########################################
####################################################################
- name: Template default project file
copy:
dest: '{{ project_src }}/docker-compose.yml'
content: '{{ test_service }}'
- name: Present stopped (check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: stopped
check_mode: true
register: present_1_check
- name: Present stopped
docker_compose_v2:
project_src: '{{ project_src }}'
state: stopped
register: present_1
- name: Present stopped (idempotent check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: stopped
check_mode: true
register: present_2_check
- name: Present stopped (idempotent)
docker_compose_v2:
project_src: '{{ project_src }}'
state: stopped
register: present_2
- name: Started (check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
check_mode: true
register: present_3_check
- name: Started
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
register: present_3
- name: Started (idempotent check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
check_mode: true
register: present_4_check
- name: Started (idempotent)
docker_compose_v2:
project_src: '{{ project_src }}'
state: present
register: present_4
- name: Restarted (check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: restarted
check_mode: true
register: present_5_check
- name: Restarted
docker_compose_v2:
project_src: '{{ project_src }}'
state: restarted
register: present_5
- name: Stopped (check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: stopped
check_mode: true
register: present_6_check
- name: Stopped
docker_compose_v2:
project_src: '{{ project_src }}'
state: stopped
register: present_6
- name: Restarted (check)
docker_compose_v2:
project_src: '{{ project_src }}'
state: restarted
check_mode: true
register: present_7_check
- name: Restarted
docker_compose_v2:
project_src: '{{ project_src }}'
state: restarted
register: present_7
- name: Cleanup
docker_compose_v2:
project_src: '{{ project_src }}'
state: absent
- assert:
that:
- present_1_check is changed
- present_1 is changed
- present_2_check is not changed
- present_2 is not changed
- present_3_check is changed
- present_3 is changed
- present_4_check is not changed
- present_4 is not changed
- present_5_check is changed
- present_5 is changed
- present_6_check is changed
- present_6 is changed
- present_7_check is changed
- present_7 is changed