Tags are ignored on plays that are included that use with_items

[jasonmichaellehman]

ISSUE TYPE

• Bug Report

COMPONENT NAME

Conditional Include

ANSIBLE VERSION

ansible 2.2.0.0
  config file = /etc/ansible/ansible.cfg
  configured module search path = Default w/o overrides

CONFIGURATION

N/A

OS / ENVIRONMENT

RHEL 7

SUMMARY

TAGS are ignored when including a playbook that uses with_items

STEPS TO REPRODUCE

run ansible-playbook tagtest.yml --tags dev

tagtest.yml

- hosts: localhost
  tags:
    - prod
  tasks:
    - set_fact:
        taskname: "foo"

    - include: tasks/{{taskname}}{{item}}.yml
      with_items: "bar"

    - debug: msg="hello prod tags"

- hosts: localhost
  tags:
    - dev
  tasks:
    - debug: msg="hello dev tags"

tasks/foobar.yml

- debug: msg="I ran foobar"

EXPECTED RESULTS

Expectation is that the first play on localhost with tags Prod would have been ignored and only "hello dev tags" would have been outputted.

ACTUAL RESULTS

The play attempted to run the include task and failed because it did NOT include the first set_fact and taskname was coming through as undefined. In prior version of ansible the complete host section would be skipped when tags were used in this fashion.

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

TASK [setup] *******************************************************************
ok: [localhost]

TASK [include] *****************************************************************
fatal: [localhost]: FAILED! => {"failed": true, "msg": "'taskname' is undefined"}
        to retry, use: --limit @/opt/jml/appstack/ansible/testtag.retry

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

[ansibot]

Files identified in the description:

• lib/ansible/modules/utilities/logic/_include.py

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]

Files identified in the description:

• lib/ansible/modules/utilities/logic/include.py

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

[mickaelperrin]

Had a really near problem and reported it first on stack overflow.

STEPS TO REPRODUCE

role/tasks/main.yml

---
- include: test.yml
  with_items:
    - A
    - B
  tags:
    - my_role_test

role/tasks/test.yml

---
- debug:
    msg: "It works"

When I run my playbook with --tags=my_role_test, I can see the expected output twice:

[20:18:52] test : debug | server | SUCCESS | 593ms
{
  - msg: It works
}

However, I got this output:

[20:15:41] test : include
[20:15:41]  ➥ system | included: /test/tasks/test.yml for server
[20:15:41]  ➥ system | included: /test/tasks/test.yml for server
[20:15:41]  ➥ system | -- Play recap --

So the tasks are not being executed.

WORKAROUND

Put tags on each task of the included file:

role/tasks/main.yml

---
- include: test.yml
  with_items:
    - A
    - B

role/tasks/test.yml

---
- debug:
    msg: "It works"
  tags:
    - my_role_test

[sivel]

@jasonmichaellehman this issue is resolved in recent ansible versions, but will require a change from include to utilize include_tasks instead.

static includes cannot utilize host variables, such as from set_fact to indicate the file to be included.

Changing to include_tasks produces the following output for me:

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

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

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

TASK [debug] *********************************************************************************************************************************************************************************************************************************
ok: [localhost] => {
    "msg": "hello dev tags"
}

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

[mickaelperrin]

@sivel unfortunately, for my test case, this doesn't work either.

I have the same output when using include_tasks.

18:53:24] test : include_tasks | server | SUCCESS | 1882ms
[18:53:25] system | included: /test/tasks/test.yml for server
[18:53:25] system | included: /test/tasks/test.yml for server
[18:53:25] system | -- Play recap --
server : ok=4    changed=0    unreachable=0    failed=0

[sivel]

@mickaelperrin your issue is different from the one described here.

What you are encountering is expected, and explained at https://docs.ansible.com/ansible/devel/porting_guides/porting_guide_2.5.html#dynamic-includes-and-attribute-inheritance

A tag applied to a dynamic include only affects the include, and is not inherited by the tasks within.

[mickaelperrin]

@sivel Thanks for taking time to answer me and to point me in the right direction.