Merge lp:~eeejay/mago/dx into lp:~mago-contributors/mago/mago-1.0

[Eitan Isaacson]

[Javier Collado (javier.collado)]

Hello Eitan,

I took a quick look at your code and run the tests to check if everything worked in my machine. Unfortunately, I had a few of problems:

- setup.py: File has to be updated to include notify-osd and indicator-applet tests.

- notify-osd: Most of the test cases failed because of screenshot differ failure. Looking at the image in the data directory and at the screenshot it seems that notify-osd draws things slightly different depending on the screen resolution, so the comparison isn't successful unless using the same screen resolution as in the original test.

- share-directory: The share directory in my installation starts with /usr/local/share and the expected shared directory starts with /usr/share so I had to change the hardcoded value to /usr/local/share to make it possible to run the tests. Anyway, I guess that the buildout changes once integrated will solve this issue.

Best regards,
    Javier

[Eitan Isaacson (eeejay)]

On Mon, May 4, 2009 at 5:11 PM, Javier Collado
<email address hidden> wrote:
> Hello Eitan,
>
> I took a quick look at your code and run the tests to check if everything worked in my machine. Unfortunately, I had a few of problems:
>
> - setup.py: File has to be updated to include notify-osd and indicator-applet tests.
>

Oops, I ignored the setup.py, I will update the branch with the new inclusions.

> - notify-osd: Most of the test cases failed because of screenshot differ failure. Looking at the image in the data directory and at the screenshot it seems that notify-osd draws things slightly different depending on the screen resolution, so the comparison isn't successful unless using the same screen resolution as in the original test.
>

This is a known problem. The pixmap produced depends on the
background, DPI, font and compositor used. It could be easily
collaborated by erasing the png files in the 'data' directory, and
running the suite. the suite will fail, but the next time you run it,
it will compare against new screenshots.

> - share-directory: The share directory in my installation starts with /usr/local/share and the expected shared directory starts with /usr/share so I had to change the hardcoded value to /usr/local/share to make pick it possible to run the tests. Anyway, I guess that the buildout changes once integrated will solve this issue.

That is just to pick up a random icon, it is not very important. I
chose an icon file that is likely to be in a default ubuntu-desktop
system. Anyway, yes, this should be tweaked once the buildout changes
are in trunk.

>
> Best regards,
>    Javier
> --
> https://code.launchpad.net/~eeejay/ubuntu-desktop-testing/dx/+merge/6157
> You are subscribed to branch lp:~eeejay/ubuntu-desktop-testing/dx.
>

[lp:~eeejay/mago/dx]

71. By Eitan Isaacson on 2009-05-04

added dx suites to setup.py

=== added file 'desktoptesting/deskex.py'
--- desktoptesting/deskex.py	1970-01-01 00:00:00 +0000
+++ desktoptesting/deskex.py	2009-05-04 11:21:59 +0000
@@ -0,0 +1,200 @@
+from desktoptesting.gnome import Application
+from time import time, sleep
+import tempfile
+import pynotify
+import ldtp, ldtputils
+import os
+import gtk, glib
+
+try:
+    import indicate
+except ImportError:
+    indicate = None
+
+class IndicatorApplet(Application):
+    IA_TOPLEVEL = "embindicator-applet"
+    def __init__(self):
+        Application.__init__(self, 'indicator-applet')
+        self.indicators = []
+        self.server = None
+
+    def open(self):
+        pass
+    
+    def add_server(self, desktop_file):
+        if not self.server:
+            try:
+                self.server = indicate.indicate_server_ref_default()
+            except AttributeError:
+                raise Exception, \
+                    "no libindicate Python bindings, install python-indicate."
+        self.server.set_type("message.im")
+        self.server.set_desktop_file(desktop_file)
+        self.server.show()
+        while gtk.events_pending():
+            gtk.main_iteration()
+
+    def show_indicator(self, sender):
+        def _timeout_cb():
+            gtk.main_quit()
+            return False
+
+        indicator = indicate.IndicatorMessage()
+        indicator.set_property("subtype", "im")
+        indicator.set_property("sender", sender)
+        indicator.set_property_time("time", time())
+        pixbuf = gtk.gdk.pixbuf_new_from_file(
+            "/usr/share/icons/hicolor/22x22/apps/gnome-freecell.png")
+        indicator.set_property_icon("icon", pixbuf)
+        indicator.show()
+        self.indicators.append(indicator)
+        glib.timeout_add_seconds(1, _timeout_cb)
+        gtk.main()
+
+    def capture_applet_icon(self):
+        x, y, w, h = ldtp.getobjectsize(self.TOP_PANEL, self.IA_TOPLEVEL)
+        screeny = ldtputils.imagecapture(
+            outFile=tempfile.mktemp('.png', 'ia_'),
+            x=x, y=y, resolution1=w, resolution2=h)        
+        return screeny
+
+    def select_indicator(self, sender):
+        ldtp.selectmenuitem(self.TOP_PANEL, 'mnu' + sender.replace(' ',''))
+
+    def wait_for_indicator_display(self, sender, timeout=5):
+        handlers = []
+        displayed = [False]
+
+        def _display_cb(indicator):
+            indicator.hide() # This is just normal behavior, so why not?
+            displayed[0] = True
+            gtk.main_quit()
+            
+        def _timeout_cb():
+            gtk.main_quit()
+            return False
+
+        for indicator in self.indicators:
+            if sender == indicator.get_property("sender"):
+                handler = indicator.connect("user-display", _display_cb)
+                handlers.append((handler, indicator))
+
+        glib.timeout_add_seconds(timeout, _timeout_cb)
+
+        gtk.main()
+
+        for handler, indicator in handlers:
+            indicator.disconnect(handler)
+
+        return displayed[0]
+
+    def wait_for_server_display(self, timeout=5):
+        displayed = [False]
+        handler = 0
+
+        def _display_cb(indicator):
+            indicator.hide() # This is just normal behavior, so why not?
+            displayed[0] = True
+            gtk.main_quit()
+            
+        def _timeout_cb():
+            gtk.main_quit()
+            return False
+
+        handler = self.server.connect("server-display", _display_cb)
+
+        glib.timeout_add_seconds(timeout, _timeout_cb)
+
+        gtk.main()
+
+        self.server.disconnect(handler)
+
+        return displayed[0]
+
+    def cleanup(self):
+        for indicator in self.indicators:
+            indicator.hide()
+        # BUG: 351537
+        # self.server.hide()
+        sleep(1)
+
+    def close(self):
+        self.cleanup()
+
+    def setup(self):
+        self.open()
+
+    def teardown(self):
+        self.close()
+
+class NotifyOSD(Application):
+    def __init__(self):
+        self.focus_desktop = False
+        self.screenshots = []
+
+        if not pynotify.init('notify-osd-test'):
+            raise ldtp.LdtpExecutionError, \
+                "Failed to initialize notification connection."
+
+        info = pynotify.get_server_info()
+        if info.get('name', None) != 'notify-osd':
+            raise ldtp.LdtpExecutionError, \
+                "The notify service is '%s', expected 'notify-dameon'" % \
+                info.get('name', None)
+
+    def open(self, focus_desktop=True):
+        self.focus_desktop = focus_desktop
+
+        if self.focus_desktop:
+            ldtp.generatekeyevent('<alt><ctrl>d')
+
+    def exit(self):
+        if self.focus_desktop:
+            ldtp.generatekeyevent('<alt><ctrl>d')
+        for screenshot in self.screenshots:
+            os.remove(screenshot)
+
+    def notify(self, summary, body="", icon=None):
+	n = pynotify.Notification (summary, body, icon)
+	n.show ()
+
+    def notify_synchronous(self, summary, body="", icon=None, value=-1):
+	n = pynotify.Notification (summary, body, icon)
+        n.set_hint("synchronous", "volume")
+        n.set_hint("value", value)
+	n.show ()
+
+    def grab_image_and_wait(self, summary):
+        ldtp.waittillguiexist(summary)
+        start_time = time()
+        x, y, w, h = ldtp.getwindowsize(summary)
+        screenshot = \
+            ldtputils.imagecapture(outFile=tempfile.mktemp('.png', 'nosd_'),
+                                   x=x+3, y=y+3, 
+                                   resolution1=w-6, 
+                                   resolution2=h-6)
+        ldtp.waittillguinotexist(summary)
+        end_time = time() - start_time
+        self.screenshots.append(screenshot)
+        return (end_time, screenshot)
+
+    def get_extents(self, summary, wait=False):
+        if wait:
+            exists = ldtp.waittillguiexist(summary)            
+        else:
+            exists = ldtp.guiexist(summary)            
+            
+        if exists:
+            return ldtp.getwindowsize(summary)
+        else:
+            return -1, -1, -1, -1
+            
+if __name__ == "__main__":
+    from time import sleep
+    test = IndicatorApplet()
+    test.open()
+    test.add_server('/usr/share/applications/transmission.desktop')
+    test.show_indicator('Elmer Fud')
+    print 'sleeping'
+    sleep(20)
+    #print test.wait_for_indicator_display('Elmer Fud', 20)
 
=== added directory 'indicator-applet'
=== added directory 'indicator-applet/data'
=== added file 'indicator-applet/data/indicator_test.desktop'
--- indicator-applet/data/indicator_test.desktop	1970-01-01 00:00:00 +0000
+++ indicator-applet/data/indicator_test.desktop	2009-03-26 14:55:36 +0000
@@ -0,0 +1,10 @@
+[Desktop Entry]
+Encoding=UTF-8
+Name=Phony Internet Messenger
+GenericName=Internet Messenger
+Comment=Send instant messages over phony protocols
+Exec=phony
+StartupNotify=true
+Terminal=false
+Type=Application
+Categories=Network;InstantMessaging;
 
=== added file 'indicator-applet/indicator_applet.py'
--- indicator-applet/indicator_applet.py	1970-01-01 00:00:00 +0000
+++ indicator-applet/indicator_applet.py	2009-04-01 09:14:02 +0000
@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+
+import ldtp
+import ldtputils
+import os
+
+from time import time, gmtime, strftime, sleep
+from desktoptesting.check import ScreenshotCompare, FAIL
+from desktoptesting.deskex import IndicatorApplet
+
+class IndicatorAppletTest(IndicatorApplet):
+    def serverTest(self, desktop_file=None):
+        self.add_server(os.path.abspath(desktop_file))
+        if not ldtp.objectexist(self.TOP_PANEL, 'mnuPhonyInternetMessenger'):
+            raise AssertionError("server does not appear in applet.")
+
+    def messageTest(self, desktop_file=None, sender=None):
+        self.add_server(os.path.abspath(desktop_file))
+        self.show_indicator(sender)
+        sleep(1)
+        if not ldtp.objectexist(self.TOP_PANEL, 'mnu' + sender.replace(' ','')):
+            raise AssertionError('indicator did not appear in applet.')
+
+    def iconChangeTest(self, desktop_file=None, sender=None):
+        self.add_server(os.path.abspath(desktop_file))
+        no_message = self.capture_applet_icon()
+        self.show_indicator(sender)
+        with_message = self.capture_applet_icon()
+
+        checker = ScreenshotCompare(no_message, with_message)
+        
+        if checker.perform_test() != FAIL:
+            raise AssertionError('icon did not change.')
+
+    def displayIndicatorTest(self, desktop_file=None, sender=None):
+        self.add_server(os.path.abspath(desktop_file))
+        self.show_indicator(sender)
+        sleep(1)
+        self.select_indicator(sender)
+        if not self.wait_for_indicator_display(sender):
+            raise AssertionError('Indicator did not get a callback')
+
+    def displayServerTest(self, desktop_file=None):
+        self.add_server(os.path.abspath(desktop_file))
+        sleep(1)
+        ldtp.selectmenuitem(self.TOP_PANEL, 'mnuPhonyInternetMessenger')
+        if not self.wait_for_server_display():
+            raise AssertionError('Server did not get a callback')
+        
 
=== added file 'indicator-applet/indicator_applet.xml'
--- indicator-applet/indicator_applet.xml	1970-01-01 00:00:00 +0000
+++ indicator-applet/indicator_applet.xml	2009-03-31 10:46:34 +0000
@@ -0,0 +1,70 @@
+<?xml version="1.0"?>
+<suite name="indicator-applet">
+  <class>indicator_applet.IndicatorAppletTest</class>
+  <description>indicator-applet tests</description>
+  <case name="Server">
+    <method>serverTest</method>
+    <description>
+      Add a server to the indicator applet.
+    </description>
+    <args>
+      <desktop_file>
+        ./indicator-applet/data/indicator_test.desktop
+      </desktop_file>
+    </args>
+  </case>
+  <case name="MessageIndicator">
+    <method>messageTest</method>
+    <description>
+      Add a message indicator to the indicator applet.
+    </description>
+    <args>
+      <desktop_file>
+        ./indicator-applet/data/indicator_test.desktop
+      </desktop_file>
+      <sender>
+        Elmer Fud
+      </sender>
+    </args>
+  </case>
+  <case name="IconChange">
+    <method>iconChangeTest</method>
+    <description>
+      Test to see if the applet's icon changes when a new message arrives.
+    </description>
+    <args>
+      <desktop_file>
+        ./indicator-applet/data/indicator_test.desktop
+      </desktop_file>
+      <sender>
+        Elmer Fud
+      </sender>
+    </args>
+  </case>
+  <case name="DisplayIndicator">
+    <method>displayIndicatorTest</method>
+    <description>
+      Test to see if the display callback is called when message
+      indicator is selected.
+    </description>
+    <args>
+      <desktop_file>
+        ./indicator-applet/data/indicator_test.desktop
+      </desktop_file>
+      <sender>
+        Elmer Fud
+      </sender>
+    </args>
+  </case>
+  <case name="DisplayServer">
+    <method>displayServerTest</method>
+    <description>
+      Test to see if the display callback is called when a server is selected.
+    </description>
+    <args>
+      <desktop_file>
+        ./indicator-applet/data/indicator_test.desktop
+      </desktop_file>
+    </args>
+  </case>
+</suite>
 
=== added directory 'notify-osd'
=== added directory 'notify-osd/data'
=== added file 'notify-osd/data/bubble_queue.xml'
--- notify-osd/data/bubble_queue.xml	1970-01-01 00:00:00 +0000
+++ notify-osd/data/bubble_queue.xml	2009-03-04 11:00:22 +0000
@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<data>
+  <bubble>icons_summary_body_data.xml</bubble>
+  <bubble>icons_summary_data.xml</bubble>
+  <bubble>summary_body_data.xml</bubble>
+  <bubble>summary_data.xml</bubble>
+</data>
 
=== added file 'notify-osd/data/icons_summary.png'
 Binary files notify-osd/data/icons_summary.png	1970-01-01 00:00:00 +0000 and notify-osd/data/icons_summary.png	2009-05-04 09:33:24 +0000 differ
=== added file 'notify-osd/data/icons_summary_body.png'
 Binary files notify-osd/data/icons_summary_body.png	1970-01-01 00:00:00 +0000 and notify-osd/data/icons_summary_body.png	2009-05-04 09:33:24 +0000 differ
=== added file 'notify-osd/data/icons_summary_body_data.xml'
--- notify-osd/data/icons_summary_body_data.xml	1970-01-01 00:00:00 +0000
+++ notify-osd/data/icons_summary_body_data.xml	2009-02-28 14:03:43 +0000
@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<data>
+    <oracle>./notify-osd/data/icons_summary_body.png</oracle>
+    <summary>Nat King Cole</summary>
+    <body>Hey pal, what's up with the party next weekend? Will you join me and Anna?</body>
+    <icon>notification-message-IM</icon>
+</data>
 
=== added file 'notify-osd/data/icons_summary_data.xml'
--- notify-osd/data/icons_summary_data.xml	1970-01-01 00:00:00 +0000
+++ notify-osd/data/icons_summary_data.xml	2009-02-28 14:03:43 +0000
@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<data>
+    <oracle>./notify-osd/data/icons_summary.png</oracle>
+    <summary>WiFi connection lost</summary>
+    <body></body>
+    <icon>notification-network-wireless-disconnected</icon>
+</data>
 
=== added file 'notify-osd/data/summary.png'
 Binary files notify-osd/data/summary.png	1970-01-01 00:00:00 +0000 and notify-osd/data/summary.png	2009-05-04 09:33:24 +0000 differ
=== added file 'notify-osd/data/summary_body.png'
 Binary files notify-osd/data/summary_body.png	1970-01-01 00:00:00 +0000 and notify-osd/data/summary_body.png	2009-05-04 09:33:24 +0000 differ
=== added file 'notify-osd/data/summary_body_data.xml'
--- notify-osd/data/summary_body_data.xml	1970-01-01 00:00:00 +0000
+++ notify-osd/data/summary_body_data.xml	2009-02-28 14:03:43 +0000
@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<data>
+    <oracle>./notify-osd/data/summary_body.png</oracle>
+    <summary>Totem</summary>
+    <body>This is a superfluous notification</body>
+    <icon></icon>
+</data>
 
=== added file 'notify-osd/data/summary_data.xml'
--- notify-osd/data/summary_data.xml	1970-01-01 00:00:00 +0000
+++ notify-osd/data/summary_data.xml	2009-02-28 14:03:43 +0000
@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<data>
+    <oracle>./notify-osd/data/summary.png</oracle>
+    <summary>Summary-only</summary>
+    <body></body>
+    <icon></icon>
+</data>
 
=== added file 'notify-osd/data/synchronous_data.xml'
--- notify-osd/data/synchronous_data.xml	1970-01-01 00:00:00 +0000
+++ notify-osd/data/synchronous_data.xml	2009-03-04 13:24:54 +0000
@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<data>
+    <summary1>Nat King Cole</summary1>
+    <body1>Hey pal, what's up with the party next weekend? Will you join me and Anna?</body1>
+    <icon1>notification-message-IM</icon1>
+
+    <summary2>Volume</summary2>
+    <body2></body2>
+    <icon2>notification-audio-volume-medium</icon2>
+    <value2>75</value2>
+</data>
 
=== added file 'notify-osd/notify_osd.py'
--- notify-osd/notify_osd.py	1970-01-01 00:00:00 +0000
+++ notify-osd/notify_osd.py	2009-03-22 23:36:18 +0000
@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+
+import ldtp
+import ldtputils
+
+from time import time, gmtime, strftime, sleep
+
+from desktoptesting.deskex import NotifyOSD
+from desktoptesting.check import ScreenshotCompare, FAIL
+
+class NotifyOSDTest(NotifyOSD):
+    def layoutTest(self, oracle=None, summary=None, body=None, icon=None):
+        self.notify(summary, body, icon)
+        elapsed, screeny = self.grab_image_and_wait(summary)
+
+        checker = ScreenshotCompare(oracle, screeny)
+
+        try:
+            passed = checker.perform_test()
+        except Exception, e:
+            checker.calibrate()
+            raise e
+
+        if passed == FAIL:
+            raise AssertionError('screenshots differ', screeny)
+
+    def queueTest(self, oracle=None, summary=None, body=None, icon=None):
+        oracles = oracle.split('|')
+        summaries = summary.split('|')
+        bodies = body.split('|')
+        icons = icon.split('|')
+
+        bubbles = []
+
+        for oracle, summary, body, icons in \
+                zip(oracles, summaries, bodies, icons):
+            bubbles.append(_Bubble(oracle, summary, body, icons))
+
+        for b in bubbles:
+            self.notify(b.summary, b.body, b.icon)
+
+        for b in bubbles:
+            b.elapsed, b.screeny = self.grab_image_and_wait(b.summary)
+            
+        for b in bubbles:
+            testcheck = ScreenshotCompare(b.oracle, b.screeny)
+
+            try:
+                check = testcheck.perform_test()
+            except Exception, e:
+                testcheck.calibrate()
+                raise e
+
+            if check == FAIL:
+                raise AssertionError("screenshots differ", b.screeny)
+
+    def synchronousTest(self, summary1=None, body1=None, icon1=None,
+                        summary2=None, body2=None, icon2=None, value2=None):
+        ALLOWED_OVERLAP = 14
+
+        self.notify(summary1, body1, icon1)
+        sleep(1)
+        self.notify_synchronous(summary2, body2, icon2, int(value2))
+
+        x2, y2, w2, h2 = self.get_extents(summary2, True)
+        x1, y1, w1, h1 = self.get_extents(summary1)
+
+        if w1 == -1:
+            # First bubble does not exist anymore, this could mean 
+            # that the second bubble did not appear synchronously.
+            raise AssertionError("not synchronous")
+        elif (y1 + h1) - y2 > ALLOWED_OVERLAP:
+            raise AssertionError("bad overlap")
+
+class _Bubble:
+    def __init__(self, oracle, summary, body, icon):
+        self.oracle = oracle
+        self.summary = summary
+        self.body = body
+        self.icon = icon
+        self.elapsed = None
+        self.screeny = None
 
=== added file 'notify-osd/notify_osd.xml'
--- notify-osd/notify_osd.xml	1970-01-01 00:00:00 +0000
+++ notify-osd/notify_osd.xml	2009-03-22 23:36:18 +0000
@@ -0,0 +1,80 @@
+<?xml version="1.0"?>
+<suite name="notify-osd">
+  <class>notify_osd.NotifyOSDTest</class>
+  <description>notify-osd tests</description>
+  <case name="IconSummaryBody">
+    <method>layoutTest</method>
+    <description>
+      Test the layout of a bubble with an icon, summary and body
+    </description>
+    <args>
+      <oracle>./notify-osd/data/icons_summary_body.png</oracle>
+      <summary>Nat King Cole</summary>
+      <body>Hey pal, what's up with the party next weekend? Will you join me and Anna?</body>
+      <icon>notification-message-IM</icon>
+    </args>
+  </case>
+  <case name="IconSummary">
+    <method>layoutTest</method>
+    <description>
+      Test the layout of a bubble with an icon and summary.
+    </description>
+    <args>
+      <oracle>./notify-osd/data/icons_summary.png</oracle>
+      <summary>WiFi connection lost</summary>
+      <body></body>
+      <icon>notification-network-wireless-disconnected</icon>
+    </args>
+  </case>
+  <case name="SummaryBody">
+    <method>layoutTest</method>
+    <description>
+      Test the layout of a bubble with a summary only.
+    </description>
+    <args>
+      <oracle>./notify-osd/data/summary_body.png</oracle>
+      <summary>Totem</summary>
+      <body>This is a superfluous notification</body>
+      <icon></icon>
+    </args>
+  </case>
+  <case name="Summary">
+    <method>layoutTest</method>
+    <description>
+      Test the layout of a bubble with a summary only.
+    </description>
+    <args>
+      <oracle>./notify-osd/data/summary.png</oracle>
+      <summary>Summary-only</summary>
+      <body></body>
+      <icon></icon>
+    </args>
+  </case>
+  <case name="Queue">
+    <method>queueTest</method>
+    <description>
+      Test the bubble queue.
+    </description>
+    <args>
+      <oracle>./notify-osd/data/icons_summary_body.png|./notify-osd/data/icons_summary.png|./notify-osd/data/summary.png</oracle>
+      <summary>Nat King Cole|WiFi connection lost|Summary-only</summary>
+      <body>Hey pal, what's up with the party next weekend? Will you join me and Anna?||</body>
+      <icon>notification-message-IM|notification-network-wireless-disconnected|</icon>
+    </args>
+  </case>
+  <case name="Synchronous">
+    <method>synchronousTest</method>
+    <description>
+      Test synchronous bubbles.
+    </description>
+    <args>
+    <summary1>Nat King Cole</summary1>
+    <body1>Hey pal, what's up with the party next weekend? Will you join me and Anna?</body1>
+    <icon1>notification-message-IM</icon1>
+    <summary2>Volume</summary2>
+    <body2></body2>
+    <icon2>notification-audio-volume-medium</icon2>
+    <value2>75</value2>
+    </args>
+  </case>
+</suite>