[v1.13.1][Bugfixes] [zos_data_set] Fixing GDG replace and empty GDG removal issues (#2035)

* Fixing #2003 and #2004 issues

* Create 2035-zos_data_set-fixing-gdg-replace-and-empty-gdg-removal-issues.yaml

* Update 2035-zos_data_set-fixing-gdg-replace-and-empty-gdg-removal-issues.yaml

* Updating code to select volumes

* Update test_zos_mount_func.py

* Update 2035-zos_data_set-fixing-gdg-replace-and-empty-gdg-removal-issues.yaml

Author: surendrababuravella

changelogs/fragments/2035-zos_data_set-fixing-gdg-replace-and-empty-gdg-removal-issues.yaml

@@ -0,0 +1,12 @@
+bugfixes:
+    - zos_data_set - Module would fail with TypeError when trying to replace an existing GDG. 
+      Fix now allows the replacement of an existing GDG.
+      (https://github.com/ansible-collections/ibm_zos_core/pull/2035)
+
+    - zos_data_set - Module would fail when trying to delete a non-existent Generation Data Group.
+      Fix now provides a successful response with `changed=false`.
+      (https://github.com/ansible-collections/ibm_zos_core/pull/2035)
+
+trivial:
+    - test_zos_volume_init.py - Adds support of dynamic volumes and allocations for testing.
+      (https://github.com/ansible-collections/ibm_zos_core/pull/2035).

plugins/module_utils/data_set.py

@@ -2414,7 +2414,7 @@ def ensure_present(self, replace):
         else:
             if not replace:
                 return changed
-            changed = self.ensure_absent()
+            changed = self.ensure_absent(True)
             gdg = gdgs.create(**arguments)
         if isinstance(gdg, gdgs.GenerationDataGroupView):
             changed = True
@@ -2434,17 +2434,21 @@ def ensure_absent(self, force):
         int
             Indicates if changes were made.
         """
-        # Try to delete
-        rc = datasets.delete(self.name)
-        if rc > 0:
-            if force:
-                if isinstance(self.gdg, gdgs.GenerationDataGroupView):
-                    self.gdg.delete()
+        # Check whether GDG exists or not
+        if gdgs.exists(name=self.name):
+            # Try to delete
+            rc = datasets.delete(self.name)
+            if rc > 0:
+                if force:
+                    if isinstance(self.gdg, gdgs.GenerationDataGroupView):
+                        self.gdg.delete()
+                    else:
+                        gdg_view = gdgs.GenerationDataGroupView(name=self.name)
+                        gdg_view.delete()
                 else:
-                    gdg_view = gdgs.GenerationDataGroupView(name=self.name)
-                    gdg_view.delete()
-            else:
-                raise DatasetDeleteError(self.raw_name, rc)
+                    raise DatasetDeleteError(self.raw_name, rc)
+        else:
+            return False
         return True
 
     def clear(self):

tests/conftest.py

@@ -14,7 +14,7 @@
 __metaclass__ = type
 import pytest
 from ibm_zos_core.tests.helpers.ztest import ZTestHelper
-from ibm_zos_core.tests.helpers.volumes import get_volumes, get_volumes_with_vvds
+from ibm_zos_core.tests.helpers.volumes import get_volumes, get_volumes_with_vvds, get_volume_and_unit
 from ansible.plugins.action import ActionBase
 import sys
 from mock import MagicMock
@@ -194,3 +194,19 @@ def get_config(request):
     """ Call the pytest-ansible plugin to check volumes on the system and work properly a list by session."""
     path = request.config.getoption("--zinventory")
     yield path
+
+
+@pytest.fixture(scope="session")
+def volumes_unit_on_systems(ansible_zos_module, request):
+    """ Call the pytest-ansible plugin to check volumes on the system and work properly a list by session."""
+    path = request.config.getoption("--zinventory")
+    list_volumes = None
+
+    if path is None:
+        src = request.config.getoption("--zinventory-raw")
+        helper = ZTestHelper.from_args(src)
+        list_volumes = helper.get_volume_and_unit()
+    else:
+        list_volumes = get_volume_and_unit(ansible_zos_module, path)
+
+    yield list_volumes

tests/functional/modules/test_zos_data_set_func.py

@@ -1103,3 +1103,33 @@ def test_create_member_special_chars(ansible_zos_module):
     finally:
         hosts.all.zos_data_set(name=data_set_name, state="absent")
 
+
+def test_gdg_create_and_replace(ansible_zos_module):
+    try:
+        hosts = ansible_zos_module
+        data_set_name = get_tmp_ds_name()
+        results = hosts.all.zos_data_set(name=data_set_name, empty=False, force=True, record_format="u", 
+                                         record_length=0, replace=True, space_primary=5, space_secondary=3, 
+                                         space_type="cyl", state="present", type="gdg", limit=3)
+        for result in results.contacted.values():
+            assert result.get("changed") is True
+            assert result.get("module_stderr") is None
+        results = hosts.all.zos_data_set(name=data_set_name, empty=False, force=True, record_format="u", 
+                                         record_length=0, replace=True, space_primary=5, space_secondary=3, 
+                                         space_type="cyl", state="present", type="gdg", limit=3)
+        for result in results.contacted.values():
+            assert result.get("changed") is True
+            assert result.get("module_stderr") is None
+    finally:
+        hosts.all.zos_data_set(name=data_set_name, state="absent", force=True, type="gdg")
+
+
+def test_gdg_deletion_when_absent(ansible_zos_module):
+    hosts = ansible_zos_module
+    data_set_name = get_tmp_ds_name()
+    results = hosts.all.zos_data_set(name=data_set_name, force=False, record_format="fb", replace=False, 
+                                    space_primary=5, space_secondary=3, space_type="m", state="absent", type="gdg")
+    for result in results.contacted.values():
+        assert result.get("changed") is False
+        assert result.get("module_stderr") is None
+        assert result.get("failed") is None

tests/functional/modules/test_zos_mount_func.py

@@ -74,7 +74,7 @@ def create_sourcefile(hosts, volume):
     mount_result = hosts.all.shell(
         cmd="zfsadm define -aggregate "
         + thisfile
-        + " -volumes {0} -cylinders 200 1".format(volume),
+        + " -volumes {0} -cylinders 10 1".format(volume),
         executable=SHELL_EXECUTABLE,
         stdin="",
     )

tests/functional/modules/test_zos_unarchive_func.py

@@ -1164,8 +1164,8 @@ def test_gdg_unarchive(ansible_zos_module, dstype, format):
 
         hosts.all.zos_data_set(
             batch=[
-                {"name": f"{data_set_name}(-1)", "state": "absent", "type": "gdg"},
-                {"name": f"{data_set_name}(0)", "state": "absent", "type": "gdg"},
+                {"name": f"{data_set_name}(-1)", "state": "absent"},
+                {"name": f"{data_set_name}(0)", "state": "absent"},
             ]
         )
         unarchive_result = hosts.all.zos_unarchive(