[zos_copy]Ensure generations are copied correctly when identical_gdg_copy is True (#2100)

* Enhancement

* Added Test Case

* added fragments

* fixed

* sanity fixing

* fixing

* fixed sanity

* SANITY FIXED

* changed fragments

* fixed error in statements

* changed fragments

* Update plugins/modules/zos_copy.py

Co-authored-by: Fernando Flores <[email protected]>

* Update plugins/modules/zos_copy.py

Co-authored-by: Fernando Flores <[email protected]>

* Removed Try and success = True

* fixed sanity

* fixed

* Update zos_copy.py

* fixed syntax error

* Update zos_copy.py

* removed condition block

* Update zos_copy.py

* fixed extra spaces

* added qualifier to delete base and gds of src and dest

* added code to validate that the absolute names are correct

* sanity fixed

* removed try and except

---------

Co-authored-by: Fernando Flores <[email protected]>

Author: mayankmani-sde

changelogs/fragments/2100-zos_copy-Identical-gdg-copy-support.yml

@@ -0,0 +1,10 @@
+minor_changes:
+  - zos_copy - Adds new option `identical_gdg_copy` in the module.
+    This allows copying GDG generations from a source base to a destination base
+    while preserving generation data set absolute names when the destination base does not exist prior to the copy.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2100).
+trivial:
+  - test_zos_copy_func - Added a test case to ensure GDG generation names are preserved
+    when copying with identical_gdg_copy is true and the destination base is non-existent.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2100).
+

plugins/modules/zos_copy.py

@@ -49,6 +49,15 @@
     type: bool
     default: false
     required: false
+  identical_gdg_copy:
+    description:
+      - If set to C(true), and the destination GDG does not exist, the module
+        will copy the source GDG to the destination GDG with identical GDS absolute names.
+      - If set to C(false), the copy will be done as a normal copy, without
+        preserving the source GDG absolute names.
+    type: bool
+    default: false
+    required: false
   backup:
     description:
       - Specifies whether a backup of the destination should be created before
@@ -983,6 +992,7 @@ def __init__(
         asa_text=False,
         backup_name=None,
         force_lock=False,
+        identical_gdg_copy=False,
         tmphlq=None
     ):
         """Utility class to handle copying data between two targets.
@@ -1047,6 +1057,7 @@ def __init__(
         self.aliases = aliases
         self.backup_name = backup_name
         self.force_lock = force_lock
+        self.identical_gdg_copy = identical_gdg_copy
         self.tmphlq = tmphlq
 
     def run_command(self, cmd, **kwargs):
@@ -1175,22 +1186,29 @@ def copy_to_gdg(self, src, dest):
         """
         src_view = gdgs.GenerationDataGroupView(src)
         generations = src_view.generations()
-        dest_generation = f"{dest}(+1)"
-
         copy_args = {
             "options": ""
         }
-
         if self.is_binary or self.asa_text:
             copy_args["options"] = "-B"
 
+        success = True
         for gds in generations:
-            rc = datasets.copy(gds.name, dest_generation, **copy_args)
-
+            # If identical_gdg_copy is True, use exact source generation name in destination
+            if self.identical_gdg_copy:
+                src_gen_absolute = gds.name
+                parts = src_gen_absolute.split('.')
+                # Extract generation number
+                generation_part = parts[-1]
+                dest_gen_name = f"{dest}.{generation_part}"
+            else:
+                # If identical_gdg_copy is False, use the default next generation
+                dest_gen_name = f"{dest}(+1)"
+                # Perform the copy operation
+            rc = datasets.copy(gds.name, dest_gen_name, **copy_args)
             if rc != 0:
-                return False
-
-        return True
+                success = False
+        return success
 
     def _copy_tree(self, entries, src, dest, dirs_exist_ok=False):
         """Recursively copy USS directory to another USS directory.
@@ -3358,6 +3376,7 @@ def run_module(module, arg_def):
     force = module.params.get('force')
     force_lock = module.params.get('force_lock')
     content = module.params.get('content')
+    identical_gdg_copy = module.params.get('identical_gdg_copy', False)
 
     # Set temporary directory at os environment level
     os.environ['TMPDIR'] = f"{os.path.realpath(module.tmpdir)}/"
@@ -3585,10 +3604,19 @@ def run_module(module, arg_def):
                     dest_member_exists = dest_exists and data_set.DataSet.files_in_data_set_members(root_dir, dest)
                 elif src_ds_type in data_set.DataSet.MVS_PARTITIONED:
                     dest_member_exists = dest_exists and data_set.DataSet.data_set_shared_members(src, dest)
-
     except Exception as err:
         module.fail_json(msg=str(err))
-
+    identical_gdg_copy = module.params.get('identical_gdg_copy', False)
+    if identical_gdg_copy:
+        # Validate destination GDG doesn't exist
+        if dest_exists:
+            module.fail_json(
+                msg=(
+                    f"Identical GDG copy failed: {raw_dest} already exists."
+                    "When using option identical_gdg_copy the destination GDG should not exist."
+                ),
+                changed=False
+            )
     # Checking that we're dealing with a positive generation when dest does not
     # exist.
     if is_dest_gds and not is_dest_gds_active:
@@ -3793,6 +3821,7 @@ def run_module(module, arg_def):
         asa_text=asa_text,
         backup_name=backup_name,
         force_lock=force_lock,
+        identical_gdg_copy=module.params.get('identical_gdg_copy', False),
         tmphlq=tmphlq
     )
 
@@ -3950,6 +3979,7 @@ def main():
             executable=dict(type='bool', default=False),
             asa_text=dict(type='bool', default=False),
             aliases=dict(type='bool', default=False, required=False),
+            identical_gdg_copy=dict(type='bool', default=False),
             encoding=dict(
                 type='dict',
                 required=False,

tests/functional/modules/test_zos_copy_func.py

@@ -5605,6 +5605,54 @@ def test_copy_gdg_to_gdg(ansible_zos_module, new_gdg):
         hosts.all.shell(cmd=f"""drm "{dest_data_set}(0)" """)
         hosts.all.shell(cmd=f"drm {dest_data_set}")
 
+def test_identical_gdg_copy(ansible_zos_module):
+   hosts = ansible_zos_module
+   try:
+       src_data_set = get_tmp_ds_name()
+       dest_data_set = get_tmp_ds_name()
+       # Create source GDG base
+       hosts.all.shell(cmd=f"dtouch -tGDG -L5 {src_data_set}")
+       # Create 5 generations in source GDG
+       hosts.all.shell(cmd=f"""dtouch -tSEQ "{src_data_set}(+1)" """)
+       hosts.all.shell(cmd=f"""dtouch -tSEQ "{src_data_set}(+1)" """)
+       hosts.all.shell(cmd=f"""dtouch -tSEQ "{src_data_set}(+1)" """)
+       hosts.all.shell(cmd=f"""dtouch -tSEQ "{src_data_set}(+1)" """)
+       hosts.all.shell(cmd=f"""dtouch -tSEQ "{src_data_set}(+1)" """)
+       
+       # Delete first two generations: (-4) and (-3)
+       hosts.all.shell(cmd=f"""drm "{src_data_set}(-4)" """)
+       hosts.all.shell(cmd=f"""drm "{src_data_set}(-3)" """)
+       # Copy with identical_gdg_copy: true
+       copy_results = hosts.all.zos_copy(
+           src=src_data_set,
+           dest=dest_data_set,
+           remote_src=True,
+           identical_gdg_copy=True
+       )
+       for result in copy_results.contacted.values():
+           assert result.get("msg") is None
+           assert result.get("changed") is True
+   finally:
+       src_gdg_result = hosts.all.shell(cmd=f"dls {src_data_set}.*")
+       src_gdgs = []
+       for result in src_gdg_result.contacted.values():
+           src_gdgs.extend(result.get("stdout_lines", []))
+       # List destination generations
+       dest_gdg_result = hosts.all.shell(cmd=f"dls {dest_data_set}.*")
+       dest_gdgs = []
+       for result in dest_gdg_result.contacted.values():
+           dest_gdgs.extend(result.get("stdout_lines", []))
+           expected_dest_gdgs = [
+               ds_name.replace(src_data_set,dest_data_set) for ds_name in src_gdgs
+           ]
+           assert sorted(dest_gdgs) == sorted(expected_dest_gdgs), f"Absolute names mismatch.\nExpected: {expected_dest_gdgs}\nFound: {dest_gdgs}"
+           print("Abssolute GDG names copied correctly.")
+           for name in dest_gdgs:
+               print(name)
+       # Clean up both source and destination
+       hosts.all.shell(cmd=f"drm {src_data_set}*")
+       hosts.all.shell(cmd=f"drm {dest_data_set}*")
+
 
 def test_copy_gdg_to_gdg_dest_attributes(ansible_zos_module):
     hosts = ansible_zos_module