[Enabler][1377]mvs_raw_support_gdg_gds_special_character (#1525)

* Add first iteration mvs_raw

* Add soultion

* Add fragment

* Add documentation

* Update plugins/modules/zos_mvs_raw.py

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

* Update plugins/modules/zos_mvs_raw.py

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

* Fix raise

* Update plugins/modules/zos_mvs_raw.py

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

---------

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

Author: AndreMarcel99

changelogs/fragments/1525-mvs_raw_support_gdg_gds_special_character.yml

@@ -0,0 +1,4 @@
+minor_changes:
+  - zos_mvs_raw - Added support for GDG and GDS relative name notation to use a data set.
+    Added support for data set names with special characters like $, /#, /- and @.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1525).

plugins/modules/zos_mvs_raw.py

@@ -88,6 +88,8 @@
           data_set_name:
             description:
               - The data set name.
+              - A data set name can be a GDS relative name.
+              - When using GDS relative name and it is a positive generation, disposition new must be used.
             type: str
             required: false
           type:
@@ -705,6 +707,8 @@
                   data_set_name:
                     description:
                       - The data set name.
+                      - A data set name can be a GDS relative name.
+                      - When using GDS relative name and it is a positive generation, disposition new must be used.
                     type: str
                     required: false
                   type:
@@ -1582,6 +1586,37 @@
                       RECORDSIZE(4086 32600) -
                       VOLUMES(222222) -
                       UNIQUE)
+
+- name: List data sets matching pattern in catalog,
+    save output to a new generation of gdgs.
+  zos_mvs_raw:
+    program_name: idcams
+    auth: true
+    dds:
+      - dd_data_set:
+          dd_name: sysprint
+          data_set_name: TEST.CREATION(+1)
+          disposition: new
+          return_content:
+            type: text
+      - dd_input:
+          dd_name: sysin
+          content: " LISTCAT ENTRIES('SOME.DATASET.*')"
+
+- name: List data sets matching pattern in catalog,
+    save output to a gds already created.
+  zos_mvs_raw:
+    program_name: idcams
+    auth: true
+    dds:
+      - dd_data_set:
+          dd_name: sysprint
+          data_set_name: TEST.CREATION(-2)
+          return_content:
+            type: text
+      - dd_input:
+          dd_name: sysin
+          content: " LISTCAT ENTRIES('SOME.DATASET.*')"
 """
 
 from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.better_arg_parser import (
@@ -1602,7 +1637,7 @@
     RawInputDefinition,
     RawOutputDefinition,
 )
-
+from ansible_collections.ibm.ibm_zos_core.plugins.module_utils import data_set
 from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.ansible_module import (
     AnsibleModuleHelper,
@@ -2545,6 +2580,9 @@ def get_dd_name_and_key(dd):
     key = ""
     if dd.get("dd_data_set"):
         dd_name = dd.get("dd_data_set").get("dd_name")
+        data_set_name = resolve_data_set_names(dd.get("dd_data_set").get("data_set_name"),
+                                               dd.get("dd_data_set").get("disposition"))
+        dd.get("dd_data_set")["data_set_name"] = data_set_name
         key = "dd_data_set"
     elif dd.get("dd_unix"):
         dd_name = dd.get("dd_unix").get("dd_name")
@@ -2589,6 +2627,42 @@ def set_extra_attributes_in_dd(dd, tmphlq, key):
     return dd
 
 
+def resolve_data_set_names(dataset, disposition):
+    """Resolve cases for data set names as relative gds or positive
+      that could be accepted if disposition is new.
+      Parameters
+      ----------
+      dataset : str
+          Data set name to determine if is a GDS relative name or regular name.
+      disposition : str
+          Disposition of data set for it creation.
+      Returns
+      -------
+      str
+          The absolute name of dataset or relative positive if disposition is new.
+    """
+    if data_set.DataSet.is_gds_relative_name(dataset):
+        if data_set.DataSet.is_gds_positive_relative_name(dataset):
+            if disposition and disposition == "new":
+                return dataset
+            else:
+                raise ("To generate a new GDS as {0} disposition 'new' is required.".format(dataset))
+        else:
+            data = data_set.MVSDataSet(
+                name=dataset
+            )
+            src = data.name
+            if data.is_gds_active:
+                if disposition and disposition == "new":
+                    raise ("GDS {0} already created, incorrect parameters for disposition and data_set_name".format(src))
+                else:
+                    return src
+            else:
+                raise ("{0} does not exist".format(src))
+    else:
+        return dataset
+
+
 def build_data_definition(dd):
     """Build a DataDefinition object for a particular DD parameter.
 

tests/functional/modules/test_zos_mvs_raw_func.py

@@ -668,6 +668,113 @@ def test_replace_existing_data_set_make_backup(ansible_zos_module):
         hosts.all.zos_data_set(name=default_data_set, state="absent")
 
 
+def test_data_set_name_gdgs(ansible_zos_module):
+    try:
+        hosts = ansible_zos_module
+        default_data_set = get_tmp_ds_name(3, 3)
+        hosts.all.shell(cmd="dtouch -tGDG -L4 {0}".format(default_data_set))
+        hosts.all.shell(cmd="""dtouch -tseq "{0}(+1)" """.format(default_data_set))
+        hosts.all.shell(cmd="""dtouch -tseq "{0}(+1)" """.format(default_data_set))
+        results = hosts.all.zos_mvs_raw(
+            program_name="idcams",
+            auth=True,
+            dds=[
+                dict(
+                    dd_data_set=dict(
+                        dd_name=SYSPRINT_DD,
+                        data_set_name=default_data_set + "(0)",
+                        return_content=dict(type="text"),
+                    ),
+                ),
+                dict(dd_input=dict(dd_name=SYSIN_DD, content=IDCAMS_STDIN)),
+            ],
+        )
+        for result in results.contacted.values():
+            assert result.get("ret_code", {}).get("code", -1) == 0
+            assert len(result.get("dd_names", [])) > 0
+        # Generation minus 1
+        results = hosts.all.zos_mvs_raw(
+            program_name="idcams",
+            auth=True,
+            dds=[
+                dict(
+                    dd_data_set=dict(
+                        dd_name=SYSPRINT_DD,
+                        data_set_name=default_data_set + "(-1)",
+                        return_content=dict(type="text"),
+                    ),
+                ),
+                dict(dd_input=dict(dd_name=SYSIN_DD, content=IDCAMS_STDIN)),
+            ],
+        )
+        for result in results.contacted.values():
+            assert result.get("ret_code", {}).get("code", -1) == 0
+            assert len(result.get("dd_names", [])) > 0
+        # Create a new one
+        results = hosts.all.zos_mvs_raw(
+            program_name="idcams",
+            auth=True,
+            dds=[
+                dict(
+                    dd_data_set=dict(
+                        dd_name=SYSPRINT_DD,
+                        data_set_name=default_data_set + "(+1)",
+                        disposition="new",
+                        return_content=dict(type="text"),
+                    ),
+                ),
+                dict(dd_input=dict(dd_name=SYSIN_DD, content=IDCAMS_STDIN)),
+            ],
+        )
+        for result in results.contacted.values():
+            assert result.get("ret_code", {}).get("code", -1) == 0
+            assert len(result.get("dd_names", [])) > 0
+        # Negative case
+        results = hosts.all.zos_mvs_raw(
+            program_name="idcams",
+            auth=True,
+            dds=[
+                dict(
+                    dd_data_set=dict(
+                        dd_name=SYSPRINT_DD,
+                        data_set_name=default_data_set + "(-4)",
+                        disposition="new",
+                        return_content=dict(type="text"),
+                    ),
+                ),
+                dict(dd_input=dict(dd_name=SYSIN_DD, content=IDCAMS_STDIN)),
+            ],
+        )
+        for result in results.contacted.values():
+            assert result.get("ret_code", {}).get("code", -1) == 8
+    finally:
+        hosts.all.shell(cmd="""drm "ANSIBLE.*" """)
+
+
+def test_data_set_name_special_characters(ansible_zos_module):
+    try:
+        hosts = ansible_zos_module
+        default_data_set = get_tmp_ds_name(5, 6, symbols=True)
+        hosts.all.zos_data_set(name=default_data_set, type="seq", state="present")
+        results = hosts.all.zos_mvs_raw(
+            program_name="idcams",
+            auth=True,
+            dds=[
+                dict(
+                    dd_data_set=dict(
+                        dd_name=SYSPRINT_DD,
+                        data_set_name=default_data_set,
+                        return_content=dict(type="text"),
+                    ),
+                ),
+                dict(dd_input=dict(dd_name=SYSIN_DD, content=IDCAMS_STDIN)),
+            ],
+        )
+        for result in results.contacted.values():
+            assert result.get("ret_code", {}).get("code", -1) == 0
+            assert len(result.get("dd_names", [])) > 0
+    finally:
+        hosts.all.shell(cmd="""drm "ANSIBLE.*" """)
 # ---------------------------------------------------------------------------- #
 #                                 Input DD Tests                                #
 # ---------------------------------------------------------------------------- #