mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
27c7d5bb01
* Note: Python2 is not as intelligent at detecting false import loops as Python3. context_objects.py cannot be added to cli/arguments because it would set up an import loop between cli/__init__.py, cli/arguments/context_objects.py, and context.py on Python2. ci_complete
122 lines
4.4 KiB
Python
122 lines
4.4 KiB
Python
# (c) 2016, Steve Kuznetsov <skuznets@redhat.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
|
|
from units.compat import unittest
|
|
from units.compat.mock import MagicMock
|
|
|
|
from ansible import context
|
|
from ansible.executor.task_queue_manager import TaskQueueManager
|
|
from ansible.playbook import Playbook
|
|
from ansible.plugins.callback import CallbackBase
|
|
from ansible.utils import context_objects as co
|
|
|
|
__metaclass__ = type
|
|
|
|
|
|
class TestTaskQueueManagerCallbacks(unittest.TestCase):
|
|
def setUp(self):
|
|
inventory = MagicMock()
|
|
variable_manager = MagicMock()
|
|
loader = MagicMock()
|
|
passwords = []
|
|
|
|
# Reset the stored command line args
|
|
co.GlobalCLIArgs._Singleton__instance = None
|
|
self._tqm = TaskQueueManager(inventory, variable_manager, loader, passwords)
|
|
self._playbook = Playbook(loader)
|
|
|
|
# we use a MagicMock to register the result of the call we
|
|
# expect to `v2_playbook_on_call`. We don't mock out the
|
|
# method since we're testing code that uses `inspect` to
|
|
# look at that method's argspec and we want to ensure this
|
|
# test is easy to reason about.
|
|
self._register = MagicMock()
|
|
|
|
def tearDown(self):
|
|
# Reset the stored command line args
|
|
co.GlobalCLIArgs._Singleton__instance = None
|
|
|
|
def test_task_queue_manager_callbacks_v2_playbook_on_start(self):
|
|
"""
|
|
Assert that no exceptions are raised when sending a Playbook
|
|
start callback to a current callback module plugin.
|
|
"""
|
|
register = self._register
|
|
|
|
class CallbackModule(CallbackBase):
|
|
"""
|
|
This is a callback module with the current
|
|
method signature for `v2_playbook_on_start`.
|
|
"""
|
|
CALLBACK_VERSION = 2.0
|
|
CALLBACK_TYPE = 'notification'
|
|
CALLBACK_NAME = 'current_module'
|
|
|
|
def v2_playbook_on_start(self, playbook):
|
|
register(self, playbook)
|
|
|
|
callback_module = CallbackModule()
|
|
self._tqm._callback_plugins.append(callback_module)
|
|
self._tqm.send_callback('v2_playbook_on_start', self._playbook)
|
|
register.assert_called_once_with(callback_module, self._playbook)
|
|
|
|
def test_task_queue_manager_callbacks_v2_playbook_on_start_wrapped(self):
|
|
"""
|
|
Assert that no exceptions are raised when sending a Playbook
|
|
start callback to a wrapped current callback module plugin.
|
|
"""
|
|
register = self._register
|
|
|
|
def wrap_callback(func):
|
|
"""
|
|
This wrapper changes the exposed argument
|
|
names for a method from the original names
|
|
to (*args, **kwargs). This is used in order
|
|
to validate that wrappers which change par-
|
|
ameter names do not break the TQM callback
|
|
system.
|
|
|
|
:param func: function to decorate
|
|
:return: decorated function
|
|
"""
|
|
|
|
def wrapper(*args, **kwargs):
|
|
return func(*args, **kwargs)
|
|
|
|
return wrapper
|
|
|
|
class WrappedCallbackModule(CallbackBase):
|
|
"""
|
|
This is a callback module with the current
|
|
method signature for `v2_playbook_on_start`
|
|
wrapped in order to change the signature.
|
|
"""
|
|
CALLBACK_VERSION = 2.0
|
|
CALLBACK_TYPE = 'notification'
|
|
CALLBACK_NAME = 'current_module'
|
|
|
|
@wrap_callback
|
|
def v2_playbook_on_start(self, playbook):
|
|
register(self, playbook)
|
|
|
|
callback_module = WrappedCallbackModule()
|
|
self._tqm._callback_plugins.append(callback_module)
|
|
self._tqm.send_callback('v2_playbook_on_start', self._playbook)
|
|
register.assert_called_once_with(callback_module, self._playbook)
|