From fa81cc6a0c44640b54e5513720d7413a762618e1 Mon Sep 17 00:00:00 2001 From: Matt Davis Date: Tue, 26 May 2020 15:55:17 -0700 Subject: [PATCH] fix delegated loading when path is not a directory (#69713) * find_module can't pop ImportError- we need to just translate to `None` since this is a normal condition with files on sys.path (eg `/usr/lib/python36.zip`) * added test --- .../utils/collection_loader/_collection_finder.py | 7 ++++++- .../utils/collection_loader/test_collection_loader.py | 9 +++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/lib/ansible/utils/collection_loader/_collection_finder.py b/lib/ansible/utils/collection_loader/_collection_finder.py index c2366680ace..1cfd04113ef 100644 --- a/lib/ansible/utils/collection_loader/_collection_finder.py +++ b/lib/ansible/utils/collection_loader/_collection_finder.py @@ -228,7 +228,12 @@ class _AnsiblePathHookFinder: if PY3: # create or consult our cached file finder for this path if not self._file_finder: - self._file_finder = _AnsiblePathHookFinder._filefinder_path_hook(self._pathctx) + try: + self._file_finder = _AnsiblePathHookFinder._filefinder_path_hook(self._pathctx) + except ImportError: + # FUTURE: log at a high logging level? This is normal for things like python36.zip on the path, but + # might not be in some other situation... + return None spec = self._file_finder.find_spec(fullname) if not spec: diff --git a/test/units/utils/collection_loader/test_collection_loader.py b/test/units/utils/collection_loader/test_collection_loader.py index fccc3a77986..e415b9e3d0d 100644 --- a/test/units/utils/collection_loader/test_collection_loader.py +++ b/test/units/utils/collection_loader/test_collection_loader.py @@ -273,6 +273,15 @@ def test_path_hook_setup(): assert repr(_AnsiblePathHookFinder(object(), '/bogus/path')) == "_AnsiblePathHookFinder(path='/bogus/path')" +def test_path_hook_importerror(): + # ensure that AnsiblePathHookFinder.find_module swallows ImportError from path hook delegation on Py3, eg if the delegated + # path hook gets passed a file on sys.path (python36.zip) + reset_collections_loader_state() + path_to_a_file = os.path.join(default_test_collection_paths[0], 'ansible_collections/testns/testcoll/plugins/action/my_action.py') + # it's a bug if the following pops an ImportError... + assert _AnsiblePathHookFinder(_AnsibleCollectionFinder(), path_to_a_file).find_module('foo.bar.my_action') is None + + def test_new_or_existing_module(): module_name = 'blar.test.module' pkg_name = module_name.rpartition('.')[0]