plugin loader: return collection name; ansible-doc: handle ansible.builtin correctly

[felixfontein]

SUMMARY

Follow-up to #70401. Determines the collection name properly also for ansible.builtin (avoid confusion with user-supplied plugins).

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

lib/ansible/cli/doc.py
lib/ansible/plugins/loader.py

[ansibot]

The test ansible-test sanity --test package-data [explain] failed with the error:

Command "/usr/bin/python3.6 /root/ansible/test/sanity/code-smell/package-data.py" returned exit status 1.
>>> Standard Error
Traceback (most recent call last):
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 373, in <module>
    main()
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 350, in main
    sdist_path = create_sdist(tmp_dir)
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 164, in create_sdist
    raise Exception('make snapshot failed:\n%s' % stderr)
Exception: make snapshot failed:
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
ERROR! Unexpected Exception, this is probably a bug: not all arguments converted during string formatting
Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/antsibull_changelog/cli.py", line 213, in run
    return arguments.func(arguments)
  File "/usr/local/lib/python3.6/dist-packages/antsibull_changelog/cli.py", line 316, in command_release
    use_ansible_doc=use_ansible_doc)
  File "/usr/local/lib/python3.6/dist-packages/antsibull_changelog/plugins.py", line 296, in load_plugins
    paths, plugin_type, collection_name, use_ansible_doc=use_ansible_doc)
  File "/usr/local/lib/python3.6/dist-packages/antsibull_changelog/plugins.py", line 242, in load_plugin_metadata
    plugins_list = list_plugins_ansibledoc(paths, plugin_type, collection_name)
  File "/usr/local/lib/python3.6/dist-packages/antsibull_changelog/plugins.py", line 198, in list_plugins_ansibledoc
    output = subprocess.check_output(command)
  File "/usr/lib/python3.6/subprocess.py", line 356, in check_output
    **kwargs).stdout
  File "/usr/lib/python3.6/subprocess.py", line 438, in run
    output=stdout, stderr=stderr)
subprocess.CalledProcessError: Command '['ansible-doc', '--json', '-t', 'become', '--list']' returned non-zero exit status 250.
make: *** [changelog] Error 1

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/plugins/loader.py:492:161: E501: line too long (169 > 160 characters)

click here for bot help

[felixfontein]

/rebuild_failed

[felixfontein]

ready_for_review

@nitzmahone @bcoca the collection name generation now works, and it can correctly distinguish between no collection (for plugins/modules from library/ etc.) and ansible.builtin (for plugins/modules from Ansible itself). For this I had to do some changes in the plugin loader:

1. the path list returned by PluginLoader._get_paths() contains for every path name a flag whether this is an Ansible-internal path, or whether this is another (user-supplied) path;
2. the PluginLoader._plugin_path_cache cache now stores pairs (path, collection_name) instead of , and PluginLoadContext has a new field plugin_resolved_collection.

[felixfontein]

At today's project meeting, we decided that this is the wrong approach since we do not want ansible.builtin. to be used for builtin plugins/modules. Will create a new simpler PR.

[nitzmahone]

rebuild_merge

[felixfontein]

/rebuild

[felixfontein]

@nitzmahone @samdoran thanks a lot for reviewing!