mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 21:32:49 +00:00
adds feature to all modules to be run locally (#18763)
* adds new error AnsibleModuleExit to handle module returns * adds new action plugin network for attaching connection to network modules * adds new shared module local to receive connection * splits out function to update task_args with common updates This commit provides a mechansim for running local modules that require a connection object for interative commands tyically implemented for network devices. It provides a way to locally import modules (post fork) and run them using exception handling to exit.
This commit is contained in:
@@ -517,19 +517,7 @@ class ActionBase(with_metaclass(ABCMeta, object)):
|
||||
data = re.sub(r'^((\r)?\n)?BECOME-SUCCESS.*(\r)?\n', '', data)
|
||||
return data
|
||||
|
||||
def _execute_module(self, module_name=None, module_args=None, tmp=None, task_vars=None, persist_files=False, delete_remote_tmp=True):
|
||||
'''
|
||||
Transfer and run a module along with its arguments.
|
||||
'''
|
||||
if task_vars is None:
|
||||
task_vars = dict()
|
||||
|
||||
# if a module name was not specified for this execution, use
|
||||
# the action from the task
|
||||
if module_name is None:
|
||||
module_name = self._task.action
|
||||
if module_args is None:
|
||||
module_args = self._task.args
|
||||
def _update_module_args(self, module_args, task_vars):
|
||||
|
||||
# set check mode in the module arguments, if required
|
||||
if self._play_context.check_mode:
|
||||
@@ -539,9 +527,6 @@ class ActionBase(with_metaclass(ABCMeta, object)):
|
||||
else:
|
||||
module_args['_ansible_check_mode'] = False
|
||||
|
||||
# Get the connection user for permission checks
|
||||
remote_user = task_vars.get('ansible_ssh_user') or self._play_context.remote_user
|
||||
|
||||
# set no log in the module arguments, if required
|
||||
module_args['_ansible_no_log'] = self._play_context.no_log or C.DEFAULT_NO_TARGET_SYSLOG
|
||||
|
||||
@@ -558,7 +543,7 @@ class ActionBase(with_metaclass(ABCMeta, object)):
|
||||
module_args['_ansible_version'] = __version__
|
||||
|
||||
# give the module information about its name
|
||||
module_args['_ansible_module_name'] = module_name
|
||||
module_args['_ansible_module_name'] = self._task.action
|
||||
|
||||
# set the syslog facility to be used in the module
|
||||
module_args['_ansible_syslog_facility'] = task_vars.get('ansible_syslog_facility', C.DEFAULT_SYSLOG_FACILITY)
|
||||
@@ -566,6 +551,25 @@ class ActionBase(with_metaclass(ABCMeta, object)):
|
||||
# let module know about filesystems that selinux treats specially
|
||||
module_args['_ansible_selinux_special_fs'] = C.DEFAULT_SELINUX_SPECIAL_FS
|
||||
|
||||
def _execute_module(self, module_name=None, module_args=None, tmp=None, task_vars=None, persist_files=False, delete_remote_tmp=True):
|
||||
'''
|
||||
Transfer and run a module along with its arguments.
|
||||
'''
|
||||
if task_vars is None:
|
||||
task_vars = dict()
|
||||
|
||||
# if a module name was not specified for this execution, use
|
||||
# the action from the task
|
||||
if module_name is None:
|
||||
module_name = self._task.action
|
||||
if module_args is None:
|
||||
module_args = self._task.args
|
||||
|
||||
# Get the connection user for permission checks
|
||||
remote_user = task_vars.get('ansible_ssh_user') or self._play_context.remote_user
|
||||
|
||||
self._update_module_args(module_args, task_vars)
|
||||
|
||||
(module_style, shebang, module_data, module_path) = self._configure_module(module_name=module_name, module_args=module_args, task_vars=task_vars)
|
||||
display.vvv("Using module file %s" % module_path)
|
||||
if not shebang and module_style != 'binary':
|
||||
|
||||
65
lib/ansible/plugins/action/network.py
Normal file
65
lib/ansible/plugins/action/network.py
Normal file
@@ -0,0 +1,65 @@
|
||||
#
|
||||
# (c) 2016 Red Hat Inc.
|
||||
#
|
||||
# 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/>.
|
||||
#
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import datetime
|
||||
|
||||
from ansible.plugins.action import ActionBase, display
|
||||
from ansible.module_utils.local import _modify_module
|
||||
from ansible.errors import AnsibleModuleExit
|
||||
|
||||
class ActionModule(ActionBase):
|
||||
|
||||
def run(self, tmp=None, task_vars=None):
|
||||
result = super(ActionModule, self).run(tmp, task_vars)
|
||||
del result['invocation']['module_args']
|
||||
|
||||
self._update_module_args(self._task.args, task_vars)
|
||||
|
||||
try:
|
||||
_modify_module(self._task.args, self._connection)
|
||||
path = self._shared_loader_obj.module_loader.find_plugin(self._task.action)
|
||||
pkg = '.'.join(['ansible', 'modules', self._task.action])
|
||||
module = self._shared_loader_obj.module_loader._load_module_source(pkg, path)
|
||||
start_time = datetime.datetime.now()
|
||||
module.main()
|
||||
|
||||
except AnsibleModuleExit as exc:
|
||||
result.update(exc.result)
|
||||
for field in ('_ansible_notify',):
|
||||
if field in result:
|
||||
results.pop(field)
|
||||
|
||||
except Exception as exc:
|
||||
if display.verbosity > 2:
|
||||
raise
|
||||
result.update(dict(failed=True, msg=str(exc)))
|
||||
|
||||
end_time = datetime.datetime.now()
|
||||
delta = end_time - start_time
|
||||
|
||||
result.update({
|
||||
'start': str(start_time),
|
||||
'end': str(end_time),
|
||||
'delta': str(delta)
|
||||
})
|
||||
|
||||
return result
|
||||
|
||||
Reference in New Issue
Block a user