[Enhancement] [zos_job_submit, zos_script, zos_unarchive] Remove use of deep copy when calling action modules (#1561)

fernandofloresg · web-flow · commit 0a5ef1603659 · 2024-07-02T15:29:17.000-06:00
* add workaround fix

* Use correct action loader

* Changed action plugin

* Added changelog fragment

* Added unarchive docs

* Added changelog

* Added changelog

* Fixed sanity issues

* fixed pyflakes
diff --git a/changelogs/fragments/1561-remove_deep_copy.yml b/changelogs/fragments/1561-remove_deep_copy.yml
@@ -0,0 +1,10 @@
+minor_changes:
+  - zos_job_submit - Improved the copy to remote mechanic to avoid using deepcopy that could
+    result in failure for some systems.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1561).
+  - zos_script - Improved the copy to remote mechanic to avoid using deepcopy that could
+    result in failure for some systems.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1561).
+  - zos_unarchive - Improved the copy to remote mechanic to avoid using deepcopy that could
+    result in failure for some systems.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1561).
diff --git a/plugins/action/zos_job_submit.py b/plugins/action/zos_job_submit.py
@@ -20,10 +20,8 @@
 from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.module_utils.parsing.convert_bool import boolean
 import os
-import copy
 
 from ansible_collections.ibm.ibm_zos_core.plugins.module_utils import template
-from ansible_collections.ibm.ibm_zos_core.plugins.action.zos_copy import ActionModule as ZosCopyActionModule
 
 
 display = Display()
@@ -151,15 +149,17 @@ def run(self, tmp=None, task_vars=None):
                     remote_src=True,
                 )
             )
-            copy_task = copy.deepcopy(self._task)
+            copy_task = self._task.copy()
             copy_task.args = copy_module_args
-            zos_copy_action_module = ZosCopyActionModule(task=copy_task,
-                                                         connection=self._connection,
-                                                         play_context=self._play_context,
-                                                         loader=self._loader,
-                                                         templar=self._templar,
-                                                         shared_loader_obj=self._shared_loader_obj)
-            result.update(zos_copy_action_module.run(task_vars=task_vars))
+            copy_action = self._shared_loader_obj.action_loader.get(
+                'ibm.ibm_zos_core.zos_copy',
+                task=copy_task,
+                connection=self._connection,
+                play_context=self._play_context,
+                loader=self._loader,
+                templar=self._templar,
+                shared_loader_obj=self._shared_loader_obj)
+            result.update(copy_action.run(task_vars=task_vars))
             if result.get("msg") is None:
                 module_args["src"] = dest_path
                 result.update(
diff --git a/plugins/action/zos_script.py b/plugins/action/zos_script.py
@@ -12,13 +12,11 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-import copy
 import shlex
 from os import path
 
 from ansible.plugins.action import ActionBase
 from ansible.module_utils.parsing.convert_bool import boolean
-from ansible_collections.ibm.ibm_zos_core.plugins.action.zos_copy import ActionModule as ZosCopyActionModule
 
 from ansible.utils.display import Display
 display = Display()
@@ -90,7 +88,7 @@ def run(self, tmp=None, task_vars=None):
             tempfile_path = tempfile_result.get('path')
 
             # Letting zos_copy handle the transfer of the script.
-            zos_copy_args = dict(
+            copy_module_args = dict(
                 src=script_path,
                 dest=tempfile_path,
                 force=True,
@@ -99,18 +97,17 @@ def run(self, tmp=None, task_vars=None):
                 use_template=module_args.get('use_template', False),
                 template_parameters=module_args.get('template_parameters', dict())
             )
-            copy_task = copy.deepcopy(self._task)
-            copy_task.args = zos_copy_args
-            zos_copy_action_plugin = ZosCopyActionModule(
+            copy_task = self._task.copy()
+            copy_task.args = copy_module_args
+            copy_action = self._shared_loader_obj.action_loader.get(
+                'ibm.ibm_zos_core.zos_copy',
                 task=copy_task,
                 connection=self._connection,
                 play_context=self._play_context,
                 loader=self._loader,
                 templar=self._templar,
-                shared_loader_obj=self._shared_loader_obj
-            )
-
-            zos_copy_result = zos_copy_action_plugin.run(task_vars=task_vars)
+                shared_loader_obj=self._shared_loader_obj)
+            zos_copy_result = copy_action.run(task_vars=task_vars)
             result.update(zos_copy_result)
 
             if not result.get("changed") or result.get("failed"):
diff --git a/plugins/action/zos_unarchive.py b/plugins/action/zos_unarchive.py
@@ -17,8 +17,6 @@
 from ansible.utils.display import Display
 from ansible.module_utils.parsing.convert_bool import boolean
 import os
-import copy
-from ansible_collections.ibm.ibm_zos_core.plugins.action.zos_copy import ActionModule as ZosCopyActionModule
 
 
 USS_SUPPORTED_FORMATS = ['tar', 'zip', 'bz2', 'pax', 'gz']
@@ -102,15 +100,17 @@ def run(self, tmp=None, task_vars=None):
                     is_binary=True,
                 )
             )
-            copy_task = copy.deepcopy(self._task)
+            copy_task = self._task.copy()
             copy_task.args = copy_module_args
-            zos_copy_action_module = ZosCopyActionModule(task=copy_task,
-                                                         connection=self._connection,
-                                                         play_context=self._play_context,
-                                                         loader=self._loader,
-                                                         templar=self._templar,
-                                                         shared_loader_obj=self._shared_loader_obj)
-            result.update(zos_copy_action_module.run(task_vars=task_vars))
+            copy_action = self._shared_loader_obj.action_loader.get(
+                'ibm.ibm_zos_core.zos_copy',
+                task=copy_task,
+                connection=self._connection,
+                play_context=self._play_context,
+                loader=self._loader,
+                templar=self._templar,
+                shared_loader_obj=self._shared_loader_obj)
+            result.update(copy_action.run(task_vars=task_vars))
             display.vvv(u"Copy result {0}".format(result), host=self._play_context.remote_addr)
             if result.get("msg") is None:
                 module_args["src"] = dest
diff --git a/plugins/modules/zos_job_submit.py b/plugins/modules/zos_job_submit.py
@@ -710,7 +710,6 @@ def submit_src_jcl(module, src, src_name=None, timeout=0, is_unix=True, start_ti
         "fetch_max_retries": timeout,
     }
 
-    present = False
     duration = 0
     job_submitted = None
     result = {}
diff --git a/plugins/modules/zos_unarchive.py b/plugins/modules/zos_unarchive.py
@@ -35,6 +35,7 @@
       - The remote absolute path or data set of the archive to be uncompressed.
       - I(src) can be a USS file or MVS data set name.
       - USS file paths should be absolute paths.
+      - MVS data sets supported types are C(SEQ), C(PDS), C(PDSE).
       - GDS relative names are supported C(e.g. USER.GDG(-1)).
     type: str
     required: true

Original file line number	Diff line number	Diff line change
`@@ -710,7 +710,6 @@ def submit_src_jcl(module, src, src_name=None, timeout=0, is_unix=True, start_ti`
`710`	`710`	`"fetch_max_retries": timeout,`
`711`	`711`	`}`
`712`	`712`
`713`		`- present = False`
`714`	`713`	`duration = 0`
`715`	`714`	`job_submitted = None`
`716`	`715`	`result = {}`