[Enhancement] - [zos_job_submit, zos_job_query, zos_job_output] - adding new params(cpu_time, execution_node, origin_node) (#2056)

* Adding cpu_time, execution_node and origin_code params in zos_job_* modules response

* Updating testcase as respective error description got changed in zoau 1.3.5

* Updating waiting time for testcase

* Update test_zos_job_submit_func.py

* Create 2056-zos_job-modules-adding-cpu_time-execution_node-origin_node.yml

* Update changelogs/fragments/2056-zos_job-modules-adding-cpu_time-execution_node-origin_node.yml

Co-authored-by: Alex Moreno <[email protected]>

* Update changelogs/fragments/2056-zos_job-modules-adding-cpu_time-execution_node-origin_node.yml

Co-authored-by: Alex Moreno <[email protected]>

* Update changelogs/fragments/2056-zos_job-modules-adding-cpu_time-execution_node-origin_node.yml

Co-authored-by: Alex Moreno <[email protected]>

* Updating execution node description

* Updating description

* updating wait_times_s to wait_time_s in zos_job_submit

---------

Co-authored-by: Alex Moreno <[email protected]>

Author: surendrababuravella

changelogs/fragments/2056-zos_job-modules-adding-cpu_time-execution_node-origin_node.yml

@@ -0,0 +1,9 @@
+minor_changes:
+   - zos_job_submit - Adds new fields cpu_time, origin_node and execution_node to response.
+     (https://github.com/ansible-collections/ibm_zos_core/pull/2056).
+
+   - zos_job_query - Adds new fields cpu_time, origin_node and execution_node to response.
+     (https://github.com/ansible-collections/ibm_zos_core/pull/2056).
+
+   - zos_job_output - Adds new fields cpu_time, origin_node and execution_node to response.
+     (https://github.com/ansible-collections/ibm_zos_core/pull/2056).

plugins/module_utils/job.py

@@ -172,6 +172,9 @@ def _job_not_found(job_id, owner, job_name, dd_name):
     job["subsystem"] = None
     job["system"] = None
     job["owner"] = owner
+    job["cpu_time"] = None
+    job["execution_node"] = None
+    job["origin_node"] = None
 
     job["ret_code"] = {}
     job["ret_code"]["msg"] = None
@@ -351,6 +354,9 @@ def _get_job_status(job_id="*", owner="*", job_name="*", dd_name=None, dd_scan=T
             job["subsystem"] = ""
             job["system"] = ""
             job["owner"] = entry.owner
+            job["cpu_time"] = None
+            job["execution_node"] = None
+            job["origin_node"] = None
             # Sometimes, with job type STC, the first entry will have an extra
             # space at the end of it.
             job["content_type"] = entry.job_type.strip()
@@ -384,6 +390,12 @@ def _get_job_status(job_id="*", owner="*", job_name="*", dd_name=None, dd_scan=T
                 job["system"] = entry.system
             if hasattr(entry, "subsystem"):
                 job["subsystem"] = entry.subsystem
+            if hasattr(entry, "cpu_time"):
+                job["cpu_time"] = entry.cpu_time
+            if hasattr(entry, "execution_node"):
+                job["execution_node"] = entry.execution_node
+            if hasattr(entry, "origin_node"):
+                job["origin_node"] = entry.origin_node
 
             if dd_scan:
                 # If true, it means the job is not ready for DD queries and the duration and

plugins/modules/zos_job_output.py

@@ -112,11 +112,31 @@
          The name of the batch job.
       type: str
       sample: HELLO
+    system:
+      description:
+         The job entry system that MVS uses to do work.
+      type: str
+      sample: STL1
     subsystem:
       description:
          The job entry subsystem that MVS uses to do work.
       type: str
       sample: STL1
+    cpu_time:
+      description:
+        Sum of the CPU time used by each job step, in microseconds.
+      type: int
+      sample: 5
+    execution_node:
+      description:
+        Execution node that picked the job and executed it.
+      type: str
+      sample: "STL1"
+    origin_node:
+      description:
+        Origin node that submitted the job.
+      type: str
+      sample: "STL1"
     class:
       description:
          Identifies the data set used in a system output data set, usually called a sysout data set.
@@ -425,7 +445,11 @@
             }
           ]
         },
-        "subsystem": "STL1"
+        "system": "STL1",
+        "subsystem": "STL1",
+        "cpu_time": 1414,
+        "execution_node": "STL1",
+        "origin_node": "STL1"
       }
   ]
 changed:

plugins/modules/zos_job_query.py

@@ -153,6 +153,21 @@
          The job entry subsystem that MVS uses to do work.
       type: str
       sample: STL1
+    cpu_time:
+      description:
+        Sum of the CPU time used by each job step, in microseconds.
+      type: int
+      sample: 5
+    execution_node:
+      description:
+        Execution node that picked the job and executed it.
+      type: str
+      sample: "STL1"
+    origin_node:
+      description:
+        Origin node that submitted the job.
+      type: str
+      sample: "STL1"
     ret_code:
       description:
          Return code output collected from job log.
@@ -271,7 +286,12 @@
             "creation_date": "2023-05-03",
             "creation_time": "12:13:00",
             "queue_position": 3,
-            "execution_time": "00:00:02"
+            "execution_time": "00:00:02",
+            "system": "STL1",
+            "subsystem": "STL1",
+            "cpu_time": 1414,
+            "execution_node": "STL1",
+            "origin_node": "STL1"
         },
         {
             "job_name": "LINKCBL",
@@ -286,7 +306,12 @@
             "creation_date": "2023-05-03",
             "creation_time": "12:14:00",
             "queue_position": 0,
-            "execution_time": "00:00:03"
+            "execution_time": "00:00:03",
+            "system": "STL1",
+            "subsystem": "STL1",
+            "cpu_time": 1414,
+            "execution_node": "STL1",
+            "origin_node": "STL1"
         },
     ]
 message:
@@ -456,6 +481,9 @@ def parsing_jobs(jobs_raw):
             "content_type": job.get("content_type"),
             "system": job.get("system"),
             "subsystem": job.get("subsystem"),
+            "cpu_time": job.get("cpu_time"),
+            "execution_node": job.get("execution_node"),
+            "origin_node": job.get("origin_node"),
             "ret_code": ret_code,
             "job_class": job.get("job_class"),
             "svc_class": job.get("svc_class"),

plugins/modules/zos_job_submit.py

@@ -367,6 +367,31 @@
         The name of the program found in the job's last completed step found in the PGM parameter.
       type: str
       sample: "IEBGENER"
+    system:
+      description:
+         The job entry system that MVS uses to do work.
+      type: str
+      sample: STL1
+    subsystem:
+      description:
+         The job entry subsystem that MVS uses to do work.
+      type: str
+      sample: STL1
+    cpu_time:
+      description:
+        Sum of the CPU time used by each job step, in microseconds.
+      type: int
+      sample: 5
+    execution_node:
+      description:
+        Execution node that picked the job and executed it.
+      type: str
+      sample: "STL1"
+    origin_node:
+      description:
+        Origin node that submitted the job.
+      type: str
+      sample: "STL1"
 
   sample:
      [
@@ -591,7 +616,10 @@
               "creation_time": "12:13:00",
               "queue_position": 3,
               "subsystem": "STL1",
-              "system": "STL1"
+              "system": "STL1",
+              "cpu_time": 1,
+              "execution_node": "STL1",
+              "origin_node": "STL1"
           }
      ]
 """
@@ -1095,10 +1123,10 @@ def run_module():
                 _msg = ("The JCL submitted with job id {0} but appears to be a long "
                         "running job that exceeded its maximum wait time of {1} "
                         "second(s). Consider using module zos_job_query to poll for "
-                        "a long running job or increase option 'wait_times_s' to a value "
+                        "a long running job or increase option 'wait_time_s' to a value "
                         "greater than {2}.".format(str(job_submitted_id), str(wait_time_s), str(duration)))
                 _msg_suffix = ("Consider using module zos_job_query to poll for "
-                               "a long running job or increase option 'wait_times_s' to a value "
+                               "a long running job or increase option 'wait_time_s' to a value "
                                "greater than {0}.".format(str(duration)))
 
                 if job_output_txt is not None:

tests/functional/modules/test_zos_job_output_func.py

@@ -117,6 +117,11 @@ def test_zos_job_output_job_exists(ansible_zos_module):
             assert result.get("jobs")[0].get("ret_code").get("steps")[0].get("step_name") == "STEP0001"
             assert result.get("jobs")[0].get("content_type") == "JOB"
             assert result.get("jobs")[0].get("execution_time") is not None
+            assert "system" in result.get("jobs")[0]
+            assert "subsystem" in result.get("jobs")[0]
+            assert "cpu_time" in result.get("jobs")[0]
+            assert "execution_node" in result.get("jobs")[0]
+            assert "origin_node" in result.get("jobs")[0]
     finally:
         hosts.all.file(path=TEMP_PATH, state="absent")
 

tests/functional/modules/test_zos_job_query_func.py

@@ -98,6 +98,9 @@ def test_zos_job_id_query_multi_wildcards_func(ansible_zos_module):
                 assert qresult.get("jobs")[0].get("execution_time") is not None
                 assert qresult.get("jobs")[0].get("system") is not None
                 assert qresult.get("jobs")[0].get("subsystem") is not None
+                assert "cpu_time" in result.get("jobs")[0]
+                assert "execution_node" in result.get("jobs")[0]
+                assert "origin_node" in result.get("jobs")[0]
 
     finally:
         hosts.all.file(path=temp_path, state="absent")

tests/functional/modules/test_zos_job_submit_func.py

@@ -486,6 +486,11 @@ def test_job_submit_pds(ansible_zos_module, location):
             assert result.get("jobs")[0].get("ret_code").get("msg_code") == "0000"
             assert result.get("jobs")[0].get("ret_code").get("code") == 0
             assert result.get("changed") is True
+            assert "system" in result.get("jobs")[0]
+            assert "subsystem" in result.get("jobs")[0]
+            assert "cpu_time" in result.get("jobs")[0]
+            assert "execution_node" in result.get("jobs")[0]
+            assert "origin_node" in result.get("jobs")[0]
     finally:
         hosts.all.file(path=temp_path, state="absent")
         hosts.all.zos_data_set(name=data_set_name, state="absent")
@@ -771,11 +776,11 @@ def test_job_submit_pds_30_sec_job_wait_10_negative(ansible_zos_module):
 @pytest.mark.parametrize("args", [
     {
         "max_rc":None,
-        "wait_time_s":10
+        "wait_time_s":20
     },
     {
         "max_rc":4,
-        "wait_time_s":10
+        "wait_time_s":20
     },
     {
         "max_rc":12,