84e473a26e
* all lookups to support config system - added get_options to get full dict with all opts - fixed tests to match new error messages - kept inline string k=v parsing methods for backwards compat - placeholder depredation for inline string k=v parsing - updated tests and examples to also show new way - refactored and added comments to most custom k=v parsing - added missing docs for template_vars to template - normalized error messages and exception types - fixed constants default - better details value errors Co-authored-by: Felix Fontein <felix@fontein.de>
97 lines
3.6 KiB
Python
97 lines
3.6 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.errors import AnsibleError
|
|
from ansible.module_utils._text import to_native
|
|
from ansible.module_utils.six import with_metaclass, string_types
|
|
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:
|
|
try:
|
|
option_value = C.config.get_config_value(option, plugin_type=get_plugin_class(self), plugin_name=self._load_name, variables=hostvars)
|
|
except AnsibleError as e:
|
|
raise KeyError(to_native(e))
|
|
self.set_option(option, option_value)
|
|
return self._options.get(option)
|
|
|
|
def get_options(self, hostvars=None):
|
|
options = {}
|
|
defs = C.config.get_configuration_definitions(plugin_type=get_plugin_class(self), name=self._load_name)
|
|
for option in defs:
|
|
options[option] = self.get_option(option, hostvars=hostvars)
|
|
return options
|
|
|
|
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 'connection variables'
|
|
:arg direct: Dict with 'direct assignment'
|
|
'''
|
|
self._options = C.config.get_plugin_options(get_plugin_class(self), self._load_name, keys=task_keys, variables=var_options, direct=direct)
|
|
|
|
# allow extras/wildcards from vars that are not directly consumed in configuration
|
|
# this is needed to support things like winrm that can have extended protocol options we don't directly handle
|
|
if self.allow_extras and var_options and '_extras' in var_options:
|
|
self.set_option('_extras', var_options['_extras'])
|
|
|
|
def has_option(self, option):
|
|
if not self._options:
|
|
self.set_options()
|
|
return option in self._options
|
|
|
|
def _check_required(self):
|
|
# FIXME: standardize required check based on config
|
|
pass
|