summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Coca <bcoca@users.noreply.github.com>2022-05-11 11:54:50 -0400
committerGitHub <noreply@github.com>2022-05-11 10:54:50 -0500
commit67f06ed83c73da996a2824803979b49863cd1497 (patch)
treebb95fdee41f446f317f92f25ce5ec642392893eb
parentd5e5bd34d6249b3b0c66c3423fa09a9f3b032467 (diff)
downloadansible-67f06ed83c73da996a2824803979b49863cd1497.tar.gz
dont rely on path to set config defs for plugins (#77659) (#77696)
(cherry picked from commit a3cc6a581ef191faf1c9ec102d1c116c4c2a8778)
-rw-r--r--changelogs/fragments/config_load_by_name.yml2
-rw-r--r--lib/ansible/plugins/loader.py13
-rwxr-xr-xtest/integration/targets/plugin_loader/runme.sh3
-rw-r--r--test/integration/targets/plugin_loader/use_coll_name.yml7
4 files changed, 21 insertions, 4 deletions
diff --git a/changelogs/fragments/config_load_by_name.yml b/changelogs/fragments/config_load_by_name.yml
new file mode 100644
index 0000000000..8174bbb311
--- /dev/null
+++ b/changelogs/fragments/config_load_by_name.yml
@@ -0,0 +1,2 @@
+bugfixes:
+ - plugin loader will now load config data for plugin by name instead of by file to avoid issues with the same file being loaded under different names (fqcn + short name).
diff --git a/lib/ansible/plugins/loader.py b/lib/ansible/plugins/loader.py
index 33dc10c2a3..d7089b96af 100644
--- a/lib/ansible/plugins/loader.py
+++ b/lib/ansible/plugins/loader.py
@@ -379,7 +379,7 @@ class PluginLoader:
type_name = get_plugin_class(self.class_name)
# if type name != 'module_doc_fragment':
- if type_name in C.CONFIGURABLE_PLUGINS:
+ if type_name in C.CONFIGURABLE_PLUGINS and not C.config.get_configuration_definition(type_name, name):
dstring = AnsibleLoader(getattr(module, 'DOCUMENTATION', ''), file_name=path).get_single_data()
if dstring:
add_fragments(dstring, path, fragment_loader=fragment_loader, is_module=(type_name == 'module'))
@@ -809,10 +809,12 @@ class PluginLoader:
if path not in self._module_cache:
self._module_cache[path] = self._load_module_source(name, path)
- self._load_config_defs(name, self._module_cache[path], path)
found_in_cache = False
+ self._load_config_defs(name, self._module_cache[path], path)
+
obj = getattr(self._module_cache[path], self.class_name)
+
if self.base_class:
# The import path is hardcoded and should be the right place,
# so we are not expecting an ImportError.
@@ -933,15 +935,18 @@ class PluginLoader:
else:
full_name = basename
module = self._load_module_source(full_name, path)
- self._load_config_defs(basename, module, path)
except Exception as e:
display.warning("Skipping plugin (%s) as it seems to be invalid: %s" % (path, to_text(e)))
continue
self._module_cache[path] = module
found_in_cache = False
+ else:
+ module = self._module_cache[path]
+
+ self._load_config_defs(basename, module, path)
try:
- obj = getattr(self._module_cache[path], self.class_name)
+ obj = getattr(module, self.class_name)
except AttributeError as e:
display.warning("Skipping plugin (%s) as it seems to be invalid: %s" % (path, to_text(e)))
continue
diff --git a/test/integration/targets/plugin_loader/runme.sh b/test/integration/targets/plugin_loader/runme.sh
index 2a1bdedaca..1b8e1a84ab 100755
--- a/test/integration/targets/plugin_loader/runme.sh
+++ b/test/integration/targets/plugin_loader/runme.sh
@@ -22,3 +22,6 @@ do
exit 1
fi
done
+
+# test config loading
+ansible-playbook use_coll_name.yml -i ../../inventory -e 'ansible_connection=ansible.builtin.ssh' "$@"
diff --git a/test/integration/targets/plugin_loader/use_coll_name.yml b/test/integration/targets/plugin_loader/use_coll_name.yml
new file mode 100644
index 0000000000..66507ced2c
--- /dev/null
+++ b/test/integration/targets/plugin_loader/use_coll_name.yml
@@ -0,0 +1,7 @@
+- name: ensure configuration is loaded when we use FQCN and have already loaded using 'short namne' (which is case will all builtin connection plugins)
+ hosts: all
+ gather_facts: false
+ tasks:
+ - name: relies on extra var being passed in with connection and fqcn
+ ping:
+ ignore_unreachable: True