log which task ended the play

[ttyS4]

Before the change no information was available why a playbook has ended.
By introducing this change information will be available which tells us which
task invoked meta end_play.

SUMMARY

I have playbooks structured in a way that if certain conditions are met the play is ended for good reasons. This can happen in multiple places and also there are multiple checks in one of the playbooks. By adding this change ansible will log which task called the meta action to end the play.

PR #20799 is somewhat related.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

core

[bcoca]

you should be able to do the same with a callback and not change it for all users.

[ttyS4]

This is a simplified version of a playbook I use:

% cat test.yaml
---
- hosts: localhost
  vars:
  - auto_reboot_days: 30
    auto_reboot_only_on_weekday: 0
  tasks:
  - name: compare uptime days to reboot threshold
    meta: end_play
    when: auto_reboot_days is not defined or ((( ansible_uptime_seconds|int + 600 ) / 86400 ) < auto_reboot_days )

  - name: check if auto_reboot_only_on_weekday matches
    meta: end_play
    when: (auto_reboot_only_on_weekday is defined) and (ansible_date_time.weekday_number|int != auto_reboot_only_on_weekday)

  - name: reboot and upgrade host
    command: /bin/echo reboot-and-stuff

If I run the latest version of ansible from the git checkout of the devel branch I get this output:

% ansible-playbook test.yaml
 [WARNING]: No inventory was parsed, only implicit localhost is available

 [WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not match 'all'


PLAY [localhost] *************************************************************************************************************

TASK [Gathering Facts] *******************************************************************************************************
ok: [localhost]

PLAY RECAP *******************************************************************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

If I increase verbosity I get:

% ansible-playbook -vv test.yaml
ansible-playbook 2.10.0.dev0
  config file = None
  configured module search path = [u'/home/cstamas/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /tmp/tmp.l5ZeiGcm6L/ansible/lib/ansible
  executable location = /tmp/tmp.l5ZeiGcm6L/ansible/bin/ansible-playbook
  python version = 2.7.16 (default, Apr  6 2019, 01:42:57) [GCC 8.3.0]
No config file found; using defaults
 [WARNING]: No inventory was parsed, only implicit localhost is available

 [WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not match 'all'


PLAYBOOK: test.yaml **********************************************************************************************************
1 plays in test.yaml

PLAY [localhost] *************************************************************************************************************

TASK [Gathering Facts] *******************************************************************************************************
task path: /tmp/tmp.l5ZeiGcm6L/test.yaml:2
ok: [localhost]
META: ran handlers
META: 
META: ending play

PLAY RECAP *******************************************************************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

After increasing verbosity it tells the meta end_play triggered the play to finish, but they do not tell where and why it ended. This is what my patch intends to do.

So with my patch I get this:

% ansible-playbook test.yaml
 [WARNING]: No inventory was parsed, only implicit localhost is available

 [WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not match 'all'


PLAY [localhost] *************************************************************************************************************

TASK [Gathering Facts] *******************************************************************************************************
ok: [localhost]
META [check if auto_reboot_only_on_weekday matches] is ending play

PLAY RECAP *******************************************************************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

with my patch and -vv the output is this:

% ansible-playbook -vv test.yaml
ansible-playbook 2.10.0.dev0
  config file = None
  configured module search path = [u'/home/cstamas/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /tmp/tmp.l5ZeiGcm6L/ansible/lib/ansible
  executable location = /tmp/tmp.l5ZeiGcm6L/ansible/bin/ansible-playbook
  python version = 2.7.16 (default, Apr  6 2019, 01:42:57) [GCC 8.3.0]
No config file found; using defaults
 [WARNING]: No inventory was parsed, only implicit localhost is available

 [WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not match 'all'


PLAYBOOK: test.yaml **********************************************************************************************************
1 plays in test.yaml

PLAY [localhost] *************************************************************************************************************

TASK [Gathering Facts] *******************************************************************************************************
task path: /tmp/tmp.l5ZeiGcm6L/test.yaml:2
ok: [localhost]
META: ran handlers
META: 
META [check if auto_reboot_only_on_weekday matches] is ending play
META: ending play

PLAY RECAP *******************************************************************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

[ttyS4]

you should be able to do the same with a callback and not change it for all users.

Maybe this should be changed for all users?
@bcoca after reading your question I realized that this could be considered as a bug and as such should be fixed.

[ttyS4]

ready_for_review

[sivel]

We have reviewed this and have decided to not accept this change. To get this information, you should be using a higher verbosity of at least -vv and you will already see end play right after the meta task that ended the play.

If you have further questions please stop by IRC or the mailing list:

• IRC: #ansible on irc.freenode.net
• mailing list: https://groups.google.com/forum/#!forum/ansible-project

[ttyS4]

@sivel Right after opening the PR at #61796 (comment)
i tried to describe why higher verbosity does not help in this case.
Please check and you will see what I mean; to get to the point: currently you cannot know which task triggerred end_play.

[sivel]

Ok, I was under the impression that the task name of the meta task would still print.

In any case, this could be extended to the existing msg but not it's own display.

[bcoca]

note: fix should be that 'explicit' meta tasks should output as normal tasks. we use many 'implicit meta tasks, that only show output under -v levels of verbosity, those should still stay hidden and we should ensure we make the distinction in the engine.