Fix name parameter templating in include_role module

[fullyint]

SUMMARY

Followup to #33386 and #21285.

Fixes problem that include_role looping over with_items and name: "{{ item }}" will use the same name for all items in the loop.

In the current code, an IncludedFile() object built using the original_task will have its inc_file._task bound to the original_task. The iterative reassignment of original_task._role_name during with_items loops leaves all returned included_files with the same inc_file._task._role_name. All have the final name from the with_items list.

This PR builds IncludedFile() objects from an original_task.copy() to avoid the problematic binding.

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

include_role module

ANSIBLE VERSION

ansible 2.6.0 (devel a5654bd63c) last updated 2018/02/18 20:37:44 (GMT -600)
  config file = None
  configured module search path = [u'/Users/philip/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/philip/projects/ansible/ansible/lib/ansible
  executable location = /Users/philip/projects/ansible/ansible/bin/ansible
  python version = 2.7.13 (default, Mar 13 2017, 12:42:50) [GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]

ADDITIONAL INFORMATION

To reproduce, create a test playbook with a looping include_role:

# include-role-test.yml
- gather_facts: false
  hosts: localhost
  tasks:
    - include_role:
        name: "{{ role }}"
      with_items:
        - role1
        - role2
      loop_control:
        loop_var: role

Create role1 and role2:

# roles/role1/tasks/main.yml
- debug:
    msg: this is role 1

# roles/role2/tasks/main.yml
- debug:
    msg: this is role 2

Output from current devel branch

The include_role task runs role2 both times, despite with_items: ['role1', 'role2'].

$ ansible-playbook -i hosts include-role-test.yml

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

TASK [include_role] ************************************************************************

TASK [role2 : debug] ***********************************************************************
ok: [localhost] => {
    "failed": false,
    "msg": "this is role 2"
}

TASK [role2 : debug] ***********************************************************************
ok: [localhost] => {
    "failed": false,
    "msg": "this is role 2"
}

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

Output after applying this PR

$ ansible-playbook -i hosts include-role-test.yml

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

TASK [include_role] ************************************************************************

TASK [role1 : debug] ***********************************************************************
ok: [localhost] => {
    "failed": false,
    "msg": "this is role 1"
}

TASK [role2 : debug] ***********************************************************************
ok: [localhost] => {
    "failed": false,
    "msg": "this is role 2"
}

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

[Im0]

Thanks for logging this @fullyint , I'm hoping to use include_role: name: {{ loopedVar }} with with_items/with_dict but running into this exact problem (along with the other referenced issues). Hoping this can be merged!

You tested against 2.6, hopefully we can see this in 2.5 as well!

Only work around I can think of at the moment is to write out to a temporary playbook file and execute it.. seems messy. :(

[sivel]

rebuild_merge