Fix import logic trying to load incorrect module

changelogs/fragments/102-fix-incorrect-module-loading.yaml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - fix turbo mode loading incorrect module (https://github.com/ansible-collections/cloud.common/pull/102).

plugins/module_utils/turbo/server.py

@@ -127,30 +127,29 @@ async def load(self):
 
             # resettle the loaded modules that were associated
             # with a different Ansiblez.
-            for path, module in tuple(sys.modules.items()):
+            for path, module in sorted(tuple(sys.modules.items())):
                 if path and module and path.startswith("ansible_collections"):
                     try:
                         prefix = sys.modules[path].__loader__.prefix
                     except AttributeError:
                         # Not from a zipimporter loader, skipping
                         continue
-                    py_path = self.ansiblez_path + os.sep + prefix
-                    my_loader = zipimporter(py_path)
-                    sys.meta_path.append(my_loader)
+                    # Reload package modules only, to pick up new modules from
+                    # packages that have been previously loaded.
                     if hasattr(sys.modules[path], "__path__"):
-                        sys.modules[path].__path__ = py_path
-
+                        py_path = self.ansiblez_path + os.sep + prefix
+                        my_loader = zipimporter(py_path)
+                        sys.modules[path].__loader__ = my_loader
+                        try:
+                            importlib.reload(sys.modules[path])
+                        except ModuleNotFoundError:
+                            pass
             # Finally, load the plugin class.
             self.module_class = importlib.import_module(self.module_path)
 
     async def unload(self):
         async with sys_path_lock:
             sys.path = [i for i in sys.path if i != self.ansiblez_path]
-            sys.meta_path = [
-                i
-                for i in sys.meta_path
-                if not (isinstance(i, zipimporter) and i.archive == self.ansiblez_path)
-            ]
 
     def create_profiler(self):
         if self.debug_mode:

plugins/module_utils/turbo_demo.py

@@ -0,0 +1 @@
+# This module is part of the test suite to check the import logic of turbo mode

plugins/modules/turbo_demo.py

@@ -65,6 +65,8 @@ def run_module():
 
 
 def main():
+    from ansible_collections.cloud.common.plugins.module_utils import turbo_demo
+
     run_module()
 
 

plugins/modules/turbo_import.py

@@ -0,0 +1,42 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (C) 2022, Red Hat
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+DOCUMENTATION = r"""
+---
+module: turbo_import
+short_description: A demo module to test import logic for turbo mode
+version_added: "1.0.0"
+description:
+- "This module tests the import logic for turbo mode."
+author:
+- Mike Graves (@gravesm)
+"""
+
+EXAMPLES = r"""
+- name: Run the module
+  cloud.common.turbo_import:
+"""
+
+
+from ansible_collections.cloud.common.plugins.module_utils.turbo.module import (
+    AnsibleTurboModule as AnsibleModule,
+)
+
+
+def run_module():
+    module = AnsibleModule(argument_spec={})
+    module.collection_name = "cloud.common"
+    module.exit_json(changed=False)
+
+
+def main():
+    from ansible_collections.cloud.common.plugins.module_utils import turbo_demo
+
+    run_module()
+
+
+if __name__ == "__main__":
+    main()

tests/integration/targets/turbo_mode/tasks/main.yaml

@@ -1,3 +1,5 @@
+- cloud.common.turbo_import:
+
 - cloud.common.turbo_demo:
   with_sequence: count=10
   register: _result

tests/sanity/ignore-2.10.txt

@@ -66,3 +66,11 @@ tests/unit/plugins/module_utils/turbo/conftest.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/conftest.py metaclass-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py metaclass-boilerplate!skip
+plugins/modules/turbo_import.py compile-2.6!skip
+plugins/modules/turbo_import.py compile-2.7!skip
+plugins/modules/turbo_import.py compile-3.5!skip
+plugins/modules/turbo_import.py future-import-boilerplate!skip
+plugins/modules/turbo_import.py import-2.6!skip
+plugins/modules/turbo_import.py import-2.7!skip
+plugins/modules/turbo_import.py import-3.5!skip
+plugins/modules/turbo_import.py metaclass-boilerplate!skip

tests/sanity/ignore-2.11.txt

@@ -74,3 +74,11 @@ tests/unit/plugins/module_utils/turbo/conftest.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/conftest.py metaclass-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py metaclass-boilerplate!skip
+plugins/modules/turbo_import.py compile-2.6!skip
+plugins/modules/turbo_import.py compile-2.7!skip
+plugins/modules/turbo_import.py compile-3.5!skip
+plugins/modules/turbo_import.py future-import-boilerplate!skip
+plugins/modules/turbo_import.py import-2.6!skip
+plugins/modules/turbo_import.py import-2.7!skip
+plugins/modules/turbo_import.py import-3.5!skip
+plugins/modules/turbo_import.py metaclass-boilerplate!skip

tests/sanity/ignore-2.12.txt

@@ -50,3 +50,11 @@ tests/unit/plugins/module_utils/turbo/conftest.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/conftest.py metaclass-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py metaclass-boilerplate!skip
+plugins/modules/turbo_import.py compile-2.6!skip
+plugins/modules/turbo_import.py compile-2.7!skip
+plugins/modules/turbo_import.py compile-3.5!skip
+plugins/modules/turbo_import.py future-import-boilerplate!skip
+plugins/modules/turbo_import.py import-2.6!skip
+plugins/modules/turbo_import.py import-2.7!skip
+plugins/modules/turbo_import.py import-3.5!skip
+plugins/modules/turbo_import.py metaclass-boilerplate!skip

tests/sanity/ignore-2.13.txt

@@ -39,3 +39,9 @@ tests/unit/plugins/module_utils/turbo/conftest.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/conftest.py metaclass-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py metaclass-boilerplate!skip
+plugins/modules/turbo_import.py compile-2.7!skip
+plugins/modules/turbo_import.py compile-3.5!skip
+plugins/modules/turbo_import.py future-import-boilerplate!skip
+plugins/modules/turbo_import.py import-2.7!skip
+plugins/modules/turbo_import.py import-3.5!skip
+plugins/modules/turbo_import.py metaclass-boilerplate!skip

tests/sanity/ignore-2.9.txt

@@ -66,3 +66,11 @@ tests/unit/plugins/module_utils/turbo/conftest.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/conftest.py metaclass-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py future-import-boilerplate!skip
 tests/unit/plugins/module_utils/turbo/test_module.py metaclass-boilerplate!skip
+plugins/modules/turbo_import.py compile-2.6!skip
+plugins/modules/turbo_import.py compile-2.7!skip
+plugins/modules/turbo_import.py compile-3.5!skip
+plugins/modules/turbo_import.py future-import-boilerplate!skip
+plugins/modules/turbo_import.py import-2.6!skip
+plugins/modules/turbo_import.py import-2.7!skip
+plugins/modules/turbo_import.py import-3.5!skip
+plugins/modules/turbo_import.py metaclass-boilerplate!skip