c1f1b2029c
* Move var plugins handling to a separate file
* Allow var plugins to require whitelisting
* Add global configuration ('demand', 'start') for users to control when they execute
* Add 'stage' configuration ('all', 'task', 'inventory') for users to control on a per-plugin basis when they execute
* Update ansible-inventory and InventoryManager to the global and stage configuration
* Update host_group_vars to use stage configuration and whitelisting
* Add documentation for using new options and to the developer's guide
* Add integration tests to exercise whitelisting and the new configuration options, using vars plugins in collections, and maintain backward compatibility
* Changelog
Co-Authored-By: Brian Coca <brian.coca+git@gmail.com>
Co-Authored-By: Sandra McCann <samccann@redhat.com>
96 lines
3.4 KiB
Python
96 lines
3.4 KiB
Python
# Copyright (c) 2018 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
|
|
from ansible import constants as C
|
|
from ansible.errors import AnsibleError
|
|
from ansible.inventory.host import Host
|
|
from ansible.module_utils._text import to_bytes
|
|
from ansible.plugins.loader import vars_loader
|
|
from ansible.utils.collection_loader import AnsibleCollectionRef
|
|
from ansible.utils.display import Display
|
|
from ansible.utils.vars import combine_vars
|
|
|
|
display = Display()
|
|
|
|
|
|
def get_plugin_vars(loader, plugin, path, entities):
|
|
|
|
data = {}
|
|
try:
|
|
data = plugin.get_vars(loader, path, entities)
|
|
except AttributeError:
|
|
try:
|
|
for entity in entities:
|
|
if isinstance(entity, Host):
|
|
data.update(plugin.get_host_vars(entity.name))
|
|
else:
|
|
data.update(plugin.get_group_vars(entity.name))
|
|
except AttributeError:
|
|
if hasattr(plugin, 'run'):
|
|
raise AnsibleError("Cannot use v1 type vars plugin %s from %s" % (plugin._load_name, plugin._original_path))
|
|
else:
|
|
raise AnsibleError("Invalid vars plugin %s from %s" % (plugin._load_name, plugin._original_path))
|
|
return data
|
|
|
|
|
|
def get_vars_from_path(loader, path, entities, stage):
|
|
|
|
data = {}
|
|
|
|
vars_plugin_list = list(vars_loader.all())
|
|
for plugin_name in C.VARIABLE_PLUGINS_ENABLED:
|
|
if AnsibleCollectionRef.is_valid_fqcr(plugin_name):
|
|
vars_plugin = vars_loader.get(plugin_name)
|
|
if vars_plugin is None:
|
|
# Error if there's no play directory or the name is wrong?
|
|
continue
|
|
if vars_plugin not in vars_plugin_list:
|
|
vars_plugin_list.append(vars_plugin)
|
|
|
|
for plugin in vars_plugin_list:
|
|
if plugin._load_name not in C.VARIABLE_PLUGINS_ENABLED and getattr(plugin, 'REQUIRES_WHITELIST', False):
|
|
# 2.x plugins shipped with ansible should require whitelisting, older or non shipped should load automatically
|
|
continue
|
|
|
|
has_stage = hasattr(plugin, 'get_option') and plugin.has_option('stage')
|
|
|
|
# if a plugin-specific setting has not been provided, use the global setting
|
|
# older/non shipped plugins that don't support the plugin-specific setting should also use the global setting
|
|
use_global = (has_stage and plugin.get_option('stage') is None) or not has_stage
|
|
|
|
if use_global:
|
|
if C.RUN_VARS_PLUGINS == 'demand' and stage == 'inventory':
|
|
continue
|
|
elif C.RUN_VARS_PLUGINS == 'start' and stage == 'task':
|
|
continue
|
|
elif has_stage and plugin.get_option('stage') not in ('all', stage):
|
|
continue
|
|
|
|
data = combine_vars(data, get_plugin_vars(loader, plugin, path, entities))
|
|
|
|
return data
|
|
|
|
|
|
def get_vars_from_inventory_sources(loader, sources, entities, stage):
|
|
|
|
data = {}
|
|
for path in sources:
|
|
|
|
if path is None:
|
|
continue
|
|
if ',' in path and not os.path.exists(path): # skip host lists
|
|
continue
|
|
elif not os.path.isdir(to_bytes(path)):
|
|
# always pass the directory of the inventory source file
|
|
path = os.path.dirname(path)
|
|
|
|
data = combine_vars(data, get_vars_from_path(loader, path, entities, stage))
|
|
|
|
return data
|