Merge lp:~sinzui/bzr-gtk/notify-gtk-import into lp:bzr-gtk

[Curtis Hovey]

Update bzr-notify to Gtk3 and AppIndicator3.

    Launchpad bug: https://bugs.launchpad.net/bugs/903444
    Pre-implementation: no one

I see a stacktrace that indicates that bzr-notify is importing gtk2 libs.
    $ bzr-notify
    Traceback (most recent call last):
      File "/usr/bin/bzr-notify", line 20, in <module>
        import gobject
      File "/usr/lib/python2.7/dist-packages/gobject/__init__.py", line 47...
        from gobject.constants import *
      File "/usr/lib/python2.7/dist-packages/gobject/constants.py", line 23...

--------------------------------------------------------------------

RULES

    * Update the imports to use gir.
    * Addendum
      * pynotify and appindicator needs updating to gir.
        The precise bzr-gtk package appears to recommend
        gir1.2-appindicator3-0.1 | gir1.2-notify-0.7
        but I do not think they were actually used.

QA

    Using Unity/appindicator3-0
    * Switch your .bazaar/plugins/gtk to point to this branch.
    * Run bzr-notify from the tree
    * Commit a change to a test branch
    * Verify the notification appears
    * Verify the indicator icon appears in the panel
    * Quickly open the bzr-gtk preferences from the indicator menu.
    * When the indicator disappears, close the preferences window
    * Verify there is not an error in the about a bad path:
      p = bzrlib.plugin.plugins()[self.model[path][0]].module

    I tested Notify and instrumenting an import failure of AppIndicator3.
    The notification appeared, but my I did not see the notification icon
    appear. There were no errors in the terminal. I added bzr-notify to
    the dconf notification area exceptions, but that still did not let
    the icon appear.

IMPLEMENTATION

Fixed a race condition where a cursor change event is fired while the
widget is being destroyed. I discovered this while watching the console
when I closed the preferences window.
  preferences/plugins.py

Updated the modules to import from GObject, Notify, and AppIndicator3.
The test for bzr-notify is crude. It will report of the process fails to
start because of import or system errors, but cannot test the actual
function. We need to move the two menu implementations and the message
implementation to another module to test them.
  bzr-notify
  notify.py
  tests/__init__.py
  tests/test_notify.py

[lp:~sinzui/bzr-gtk/notify-gtk-import]

776. By Curtis Hovey on 2012-02-03

Use the one-true way to setup the plugin path for the test.

[Jelmer Vernooij (jelmer)]

Nice, and great to have some smoke tests.

review: Approve

=== modified file 'bzr-notify'
--- bzr-notify	2011-07-31 16:50:29 +0000
+++ bzr-notify	2012-02-03 23:06:20 +0000
@@ -15,31 +15,36 @@
 Gtk = open_display()
 
 import cgi
+import sys
+
 import dbus
 import dbus.service
-import gobject
-import pynotify
+from gi.repository import GObject
+from gi.repository import Notify
+
 from bzrlib.bzrdir import BzrDir
 from bzrlib.osutils import format_date
 from bzrlib.transport import get_transport
 
 menu = NotifyPopupMenu()
 try:
-    import appindicator
+    from gi.repository import AppIndicator3
 except ImportError:
-    icon = gtk.status_icon_new_from_icon_name("bzr-panel")
+    icon = Gtk.StatusIcon.new_from_icon_name("bzr-panel")
     icon.connect('popup-menu', menu.display)
     icon.set_visible(False)
     hide_icon = lambda: icon.set_visible(False)
     show_icon = lambda: icon.set_visible(True)
 else:
-    indicator = appindicator.Indicator ("bzr-gtk-notify",
-        "bzr-panel", appindicator.CATEGORY_OTHER)
-    indicator.set_status (appindicator.STATUS_PASSIVE)
+    indicator = AppIndicator3.Indicator.new(
+        "bzr-gtk-notify", "bzr-panel", AppIndicator3.IndicatorCategory.OTHER)
+    indicator.set_status (AppIndicator3.IndicatorStatus.PASSIVE)
     indicator.set_attention_icon("bzr-panel")
     indicator.set_menu(menu)
-    hide_icon = lambda: indicator.set_status (appindicator.STATUS_PASSIVE)
-    show_icon = lambda: indicator.set_status (appindicator.STATUS_ATTENTION)
+    hide_icon = lambda: indicator.set_status (
+        AppIndicator3.IndicatorStatus.PASSIVE)
+    show_icon = lambda: indicator.set_status (
+        AppIndicator3.IndicatorStatus.ATTENTION)
 
 if getattr(dbus, 'version', (0,0,0)) >= (0,41,0):
     import dbus.glib
@@ -64,7 +69,7 @@
         body += '\n'
         body += revision.message
         body = cgi.escape(body)
-        nw = pynotify.Notification(summary, body)
+        nw = Notify.Notification.new(summary, body, None)
         def start_viz(notification=None, action=None, data=None):
             """Start the viz program."""
             from bzrlib.plugins.gtk.commands import start_viz_window
@@ -75,11 +80,11 @@
             from bzrlib.plugins.gtk.branch import BranchDialog
             bd = BranchDialog(remote_path=url)
             bd.run()
-        if "actions" in pynotify.get_server_caps():
+        if "actions" in Notify.get_server_caps():
             nw.add_action("inspect", "Inspect", start_viz, None)
             nw.add_action("branch", "Branch", start_branch, None)
         show_icon()
-        gobject.timeout_add(5000, hide_icon)
+        GObject.timeout_add(5000, hide_icon)
         nw.set_timeout(5000)
         nw.show()
     except Exception, e:
@@ -88,5 +93,10 @@
 bus.add_signal_receiver(catch_branch,
                         dbus_interface=BROADCAST_INTERFACE,
                         signal_name="Revision")
-pynotify.init("bzr-notify")
-gtk.main()
+Notify.init("bzr-notify")
+
+if sys.argv[-1] == 'test':
+    # Exit before main loop.
+    sys.exit(0)
+
+Gtk.main()

=== modified file 'notify.py'
--- notify.py	2011-09-03 01:25:04 +0000
+++ notify.py	2012-02-03 23:06:20 +0000
@@ -30,6 +30,8 @@
 
 class NotifyPopupMenu(Gtk.Menu):
 
+    SHOW_WIDGETS = True
+
     def __init__(self):
         super(NotifyPopupMenu, self).__init__()
         self.create_items()
@@ -46,7 +48,7 @@
         except ImportError:
             item.set_sensitive(False)
         except errors.BzrError:
-            # FIXME: Should only catch errors that indicate a lan-notify 
+            # FIXME: Should only catch errors that indicate a lan-notify
             # process is already running.
             item.set_sensitive(False)
 
@@ -62,20 +64,21 @@
         except ImportError:
             item.set_sensitive(False)
 
-        item = Gtk.ImageMenuItem(Gtk.STOCK_PREFERENCES, None)
+        item = Gtk.ImageMenuItem.new_from_stock(Gtk.STOCK_PREFERENCES, None)
         item.connect('activate', self.show_preferences)
         self.append(item)
-        item = Gtk.ImageMenuItem(Gtk.STOCK_ABOUT, None)
+        item = Gtk.ImageMenuItem.new_from_stock(Gtk.STOCK_ABOUT, None)
         item.connect('activate', self.show_about)
         self.append(item)
         self.append(Gtk.SeparatorMenuItem())
-        item = Gtk.ImageMenuItem(Gtk.STOCK_QUIT, None)
+        item = Gtk.ImageMenuItem.new_from_stock(Gtk.STOCK_QUIT, None)
         item.connect('activate', Gtk.main_quit)
         self.append(item)
-        self.show_all()
+        if self.SHOW_WIDGETS:
+            self.show_all()
 
     def display(self, icon, event_button, event_time):
-        self.popup(None, None, Gtk.status_icon_position_menu, 
+        self.popup(None, None, Gtk.status_icon_position_menu,
                event_button, event_time, icon)
 
     def toggle_lan_gateway(self, item):
@@ -99,4 +102,3 @@
         from bzrlib.plugins.gtk.preferences import PreferencesWindow
         prefs = PreferencesWindow()
         prefs.run()
-

=== modified file 'preferences/plugins.py'
--- preferences/plugins.py	2011-09-05 03:44:26 +0000
+++ preferences/plugins.py	2012-02-03 23:06:20 +0000
@@ -72,6 +72,9 @@
     def row_selected(self, tv, path=None, tvc=None):
         if path is None:
             (path, focus) = tv.get_cursor()
+        if path is None:
+            # The event was fired as the widget was destroyed.
+            return
         import bzrlib
         p = bzrlib.plugin.plugins()[self.model[path][0]].module
         from inspect import getdoc

=== modified file 'tests/__init__.py'
--- tests/__init__.py	2012-01-23 16:52:40 +0000
+++ tests/__init__.py	2012-02-03 23:06:20 +0000
@@ -24,6 +24,7 @@
         'test_history',
         'test_graphcell',
         'test_linegraph',
+        'test_notify',
         'test_revisionview',
         'test_treemodel',
         ]

=== added file 'tests/test_notify.py'
--- tests/test_notify.py	1970-01-01 00:00:00 +0000
+++ tests/test_notify.py	2012-02-03 23:06:20 +0000
@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2012 Curtis C. Hovey <[e-mail]>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+import os
+import subprocess
+
+from bzrlib import tests
+from bzrlib.plugins.gtk.notify import NotifyPopupMenu
+
+
+class FakeNotifyPopupMenu(NotifyPopupMenu):
+
+    SHOW_WIDGETS = False
+
+
+class NotifyPopupMenuTestCase(tests.TestCase):
+
+    def test_init(self):
+        menu = FakeNotifyPopupMenu()
+        items = menu.get_children()
+        self.assertEqual(8, len(items))
+        self.assertEqual('_Gateway to LAN', items[0].props.label)
+        self.assertEqual('Announce _branches on LAN', items[2].props.label)
+        self.assertEqual('gtk-preferences', items[4].props.label)
+        self.assertEqual('gtk-about', items[5].props.label)
+        self.assertEqual('gtk-quit', items[7].props.label)
+
+
+class BzrNotifyTestCase(tests.TestCase):
+
+    def setUp(self):
+        top = os.path.abspath(os.path.join(
+            os.path.dirname(__file__), os.pardir))
+        self.script = os.path.join(top, 'bzr-notify')
+        self.env = dict(os.environ)
+        self.env['BZR_PLUGINS_AT'] = 'gtk@%s' % top
+        super(BzrNotifyTestCase, self).setUp()
+
+    def test_smoketest(self):
+        # This is a smoke test to verify the process starts.
+        # The logic of the module must be moved into notify.py
+        # where it can be properly tested.
+        bzr_notify = subprocess.Popen(
+            [self.script, 'test'],
+            stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=self.env)
+        stdout, stderr = bzr_notify.communicate()
+        self.assertEqual('', stdout)
+        self.assertEqual('', stderr)