mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-30 22:31:25 -07:00
23b1dbacaf
* included inventory and callback in new config allow inventory to be configurable updated connection options settings also updated winrm to work with new configs removed now obsolete set_host_overrides added notes for future bcoca, current one is just punting, it's future's problem updated docs per feedback added remove group/host methods to inv data moved fact cache from data to constructed cleaner/better options fix when vars are added extended ignore list to config dicts updated paramiko connection docs removed options from base that paramiko already handles left the look option as it is used by other plugin types resolve delegation updated cache doc options fixed test_script better fragment merge for options fixed proxy command restore ini for proxy normalized options moved pipelining to class updates for host_key_checking restructured mixins * fix typo
90 lines
3.2 KiB
Python
90 lines
3.2 KiB
Python
# (c) 2012, Daniel Hokka Zakrisson <daniel@hozac.com>
|
|
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com> and others
|
|
# (c) 2017, Toshio Kuratomi <tkuratomi@ansible.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)
|
|
__metaclass__ = type
|
|
|
|
from abc import ABCMeta
|
|
|
|
from ansible import constants as C
|
|
from ansible.module_utils.six import with_metaclass, string_types
|
|
|
|
try:
|
|
from __main__ import display
|
|
except ImportError:
|
|
from ansible.utils.display import Display
|
|
display = Display()
|
|
|
|
# Global so that all instances of a PluginLoader will share the caches
|
|
MODULE_CACHE = {}
|
|
PATH_CACHE = {}
|
|
PLUGIN_PATH_CACHE = {}
|
|
|
|
|
|
def get_plugin_class(obj):
|
|
if isinstance(obj, string_types):
|
|
return obj.lower().replace('module', '')
|
|
else:
|
|
return obj.__class__.__name__.lower().replace('module', '')
|
|
|
|
|
|
class AnsiblePlugin(with_metaclass(ABCMeta, object)):
|
|
|
|
# allow extra passthrough parameters
|
|
allow_extras = False
|
|
|
|
def __init__(self):
|
|
self._options = {}
|
|
|
|
def get_option(self, option, hostvars=None):
|
|
if option not in self._options:
|
|
option_value = C.config.get_config_value(option, plugin_type=get_plugin_class(self), plugin_name=self.name, variables=hostvars)
|
|
self.set_option(option, option_value)
|
|
return self._options.get(option)
|
|
|
|
def set_option(self, option, value):
|
|
self._options[option] = value
|
|
|
|
def set_options(self, task_keys=None, var_options=None, direct=None):
|
|
'''
|
|
Sets the _options attribute with the configuration/keyword information for this plugin
|
|
|
|
:arg task_keys: Dict with playbook keywords that affect this option
|
|
:arg var_options: Dict with either 'conneciton variables'
|
|
:arg direct: Dict with 'direct assignment'
|
|
'''
|
|
|
|
if not self._options:
|
|
# load config options if we have not done so already, if vars provided we should be mostly done
|
|
self._options = C.config.get_plugin_options(get_plugin_class(self), self._load_name, keys=task_keys, variables=var_options)
|
|
|
|
# they can be direct options overriding config
|
|
if direct:
|
|
for k in self._options:
|
|
if k in direct:
|
|
self.set_option(k, direct[k])
|
|
|
|
# allow extras/wildcards from vars that are not directly consumed in configuration
|
|
if self.allow_extras and var_options and '_extras' in var_options:
|
|
self.set_option('_extras', var_options['_extras'])
|
|
|
|
def _check_required(self):
|
|
# FIXME: standarize required check based on config
|
|
pass
|