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

better information for user from inventory plugins (#46766)

Browse source 
* better information for user from inventory plugins

 - use foreman as example
This commit is contained in:
Brian Coca 2018-10-12 11:27:29 -04:00 committed by GitHub
parent a5bd84758a
commit 9e0c2a658f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/inv_fixes.yml Normal file
View file

@ -0,0 +1,2 @@
bugfixes:
- Give user better error messages and more information on verbose about inventory plugin behaviour

2
lib/ansible/inventory/manager.py
View file

@ -278,7 +278,7 @@ class InventoryManager(object):
display.debug('%s failed to parse %s' % (plugin_name, source)) display.debug('%s failed to parse %s' % (plugin_name, source))
failures.append({'src': source, 'plugin': plugin_name, 'exc': AnsibleError(e)}) failures.append({'src': source, 'plugin': plugin_name, 'exc': AnsibleError(e)})
else: else:
display.debug('%s did not meet %s requirements' % (source, plugin_name)) display.v('%s did not meet %s requirements, check plugin documentation if this is unexpected' % (source, plugin_name))
else: else:
if not parsed and failures: if not parsed and failures:
# only if no plugin processed files should we show errors. # only if no plugin processed files should we show errors.

7
lib/ansible/plugins/inventory/__init__.py
View file

@ -170,8 +170,13 @@ class BaseInventoryPlugin(AnsiblePlugin):
So only call this base class if you expect it to be a file. So only call this base class if you expect it to be a file.
''' '''
valid = False
b_path = to_bytes(path, errors='surrogate_or_strict') b_path = to_bytes(path, errors='surrogate_or_strict')
return (os.path.exists(b_path) and os.access(b_path, os.R_OK)) if (os.path.exists(b_path) and os.access(b_path, os.R_OK)):
valid = True
else:
self.display.vvv('Skipping due to inventory source not existing or not being readable by the current user')
return valid
def _populate_host_vars(self, hosts, variables, group=None, port=None): def _populate_host_vars(self, hosts, variables, group=None, port=None):
if not isinstance(variables, Mapping): if not isinstance(variables, Mapping):

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

@ -14,7 +14,7 @@ DOCUMENTATION = '''
- requests >= 1.1 - requests >= 1.1
description: description:
- Get inventory hosts from the foreman service. - Get inventory hosts from the foreman service.
- "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
options: options:
@ -29,7 +29,7 @@ DOCUMENTATION = '''
description: foreman authentication user description: foreman authentication user
required: True required: True
password: password:
description: forman authentication password description: foreman authentication password
required: True required: True
validate_certs: validate_certs:
description: verify SSL certificate if using https description: verify SSL certificate if using https
@ -102,6 +102,8 @@ class InventoryModule(BaseInventoryPlugin, Cacheable):
if super(InventoryModule, self).verify_file(path): if super(InventoryModule, self).verify_file(path):
if path.endswith(('foreman.yaml', 'foreman.yml')): if path.endswith(('foreman.yaml', 'foreman.yml')):
valid = True valid = True
else:
self.display.vvv('Skipping due to inventory source not ending in "foreman.yaml" nor "foreman.yml"')
return valid return valid
def _get_session(self): def _get_session(self):