wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add Constructed to Foreman inventory plugin (#62542)

Browse source 
* add constructed

* changelog
This commit is contained in:
willtome 2019-10-17 05:43:22 -04:00 committed by Sloane Hertel
parent ba686154b9
commit f2ca4cce2b
2 changed files with 18 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/62542-constructed-options-foreman-inventory-plugin.yaml Normal file
View file

@ -0,0 +1,2 @@
minor_changes:
- foreman inventory plugin - Add support for constructed options.

24
lib/ansible/plugins/inventory/foreman.py
View file

@ -17,6 +17,7 @@ DOCUMENTATION = '''
- "Uses a configuration file as an inventory source, it must end in ``.foreman.yml`` or ``.foreman.yaml`` and has a ``plugin: foreman`` entry." - "Uses a configuration file as an inventory source, it must end in ``.foreman.yml`` or ``.foreman.yaml`` and has a ``plugin: foreman`` entry."
extends_documentation_fragment: extends_documentation_fragment:
- inventory_cache - inventory_cache
- constructed
options: options:
plugin: plugin:
description: the name of this plugin, it should always be set to 'foreman' for this plugin to recognize it as it's own. description: the name of this plugin, it should always be set to 'foreman' for this plugin to recognize it as it's own.
@ -74,7 +75,7 @@ from distutils.version import LooseVersion
from ansible.errors import AnsibleError from ansible.errors import AnsibleError
from ansible.module_utils._text import to_bytes, to_native, to_text from ansible.module_utils._text import to_bytes, to_native, to_text
from ansible.module_utils.common._collections_compat import MutableMapping from ansible.module_utils.common._collections_compat import MutableMapping
from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, to_safe_group_name from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, to_safe_group_name, Constructable
# 3rd party imports # 3rd party imports
try: try:
@ -87,7 +88,7 @@ except ImportError:
from requests.auth import HTTPBasicAuth from requests.auth import HTTPBasicAuth
class InventoryModule(BaseInventoryPlugin, Cacheable): class InventoryModule(BaseInventoryPlugin, Cacheable, Constructable):
''' Host inventory parser for ansible using foreman as source. ''' ''' Host inventory parser for ansible using foreman as source. '''
NAME = 'foreman' NAME = 'foreman'
@ -197,38 +198,45 @@ class InventoryModule(BaseInventoryPlugin, Cacheable):
for host in self._get_hosts(): for host in self._get_hosts():
if host.get('name'): if host.get('name'):
self.inventory.add_host(host['name']) host_name = self.inventory.add_host(host['name'])
# create directly mapped groups # create directly mapped groups
group_name = host.get('hostgroup_title', host.get('hostgroup_name')) group_name = host.get('hostgroup_title', host.get('hostgroup_name'))
if group_name: if group_name:
group_name = to_safe_group_name('%s%s' % (self.get_option('group_prefix'), group_name.lower().replace(" ", ""))) group_name = to_safe_group_name('%s%s' % (self.get_option('group_prefix'), group_name.lower().replace(" ", "")))
group_name = self.inventory.add_group(group_name) group_name = self.inventory.add_group(group_name)
self.inventory.add_child(group_name, host['name']) self.inventory.add_child(group_name, host_name)
# set host vars from host info # set host vars from host info
try: try:
for k, v in host.items(): for k, v in host.items():
if k not in ('name', 'hostgroup_title', 'hostgroup_name'): if k not in ('name', 'hostgroup_title', 'hostgroup_name'):
try: try:
self.inventory.set_variable(host['name'], self.get_option('vars_prefix') + k, v) self.inventory.set_variable(host_name, self.get_option('vars_prefix') + k, v)
except ValueError as e: except ValueError as e:
self.display.warning("Could not set host info hostvar for %s, skipping %s: %s" % (host, k, to_text(e))) self.display.warning("Could not set host info hostvar for %s, skipping %s: %s" % (host, k, to_text(e)))
except ValueError as e: except ValueError as e:
self.display.warning("Could not get host info for %s, skipping: %s" % (host['name'], to_text(e))) self.display.warning("Could not get host info for %s, skipping: %s" % (host_name, to_text(e)))
# set host vars from params # set host vars from params
if self.get_option('want_params'): if self.get_option('want_params'):
for p in self._get_all_params_by_id(host['id']): for p in self._get_all_params_by_id(host['id']):
try: try:
self.inventory.set_variable(host['name'], p['name'], p['value']) self.inventory.set_variable(host_name, p['name'], p['value'])
except ValueError as e: except ValueError as e:
self.display.warning("Could not set hostvar %s to '%s' for the '%s' host, skipping: %s" % self.display.warning("Could not set hostvar %s to '%s' for the '%s' host, skipping: %s" %
(p['name'], to_native(p['value']), host, to_native(e))) (p['name'], to_native(p['value']), host, to_native(e)))
# set host vars from facts # set host vars from facts
if self.get_option('want_facts'): if self.get_option('want_facts'):
self.inventory.set_variable(host['name'], 'ansible_facts', self._get_facts(host)) self.inventory.set_variable(host_name, 'ansible_facts', self._get_facts(host))
strict = self.get_option('strict')
hostvars = self.inventory.get_host(host_name).get_vars()
self._set_composite_vars(self.get_option('compose'), hostvars, host_name, strict)
self._add_host_to_composed_groups(self.get_option('groups'), hostvars, host_name, strict)
self._add_host_to_keyed_groups(self.get_option('keyed_groups'), hostvars, host_name, strict)
def parse(self, inventory, loader, path, cache=True): def parse(self, inventory, loader, path, cache=True):