From a96088de9c9e19a9dc72a687957d112c7b5bcc2e Mon Sep 17 00:00:00 2001
From: Javi Merino <javi.merino@arm.com>
Date: Tue, 14 Apr 2015 11:30:03 +0100
Subject: [PATCH] Add a notify result processor

This result processor displays a desktop notification when the run
finishes.  It's useful when you are running a long agenda in WA and want
to be notified when the results are available.
---
 wlauto/result_processors/notify.py | 67 ++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 wlauto/result_processors/notify.py

diff --git a/wlauto/result_processors/notify.py b/wlauto/result_processors/notify.py
new file mode 100644
index 00000000..41db4068
--- /dev/null
+++ b/wlauto/result_processors/notify.py
@@ -0,0 +1,67 @@
+#    Copyright 2015 ARM Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import collections
+import sys
+
+from wlauto import ResultProcessor
+from wlauto.core.result import IterationResult
+from wlauto.exceptions import ResultProcessorError
+
+try:
+    import pynotify
+except ImportError:
+    pynotify = None
+
+
+class NotifyProcessor(ResultProcessor):
+
+    name = 'notify'
+    description = '''Display a desktop notification when the run finishes
+
+    Notifications only work in linux systems. It uses the generic
+    freedesktop notification specification. For this results processor
+    to work, you need to have python-notify installed in your system.
+
+    '''
+
+    def initialize(self, context):
+        if sys.platform != 'linux2':
+            raise ResultProcessorError('Notifications are only supported in linux')
+
+        if not pynotify:
+            raise ResultProcessorError('pynotify not installed.  Please install the python-notify package')
+
+        pynotify.init("Workload Automation")
+
+    def process_run_result(self, result, context):
+        num_iterations = sum(context.job_iteration_counts.values())
+
+        counter = collections.Counter()
+        for result in result.iteration_results:
+            counter[result.status] += 1
+
+        score_board = []
+        for status in IterationResult.values:
+            if status in counter:
+                score_board.append('{} {}'.format(counter[status], status))
+
+        summary = 'Workload Automation run finised'
+        body = 'Ran a total of {} iterations: '.format(num_iterations)
+        body += ', '.join(score_board)
+        notification = pynotify.Notification(summary, body)
+
+        if not notification.show():
+            self.logger.warning('Notification failed to show')