[Bugfix] [module_utils] [multiple modules] tmp_hlq use in utils whenever mvscmd gets called

changelogs/fragments/1695-tmp_hlq_when_calling_mvscmd.yml

@@ -0,0 +1,31 @@
+bugfixes:
+  - zos_apf - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
+  - zos_archive - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
+  - zos_blockinfile - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
+  - zos_copy - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
+  - zos_data_set - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
+  - zos_encode - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
+  - zos_fetch - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
+  - zos_lineinfile - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
+  - zos_mount - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
+  - zos_unarchive - The ``tmp_hlq`` option was previously ignored and default
+    values were used instead. Fix now honors the value set in the module option.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1695).

plugins/module_utils/backup.py

@@ -76,6 +76,8 @@ def mvs_file_backup(dsn, bk_dsn=None, tmphlq=None):
         It could be an MVS PS/PDS/PDSE/VSAM(KSDS), etc.
     bk_dsn : str
         The name of the backup data set.
+    tmphlq : str
+        High Level Qualifier for temporary datasets.
 
     Returns
     -------
@@ -128,14 +130,14 @@ def mvs_file_backup(dsn, bk_dsn=None, tmphlq=None):
             if DataSet.is_gds_positive_relative_name(bk_dsn):
                 cp_rc = datasets.copy(dsn, bk_dsn)
             else:
-                cp_rc = _copy_ds(dsn, bk_dsn)
+                cp_rc = _copy_ds(dsn, bk_dsn, tmphlq=tmphlq)
 
         if cp_rc == 12:  # The data set is probably a PDS or PDSE
             # Delete allocated backup that was created when attempting to use _copy_ds()
             # Safe to delete because _copy_ds() would have raised an exception if it did
             # not successfully create the backup data set, so no risk of it predating module invocation
             datasets.delete(bk_dsn)
-            _allocate_model(bk_dsn, dsn)
+            _allocate_model(bk_dsn, dsn, tmphlq=tmphlq)
             rc, out, err = _copy_pds(dsn, bk_dsn)
             if rc != 0:
                 raise BackupError(
@@ -222,7 +224,7 @@ def uss_file_backup(path, backup_name=None, compress=False):
     return backup_name
 
 
-def _copy_ds(ds, bk_ds):
+def _copy_ds(ds, bk_ds, tmphlq=None):
     """Copy the contents of a data set to another.
 
     Parameters
@@ -231,6 +233,8 @@ def _copy_ds(ds, bk_ds):
         The source data set to be copied from. Should be SEQ or VSAM.
     bk_dsn : str
         The destination data set to copy to.
+    tmphlq : str
+        High Level Qualifier for temporary datasets.
 
     Returns
     -------
@@ -243,14 +247,19 @@ def _copy_ds(ds, bk_ds):
         When copying data fails.
     """
     module = AnsibleModuleHelper(argument_spec={})
-    _allocate_model(bk_ds, ds)
+    _allocate_model(bk_ds, ds, tmphlq=tmphlq)
     repro_cmd = """  REPRO -
     INDATASET('{0}') -
     OUTDATASET('{1}')""".format(
         ds, bk_ds
     )
+
+    cmd = "mvscmdauth --pgm=idcams --sysprint=* --sysin=stdin"
+    if tmphlq:
+        cmd = "{0} -Q={1}".format(cmd, tmphlq)
+
     rc, out, err = module.run_command(
-        "mvscmdauth --pgm=idcams --sysprint=* --sysin=stdin", data=repro_cmd, errors='replace'
+        cmd, data=repro_cmd, errors='replace'
     )
     if rc != 0 and rc != 12:
         datasets.delete(bk_ds)
@@ -259,12 +268,12 @@ def _copy_ds(ds, bk_ds):
                 ds, out, err
             )
         )
-    if rc != 0 and DataSet.is_empty(ds):
+    if rc != 0 and DataSet.is_empty(ds, tmphlq=tmphlq):
         rc = 0
     return rc
 
 
-def _allocate_model(ds, model):
+def _allocate_model(ds, model, tmphlq=None):
     """Allocate a data set using allocation information of a model data set.
 
     Parameters
@@ -273,6 +282,8 @@ def _allocate_model(ds, model):
         The name of the data set to be allocated.
     model : str
         The name of the data set whose allocation parameters should be used.
+    tmphlq : str
+        High Level Qualifier for temporary datasets.
 
     Returns
     -------
@@ -290,7 +301,11 @@ def _allocate_model(ds, model):
     LIKE('{1}')""".format(
         ds, model
     )
+
     cmd = "mvscmdauth --pgm=ikjeft01 --systsprt=* --systsin=stdin"
+    if tmphlq:
+        cmd = "{0} -Q={1}".format(cmd, tmphlq)
+
     rc, out, err = module.run_command(cmd, data=alloc_cmd, errors='replace')
     if rc != 0:
         raise BackupError(

plugins/module_utils/copy.py

@@ -339,7 +339,7 @@ def copy_mvs2mvs(src, dest, is_binary=False):
     return rc, out, err
 
 
-def copy_vsam_ps(src, dest):
+def copy_vsam_ps(src, dest, tmphlq=None):
     """Copy a VSAM(KSDS) data set to a PS data set vise versa.
 
     Parameters
@@ -348,6 +348,8 @@ def copy_vsam_ps(src, dest):
         The VSAM(KSDS) or PS data set to be copied.
     dest : str
         The PS or VSAM(KSDS) data set.
+    tmphlq : str
+        High Level Qualifier for temporary datasets.
 
     Returns
     -------
@@ -367,14 +369,18 @@ def copy_vsam_ps(src, dest):
     src = _validate_data_set_name(src)
     dest = _validate_data_set_name(dest)
     repro_cmd = REPRO.format(src, dest)
+
     cmd = "mvscmdauth --pgm=idcams --sysprint=stdout --sysin=stdin"
+    if tmphlq:
+        cmd = "{0} -Q={1}".format(cmd, tmphlq)
+
     rc, out, err = module.run_command(cmd, data=repro_cmd, errors='replace')
     if rc:
         raise USSCmdExecError(cmd, rc, out, err)
     return rc, out, err
 
 
-def copy_asa_uss2mvs(src, dest):
+def copy_asa_uss2mvs(src, dest, tmphlq=None):
     """Copy a file from USS to an ASA sequential data set or PDS/E member.
 
     Parameters
@@ -383,6 +389,8 @@ def copy_asa_uss2mvs(src, dest):
         Path of the USS file.
     dest : str
         The MVS destination data set or member.
+    tmphlq : str
+        High Level Qualifier for temporary datasets.
 
     Returns
     -------
@@ -394,12 +402,12 @@ def copy_asa_uss2mvs(src, dest):
         The stderr after the copy command executed successfully.
     """
     oget_cmd = "OGET '{0}' '{1}'".format(src, dest)
-    rc, out, err = ikjeft01(oget_cmd, authorized=True)
+    rc, out, err = ikjeft01(oget_cmd, authorized=True, tmphlq=tmphlq)
 
     return TSOCmdResponse(rc, out, err)
 
 
-def copy_asa_mvs2uss(src, dest):
+def copy_asa_mvs2uss(src, dest, tmphlq=None):
     """Copy an ASA sequential data set or member to USS.
 
     Parameters
@@ -408,6 +416,8 @@ def copy_asa_mvs2uss(src, dest):
         The MVS data set to be copied.
     dest : str
         Destination path in USS.
+    tmphlq : str
+        High Level Qualifier for temporary datasets.
 
     Returns
     -------
@@ -422,12 +432,12 @@ def copy_asa_mvs2uss(src, dest):
     dest = _validate_path(dest)
 
     oput_cmd = "OPUT '{0}' '{1}'".format(src, dest)
-    rc, out, err = ikjeft01(oput_cmd, authorized=True)
+    rc, out, err = ikjeft01(oput_cmd, authorized=True, tmphlq=tmphlq)
 
     return TSOCmdResponse(rc, out, err)
 
 
-def copy_asa_pds2uss(src, dest):
+def copy_asa_pds2uss(src, dest, tmphlq=None):
     """Copy all members from an ASA PDS/E to USS.
 
     Parameters
@@ -436,6 +446,8 @@ def copy_asa_pds2uss(src, dest):
         The MVS data set to be copied.
     dest : str
         Destination path in USS (must be a directory).
+    tmphlq : str
+        High Level Qualifier for temporary datasets.
 
     Returns
     -------
@@ -465,7 +477,7 @@ def copy_asa_pds2uss(src, dest):
         dest_path = path.join(dest, member)
 
         oput_cmd = "OPUT '{0}' '{1}'".format(src_member, dest_path)
-        rc, out, err = ikjeft01(oput_cmd, authorized=True)
+        rc, out, err = ikjeft01(oput_cmd, authorized=True, tmphlq=tmphlq)
 
         if rc != 0:
             return TSOCmdResponse(rc, out, err)