docs example of using notify in a block: to call a handler doesn't work #33381

alikins · 2017-11-29T15:12:53Z

ISSUE TYPE

Bug Report
Documentation Report

COMPONENT NAME

lib/ansible/playbook/block.py
lib/ansible/plugins/strategy/init.py
lib/ansible/executor/init.py
docs/docsite/rst/playbooks_blocks.rst

ANSIBLE VERSION

ansible 2.5.0 (devel fec39ba1f2) last updated 2017/11/29 09:53:12 (GMT -400)
  config file = None
  configured module search path = [u'/home/adrian/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /home/adrian/src/ansible/lib/ansible
  executable location = /home/adrian/src/ansible/bin/ansible
  python version = 2.7.14 (default, Nov  3 2017, 10:55:25) [GCC 7.2.1 20170915 (Red Hat 7.2.1-2)]

CONFIGURATION

default config

OS / ENVIRONMENT

fedora27 x86_64

SUMMARY

The example code at http://docs.ansible.com/ansible/latest/playbooks_blocks.html#id3
describing 'Another example is how to run handlers after an error occurred' doesn't work.

Not sure if the docs are wrong or if it is a bug

STEPS TO REPRODUCE

- name: example  # from http://docs.ansible.com/ansible/latest/playbooks_blocks.html#id3
  hosts: localhost
  gather_facts: false
  tasks:
     - name: Attempt and gracefull roll back demo
       block:
         - debug: msg='I execute normally'
           notify: run me even after an error
         - command: /bin/false
       rescue:
         - name: make sure all handlers run
           meta: flush_handlers
  handlers:
    - name: run me even after an error
      debug: msg='this handler runs even on error'

EXPECTED RESULTS

The 'run me even after an error' handler would run and debug display
the message ''this handler runs even on error''

ACTUAL RESULTS

The 'run me even after an error' doesn't appear to be run.

first, with no verbosity, then with -vvv:

[newswoop:F27:ansible (devel % u=)]$ ansible-playbook -i hosts block_example.yml 

PLAY [example] ***********************************************************************************

TASK [debug] *************************************************************************************
ok: [localhost] => {
    "msg": "I execute normally"
}

TASK [command] ***********************************************************************************
fatal: [localhost]: FAILED! => {"changed": true, "cmd": ["/bin/false"], "delta": "0:00:00.002713", "end": "2017-11-29 10:04:51.748003", "msg": "non-zero return code", "rc": 1, "start": "2017-11-29 10:04:51.745290", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}

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

with -vvv:

[newswoop:F27:ansible (devel % u=)]$ ansible-playbook -i hosts -vvv block_example.yml 
ansible-playbook 2.5.0 (devel fec39ba1f2) last updated 2017/11/29 09:53:12 (GMT -400)
  config file = None
  configured module search path = [u'/home/adrian/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /home/adrian/src/ansible/lib/ansible
  executable location = /home/adrian/src/ansible/bin/ansible-playbook
  python version = 2.7.14 (default, Nov  3 2017, 10:55:25) [GCC 7.2.1 20170915 (Red Hat 7.2.1-2)]
No config file found; using defaults
Parsed /home/adrian/src/ansible/hosts inventory source with ini plugin

PLAYBOOK: block_example.yml **********************************************************************
1 plays in block_example.yml

PLAY [example] ***********************************************************************************
META: ran handlers

TASK [debug] *************************************************************************************
task path: /home/adrian/src/ansible/block_example.yml:7
ok: [localhost] => {
    "msg": "I execute normally"
}

TASK [command] ***********************************************************************************
task path: /home/adrian/src/ansible/block_example.yml:9
Using module file /home/adrian/src/ansible/lib/ansible/modules/commands/command.py
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: adrian
<localhost> EXEC /bin/sh -c 'echo ~ && sleep 0'
<localhost> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo /home/adrian/.ansible/tmp/ansible-tmp-1511967836.08-210701305656610 `" && echo ansible-tmp-1511967836.08-210701305656610="` echo /home/adrian/.ansible/tmp/ansible-tmp-1511967836.08-210701305656610 `" ) && sleep 0'
<localhost> PUT /tmp/tmpgVIyAa TO /home/adrian/.ansible/tmp/ansible-tmp-1511967836.08-210701305656610/command.py
<localhost> EXEC /bin/sh -c 'chmod u+x /home/adrian/.ansible/tmp/ansible-tmp-1511967836.08-210701305656610/ /home/adrian/.ansible/tmp/ansible-tmp-1511967836.08-210701305656610/command.py && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python /home/adrian/.ansible/tmp/ansible-tmp-1511967836.08-210701305656610/command.py; rm -rf "/home/adrian/.ansible/tmp/ansible-tmp-1511967836.08-210701305656610/" > /dev/null 2>&1 && sleep 0'
fatal: [localhost]: FAILED! => {
    "changed": true, 
    "cmd": [
        "/bin/false"
    ], 
    "delta": "0:00:00.001654", 
    "end": "2017-11-29 10:03:56.214393", 
    "invocation": {
        "module_args": {
            "_raw_params": "/bin/false", 
            "_uses_shell": false, 
            "chdir": null, 
            "creates": null, 
            "executable": null, 
            "removes": null, 
            "stdin": null, 
            "warn": true
        }
    }, 
    "msg": "non-zero return code", 
    "rc": 1, 
    "start": "2017-11-29 10:03:56.212739", 
    "stderr": "", 
    "stderr_lines": [], 
    "stdout": "", 
    "stdout_lines": []
}
META: ran handlers
META: ran handlers
META: ran handlers

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

The text was updated successfully, but these errors were encountered:

ansibot · 2017-11-29T15:15:27Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

alikins · 2017-11-29T15:18:38Z

Trying a few variants of that example doesn't seem to work either:

Also tried with an ignore_errors: on the 'command: /bin/false' but didn't seem to matter.

[newswoop:F27:ansible (devel % u=)]$ ansible-playbook -i hosts block_example.yml 

PLAY [example] ***********************************************************************************

TASK [debug] *************************************************************************************
ok: [localhost] => {
    "msg": "I execute normally"
}

TASK [command] ***********************************************************************************
fatal: [localhost]: FAILED! => {"changed": true, "cmd": ["/bin/false"], "delta": "0:00:00.002713", "end": "2017-11-29 10:04:51.748003", "msg": "non-zero return code", "rc": 1, "start": "2017-11-29 10:04:51.745290", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}

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

results:

[newswoop:F27:ansible (devel % u=)]$ ansible-playbook -i hosts -vv block_example_fix.yml 
PLAYBOOK: block_example_fix.yml ******************************************************************
1 plays in block_example_fix.yml

PLAY [example] ***********************************************************************************
META: ran handlers

TASK [debug] *************************************************************************************
task path: /home/adrian/src/ansible/block_example_fix.yml:7
ok: [localhost] => {
    "msg": "I execute normally"
}

TASK [command] ***********************************************************************************
task path: /home/adrian/src/ansible/block_example_fix.yml:10
fatal: [localhost]: FAILED! => {"changed": true, "cmd": ["/bin/false"], "delta": "0:00:00.001665", "end": "2017-11-29 10:14:45.707840", "msg": "non-zero return code", "rc": 1, "start": "2017-11-29 10:14:45.706175", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}

TASK [debug] *************************************************************************************
task path: /home/adrian/src/ansible/block_example_fix.yml:14
ok: [localhost] => {
    "msg": "I failed to execute normally."
}
META: ran handlers

TASK [debug] *************************************************************************************
task path: /home/adrian/src/ansible/block_example_fix.yml:20
ok: [localhost] => {
    "msg": "I always run"
}
META: ran handlers
META: ran handlers
META: ran handlers

PLAY RECAP ***************************************************************************************
localhost                  : ok=3    changed=0    unreachable=0    failed=1

alikins · 2017-11-29T15:19:31Z

pinging @jimi-c @dharmabumstead

ansibot · 2017-11-29T15:23:31Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

flowerysong · 2017-11-30T00:43:34Z

This is a documentation bug; since the debug task doesn't return a 'changed' result the handler isn't notified and will never run. If you use a task that actually notifies the handler it should work as expected.

- name: example  # from http://docs.ansible.com/ansible/latest/playbooks_blocks.html#id3
  hosts: localhost
  gather_facts: false
  tasks:
     - name: Attempt and gracefull roll back demo
       block:
         - debug: msg='I execute normally'
           changed_when: true
           notify: run me even after an error
         - command: /bin/false
       rescue:
         - name: make sure all handlers run
           meta: flush_handlers
  handlers:
    - name: run me even after an error
      debug: msg='this handler runs even on error'

PLAY [example] *****************************************************************

TASK [debug] *******************************************************************
changed: [localhost] => {
    "msg": "I execute normally"
}

TASK [command] *****************************************************************
fatal: [localhost]: FAILED! => {"changed": true, "cmd": ["/bin/false"], "delta": "0:00:00.002008", "end": "2017-11-29 19:41:21.177788", "msg": "non-zero return code", "rc": 1, "start": "2017-11-29 19:41:21.175780", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}

RUNNING HANDLER [run me even after an error] ***********************************
ok: [localhost] => {
    "msg": "this handler runs even on error"
}

PLAY RECAP *********************************************************************
localhost                  : ok=2    changed=1    unreachable=0    failed=1

ansibot · 2018-02-14T18:35:45Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

ansibot · 2018-08-01T00:38:59Z

cc @acozine
click here for bot help

ansibot · 2018-08-25T01:08:58Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

ansibot · 2018-10-04T01:59:34Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

ansibot · 2018-12-04T20:12:39Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

ansibot · 2019-01-16T15:30:52Z

cc @jborean93 @nitzmahone
click here for bot help

ansibot · 2019-03-05T18:20:34Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

ShachafGoldstein · 2019-06-16T00:36:29Z

This issue is fixed in the docs site, can someone close?

ansibot · 2019-09-01T13:04:16Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

nitzmahone · 2020-03-13T20:42:42Z

closing, since docs seem to have been updated

ansibot added affects_2.5 This issue/PR affects Ansible v2.5 bug_report needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Nov 29, 2017

gundalow added c:playbook/block playbook/block and removed needs_triage Needs a first human triage before being processed. labels Nov 29, 2017

ansibot added bug This issue/PR relates to a bug. and removed bug_report labels Mar 1, 2018

ansibot added the docs This issue/PR relates to or includes documentation. label May 20, 2018

ansibot added the support:community This issue/PR relates to code supported by the Ansible community. label Sep 18, 2018

ansibot removed the support:community This issue/PR relates to code supported by the Ansible community. label Nov 26, 2018

ansibot added the docsite This issue/PR relates to the documentation website. label Dec 4, 2018

ansibot added the windows Windows community label Jan 16, 2019

nitzmahone closed this as completed Mar 13, 2020

ansible locked and limited conversation to collaborators Apr 13, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs example of using notify in a block: to call a handler doesn't work #33381

docs example of using notify in a block: to call a handler doesn't work #33381

alikins commented Nov 29, 2017 •

edited

Loading

ansibot commented Nov 29, 2017

alikins commented Nov 29, 2017

alikins commented Nov 29, 2017

ansibot commented Nov 29, 2017

flowerysong commented Nov 30, 2017

ansibot commented Feb 14, 2018

ansibot commented Aug 1, 2018

ansibot commented Aug 25, 2018

ansibot commented Oct 4, 2018

ansibot commented Dec 4, 2018

ansibot commented Jan 16, 2019

ansibot commented Mar 5, 2019

ShachafGoldstein commented Jun 16, 2019

ansibot commented Sep 1, 2019

nitzmahone commented Mar 13, 2020

docs example of using notify in a block: to call a handler doesn't work #33381

docs example of using notify in a block: to call a handler doesn't work #33381

Comments

alikins commented Nov 29, 2017 • edited Loading

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

CONFIGURATION

OS / ENVIRONMENT

SUMMARY

STEPS TO REPRODUCE

EXPECTED RESULTS

ACTUAL RESULTS

ansibot commented Nov 29, 2017

alikins commented Nov 29, 2017

alikins commented Nov 29, 2017

ansibot commented Nov 29, 2017

flowerysong commented Nov 30, 2017

ansibot commented Feb 14, 2018

ansibot commented Aug 1, 2018

ansibot commented Aug 25, 2018

ansibot commented Oct 4, 2018

ansibot commented Dec 4, 2018

ansibot commented Jan 16, 2019

ansibot commented Mar 5, 2019

ShachafGoldstein commented Jun 16, 2019

ansibot commented Sep 1, 2019

nitzmahone commented Mar 13, 2020

alikins commented Nov 29, 2017 •

edited

Loading