Merge lp:~vrruiz/unity8/helpers-notify into lp:unity8

[Víctor R. Ruiz]

Move autopilot notification code to a helper method.

Move autopilot notification code to a helper method.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:824
http://jenkins.qa.ubuntu.com/job/unity8-ci/2816/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-trusty-touch/234
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/4826
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-trusty/1680
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-amd64-ci/1337
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/1341
        deb: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/1341/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-i386-ci/1337
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/221
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4403
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4403/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/6006
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/4171
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4958
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4958/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/2816/rebuild

review: Needs Fixing (continuous-integration)

[Allan LeSage (allanlesage)]

Get the PITA out of the way:

38-45: Comments to the left by four spaces (although I see in the prior commit ;) ).
93-94: IMO it's better to use parentheses to join these broken lines.

On the whole it's nice small change and more convenient, looks good.

review: Needs Fixing

[lp:~vrruiz/unity8/helpers-notify]

825. By Víctor R. Ruiz on 2014-04-16

Autopilot: Style fixes

[Víctor R. Ruiz (vrruiz)]

Thanks for the comments, Allan. Changes done.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:825
http://jenkins.qa.ubuntu.com/job/unity8-ci/2840/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-trusty-touch/298
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/4909/console
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-trusty/1704
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-amd64-ci/1361
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/1365
        deb: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/1365/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-i386-ci/1361
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/280
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4487
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4487/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/6130
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/4241/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/5054
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/5054/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/2840/rebuild

review: Needs Fixing (continuous-integration)

[Leo Arias (elopio)]

Please add to the description of your MP the dev checklist from:
https://wiki.ubuntu.com/Process/Merges/Checklists/Unity8

review: Approve (code review)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:825
http://jenkins.qa.ubuntu.com/job/unity8-ci/2853/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-trusty-touch/336
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-trusty/1717
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-amd64-ci/1374
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/1378
        deb: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/1378/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-i386-ci/1374
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/309
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4548
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4548/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/6215

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/2853/rebuild

review: Needs Fixing (continuous-integration)

[Víctor R. Ruiz (vrruiz)]

* Are there any related MPs required for this MP to build/function as expected? Please list.
- No.

* Did you perform an exploratory manual test run of your code change and any related functionality?
- Yes.

* Did you make sure that your branch does not contain spurious tags?
- Yes.

* If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
- No changes.

* If you changed the UI, has there been a design review?
- No changes.

[Andrea Cimitan (cimi)]

 * Did you perform an exploratory manual test run of the code change and any related functionality?
Yes
 * Did CI run pass? If not, please explain why.
Unrelated

review: Approve

[Michał Sawicz (saviq)]

Hey, please run http://people.canonical.com/~msawicz/unity8/strip-u8-tags.sh on your branch.

review: Needs Fixing

[lp:~vrruiz/unity8/helpers-notify]

826. By Víctor R. Ruiz on 2014-04-28

Strip tags

[Víctor R. Ruiz (vrruiz)]

Michal: Done!

=== modified file 'tests/autopilot/unity8/shell/__init__.py'
--- tests/autopilot/unity8/shell/__init__.py	2014-02-13 04:13:36 +0000
+++ tests/autopilot/unity8/shell/__init__.py	2014-04-28 14:18:27 +0000
@@ -21,9 +21,10 @@
 
 from time import sleep
 from functools import wraps
+from gi.repository import Notify
+
 import logging
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -48,6 +49,7 @@
         return fn(*args, **kwargs)
     return wrapper
 
+
 class DragMixin(object):
     def _drag(self, x1, y1, x2, y2):
         # XXX This ugly code is here just temporarily, waiting for drag
@@ -69,3 +71,50 @@
             self.touch._finger_move(int(x2), int(y2))
         except AttributeError:
             self.touch._device.finger_move(int(x2), int(y2))
+
+
+def create_ephemeral_notification(
+    summary='',
+    body='',
+    icon=None,
+    hints=[],
+    urgency='NORMAL'
+):
+    """Create an ephemeral (non-interactive) notification
+
+    :param summary: Summary text for the notification
+    :param body: Body text to display in the notification
+    :param icon: Path string to the icon to use
+    :param hint_strings: List of tuples containing the 'name' and value
+        for setting the hint strings for the notification
+    :param urgency: Urgency string for the noticiation, either: 'LOW',
+        'NORMAL', 'CRITICAL'
+    """
+    Notify.init('Unity8')
+
+    logger.info(
+        "Creating ephemeral: summary(%s), body(%s), urgency(%r) "
+        "and Icon(%s)",
+        summary,
+        body,
+        urgency,
+        icon
+    )
+
+    notification = Notify.Notification.new(summary, body, icon)
+
+    for hint in hints:
+        key, value = hint
+        notification.set_hint_string(key, value)
+        logger.info("Adding hint to notification: (%s, %s)", key, value)
+    notification.set_urgency(_get_urgency(urgency))
+
+    return notification
+
+
+def _get_urgency(urgency):
+    """Translates urgency string to enum."""
+    _urgency_enums = {'LOW': Notify.Urgency.LOW,
+                      'NORMAL': Notify.Urgency.NORMAL,
+                      'CRITICAL': Notify.Urgency.CRITICAL}
+    return _urgency_enums.get(urgency.upper())

=== modified file 'tests/autopilot/unity8/shell/tests/test_notifications.py'
--- tests/autopilot/unity8/shell/tests/test_notifications.py	2014-03-21 14:21:20 +0000
+++ tests/autopilot/unity8/shell/tests/test_notifications.py	2014-04-28 14:18:27 +0000
@@ -21,6 +21,7 @@
 
 from __future__ import absolute_import
 
+from unity8 import shell
 from unity8.process_helpers import unlock_unity
 from unity8.shell.tests import UnityTestCase, _get_device_emulation_scenarios
 
@@ -64,7 +65,8 @@
         if os.path.abspath(__file__).startswith('/usr/'):
             return '/usr/share/unity8/graphics/' + icon_name
         else:
-            return os.path.dirname(__file__) + "/../../../../../qml/graphics/" + icon_name
+            return os.path.dirname(__file__) + (
+                "/../../../../../qml/graphics/" + icon_name)
 
     def _get_notifications_list(self):
         return self.main_window.select_single(
@@ -354,7 +356,7 @@
             )
         ]
 
-        notification = self._create_ephemeral_notification(
+        notification = shell.create_ephemeral_notification(
             summary,
             body,
             icon_path,
@@ -391,7 +393,7 @@
             )
         ]
 
-        notification = self._create_ephemeral_notification(
+        notification = shell.create_ephemeral_notification(
             summary,
             None,
             None,
@@ -433,7 +435,7 @@
         body_critical = 'Dude, this is so urgent you have no idea :)'
         icon_path_critical = self._get_icon_path('avatars/anna_olsson.png')
 
-        notification_normal = self._create_ephemeral_notification(
+        notification_normal = shell.create_ephemeral_notification(
             summary_normal,
             body_normal,
             icon_path_normal,
@@ -441,7 +443,7 @@
         )
         notification_normal.show()
 
-        notification_low = self._create_ephemeral_notification(
+        notification_low = shell.create_ephemeral_notification(
             summary_low,
             body_low,
             icon_path_low,
@@ -449,7 +451,7 @@
         )
         notification_low.show()
 
-        notification_critical = self._create_ephemeral_notification(
+        notification_critical = shell.create_ephemeral_notification(
             summary_critical,
             body_critical,
             icon_path_critical,
@@ -510,7 +512,7 @@
         summary = 'Summary-Body'
         body = 'This is a superfluous notification'
 
-        notification = self._create_ephemeral_notification(summary, body)
+        notification = shell.create_ephemeral_notification(summary, body)
         notification.show()
 
         notification = notify_list.wait_select_single(
@@ -534,7 +536,7 @@
 
         summary = 'Summary-Only'
 
-        notification = self._create_ephemeral_notification(summary)
+        notification = shell.create_ephemeral_notification(summary)
         notification.show()
 
         notification = notify_list.wait_select_single(
@@ -554,7 +556,7 @@
         body = 'This is the original content of this notification-bubble.'
         icon_path = self._get_icon_path('avatars/funky.png')
 
-        notification = self._create_ephemeral_notification(
+        notification = shell.create_ephemeral_notification(
             summary,
             body,
             icon_path
@@ -594,7 +596,7 @@
         icon_path = self._get_icon_path('avatars/anna_olsson.png')
         hint_icon = self._get_icon_path('applicationIcons/phone-app.png')
 
-        notification = self._create_ephemeral_notification(
+        notification = shell.create_ephemeral_notification(
             summary,
             body,
             icon_path
@@ -638,7 +640,7 @@
         body = 'Hey Bro Coly!'
         icon_path = self._get_icon_path('avatars/amanda.png')
         body_sum = body
-        notification = self._create_ephemeral_notification(
+        notification = shell.create_ephemeral_notification(
             summary,
             body,
             icon_path,
@@ -674,7 +676,7 @@
         for new_body in bodies:
             body = new_body
             body_sum += '\n' + body
-            notification = self._create_ephemeral_notification(
+            notification = shell.create_ephemeral_notification(
                 summary,
                 body,
                 icon_path,
@@ -695,48 +697,3 @@
                 False,
                 1.0
             )
-
-    def _create_ephemeral_notification(
-        self,
-        summary="",
-        body="",
-        icon=None,
-        hints=[],
-        urgency="NORMAL"
-    ):
-        """Create an ephemeral (non-interactive) notification
-
-            :param summary: Summary text for the notification
-            :param body: Body text to display in the notification
-            :param icon: Path string to the icon to use
-            :param hint_strings: List of tuples containing the 'name' and value
-                for setting the hint strings for the notification
-            :param urgency: Urgency string for the noticiation, either: 'LOW',
-                'NORMAL', 'CRITICAL'
-
-        """
-        logger.info(
-            "Creating ephemeral: summary(%s), body(%s), urgency(%r) "
-            "and Icon(%s)",
-            summary,
-            body,
-            urgency,
-            icon
-        )
-
-        n = Notify.Notification.new(summary, body, icon)
-
-        for hint in hints:
-            key, value = hint
-            n.set_hint_string(key, value)
-            logger.info("Adding hint to notification: (%s, %s)", key, value)
-        n.set_urgency(self._get_urgency(urgency))
-
-        return n
-
-    def _get_urgency(self, urgency):
-        """Translates urgency string to enum."""
-        _urgency_enums = {'LOW': Notify.Urgency.LOW,
-                          'NORMAL': Notify.Urgency.NORMAL,
-                          'CRITICAL': Notify.Urgency.CRITICAL}
-        return _urgency_enums.get(urgency.upper())