Add PDS member support to region_jcl module

Author: andrewhughes101

plugins/module_utils/_data_set_utils.py

@@ -7,10 +7,10 @@
 
 from __future__ import (absolute_import, division, print_function)
 
-from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.ansible_module import AnsibleModuleHelper
 __metaclass__ = type
 import re
-
+import tempfile
+from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.ansible_module import AnsibleModuleHelper
 from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._response import _execution, MVSExecutionException
 from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.zos_mvs_raw import MVSCmd
 from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.dd_statement import DDStatement, StdoutDefinition, DatasetDefinition, StdinDefinition
@@ -214,6 +214,9 @@ def _run_listds(location):  # type: (str) -> tuple[list[_execution], bool, str]
     if listds_response.rc == 8 and "NOT IN CATALOG" in listds_response.stdout:
         return executions, False, "NONE"
 
+    if listds_response.rc == 4 and "MEMBER NAME NOT FOUND" in listds_response.stdout:
+        return executions, False, "NONE"
+
     # Exists
 
     if listds_response.rc != 0:
@@ -287,3 +290,23 @@ def _read_data_set_content(data_set_name):
             "RC {0} when reading content from data set {1}".format(
                 rc, data_set_name), executions)
     return executions, stdout
+
+
+def _write_jcl_to_data_set(jcl, data_set_name):
+    """Writes generated JCL content to the specified data set
+    """
+    executions = []
+
+    temp = tempfile.NamedTemporaryFile(delete=True)
+    with open(temp.name, "w") as f:
+        f.write(jcl)
+    rc, stdout, stderr = _execute_command("cp -O u {0} \"//'{1}'\"".format(temp.name, data_set_name))
+    executions.append(
+        _execution(
+            name="Copy JCL contents to data set",
+            rc=rc,
+            stdout=stdout,
+            stderr=stderr))
+    if rc != 0:
+        raise MVSExecutionException("Failed to copy JCL content to data set", executions)
+    return executions

plugins/module_utils/_jcl_helper.py

@@ -6,8 +6,6 @@
 # FOR INTERNAL USE IN THE COLLECTION ONLY.
 
 from __future__ import absolute_import, division, print_function
-from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._response import _execution, MVSExecutionException
-from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.data_set import DataSet, DatasetWriteError
 
 __metaclass__ = type
 import re
@@ -377,13 +375,3 @@ def _add_single_quotes_to_text(value):
             value = value.replace("'", "''")
 
         return "'{0}'".format(value)
-
-    @staticmethod
-    def _write_jcl_to_data_set(jcl, data_set_name):
-        """Writes generated JCL content to the specified data set
-        """
-        try:
-            DataSet.write(data_set_name, jcl)
-            return [_execution("Copy JCL contents to data set", 0, "", "")]
-        except DatasetWriteError as e:
-            raise MVSExecutionException("Failed to copy JCL content to data set", [_execution("Copy JCL contents to data set", 1, "", e.msg)])

plugins/modules/region_jcl.py

@@ -183,6 +183,7 @@
 
 import string
 import math
+from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.data_set import is_member
 from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._data_set import (
     MEGABYTES,
     REGION_DATA_SETS,
@@ -193,12 +194,13 @@
     WARM,
     DataSet
 )
-from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._data_set_utils import _read_data_set_content
+from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._data_set_utils import _read_data_set_content, _write_jcl_to_data_set
 from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.dd_statement import DatasetDefinition
 from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._jcl_helper import (
     JCLHelper, DLM, DD_INSTREAM, CONTENT, END_INSTREAM, JOB_CARD, EXECS, JOB_NAME, DDS, NAME
 )
 from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._response import MVSExecutionException
+from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._data_set_utils import _run_listds
 
 
 DFHSTART = "dfhstart"
@@ -207,7 +209,7 @@
 
 
 region_data_sets_list = ['dfhauxt', 'dfhbuxt', 'dfhcsd', 'dfhgcd', 'dfhintra',
-                         'dfhlcd', 'dfhlrq', 'dfhtemp', 'dfhdmpa', 'dfhdmpb', 'dfhstart']
+                         'dfhlcd', 'dfhlrq', 'dfhtemp', 'dfhdmpa', 'dfhdmpb']
 APPLID = 'applid'
 CEEMSG = 'ceemsg'
 CEEOUT = 'ceeout'
@@ -227,7 +229,9 @@
 MSGUSR = 'msgusr'
 OMIT = 'omit'
 OUTPUT_DATA_SETS = 'output_data_sets'
+PARTITIONED = 'Partitioned'
 PGM = 'pgm'
+SEQUENTIAL = 'Sequential'
 SIT_PARAMETERS = 'sit_parameters'
 SHR = 'SHR'
 STEPLIB = 'steplib'
@@ -245,12 +249,24 @@ def __init__(self):
         self.jcl = ""
         super(AnsibleRegionJCLModule, self).__init__(1, 1)
         self.name = self.region_param[DFHSTART][DSN].upper()
-        self.expected_data_set_organization = "Sequential"
+        self.base_data_set_name = ""
+        self.base_exists = False
+        self.base_data_set_organization = ""
         self.dds = []
         self.jcl_helper = JCLHelper()
         self.primary_unit = ""
         self.secondary_unit = ""
 
+    def check_member(self):
+        ds_name_param = self._module.params[REGION_DATA_SETS][DFHSTART][DSN]
+        return is_member(ds_name_param)
+
+    def get_expected_ds_org(self):
+        if self.member:
+            return PARTITIONED
+        else:
+            return SEQUENTIAL
+
     def get_result(self):  # type: () -> dict
         result = super().get_result()
         result.update({
@@ -270,6 +286,12 @@ def _get_arg_spec(self):  # type: () -> dict
     def get_arg_defs(self):  # type: () -> dict
         defs = super().get_arg_defs()
         defs.update(self.init_argument_spec())
+        self.member = self.check_member()
+        self.expected_data_set_organization = self.get_expected_ds_org()
+        if self.member:
+            self.update_arg_def(defs[REGION_DATA_SETS]["options"][DFHSTART]["options"][DSN], "data_set_member")
+        else:
+            region_data_sets_list.append("dfhstart")
         self.batch_update_arg_defs_for_ds(defs, REGION_DATA_SETS, region_data_sets_list, True)
         self.batch_update_arg_defs_for_ds(defs, CICS_DATA_SETS, ["sdfhauth", "sdfhlic", "sdfhload"])
         self.batch_update_arg_defs_for_ds(defs, LE_DATA_SETS, ["sceecics", "sceerun", "sceerun2"])
@@ -298,7 +320,7 @@ def update_arg_def(self, dict_to_update, arg_type="data_set_base"):
         dict_to_update.pop("type")
 
     def calculate_size_parameters(self):
-        # Default primary and seconddary units to the space_type module arg
+        # Default primary and secondary units to the space_type module arg
         self.primary_unit = self.unit
         self.secondary_unit = self.unit
 
@@ -317,23 +339,29 @@ def calculate_size_parameters(self):
 
     def create_data_set(self):  # type: () -> None
         self.calculate_size_parameters()
-        data_set_def = DatasetDefinition(
-            dataset_name=self.name,
-            primary=self.primary,
-            secondary=self.secondary,
-            primary_unit=self.primary_unit,
-            secondary_unit=self.secondary_unit,
-            volumes=self.volumes,
-            block_size=4096,
-            record_length=80,
-            record_format="FB",
-            disposition="NEW",
-            normal_disposition="CATALOG",
-            conditional_disposition="DELETE",
-            type="SEQ"
-        )
-
-        super().build_seq_data_set(DFHSTART, data_set_def)
+        if self.member:
+            if not self.base_exists:
+                self._fail("Base data set {0} does not exist. Can only create a member in an existing PDS/E".format(self.base_data_set_name))
+            if self.base_data_set_organization != PARTITIONED:
+                self._fail("Base data set {0} is not a PDS/E. Member cannot be created in base data set".format(self.base_data_set_name))
+        else:
+            data_set_def = DatasetDefinition(
+                dataset_name=self.name,
+                primary=self.primary,
+                secondary=self.secondary,
+                primary_unit=self.primary_unit,
+                secondary_unit=self.secondary_unit,
+                volumes=self.volumes,
+                block_size=4096,
+                record_length=80,
+                record_format="FB",
+                disposition="NEW",
+                normal_disposition="CATALOG",
+                conditional_disposition="DELETE",
+                type="SEQ"
+            )
+            super().build_seq_data_set(DFHSTART, data_set_def)
+
         self.write_jcl()
 
     def generate_jcl(self):
@@ -343,8 +371,9 @@ def generate_jcl(self):
 
     def write_jcl(self):
         try:
-            jcl_writer_execution = JCLHelper._write_jcl_to_data_set(self.jcl, self.name)
+            jcl_writer_execution = _write_jcl_to_data_set(self.jcl, self.name)
             self.executions.extend(jcl_writer_execution)
+            self.changed = True
         except MVSExecutionException as e:
             self.executions.extend(e.executions)
             super()._fail(e.message)
@@ -353,18 +382,22 @@ def init_data_set(self):
         self.generate_jcl()
         if self.exists:
             super().delete_data_set()
-            super().update_data_set_state()
+            self.update_data_set_state()
             self.create_data_set()
         else:
             self.create_data_set()
 
     def warm_target_state(self):
-        if self.exists:
+        if (self.exists and not self.member) or (self.exists and self.base_exists and self.member):
             self.generate_jcl()
             try:
                 jcl_writer_execution, jcl_data = _read_data_set_content(self.name)
                 self.executions.extend(jcl_writer_execution)
-                if jcl_data.strip() != self.jcl.strip():
+                gen_jcl = set(self.jcl.split())
+                existing_jcl = set(jcl_data.split())
+
+                jcl_diff = gen_jcl.symmetric_difference(existing_jcl)
+                if len(jcl_diff) != 0:
                     super()._fail("Data set {0} does not contain the expected Region JCL.".format(self.name))
             except MVSExecutionException as e:
                 self.executions.extend(e.executions)
@@ -382,6 +415,20 @@ def execute_target_state(self):   # type: () -> None
         else:
             super().invalid_target_state()
 
+    def update_data_set_state(self):   # type: () -> None
+        try:
+            if self.member:
+                self.base_data_set_name = self.name.split("(")[0]
+
+                listds_executions, self.base_exists, self.base_data_set_organization = _run_listds(self.base_data_set_name)
+                self.executions.extend(listds_executions)
+
+            listds_executions, self.exists, self.data_set_organization = _run_listds(self.name)
+            self.executions.extend(listds_executions)
+        except MVSExecutionException as e:
+            self.executions.extend(e.executions)
+            self._fail(e.message)
+
     def _build_data_structure_of_arguments(self):
         self._remove_none_values_from_dict(self._module.params)
         self._populate_job_card_dict()