Enabler/1379/zos tso command gdg support (#1563)

* Add test case and support for gds

* Add functional test cases and gds suport for 0 and - notation

* modified check for data sets function

* Documented tso_command functions

* Simplified the data set name find

* Removed unused fullmatch import

* Added changelog

* Adding profile noprefix to zos_tso_command tests

* Added changelog fragment

* Fixed test about GDS

* Modified tests

* Fixed pep issue

* Added gds relative name check

---------

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

Author: fernandofloresg

changelogs/fragments/1563-zos_tso_command-gdg-support.yml

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

plugins/modules/zos_tso_command.py

@@ -126,7 +126,9 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.ibm.ibm_zos_core.plugins.module_utils import data_set
 from os import chmod
+import re
 from tempfile import NamedTemporaryFile
 from stat import S_IEXEC, S_IREAD, S_IWRITE
 from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.better_arg_parser import (
@@ -253,6 +255,31 @@ def list_or_str_type(contents, dependencies):
     return contents
 
 
+def preprocess_data_set_names(command):
+    """
+    Applies necessary preprocessing to the data set names, such as converting
+    a GDS relative name into an absolute one.
+
+    Parameters
+    ----------
+    command : str
+        command in which to look for a data set name.
+
+    Returns
+    -------
+    str
+        The command with the modified data set names if any.
+
+    """
+    pattern = r"(?:(?:[A-Z$#@]{1}[A-Z0-9$#@-]{0,7})(?:[.]{1})){1,21}[A-Z$#@]{1}[A-Z0-9$#@-]{0,7}(?:\([A-Z$#@]{1}[A-Z0-9$#@]{0,7}\)|\((?:[-+]?[0-9]+)\)){0,1}"
+    data_set_list = re.findall(pattern, command)
+    for name in data_set_list:
+        if data_set.DataSet.is_gds_relative_name(name):
+            dataset_name = data_set.DataSet.resolve_gds_absolute_name(name)
+            command = command.replace(name, dataset_name)
+    return command
+
+
 def run_module():
     """Initialize module.
 
@@ -287,6 +314,7 @@ def run_module():
         module.fail_json(msg=repr(e), **result)
 
     commands = parsed_args.get("commands")
+    commands = list(map(preprocess_data_set_names, commands))
     max_rc = parsed_args.get("max_rc")
     if max_rc is None:
         max_rc = 0

tests/functional/modules/test_zos_tso_command_func.py

@@ -141,3 +141,36 @@ def test_zos_tso_command_maxrc(ansible_zos_module):
         for item in result.get("output"):
             assert item.get("rc") < 5
         assert result.get("changed") is True
+
+
+def test_zos_tso_command_gds(ansible_zos_module):
+    try:
+        hosts = ansible_zos_module
+        default_data_set = get_tmp_ds_name(3, 3, symbols=True)
+        hosts.all.shell(cmd="dtouch -tGDG -L2 '{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))
+        print(f"data set name {default_data_set}")
+        hosts = ansible_zos_module
+        results = hosts.all.zos_tso_command(
+            commands=["""LISTDSD DATASET('{0}(0)') ALL GENERIC""".format(default_data_set)],
+            max_rc=4
+        )
+        for result in results.contacted.values():
+            for item in result.get("output"):
+                assert result.get("changed") is True
+        results = hosts.all.zos_tso_command(
+            commands=["""LISTDSD DATASET('{0}(-1)') ALL GENERIC""".format(default_data_set)],
+            max_rc=4
+        )
+        for result in results.contacted.values():
+            for item in result.get("output"):
+                assert result.get("changed") is True
+        results = hosts.all.zos_tso_command(
+            commands=["""LISTDS '{0}(-1)'""".format(default_data_set)]
+        )
+        for result in results.contacted.values():
+            assert result.get("changed") is True
+    finally:
+        None
+        # hosts.all.shell(cmd="drm ANSIBLE.*".format(default_data_set))