ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-23 13:20:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

include_role handlers bug fix (#26335)

Browse source 
* Ensure that include_role properly fires handlers

include_role needs to ensure that any handlers included
with the role are added to the _notified_handler and
_listening_handler lists of the TaskQueueManager, otherwise
it fails when trying to run the handler.

Additionally, the handler needs to be added to the
PlayIterator's `_uuid_cache` or it fails after running
the handler

Add more uuid debug statements - this code was hard
to debug with existing debug statements, so add more
uuid information at little additional output cost.

Fixes #18411

* Add tests for include_role handlers

Tests for #18411
This commit is contained in:
Will Thames 2017-07-20 06:02:32 +10:00 • committed by James Cammarata
commit ef8c9798d3
13 changed files with 86 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lib/ansible/executor/process/worker.py
View file

@ -118,7 +118,7 @@ class WorkerProcess(multiprocessing.Process):
self._rslt_q
).run()
display.debug("done running TaskExecutor() for %s/%s" % (self._host, self._task))
display.debug("done running TaskExecutor() for %s/%s [%s]" % (self._host, self._task, self._task._uuid))
self._host.vars = dict()
self._host.groups = []
task_result = TaskResult(
@ -129,9 +129,9 @@ class WorkerProcess(multiprocessing.Process):
)
# put the result on the result queue
display.debug("sending task result")
display.debug("sending task result for task %s" % self._task._uuid)
self._rslt_q.put(task_result)
display.debug("done sending task result")
display.debug("done sending task result for task %s" % self._task._uuid)
except AnsibleConnectionFailure:
self._host.vars = dict()

2
lib/ansible/executor/task_executor.py
View file

@ -81,7 +81,7 @@ class TaskExecutor:
returned as a dict.
'''
display.debug("in run()")
display.debug("in run() - task %s" % self._task._uuid)
try:
try:

6
lib/ansible/executor/task_queue_manager.py
View file

@ -137,10 +137,13 @@ class TaskQueueManager:
handler_list = []
for handler_block in play.handlers:
handler_list.extend(_process_block(handler_block))
# then initialize it with the given handler list
self.update_handler_list(handler_list)
def update_handler_list(self, handler_list):
for handler in handler_list:
if handler._uuid not in self._notified_handlers:
display.debug("Adding handler %s to notified list" % handler.name)
self._notified_handlers[handler._uuid] = []
if handler.listen:
listeners = handler.listen
@ -149,6 +152,7 @@ class TaskQueueManager:
for listener in listeners:
if listener not in self._listening_handlers:
self._listening_handlers[listener] = []
display.debug("Adding handler %s to listening list" % handler.name)
self._listening_handlers[listener].append(handler._uuid)
def load_callbacks(self):

3
lib/ansible/playbook/helpers.py
View file

@ -319,7 +319,8 @@ def load_list_of_tasks(ds, play, block=None, role=None, task_include=None, use_h
if is_static:
# uses compiled list from object
t = task_list.extend(ir.get_block_list(variable_manager=variable_manager, loader=loader))
blocks, _ = ir.get_block_list(variable_manager=variable_manager, loader=loader)
t = task_list.extend(blocks)
else:
# passes task object itself for latter generation of list
t = task_list.append(ir)

6
lib/ansible/playbook/role_include.py
View file

@ -87,9 +87,9 @@ class IncludeRole(TaskInclude):
b._parent = self
# updated available handlers in play
myplay.handlers = myplay.handlers + actual_role.get_handler_blocks(play=myplay)
return blocks
handlers = actual_role.get_handler_blocks(play=myplay)
myplay.handlers = myplay.handlers + handlers
return blocks, handlers
@staticmethod
def load(data, block=None, role=None, task_include=None, variable_manager=None, loader=None):

4
lib/ansible/plugins/strategy/__init__.py
View file

@ -450,6 +450,8 @@ class StrategyBase:
target_handler = search_handler_blocks_by_name(handler_name, iterator._play.handlers)
if target_handler is not None:
found = True
if target_handler._uuid not in self._notified_handlers:
self._notified_handlers[target_handler._uuid] = []
if original_host not in self._notified_handlers[target_handler._uuid]:
self._notified_handlers[target_handler._uuid].append(original_host)
# FIXME: should this be a callback?
@ -761,6 +763,8 @@ class StrategyBase:
host_results = []
for host in notified_hosts:
if not handler.has_triggered(host) and (not iterator.is_failed(host) or play_context.force_handlers):
if handler._uuid not in iterator._task_uuid_cache:
iterator._task_uuid_cache[handler._uuid] = handler
task_vars = self._variable_manager.get_vars(play=iterator._play, host=host, task=handler)
self.add_tqm_variables(task_vars, play=iterator._play)
self._queue_task(host, handler, task_vars, play_context)

4
lib/ansible/plugins/strategy/linear.py
View file

@ -315,7 +315,9 @@ class StrategyModule(StrategyBase):
if loop_var and loop_var in include_result:
new_ir.vars[loop_var] = include_result[loop_var]
all_role_blocks.extend(new_ir.get_block_list(play=iterator._play, variable_manager=self._variable_manager, loader=self._loader))
blocks, handler_blocks = new_ir.get_block_list(play=iterator._play, variable_manager=self._variable_manager, loader=self._loader)
all_role_blocks.extend(blocks)
self._tqm.update_handler_list([handler for handler_block in handler_blocks for handler in handler_block.block])
if len(all_role_blocks) > 0:
for host in hosts_left: