docker_compose - Fix idempotency when services have no enabled profiles (#192)

* Initial Commit

* Adding integration tests

* Fixing integration and adding changelog fragment
This commit is contained in:
Ajpantuso 2021-08-20 07:33:35 -04:00 committed by GitHub
parent 50d3b9c280
commit 4dfc3ae5d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 12 deletions

View File

@ -0,0 +1,4 @@
---
bugfixes:
- docker_compose - fixed incorrect ``changed`` status for services with ``profiles`` defined, but none enabled
(https://github.com/ansible-collections/community.docker/pull/192).

View File

@ -790,6 +790,8 @@ class ContainerManager(DockerBaseClass):
# In case the only action is starting, and the user requested
# that the service should be stopped, ignore this service.
continue
if not self._service_profile_enabled(service):
continue
if plan.action != 'noop':
result['changed'] = True
result_action = dict(service=service.name)
@ -1010,6 +1012,14 @@ class ContainerManager(DockerBaseClass):
))
return result
def _service_profile_enabled(self, service):
"""Returns `True` if the service has no profiles defined or has a profile which is among
the profiles passed to the `docker compose up` command. Otherwise returns `False`.
"""
if LooseVersion(compose_version) < LooseVersion('1.28.0'):
return True
return service.enabled_for_profiles(self.profiles or [])
def cmd_down(self):
result = dict(
changed=False,

View File

@ -30,6 +30,7 @@
- profile_all
stop_grace_period: 1s
test_cases:
- test_name: no services enabled
- test_name: enable 1
profiles_value:
- profile_1
@ -61,7 +62,7 @@
docker_compose:
project_name: "{{ pname }}"
definition: "{{ test_service | from_yaml }}"
profiles: "{{ test_case.profiles_value }}"
profiles: "{{ test_case.profiles_value | default(omit) }}"
stopped: "{{ test_case.stopped_value | default(omit) }}"
state: present
register: profiles_outputs
@ -77,20 +78,21 @@
- assert:
that:
- profiles_outputs.results[0].services[cname_1][cname_1_name].state.running
- profiles_outputs.results[0].services[cname_2] == {}
- not profiles_outputs.results[1].services[cname_1][cname_1_name].state.running
- profiles_outputs.results[0] is not changed
- profiles_outputs.results[1].services[cname_1][cname_1_name].state.running
- profiles_outputs.results[1].services[cname_2] == {}
- not profiles_outputs.results[2].services[cname_1][cname_1_name].state.running
- profiles_outputs.results[2].services[cname_2][cname_2_name].state.running
- profiles_outputs.results[2].services[cname_2] == {}
- not profiles_outputs.results[3].services[cname_1][cname_1_name].state.running
- not profiles_outputs.results[3].services[cname_2][cname_2_name].state.running
- profiles_outputs.results[4].services[cname_1][cname_1_name].state.running
- profiles_outputs.results[4].services[cname_2][cname_2_name].state.running
- not profiles_outputs.results[5].services[cname_1][cname_1_name].state.running
- not profiles_outputs.results[5].services[cname_2][cname_2_name].state.running
- profiles_outputs.results[6].services[cname_1][cname_1_name].state.running
- profiles_outputs.results[6].services[cname_2][cname_2_name].state.running
- profiles_outputs.results[3].services[cname_2][cname_2_name].state.running
- not profiles_outputs.results[4].services[cname_1][cname_1_name].state.running
- not profiles_outputs.results[4].services[cname_2][cname_2_name].state.running
- profiles_outputs.results[5].services[cname_1][cname_1_name].state.running
- profiles_outputs.results[5].services[cname_2][cname_2_name].state.running
- not profiles_outputs.results[6].services[cname_1][cname_1_name].state.running
- not profiles_outputs.results[6].services[cname_2][cname_2_name].state.running
- profiles_outputs.results[7].services[cname_1][cname_1_name].state.running
- profiles_outputs.results[7].services[cname_2][cname_2_name].state.running
vars:
cname_1_name: "{{ pname + '_' + cname_1 + '_1' }}"
cname_2_name: "{{ pname + '_' + cname_2 + '_1' }}"