Reverted rmutl job submit changes

Signed-off-by: Samarin Nayak <[email protected]>

Author: Samarinnayak

plugins/module_utils/_data_set_utils.py

@@ -13,8 +13,7 @@
 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, StdinDefinition
-from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.job import job_output
+from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.dd_statement import DDStatement, StdoutDefinition, DatasetDefinition, StdinDefinition
 
 MVS_CMD_RETRY_ATTEMPTS = 10
 
@@ -275,73 +274,6 @@ def _execute_command(command):
     return module.run_command(command)
 
 
-def _submit_jcl(jcl_uss_path, job_name):
-    executions = []
-    command = "jsub -f '{0}'".format(jcl_uss_path)
-
-    rc, stdout, stderr = _execute_command(command)
-    executions.append(
-        _execution(
-            name="Submit JCL job for {0}".format(job_name),
-            rc=rc,
-            stdout=stdout,
-            stderr=stderr))
-    if rc != 0:
-        raise MVSExecutionException(
-            "RC {0} when submitting JCL from {1}".format(
-                rc, jcl_uss_path), executions)
-    return executions
-
-
-def _get_job_output(job_id, job_name):
-    executions = []
-
-    jobs = job_output(job_id=job_id, job_name=job_name)
-
-    # There should only be one job found for the JCL submitted
-    if (len(jobs) != 1):
-        raise MVSExecutionException(
-            "Query for job status for {0} with job ID {1} returned more than one result. Jobs returned: {2}".format(
-                job_name,
-                job_id,
-                jobs), executions)
-
-    executions.append(
-        _execution(
-            name="Get job output for {0}".format(job_id),
-            rc=jobs[0]["ret_code"].get("code"),
-            stdout=jobs[0]["ret_code"].get("msg", ""),
-            stderr=jobs[0]["ret_code"].get("msg_txt", "")))
-
-    # job output fails to get the ddname content in its response. Call direct into zoau to do it
-    for i in range(len(jobs[0].get("ddnames"))):
-        dd_executions, job_stdout = _get_job_dd(job_id, jobs[0]["ddnames"][i]["ddname"])
-
-        # Put the content back in the job response object
-        jobs[0]["ddnames"][i]["content"] = job_stdout
-        executions.append(dd_executions)
-
-    return jobs[0], executions
-
-
-def _get_job_dd(job_id, dd_name):
-    executions = []
-    command = "pjdd {0} {1}".format(job_id, dd_name)
-
-    rc, stdout, stderr = _execute_command(command)
-    executions.append(
-        _execution(
-            name="Get job DD {0} output for {1}".format(dd_name, job_id),
-            rc=rc,
-            stdout=stdout,
-            stderr=stderr))
-    if rc != 0:
-        raise MVSExecutionException(
-            "RC {0} when getting job output for {1} from {2}".format(
-                rc, dd_name, job_id), executions)
-    return executions, stdout
-
-
 def _read_data_set_content(data_set_name):
     executions = []
     command = "dcat '{0}'".format(data_set_name)

plugins/module_utils/_global_catalog.py

@@ -6,14 +6,13 @@
 # FOR INTERNAL USE IN THE COLLECTION ONLY.
 
 from __future__ import (absolute_import, division, print_function)
-from os import remove
 __metaclass__ = type
 
 
+from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.zos_mvs_raw import MVSCmd, MVSCmdResponse
+from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.dd_statement import StdoutDefinition, DatasetDefinition, DDStatement, InputDefinition
 from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._response import MVSExecutionException, _execution
-from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._data_set_utils import MVS_CMD_RETRY_ATTEMPTS, _submit_jcl, _get_job_output
-from tempfile import NamedTemporaryFile
-from time import sleep
+from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils._data_set_utils import MVS_CMD_RETRY_ATTEMPTS
 
 
 def _get_value_from_line(line):  # type: (list[str]) -> str | None
@@ -27,6 +26,18 @@ def _get_filtered_list(elements, target):  # type: (list[str],str) -> list[str]
     return list(filter(lambda x: target in x, elements))
 
 
+def _get_rmutl_dds(
+        location,
+        sdfhload,
+        cmd):  # type: (str, str, str) -> list[DDStatement]
+    return [
+        DDStatement('steplib', DatasetDefinition(sdfhload)),
+        DDStatement('dfhgcd', DatasetDefinition(location)),
+        DDStatement('sysin', InputDefinition(content=cmd)),
+        DDStatement('sysprint', StdoutDefinition()),
+    ]
+
+
 def _get_reason_code(stdout_lines_arr):  # type: (list[str]) -> str | None
     if len(stdout_lines_arr) == 0:
         return None
@@ -57,132 +68,63 @@ def _get_catalog_records(stdout):  # type: (str) -> tuple[str | None, str | None
     return (autostart_override, nextstart)
 
 
-def _create_dfhrmutl_jcl(location, sdfhload, cmd=""):
-    steplib_line = f"//STEPLIB  DD DSNAME={sdfhload},DISP=SHR"
-    dfhgcd_line = f"//DFHGCD   DD DSNAME={location},DISP=OLD"
-    # Validate line lengths
-    _validate_line_length(steplib_line, sdfhload, "cics_data_sets")
-    _validate_line_length(dfhgcd_line, location, "region_data_sets")
-
-    jcl = ""
-    if (cmd == ""):
-        jcl = f'''
-//DFHRMUTL JOB
-//RMUTL    EXEC PGM=DFHRMUTL,REGION=1M
-{steplib_line}
-//SYSPRINT DD SYSOUT=*
-{dfhgcd_line}
-//SYSIN    DD *
-/*
-'''
-    else:
-        jcl = f'''
-//DFHRMUTL JOB
-//RMUTL    EXEC PGM=DFHRMUTL,REGION=1M
-{steplib_line}
-//SYSPRINT DD SYSOUT=*
-{dfhgcd_line}
-//SYSIN    DD *
-    {cmd}
-/*
-'''
-
-    # Create a temporary file
-    with NamedTemporaryFile(mode='w+', delete=False) as fp:
-        fp.write(jcl)
-        fp.flush()
-
-        # Get the temporary file's name
-        qualified_file_path = fp.name
-    return qualified_file_path
-
-
-def _validate_line_length(line, name, parameter):
-    """
-    Validates that the JCL line does not exceed MAX_LINE_LENGTH.
-    Raises ValueError if validation fails.
-    """
-    if len(line) > MAX_LINE_LENGTH:
-        raise ValueError(f"Value supplied for {parameter} ({name}) is {len(line) - MAX_LINE_LENGTH} characters too long")
-    return True
-
-
 def _run_dfhrmutl(
         location,  # type: str
         sdfhload,  # type: str
         cmd=""  # type: str
 ):
     # type: (...) -> tuple[list[dict[str, str| int]], tuple[str | None, str | None]] | list[dict[str, str| int]]
-
-    qualified_file_path = _create_dfhrmutl_jcl(
-        location,
-        sdfhload,
-        cmd
-    )
     executions = []
-    try:
-        for x in range(MVS_CMD_RETRY_ATTEMPTS):
-            dfhrmutl_response, jcl_executions = _execute_dfhrmutl(qualified_file_path)
-            dfhrmutl_rc = dfhrmutl_response["ret_code"].get("code")
-
-            allContent = []
-            for ddname in dfhrmutl_response.get("ddnames"):
-                allContent += ddname.get("content")
-            stdout_raw = "".join(allContent)
-
-            executions.append(jcl_executions)
-            executions.append(
-                _execution(
-                    name="DFHRMUTL - {0} - Run {1}".format(
-                        "Get current catalog" if cmd == "" else "Updating autostart override",
-                        x + 1),
-                    rc=dfhrmutl_rc,
-                    stdout=stdout_raw,
-                    stderr=dfhrmutl_response["ret_code"].get("msg_txt", "")))
-
-            if dfhrmutl_rc not in (0, 16):
-                raise MVSExecutionException(
-                    "DFHRMUTL failed with RC {0}".format(
-                        dfhrmutl_rc), executions)
-
-            if dfhrmutl_rc == 0:
-                break
-            if dfhrmutl_rc == 16:
+
+    for x in range(MVS_CMD_RETRY_ATTEMPTS):
+        dfhrmutl_response = _execute_dfhrmutl(location, sdfhload, cmd)
+        execution_entry = _execution(
+            name="DFHRMUTL - {0} - Run {1}".format(
+                "Get current catalog" if cmd == "" else "Updating autostart override",
+                x + 1),
+            rc=dfhrmutl_response.rc,
+            stdout=dfhrmutl_response.stdout,
+            stderr=dfhrmutl_response.stderr
+        )
+        executions.append(execution_entry)
+
+        if dfhrmutl_response.rc == 0:
+            break
+        if dfhrmutl_response.rc != 0:
+            # DFHRMUTL fails when running with MVSCMD so check it ran successfully
+            if DFHRMUTL_PROGRAM_HEADER not in dfhrmutl_response.stdout or SUBPROCESS_EXIT_MESSAGE not in dfhrmutl_response.stderr:
                 formatted_stdout_lines = [
                     "{0}".format(element.replace(" ", "").upper())
-                    for element in stdout_raw.split("\n")
+                    for element in dfhrmutl_response.stdout.split("\n")
                 ]
                 stdout_with_rc = list(filter(lambda x: "REASON:X" in x, formatted_stdout_lines))
 
                 reason_code = _get_reason_code(stdout_with_rc)
                 if reason_code and reason_code != "A8":
                     raise MVSExecutionException(
-                        "DFHRMUTL failed with RC 16 - {0}".format(stdout_with_rc[0]), executions
+                        f"DFHRMUTL failed with RC {dfhrmutl_response.rc} - {stdout_with_rc[0]}", executions
                     )
                 elif reason_code is None:
                     raise MVSExecutionException(
-                        "DFHRMUTL failed with RC 16 but no reason code was found",
-                        executions,
+                        f"DFHRMUTL failed with RC {dfhrmutl_response.rc} but no reason code was found",
+                        executions
                     )
+            else :
+                execution_entry["rc"] = 0
+                break
 
-        if cmd != "":
-            return executions
-    finally:
-        remove(qualified_file_path)
-    return executions, _get_catalog_records(stdout_raw)
-
-
-def _execute_dfhrmutl(rmutl_jcl_path, job_name="DFHRMUTL"):
-    executions = _submit_jcl(rmutl_jcl_path, job_name)
-    job_id = executions[0].get("stdout").strip()
+    if cmd != "":
+        return executions
 
-    # Give RMUTL a second to run
-    sleep(JOB_SUBMIT_WAIT_TIME)
+    return executions, _get_catalog_records(dfhrmutl_response.stdout)
 
-    job, job_executions = _get_job_output(job_id, job_name)
-    executions.append(job_executions)
 
-    return job, executions
+def _execute_dfhrmutl(location, sdfhload, cmd=""):   # type: (str, str, str) -> MVSCmdResponse
+    return MVSCmd.execute(
+        pgm="DFHRMUTL",
+        dds=_get_rmutl_dds(location=location, sdfhload=sdfhload, cmd=cmd),
+        verbose=True,
+        debug=False)
 
 
 def _get_idcams_cmd_gcd(dataset):   # type: (dict) -> dict
@@ -206,7 +148,6 @@ def _get_idcams_cmd_gcd(dataset):   # type: (dict) -> dict
     return defaults
 
 
-# IDCAMS Consts
 RECORD_COUNT_DEFAULT = 4089
 RECORD_SIZE_DEFAULT = 32760
 CONTROL_INTERVAL_SIZE_DEFAULT = 32768
@@ -216,6 +157,5 @@ def _get_idcams_cmd_gcd(dataset):   # type: (dict) -> dict
 CA_PERCENT = 10
 SHARE_CROSSREGION = 2
 
-# RMUTL Consts
-MAX_LINE_LENGTH = 72
-JOB_SUBMIT_WAIT_TIME = 1
+DFHRMUTL_PROGRAM_HEADER = "===DFHRMUTL CICS RECOVERY MANAGER BATCH UTILITY==="
+SUBPROCESS_EXIT_MESSAGE = "Attach Exit code: 0 from DFHRMUTL."