[Enhancement] [zos_copy] supporting alias names in src and dest for PS, PDS and PDSE data sets (#2103)

surendrababuravella · fernandofloresg · web-flow · commit 7796efc3ed34 · 2025-05-29T09:22:43.000-06:00
* Update zos_copy.py

* Adding testcases

* Update zos_copy.py

* Updating logic and testcases

* Update data_set.py

* Create 2103-zos_copy-supporting-aliases-for-src-and-dest.yml

* Update 2103-zos_copy-supporting-aliases-for-src-and-dest.yml

* Update data_set.py

* Update changelogs/fragments/2103-zos_copy-supporting-aliases-for-src-and-dest.yml

Co-authored-by: Fernando Flores &lt;fernandofloresdev@gmail.com&gt;

* Update test_zos_copy_func.py

---------

Co-authored-by: Fernando Flores &lt;fernandofloresdev@gmail.com&gt;
diff --git a/changelogs/fragments/2103-zos_copy-supporting-aliases-for-src-and-dest.yml b/changelogs/fragments/2103-zos_copy-supporting-aliases-for-src-and-dest.yml
@@ -0,0 +1,3 @@
+minor_changes:
+  - zos_copy - Adds support of using alias names in src and dest parameters for PS, PDS and PDSE data sets.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2103)
diff --git a/plugins/module_utils/data_set.py b/plugins/module_utils/data_set.py
@@ -2181,24 +2181,23 @@ def get_name_if_data_set_is_alias(name, tmp_hlq=None):
         # We need to unescape because this call to the system can handle
         # special characters just fine.
         name = name.upper().replace("\\", '')
-        idcams_cmd = f" LISTCAT ENTRIES('{name}') ALL"
+        idcams_cmd = f" LISTCAT ALIAS ENTRIES('{name}')ALL"
         response = DataSet._execute_idcams_cmd(idcams_cmd, tmp_hlq=tmp_hlq)
 
-        if response.rc > 0 or response.stderr_response != '':
-            raise MVSCmdExecError(
-                rc=response.rc,
-                stdout=response.stdout_response,
-                stderr=response.stderr_response
-            )
-
-        if re.search(r'(ALIAS -+)(1)', response.stdout_response):
+        if response.rc == 0:
             base_name = re.search(
                 r'(ASSOCIATIONS\s*\n\s*[0-9a-zA-Z]+-+)([0-9a-zA-Z\.@\$#-]+)',
                 response.stdout_response
             ).group(2)
             return True, base_name
-        else:
+        elif response.rc == 4:
             return False, name
+        elif response.rc != 0 or response.stderr_response != '':
+            raise MVSCmdExecError(
+                rc=response.rc,
+                out=response.stdout_response,
+                err=response.stderr_response
+            )
 
     @staticmethod
     def _execute_idcams_cmd(
diff --git a/plugins/modules/zos_copy.py b/plugins/modules/zos_copy.py
@@ -94,6 +94,7 @@
     description:
       - The remote absolute path or data set where the content should be copied to.
       - C(dest) can be a USS file, directory or MVS data set name.
+      - C(dest) can be a alias name of a PS, PDS or PDSE data set.
       - If C(dest) has missing parent directories, they will be created.
       - If C(dest) is a nonexistent USS file, it will be created.
       - If C(dest) is a new USS file or replacement, the file will be appropriately tagged with
@@ -304,6 +305,7 @@
     description:
       - Path to a file/directory or name of a data set to copy to remote
         z/OS system.
+      - C(src) can be a alias name of a PS, PDS or PDSE data set.
       - If C(remote_src) is true, then C(src) must be the path to a Unix
         System Services (USS) file, name of a data set, or data set member.
       - If C(src) is a local path or a USS path, it can be absolute or relative.
@@ -3379,6 +3381,17 @@ def run_module(module, arg_def):
     src_member = is_member(src)
     raw_src = src
     raw_dest = dest
+    is_src_alias = False
+    is_dest_alias = False
+
+    if is_mvs_src and not src_member and not is_src_gds:
+        is_src_alias, src_base_name = data_set.DataSet.get_name_if_data_set_is_alias(src, tmphlq)
+        if is_src_alias:
+            src = src_base_name
+    if is_mvs_dest and not copy_member and not is_dest_gds:
+        is_dest_alias, dest_base_name = data_set.DataSet.get_name_if_data_set_is_alias(dest, tmphlq)
+        if is_dest_alias:
+            dest = dest_base_name
 
     # Validation for copy from a member
     if src_member:
@@ -3910,8 +3923,8 @@ def run_module(module, arg_def):
 
     res_args.update(
         dict(
-            src=src,
-            dest=dest,
+            src=module.params.get('src') if is_src_alias else src,
+            dest=module.params.get('dest') if is_dest_alias else dest,
             ds_type=dest_ds_type,
             dest_exists=dest_exists,
             backup_name=backup_name,
diff --git a/tests/functional/modules/test_zos_copy_func.py b/tests/functional/modules/test_zos_copy_func.py
@@ -23,7 +23,6 @@
 import tempfile
 import subprocess
 from shellescape import quote
-
 from ibm_zos_core.tests.helpers.volumes import Volume_Handler
 from ibm_zos_core.tests.helpers.dataset import get_tmp_ds_name
 from ibm_zos_core.tests.helpers.utils import get_random_file_name
@@ -5811,3 +5810,232 @@ def test_job_script_async(ansible_zos_module, get_config):
         assert result.stderr == ""
     finally:
         ansible_zos_module.all.zos_data_set(name=ds_name, state="absent")
+
+def test_copy_data_set_seq_with_aliases(ansible_zos_module, volumes_on_systems):
+    hosts = ansible_zos_module
+    src = get_tmp_ds_name(mlq_size=3, llq_size=3)
+    src_alias = get_tmp_ds_name(mlq_size=3, llq_size=3)
+    src = f'{src[:7]}.{src[13:]}'
+    src_alias = f'{src_alias[:7]}.{src_alias[13:]}'
+    dest = get_tmp_ds_name(mlq_size=3, llq_size=3)
+    dest_alias = get_tmp_ds_name(mlq_size=3, llq_size=3)
+    dest = f'{dest[:7]}.{dest[13:]}'
+    dest_alias = f'{dest_alias[:7]}.{dest_alias[13:]}'
+    volumes = Volume_Handler(volumes_on_systems)
+    available_vol = volumes.get_available_vol()
+    try:
+        data_set_creation_result = hosts.all.shell(
+            cmd=f'dtouch -tseq -V{available_vol} {src}'
+        )
+        hosts.all.shell(cmd=f"""decho "{DUMMY_DATA}" "{src}" """)
+        for result in data_set_creation_result.contacted.values():
+            assert result.get('changed') is True
+            assert result.get('failed', False) is False
+        dest_data_set_creation_result = hosts.all.shell(
+            cmd=f'dtouch -tseq {dest}'
+        )
+        for result in dest_data_set_creation_result.contacted.values():
+            assert result.get('changed') is True
+            assert result.get('failed', False) is False
+        alias_creation_result = hosts.all.shell(
+            cmd=f'echo "  DEFINE ALIAS (NAME({src_alias}) RELATE({src}))" | mvscmdauth --pgm=idcams --sysin=stdin --sysprint=*'
+        )
+        for result in alias_creation_result.contacted.values():
+            assert result.get('changed') is True
+            assert result.get('failed', False) is False
+        dest_alias_creation_result = hosts.all.shell(
+            cmd=f'echo "  DEFINE ALIAS (NAME({dest_alias}) RELATE({dest}))" | mvscmdauth --pgm=idcams --sysin=stdin --sysprint=*'
+        )
+        for result in dest_alias_creation_result.contacted.values():
+            assert result.get('changed') is True
+            assert result.get('failed', False) is False
+        zos_copy_result = hosts.all.zos_copy(
+            src=src_alias,
+            dest=dest_alias,
+            remote_src=True
+        )
+        for result in zos_copy_result.contacted.values():
+            assert result.get('changed') is True
+            assert result.get('failed', False) is False
+        verify_copy = hosts.all.shell(
+            cmd="cat \"//'{0}'\"".format(dest),
+            executable=SHELL_EXECUTABLE,
+        )
+        for v_cp in verify_copy.contacted.values():
+            assert v_cp.get("rc") == 0
+            assert v_cp.get("stdout") == DUMMY_DATA
+    finally:
+        hosts.all.shell(cmd=f'drm {src_alias}')
+        hosts.all.shell(cmd=f'drm {dest_alias}')
+        hosts.all.shell(cmd=f'drm {src}')
+        hosts.all.shell(cmd=f'drm {dest}')
+
+def test_copy_pds_to_pds_using_dest_alias(ansible_zos_module):
+    hosts = ansible_zos_module
+
+    try:
+        src_pds = get_tmp_ds_name(mlq_size=3, llq_size=3)
+        src_pds = f'{src_pds[:7]}.{src_pds[13:]}'
+        dest_pds = get_tmp_ds_name(mlq_size=3, llq_size=3)
+        dest_pds = f'{dest_pds[:7]}.{dest_pds[13:]}'
+        dest_pds_alias = get_tmp_ds_name(mlq_size=3, llq_size=3)
+        dest_pds_alias = f'{dest_pds_alias[:7]}.{dest_pds_alias[13:]}'
+
+        hosts.all.shell(cmd=f"dtouch -tPDS {src_pds}")
+        hosts.all.shell(cmd=f"""decho "{DUMMY_DATA}" "{src_pds}(MEMBER)" """)
+        hosts.all.shell(cmd=f"dtouch -tPDS {dest_pds}")
+        hosts.all.shell(
+            cmd=f'echo "  DEFINE ALIAS (NAME({dest_pds_alias}) RELATE({dest_pds}))" | mvscmdauth --pgm=idcams --sysin=stdin --sysprint=*'
+        )
+
+        copy_results = hosts.all.zos_copy(
+            src=src_pds,
+            dest=dest_pds_alias,
+            remote_src=True
+        )
+
+        for cp_res in copy_results.contacted.values():
+            assert cp_res.get("msg") is None
+            assert cp_res.get("changed") is True
+
+        verify_dest = hosts.all.shell(
+            cmd=f"""dcat "{dest_pds}(MEMBER)" """,
+            executable=SHELL_EXECUTABLE,
+        )
+        for v_res in verify_dest.contacted.values():
+            assert v_res.get("rc") == 0
+            assert len(v_res.get("stdout_lines")) > 0
+    finally:
+        hosts.all.shell(cmd=f"drm {src_pds}")
+        hosts.all.shell(cmd=f"drm {dest_pds}")
+        hosts.all.shell(cmd=f"drm {dest_pds_alias}")
+
+
+@pytest.mark.pdse
+@pytest.mark.loadlib
+@pytest.mark.aliases
+def test_copy_pdse_loadlib_to_pdse_loadlib_using_aliases(ansible_zos_module):
+
+    hosts = ansible_zos_module
+    mlq_size = 3
+    cobol_src_pds = get_tmp_ds_name(mlq_size)
+    cobol_src_mem = "HELLOCBL"
+    cobol_src_mem2 = "HICBL2"
+    src_lib = get_tmp_ds_name(mlq_size=3, llq_size=3)
+    src_lib = f'{src_lib[:7]}.{src_lib[13:]}'
+    src_lib_aliases = get_tmp_ds_name(mlq_size=3, llq_size=3)
+    src_lib_aliases = f'{src_lib_aliases[:7]}.{src_lib_aliases[13:]}'
+    dest_lib = get_tmp_ds_name(mlq_size=3, llq_size=3)
+    dest_lib = f'{dest_lib[:7]}.{dest_lib[13:]}'
+    dest_lib_aliases = get_tmp_ds_name(mlq_size=3, llq_size=3)
+    dest_lib_aliases = f'{dest_lib_aliases[:7]}.{dest_lib_aliases[13:]}'
+    pgm_mem = "HELLO"
+    pgm2_mem = "HELLO2"
+    pgm_mem_alias = "ALIAS1"
+    pgm2_mem_alias = "ALIAS2"
+    try:
+        # allocate pds for cobol src code
+        hosts.all.zos_data_set(
+            name=cobol_src_pds,
+            state="present",
+            type="pds",
+            space_primary=2,
+            record_format="fb",
+            record_length=80,
+            block_size=3120,
+            replace=True,
+        )
+        # allocate pds for src loadlib
+        hosts.all.zos_data_set(
+            name=src_lib,
+            state="present",
+            type="pdse",
+            record_format="u",
+            record_length=0,
+            block_size=32760,
+            space_primary=2,
+            space_type="m",
+            replace=True
+        )
+
+        hosts.all.zos_data_set(
+                name=dest_lib,
+                state="present",
+                type="pdse",
+                record_format="u",
+                record_length=0,
+                block_size=32760,
+                space_primary=2,
+                space_type="m",
+                replace=True
+        )
+
+        # generate loadlib w 2 members w 1 alias each
+        generate_loadlib(
+            hosts=hosts,
+            cobol_src_pds=cobol_src_pds,
+            cobol_src_mems=[cobol_src_mem, cobol_src_mem2],
+            loadlib_pds=src_lib,
+            loadlib_mems=[pgm_mem, pgm2_mem],
+            loadlib_alias_mems=[pgm_mem_alias, pgm2_mem_alias]
+        )
+
+        hosts.all.shell(
+            cmd=f'echo "  DEFINE ALIAS (NAME({src_lib_aliases}) RELATE({src_lib}))" | mvscmdauth --pgm=idcams --sysin=stdin --sysprint=*'
+        )
+
+        hosts.all.shell(
+            cmd=f'echo "  DEFINE ALIAS (NAME({dest_lib_aliases}) RELATE({dest_lib}))" | mvscmdauth --pgm=idcams --sysin=stdin --sysprint=*'
+        )
+
+        # copy src loadlib to dest library pds w aliases
+        copy_res_aliases = hosts.all.zos_copy(
+                src="{0}".format(src_lib_aliases),
+                dest="{0}".format(dest_lib_aliases),
+                remote_src=True,
+                executable=True,
+                aliases=True,
+                dest_data_set={
+                    'type': "library",
+                    'record_format': "u",
+                    'record_length': 0,
+                    'block_size': 32760,
+                    'space_primary': 2,
+                    'space_type': "m",
+                }
+        )
+
+        for result in copy_res_aliases.contacted.values():
+            assert result.get("msg") is None
+            assert result.get("changed") is True
+            assert result.get("dest") == "{0}".format(dest_lib_aliases)
+
+        verify_copy_mls_aliases = hosts.all.shell(
+            cmd="mls {0}".format(dest_lib),
+            executable=SHELL_EXECUTABLE
+        )
+
+        for v_cp in verify_copy_mls_aliases.contacted.values():
+            assert v_cp.get("rc") == 0
+            stdout = v_cp.get("stdout")
+            assert stdout is not None
+            expected_mls_str = "{0} ALIAS({1})".format(pgm_mem, pgm_mem_alias)
+            expected_mls_str2 = "{0} ALIAS({1})".format(pgm2_mem, pgm2_mem_alias)
+            assert expected_mls_str in stdout
+            assert expected_mls_str2 in stdout
+
+        # verify pgms remain executable
+        pgm_output_map = {
+            (dest_lib, pgm_mem, COBOL_PRINT_STR),
+            (dest_lib, pgm2_mem, COBOL_PRINT_STR2)
+        }
+        for steplib, pgm, output in pgm_output_map:
+            validate_loadlib_pgm(hosts, steplib=steplib, pgm_name=pgm, expected_output_str=output)
+
+    finally:
+        hosts.all.zos_data_set(name=cobol_src_pds, state="absent")
+        hosts.all.zos_data_set(name=src_lib, state="absent")
+        hosts.all.zos_data_set(name=dest_lib, state="absent")
+        hosts.all.zos_data_set(name=src_lib_aliases, state="absent")
+        hosts.all.zos_data_set(name=dest_lib_aliases, state="absent")
+

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+minor_changes:`
	`2`	`+ - zos_copy - Adds support of using alias names in src and dest parameters for PS, PDS and PDSE data sets.`
	`3`	`+ (https://github.com/ansible-collections/ibm_zos_core/pull/2103)`