diff options
author | Sloane Hertel <19572925+s-hertel@users.noreply.github.com> | 2022-09-15 14:15:42 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-15 14:15:42 -0400 |
commit | 86b86398f0e0c61df615d1fcf7643f01a1084327 (patch) | |
tree | e5d9f5101bab43a2ec33224015d7313ac57ab62f /lib/ansible/utils | |
parent | a55afcc39a0567850de20ea5223c613bd8b1da83 (diff) | |
download | ansible-86b86398f0e0c61df615d1fcf7643f01a1084327.tar.gz |
add ansible_name/ansible_aliases attrs to plugin objects (#78700)
* new _fqcn attribute to plugin objects
* unbreak plugins in subdirs
* Fix inadventent changes to _load_name and use existing vars
* add plugin aliases and name property, and replace plugin._load_name where incorrect
* Fix listing plugin names
Fix listing legacy and builtin together
test deprecated plugin documentation
fix doc extensions
remove sometimes inaccurate _load_name handling from plugin.name
* Add tests for REJECT_EXTS and doc extensions
Fix unpredictable collection redirects so non-fqcns in the redirect list are guaranteed to be legacy (instead of determined by the collections keyword)
Move aliases and name properties to _update_object so all plugin types, including doc fragments, can use them
* make legacy plugin names internally consistent
* rename attributes to ansible_name and ansible_aliases
Diffstat (limited to 'lib/ansible/utils')
-rw-r--r-- | lib/ansible/utils/plugin_docs.py | 19 |
1 files changed, 5 insertions, 14 deletions
diff --git a/lib/ansible/utils/plugin_docs.py b/lib/ansible/utils/plugin_docs.py index a4c1022992..90943c6d31 100644 --- a/lib/ansible/utils/plugin_docs.py +++ b/lib/ansible/utils/plugin_docs.py @@ -163,10 +163,8 @@ def add_fragments(doc, filename, fragment_loader, is_module=False): fragment = AnsibleLoader(fragment_yaml, file_name=filename).get_single_data() - real_collection_name = 'ansible.builtin' - real_fragment_name = getattr(fragment_class, '_load_name') - if real_fragment_name.startswith('ansible_collections.'): - real_collection_name = '.'.join(real_fragment_name.split('.')[1:3]) + real_fragment_name = getattr(fragment_class, 'ansible_name') + real_collection_name = '.'.join(real_fragment_name.split('.')[0:2]) if '.' in real_fragment_name else '' add_collection_to_versions_and_dates(fragment, real_collection_name, is_module=is_module) if 'notes' in fragment: @@ -296,7 +294,6 @@ def find_plugin_docfile(plugin, plugin_type, loader): ''' if the plugin lives in a non-python file (eg, win_X.ps1), require the corresponding 'sidecar' file for docs ''' context = loader.find_plugin_with_context(plugin, ignore_deprecated=False, check_aliases=True) - plugin_obj = None if (not context or not context.resolved) and plugin_type in ('filter', 'test'): # should only happen for filters/test plugin_obj, context = loader.get_with_context(plugin) @@ -305,14 +302,8 @@ def find_plugin_docfile(plugin, plugin_type, loader): raise AnsiblePluginNotFound('%s was not found' % (plugin), plugin_load_context=context) docfile = Path(context.plugin_resolved_path) - possible_names = [plugin, getattr(plugin_obj, '_load_name', None), docfile.name.removeprefix('_'), docfile.name] - if context: - if context.redirect_list: - possible_names.append(context.redirect_list[-1]) - possible_names.append(context.plugin_resolved_name) - if docfile.suffix not in C.DOC_EXTENSIONS or docfile.name not in possible_names: - # only look for adjacent if plugin file does not support documents or - # name does not match file basname (except deprecated) + if docfile.suffix not in C.DOC_EXTENSIONS: + # only look for adjacent if plugin file does not support documents filename = _find_adjacent(docfile, plugin, C.DOC_EXTENSIONS) else: filename = to_native(docfile) @@ -348,7 +339,7 @@ def get_plugin_docs(plugin, plugin_type, loader, fragment_loader, verbose): # add extra data to docs[0] (aka 'DOCUMENTATION') if docs[0] is None: - raise AnsibleParserError('No documentation availalbe for %s (%s)' % (plugin, filename)) + raise AnsibleParserError('No documentation available for %s (%s)' % (plugin, filename)) else: docs[0]['filename'] = filename docs[0]['collection'] = collection_name |