updated stop action to use self attributes

Signed-off-by: Andrew Twydell <[email protected]>

Author: AndrewTwydell

plugins/action/stop_region.py

@@ -49,21 +49,20 @@ def run(self, tmp=None, task_vars=None):
         self._setup(tmp, task_vars)
         self._execute_stop_module()
 
-        if self.result.get(FAILED):
-            return self.result
+        if self.failed:
+            return self.get_result()
 
         self._parse_module_params()
 
         try:
             self._get_job_data()
         except AnsibleActionFail as e:
-            self.result.update(
-                {MSG: e.args[0], FAILED: True, CHANGED: False})
-            return self.result
+            self.failed = True
+            return self.get_result(e.args[0])
 
         if not self.job_id or not self.job_name or self.job_status != EXECUTING:
-            self.result.update({FAILED: False, CHANGED: False, })
-            return self.result
+            self.failed = True
+            return self.get_result()
 
         self.logger.debug(RUNNING_ATTEMPTING_TO_STOP)
         try:
@@ -72,17 +71,17 @@ def run(self, tmp=None, task_vars=None):
             else:
                 self._perform_shutdown()
         except AnsibleActionFail as e:
-            self.result.update(
-                {MSG: e.args[0], FAILED: True, CHANGED: False})
-            return self.result
+            self.failed = True
+            return self.get_result(e.args[0])
 
         try:
             self.wait_for_shutdown()
-            self.result.update({CHANGED: True})
+            self.changed = True
         except TimeoutError as e:
-            self.result.update({MSG: e.args[0], FAILED: True})
+            self.failed = True
+            self.msg = e.args[0]
 
-        return self.result
+        return self.get_result()
 
     def _cancel_region(self):
         run_command_result = self.execute_cancel_shell_cmd(
@@ -104,21 +103,28 @@ def _setup(self, tmp, task_vars):
         self.module_args = self._task.args.copy()
         self.logger = logging.getLogger(__name__)
 
-        self.result = {
-            FAILED: False,
-            CHANGED: False,
-            MSG: "",
-            EXECUTIONS: [],
+        self.failed = False
+        self.changed = False
+        self.msg = ""
+        self.executions = []
+
+    def get_result(self, msg=None):
+        return {
+            FAILED: self.failed,
+            CHANGED: self.changed,
+            MSG: msg if msg else self.msg,
+            EXECUTIONS: self.executions,
         }
 
     def _execute_stop_module(self):
-        self.result.update(
-            self._execute_module(
-                module_name=STOP_MODULE_NAME,
-                module_args=self.module_args,
-                task_vars=self.task_vars,
-                tmp=self.tmp,
-            ))
+        stop_module_output = self._execute_module(
+            module_name=STOP_MODULE_NAME,
+            module_args=self.module_args,
+            task_vars=self.task_vars,
+            tmp=self.tmp,
+        )
+        self.failed = stop_module_output.get(FAILED, self.failed)
+        self.msg = stop_module_output.get(MSG, self.msg)
 
     def _parse_module_params(self):
         self.job_name = self.module_args.get(JOB_NAME)
@@ -141,7 +147,8 @@ def _get_job_data(self):
             if len(running_jobs) > 1:
                 self.job_status = "MULTIPLE"
                 raise AnsibleActionFail(
-                    "Cannot ambiguate between multiple running jobs with the same name ({0}). Use `job_id` as a parameter to specify the correct job.".format(self.job_name))
+                    "Cannot ambiguate between multiple running jobs with the same name ({0}). Use `job_id` as a parameter to specify the correct job.".format(
+                        self.job_name))
 
             self.job_id = running_jobs[0][JOB_ID]
             self.job_status = running_jobs[0][STATUS]
@@ -186,7 +193,7 @@ def _get_running_jobs(self):
         return running
 
     def _add_status_execution(self, job, result):
-        self.result[EXECUTIONS].append({
+        self.executions.append({
             NAME: CHECK_CICS_STATUS.format(job),
             RETURN: result,
         })
@@ -195,7 +202,7 @@ def wait_for_shutdown(self):
         end_time = calculate_end_time(
             self.timeout) if self.timeout > 0 else None
 
-        self.result[EXECUTIONS].append({})
+        self.executions.append({})
         status = EXECUTING
         while status == EXECUTING and (
             get_datetime_now() < end_time if end_time else True
@@ -207,7 +214,7 @@ def wait_for_shutdown(self):
                 TSO_STATUS_ID_COMMAND.format(self.job_name, self.job_id)
             )
 
-            self.result[EXECUTIONS].pop()
+            self.executions.pop()
             self._add_status_execution(self.job_id, tso_cmd_response)
 
             status = _get_job_status_name_id(
@@ -232,7 +239,7 @@ def execute_zos_job_query(self, job_id):
             module_args={JOB_ID: job_id},
             task_vars=self.task_vars,
         )
-        self.result[EXECUTIONS].append({
+        self.executions.append({
             NAME: "ZOS Job Query - {0}".format(job_id),
             RETURN: query_response
         })
@@ -244,7 +251,7 @@ def execute_zos_operator_cmd(self, command):
             module_args={"cmd": command},
             task_vars=self.task_vars,
         )
-        self.result[EXECUTIONS].append({
+        self.executions.append({
             NAME: "ZOS Operator Command - {0}".format(command),
             RETURN: operator_response,
         })
@@ -267,7 +274,7 @@ def execute_cancel_shell_cmd(self, job_name, job_id):
             shared_loader_obj=self._shared_loader_obj,
         )
         cancel_response = command_action.run(task_vars=self.task_vars)
-        self.result[EXECUTIONS].append({
+        self.executions.append({
             NAME: "Cancel command - {0}({1})".format(job_name, job_id),
             RETURN: cancel_response,
         })

plugins/modules/stop_region.py

@@ -220,10 +220,8 @@ def __init__(self):
             mutually_exclusive=[(SDTRAN, NO_SDTRAN)],
             required_one_of=[(JOB_ID, JOB_NAME)],
         )
-        self.changed = False
         self.failed = False
         self.msg = ""
-        self.executions = []
 
     def main(self):
         if self._module.params.get(SDTRAN):
@@ -247,9 +245,9 @@ def _fail(self, msg):  # type: (str) -> None
 
     def get_result(self):  # type: () -> dict
         return {
-            "changed": self.changed,
+            "changed": False,
             "failed": self.failed,
-            "executions": self.executions,
+            "executions": [],
             "msg": self.msg
         }
 

tests/integration/targets/cics_start_stop/playbooks/stop_args.yml

@@ -142,7 +142,7 @@
           ansible.builtin.assert:
             that:
               - stop_result.failed == true
-              - stop_result.msg == "No jobs found with name TWYD01 and ID NONJOB"
+              - stop_result.msg == "No jobs found with name {{ start_region_applid }} and ID NONJOB"
 
         - name: Issue shutdown command (wrong name)
           ibm.ibm_zos_cics.stop_region: