[Enabler][2147-2149]update_job_modules_interfaces (#2208)

* Test

* Modify action job submit

* Replace structure for empty jobs

* Modify structure

* Modify test to properly test new interface

* Modify test on base of job submit new interface

* Be alignt

* Modify job submit

* Add fragment

* Better fragment

* Update documentation

* Fix commit

* Fix documentation

* Keep documentation

* Replace job submit

* Fix sanity

* Fix sanity

* Return values

* Return values to module

* Return values to test suite and empty response

* Update changelogs/fragments/2208_update_job_modules_interfaces.yml

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

* Update changelogs/fragments/2208_update_job_modules_interfaces.yml

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

* Update changelogs/fragments/2208_update_job_modules_interfaces.yml

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

* Fix job submit

* Validate test case

* Validate test case

* Validate test case

* Validate test case

* Validate test case

* Validate test case

* Validate test case

* Update changelogs/fragments/2204-Update_zos_job_query_module.yml

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

* Update plugins/modules/zos_job_submit.py

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

* Update plugins/modules/zos_job_submit.py

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

* Update plugins/modules/zos_job_submit.py

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

* Update plugins/modules/zos_job_submit.py

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

* Update changelogs/fragments/2208_update_job_modules_interfaces.yml

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

* Update changelogs/fragments/2208_update_job_modules_interfaces.yml

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

* Update changelogs/fragments/2208_update_job_modules_interfaces.yml

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

---------

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

Author: 4 people

changelogs/fragments/2204-Update_zos_job_query_module.yml

@@ -1,3 +1,3 @@
 breaking_changes:
-  - zos_job_query - Return value ``message`` is deprecated in favor of ``msg``. Return value ``steps`` are no longer under `` but is now included under jobs.
+  - zos_job_query - Return field ``message`` is deprecated in favor of ``msg``. Return field ``steps`` is no longer under ``ret_code`` but is now included under ``jobs``.
     (https://github.com/ansible-collections/ibm_zos_core/pull/2204).

changelogs/fragments/2208_update_job_modules_interfaces.yml

@@ -0,0 +1,12 @@
+breaking_changes:
+  - zos_job_output - Option name ``ddname`` is substituted for ``dd_name``, but ``ddname`` is kept as an alias. Return value ``changed`` is always returned and return value ``steps`` are no longer under ``ret_code``
+    but is now included under `jobs`. Return value ``ddnames`` is replaced by ``dds`` and value ``ddname`` under ``ddnames`` is replaced by ``dd_name``.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2208).
+  - zos_job_submit - Interface value ``location`` is replace for ``remote_src`` in a bool value and ``wait_time_s`` is replaced for ``wait_time``.
+    Return value ``ddnames`` replaced by ``dds`` and value ``ddname`` under ``ddnames`` is replace by ``dd_name``. Now all values are returned under ``jobs`` except ``changed``.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2208).
+
+trivial:
+  - test/zos_job_query_func.py - Update test validation to new values for job submit. Return value ``steps`` are no longer under `ret_code`
+    but is now included under `jobs`.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2208).

plugins/action/zos_job_submit.py

@@ -45,16 +45,16 @@ def run(self, tmp=None, task_vars=None):
         module_args = self._task.args.copy()
 
         use_template = _process_boolean(module_args.get("use_template"))
-        location = module_args.get("location")
-        if use_template and location != "local":
+        remote_src = module_args.get("remote_src")
+        if use_template and remote_src:
             result.update(dict(
                 failed=True,
                 changed=False,
-                msg="Use of Jinja2 templates is only valid for local files. Location is set to '{0}' but should be 'local'".format(location)
+                msg="Use of Jinja2 templates is only valid for local files. remote_src is set to '{0}' but should be False".format(remote_src)
             ))
             return result
 
-        if location == "local":
+        if not remote_src:
 
             source = self._task.args.get("src", None)
 

plugins/module_utils/job.py

@@ -167,6 +167,7 @@ def _job_not_found(job_id, owner, job_name, dd_name):
         job_not_found_msg = "with the name {0}".format(job_name.upper())
     job = {}
 
+    job["job_not_found"] = True
     job["job_id"] = job_id
     job["job_name"] = job_name
     job["subsystem"] = None
@@ -175,24 +176,36 @@ def _job_not_found(job_id, owner, job_name, dd_name):
     job["cpu_time"] = None
     job["execution_node"] = None
     job["origin_node"] = None
+    job["content_type"] = None
+    job["creation_date"] = None
+    job["creation_time"] = None
+    job["execution_time"] = None
+    job["job_class"] = None
+    job["svc_class"] = None
+    job["priority"] = None
+    job["asid"] = None
+    job["queue_position"] = None
+    job["program_name"] = None
 
     job["ret_code"] = {}
     job["ret_code"]["msg"] = None
     job["ret_code"]["code"] = None
     job["ret_code"]["msg_code"] = None
     job["ret_code"]["msg_txt"] = "The job {0} could not be found.".format(job_not_found_msg)
+    job["steps"] = []
 
-    job["class"] = ""
+    job["class"] = None
 
-    job["ddnames"] = []
+    job["dds"] = []
     dd = {}
-    dd["ddname"] = dd_name
-    dd["record_count"] = "0"
-    dd["id"] = ""
+    dd["dd_name"] = dd_name
+    dd["record_count"] = 0
+    dd["id"] = None
     dd["stepname"] = None
-    dd["procstep"] = ""
-    dd["byte_count"] = "0"
-    job["ddnames"].append(dd)
+    dd["procstep"] = None
+    dd["byte_count"] = 0
+    dd["content"] = None
+    job["dds"].append(dd)
 
     jobs.append(job)
 
@@ -351,8 +364,8 @@ def _get_job_status(job_id="*", owner="*", job_name="*", dd_name=None, dd_scan=T
             job = {}
             job["job_id"] = entry.job_id
             job["job_name"] = entry.name
-            job["subsystem"] = ""
-            job["system"] = ""
+            job["subsystem"] = None
+            job["system"] = None
             job["owner"] = entry.owner
             job["cpu_time"] = None
             job["execution_node"] = None
@@ -380,9 +393,9 @@ def _get_job_status(job_id="*", owner="*", job_name="*", dd_name=None, dd_scan=T
             job["creation_time"] = str(entry.creation_datetime)[12:]
             job["queue_position"] = entry.queue_position
             job["program_name"] = entry.program_name
-            job["class"] = ""
+            job["class"] = None
             job["steps"] = []
-            job["ddnames"] = []
+            job["dds"] = []
             job["duration"] = duration
             if hasattr(entry, "execution_time"):
                 job["execution_time"] = entry.execution_time
@@ -444,7 +457,7 @@ def _get_job_status(job_id="*", owner="*", job_name="*", dd_name=None, dd_scan=T
                         if dd_name not in single_dd["dd_name"]:
                             continue
                         else:
-                            dd["ddname"] = single_dd["dd_name"]
+                            dd["dd_name"] = single_dd["dd_name"]
 
                     if "records" in single_dd:
                         dd["record_count"] = single_dd["records"]
@@ -495,8 +508,8 @@ def _get_job_status(job_id="*", owner="*", job_name="*", dd_name=None, dd_scan=T
 
                     job["steps"].extend(_parse_steps(tmpcont))
 
-                    job["ddnames"].append(dd)
-                    if len(job["class"]) < 1:
+                    job["dds"].append(dd)
+                    if job["class"] is None:
                         job["class"] = entry.job_class
 
                     if job["system"] is None:
@@ -545,7 +558,7 @@ def _ddname_pattern(contents, resolve_dependencies):
         re.IGNORECASE,
     ):
         raise ValueError(
-            'Invalid argument type for "{0}". Expected "ddname_pattern"'.format(
+            'Invalid argument type for "{0}". Expected "dd_name_pattern"'.format(
                 contents
             )
         )