From de58d6764f5757086c86cdd63705912a31cc28ad Mon Sep 17 00:00:00 2001
From: AlanCoding <arominge@redhat.com>
Date: Wed, 30 Aug 2017 13:19:53 -0400
Subject: [PATCH] use exceptions for job cancel and failure

---
 awx/main/exceptions.py | 24 ++++++++++++++++++++++++
 awx/main/tasks.py      | 11 +++++++----
 2 files changed, 31 insertions(+), 4 deletions(-)
 create mode 100644 awx/main/exceptions.py

diff --git a/awx/main/exceptions.py b/awx/main/exceptions.py
new file mode 100644
index 0000000000..cc2dda4968
--- /dev/null
+++ b/awx/main/exceptions.py
@@ -0,0 +1,24 @@
+class AwxTaskError(Exception):
+    """Base exception for errors in unified job runs"""
+    def __init__(self, task, message=None):
+        if message is None:
+            message = "Execution error running {}".format(task.log_format)
+        super(AwxTaskError, self).__init__(message)
+        self.task = task
+ 
+ 
+class TaskCancel(AwxTaskError):
+    """Canceled flag caused run_pexpect to kill the job run"""
+    def __init__(self, task, rc):
+        super(TaskCancel, self).__init__(
+            task, message="{} was canceled (rc={})".format(task.log_format, rc))
+        self.rc = rc
+
+
+class TaskError(AwxTaskError):
+    """Userspace error (non-zero exit code) in run_pexpect subprocess"""
+    def __init__(self, task, rc):
+        super(TaskError, self).__init__(
+            task, message="%s encountered an error (rc=%s), please see task stdout for details.".format(task.log_format, rc))
+        self.rc = rc
+
diff --git a/awx/main/tasks.py b/awx/main/tasks.py
index 2c884802c2..f2b555d01b 100644
--- a/awx/main/tasks.py
+++ b/awx/main/tasks.py
@@ -50,6 +50,7 @@ from awx import __version__ as awx_application_version
 from awx.main.constants import CLOUD_PROVIDERS, PRIVILEGE_ESCALATION_METHODS
 from awx.main.models import * # noqa
 from awx.main.models.unified_jobs import ACTIVE_STATES
+from awx.main.exceptions import AwxTaskError, TaskCancel, TaskError
 from awx.main.queue import CallbackQueueDispatcher
 from awx.main.expect import run, isolated_manager
 from awx.main.utils import (get_ansible_version, get_ssh_version, decrypt_field, update_scm_url,
@@ -80,7 +81,10 @@ logger = logging.getLogger('awx.main.tasks')
 
 class LogErrorsTask(Task):
     def on_failure(self, exc, task_id, args, kwargs, einfo):
-        if isinstance(self, BaseTask):
+        if isinstance(exc, AwxTaskError):
+            # Error caused by user / tracked in job output
+            logger.warning(str(exc))
+        elif isinstance(self, BaseTask):
             logger.exception(
                 '%s %s execution encountered exception.',
                 get_type_for_model(self.model), args[0])
@@ -900,10 +904,9 @@ class BaseTask(LogErrorsTask):
             # Raising an exception will mark the job as 'failed' in celery
             # and will stop a task chain from continuing to execute
             if status == 'canceled':
-                raise Exception("%s was canceled (rc=%s)" % (instance.log_format, str(rc)))
+                raise TaskCancel(instance, rc)
             else:
-                raise Exception("%s encountered an error (rc=%s), please see task stdout for details." %
-                                (instance.log_format, str(rc)))
+                raise TaskError(instance, rc)
         if not hasattr(settings, 'CELERY_UNIT_TEST'):
             self.signal_finished(pk)