internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-06 05:12:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix loading namespaced doc_fragments from collections (#55249)

Browse Source 
* Fix loading namespaced doc_fragments

The syntax for specifying a different fragment name was already
using '.' as a separator, so the code needed to be tweaked to
avoid choking on names like `testns.testcoll.fragname` and
`testns.testcoll.fragname.altvar`.

`get_plugin_class()` returns 'docfragment' for the fragment loader;
mangling `subdir` provides consistent alignment with the normal plugin
directory names and avoids needing special handling of plugin types
with 'module' in the name.

* Add changelog entry
This commit is contained in:
flowerysong
2019-05-02 21:15:58 -04:00
committed by ansibot
parent fcca1a124d
commit 2ef8b297ff
6 changed files with 39 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
lib/ansible/plugins/loader.py
View File

@@ -330,15 +330,12 @@ class PluginLoader:
package = splitname[0]
resource = splitname[1]
append_plugin_type = self.class_name or self.subdir
append_plugin_type = self.subdir.replace('_plugins', '')
if append_plugin_type:
# only current non-class special case, module_utils don't use this loader method
if append_plugin_type == 'library':
append_plugin_type = 'modules'
elif append_plugin_type != 'module_utils':
append_plugin_type = get_plugin_class(append_plugin_type)
package += '.plugins.{0}'.format(append_plugin_type)
if append_plugin_type == 'library':
append_plugin_type = 'modules'
package += '.plugins.{0}'.format(append_plugin_type)
if extension:
resource += extension

8
lib/ansible/utils/plugin_docs.py
View File

@@ -50,14 +50,20 @@ def add_fragments(doc, filename, fragment_loader):
# Allow the module to specify a var other than DOCUMENTATION
# to pull the fragment from, using dot notation as a separator
for fragment_slug in fragments:
fallback_name = None
fragment_slug = fragment_slug.lower()
if '.' in fragment_slug:
fragment_name, fragment_var = fragment_slug.split('.', 1)
fallback_name = fragment_slug
fragment_name, fragment_var = fragment_slug.rsplit('.', 1)
fragment_var = fragment_var.upper()
else:
fragment_name, fragment_var = fragment_slug, 'DOCUMENTATION'
fragment_class = fragment_loader.get(fragment_name)
if fragment_class is None and fallback_name:
fragment_class = fragment_loader.get(fallback_name)
fragment_var = 'DOCUMENTATION'
if fragment_class is None:
raise AnsibleAssertionError('fragment_class is None')