[Bugfix][2285]zos_mount_persistant_delete_all_content (#2347)

* First iteration

* Second definition

* Fix problem of testing binary

* Add fragment

* Modify fragment

---------

Co-authored-by: André Marcel Gutiérrez Benítez <[email protected]>
Co-authored-by: Fernando Flores <[email protected]>

Author: 3 people

changelogs/fragments/2347-zos_mount_persistant_delete_all_content.yaml

@@ -0,0 +1,5 @@
+bugfixes:
+  - zos_mount - Previously, using the persistent parameter caused the module to clear the entire member or data set
+    provided even without a pattern match, leaving it empty despite a successful mount.
+    The fix now ensures content is only deleted when a pattern match is detected, preserving existing configuration.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2347).

plugins/modules/zos_mount.py

@@ -1048,30 +1048,26 @@ def run_module(module, arg_def):
                 stderr=str(res_args),
             )
 
-        bk_ds = datasets.tmp_name(high_level_qualifier=tmphlq)
-        datasets.create(name=bk_ds, dataset_type="SEQ")
-
         new_str = get_str_to_keep(dataset=name, src=src)
 
-        rc_write = 0
+        if new_str:
+            modified_str = [line for line in new_str if line.strip() or line.lstrip()]
+
+            rc_write = 0
 
-        try:
-            for line in new_str:
-                rc_write = datasets.write(dataset_name=bk_ds, content=line.rstrip(), append=True)
+            try:
+                # zoau_io.zopen on mode w allow delete all the content inside the dataset allowing to write the new one
+                with zoau_io.zopen(f"//'{name}'", "w", "cp1047", recfm="*") as ds:
+                    pass
+                full_text = "\n".join(modified_str)
+                rc_write = datasets.write(dataset_name=name, content=full_text, append=True, force=True)
                 if rc_write != 0:
                     raise Exception("Non zero return code from datasets.write.")
-        except Exception as e:
-            datasets.delete(dataset=bk_ds)
-            module.fail_json(
-                msg="Unable to write on persistent data set {0}. {1}".format(name, e),
-                stderr=str(res_args),
-            )
-
-        try:
-            datasets.delete(dataset=name)
-            datasets.copy(source=bk_ds, target=name)
-        finally:
-            datasets.delete(dataset=bk_ds)
+            except Exception as e:
+                module.fail_json(
+                    msg="Unable to write on persistent data set {0}. {1}".format(name, e),
+                    stderr=str(res_args),
+                )
 
         if will_mount:
             d = datetime.today()

tests/functional/modules/test_zos_mount_func.py

@@ -38,6 +38,12 @@
     SECURITY
 """
 
+TEXT_TO_KEEP = """/* Service path                                                    */
+MOUNT FILESYSTEM('{0}')
+    TYPE(ZFS) MODE(RDWR) AUTOMOVE
+    MOUNTPOINT('/Service')
+"""
+
 SHELL_EXECUTABLE = "/bin/sh"
 
 
@@ -315,6 +321,75 @@ def test_basic_mount_with_bpx_no_utf_8_characters(ansible_zos_module, volumes_on
             stdin="",
         )
 
+def test_basic_mount_with_persistent_keep_dataset(ansible_zos_module, volumes_on_systems):
+    hosts = ansible_zos_module
+    volumes = Volume_Handler(volumes_on_systems)
+    volume_1 = volumes.get_available_vol()
+    srcfn = create_sourcefile(hosts, volume_1)
+
+    tmp_file_filename = "/tmp/testfile.txt"
+
+    hosts.all.shell(
+        cmd="touch {0}".format(tmp_file_filename)
+    )
+
+    dest = get_tmp_ds_name()
+    dest_path = dest + "(AUTO1)"
+
+    hosts.all.zos_blockinfile(path=tmp_file_filename, insertafter="EOF", block=TEXT_TO_KEEP.format(srcfn))
+
+    hosts.all.shell(
+        cmd="dtouch -tpdse {0}".format(dest)
+    )
+
+    hosts.all.zos_copy(
+        src=tmp_file_filename,
+        dest=dest_path,
+        binary=True,
+        remote_src=True,
+    )
+
+    try:
+        mount_result = hosts.all.zos_mount(
+            src=srcfn,
+            path="/pythonx",
+            fs_type="zfs",
+            state="mounted",
+            persistent=dict(name=dest_path),
+        )
+
+        for result in mount_result.values():
+            assert result.get("rc") == 0
+            assert result.get("changed") is True
+
+        result_cat = hosts.all.shell(
+            cmd="dcat '{0}'".format(dest_path),
+        )
+
+        for result in result_cat.contacted.values():
+            print(result)
+            assert srcfn in result.get("stdout")
+            assert "Service path" in result.get("stdout")
+    finally:
+        hosts.all.zos_mount(
+            src=srcfn,
+            path="/pythonx",
+            fs_type="zfs",
+            state="absent",
+        )
+        hosts.all.shell(
+            cmd="drm " + DataSet.escape_data_set_name(srcfn),
+            executable=SHELL_EXECUTABLE,
+            stdin="",
+        )
+        hosts.all.file(path=tmp_file_filename, state="absent")
+        hosts.all.file(path="/pythonx/", state="absent")
+        hosts.all.shell(
+            cmd="drm " + dest,
+            executable=SHELL_EXECUTABLE,
+            stdin="",
+        )
+
 def test_basic_mount_with_bpx_marker_backup(ansible_zos_module, volumes_on_systems):
     hosts = ansible_zos_module
     volumes = Volume_Handler(volumes_on_systems)
@@ -326,13 +401,6 @@ def test_basic_mount_with_bpx_marker_backup(ansible_zos_module, volumes_on_syste
     hosts.all.zos_copy(
         content=INITIAL_PRM_MEMBER,
         dest=tmp_file_filename,
-        binary=True,
-    )
-    # Make it readable at console
-    hosts.all.shell(
-        cmd="chtag -t -c ISO8859-1 " + tmp_file_filename,
-        executable=SHELL_EXECUTABLE,
-        stdin="",
     )
 
     # Dump the values of the file once copied to the target(s)
@@ -356,7 +424,6 @@ def test_basic_mount_with_bpx_marker_backup(ansible_zos_module, volumes_on_syste
     hosts.all.zos_copy(
         src=tmp_file_filename,
         dest=dest_path,
-        binary=True,
         remote_src=True,
     )
 
@@ -375,25 +442,16 @@ def test_basic_mount_with_bpx_marker_backup(ansible_zos_module, volumes_on_syste
                 marker=["bpxtablemarker - try this", "second line of marker"],
             ),
         )
-        # copying from dataset to make editable copy on target
-        test_tmp_file_filename = tmp_file_filename + "-a"
-
-        hosts.all.zos_copy(
-            src=dest_path,
-            dest=test_tmp_file_filename,
-            binary=True,
-            remote_src=True,
-        )
+
         results = hosts.all.shell(
-            cmd="cat " + test_tmp_file_filename, executable=SHELL_EXECUTABLE, stdin=""
+            cmd="dcat '{0}'".format(dest_path),
         )
-        data = ""
-        for result in results.values():
+
+        for result in results.contacted.values():
             print("\nbcb-postmount result: {0}\n".format(result.get("stdout")))
             data += result.get("stdout")
 
         print("\n====================================================\n")
-
         for result in mount_result.values():
             assert result.get("rc") == 0
             assert result.get("changed") is True
@@ -414,7 +472,6 @@ def test_basic_mount_with_bpx_marker_backup(ansible_zos_module, volumes_on_syste
         )
 
         hosts.all.file(path=tmp_file_filename, state="absent")
-        hosts.all.file(path=test_tmp_file_filename, state="absent")
         hosts.all.file(path="/pythonx/", state="absent")
         hosts.all.shell(cmd=f"drm {dest}")