ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Give a module the possibility to known its own name (#16087)

Browse source 
* Give a module the possibility to known its own name

This is useful for logging and reporting and fixes the longstanding problem with syslog-messages:

    May 30 15:50:11 moria ansible-<stdin>: Invoked with ...

now becomes:

    Jun  1 17:32:03 moria ansible-copy: Invoked with ...

This fixes #15830

* Rename the internal name from module.ansible_module_name to module._name
This commit is contained in:
Dag Wieers 2016-06-10 17:48:54 +02:00 committed by Brian Coca
parent a529a60478
commit 04ce71b4bd
2 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lib/ansible/module_utils/basic.py
View file

@ -608,7 +608,7 @@ class AnsibleModule(object):
self.run_command_environ_update = {} self.run_command_environ_update = {}
self.aliases = {} self.aliases = {}
self._legal_inputs = ['_ansible_check_mode', '_ansible_no_log', '_ansible_debug', '_ansible_diff', '_ansible_verbosity', '_ansible_selinux_special_fs', '_ansible_version', '_ansible_syslog_facility'] self._legal_inputs = ['_ansible_check_mode', '_ansible_no_log', '_ansible_debug', '_ansible_diff', '_ansible_verbosity', '_ansible_selinux_special_fs', '_ansible_module_name', '_ansible_version', '_ansible_syslog_facility']
if add_file_common_args: if add_file_common_args:
for k, v in FILE_COMMON_ARGUMENTS.items(): for k, v in FILE_COMMON_ARGUMENTS.items():
@ -1229,8 +1229,6 @@ class AnsibleModule(object):
for (k,v) in list(self.params.items()): for (k,v) in list(self.params.items()):
if k == '_ansible_check_mode' and v: if k == '_ansible_check_mode' and v:
if not self.supports_check_mode:
self.exit_json(skipped=True, msg="remote module does not support check mode")
self.check_mode = True self.check_mode = True
elif k == '_ansible_no_log': elif k == '_ansible_no_log':
@ -1254,6 +1252,9 @@ class AnsibleModule(object):
elif k == '_ansible_version': elif k == '_ansible_version':
self.ansible_version = v self.ansible_version = v
elif k == '_ansible_module_name':
self._name = v
elif check_invalid_arguments and k not in self._legal_inputs: elif check_invalid_arguments and k not in self._legal_inputs:
self.fail_json(msg="unsupported parameter for module: %s" % k) self.fail_json(msg="unsupported parameter for module: %s" % k)
@ -1261,6 +1262,9 @@ class AnsibleModule(object):
if k.startswith('_ansible_'): if k.startswith('_ansible_'):
del self.params[k] del self.params[k]
if self.check_mode and not self.supports_check_mode:
self.exit_json(skipped=True, msg="remote module (%s) does not support check mode" % self._name)
def _count_terms(self, check): def _count_terms(self, check):
count = 0 count = 0
for term in check: for term in check:
@ -1537,7 +1541,7 @@ class AnsibleModule(object):
def _log_to_syslog(self, msg): def _log_to_syslog(self, msg):
if HAS_SYSLOG: if HAS_SYSLOG:
module = 'ansible-%s' % os.path.basename(__file__) module = 'ansible-%s' % self._name
facility = getattr(syslog, self._syslog_facility, syslog.LOG_USER) facility = getattr(syslog, self._syslog_facility, syslog.LOG_USER)
syslog.openlog(str(module), 0, facility) syslog.openlog(str(module), 0, facility)
syslog.syslog(syslog.LOG_INFO, msg) syslog.syslog(syslog.LOG_INFO, msg)
@ -1553,7 +1557,7 @@ class AnsibleModule(object):
if log_args is None: if log_args is None:
log_args = dict() log_args = dict()
module = 'ansible-%s' % os.path.basename(__file__) module = 'ansible-%s' % self._name
if isinstance(module, bytes): if isinstance(module, bytes):
module = module.decode('utf-8', 'replace') module = module.decode('utf-8', 'replace')

3
lib/ansible/plugins/action/__init__.py
View file

@ -574,6 +574,9 @@ class ActionBase(with_metaclass(ABCMeta, object)):
# give the module information about the ansible version # give the module information about the ansible version
module_args['_ansible_version'] = __version__ module_args['_ansible_version'] = __version__
# give the module information about its name
module_args['_ansible_module_name'] = module_name
# set the syslog facility to be used in the module # 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) module_args['_ansible_syslog_facility'] = task_vars.get('ansible_syslog_facility', C.DEFAULT_SYSLOG_FACILITY)