Merge lp:~barry/ubiquity/bug-792652 into lp:ubiquity

[Barry Warsaw]

Solves LP: #792652, the "multiple clicks on Try Ubuntu crashes the installer"
problem. I'm not sure that's everything that bug 792652 is describing but
it's certainly one specific case.

[lp:~barry/ubiquity/bug-792652]

5267. By Barry Warsaw on 2012-03-19

Update master bug number

[Evan (ev)]

Looks good to me. I thought we might want to generalize this in plugin.only_this_page, but we do not appear to be calling into ok_handler from outside the normal flow anywhere else in the code.

review: Approve

[Evan (ev)]

From IRC:
[2:45pm] barry: cjwatson: branch update pushed; i'm not going to push to a different branch name
[2:48pm] cjwatson: barry: this is going to come across as a bit "oh, and another thing" - but I think it should be possible to unit-test this, and it'd be a good exercise
[2:49pm] cjwatson: you would do that by instantiating the UI widget in a test, firing the try-ubuntu-clicked event twice, and only then processing events
[2:49pm] barry: cjwatson: sure, it would be a good exercise for me to figure out how to do that. so, let me look into that.
[2:49pm] cjwatson: the wiki has details on running the test suite
[2:49pm] barry: cool. first, more tea, then i'll look at that
[2:49pm] cjwatson: in this case I guess the test case ought to go in tests/test_language.pyp
[2:49pm] cjwatson: -p
[2:50pm] cjwatson: (and I think it'd be good for other folks to see how that's done, too, UI tests being their own special black art)
[2:50pm] cjwatson: I don't especially care about separate tests for the KDE frontend - there's no framework for that as yet - but at least the GTK frontend
[2:50pm] barry: right. i've never done that before, so it's good to learn it.
[2:50pm] barry: brb
[2:51pm] cjwatson: there's a "gtkwidgets.refresh()" helper that processes any events that are pending
[2:51pm] cjwatson: you'll see it used in other tests
[2:51pm] cjwatson: the trick here may be in arranging for the backend filter to be in place

[Barry Warsaw (barry)]

Test added, ready for review. One caveat, from the commit message:

"One possibly questionable change is the coding: line, which is required to not
freak out Emacs."

[lp:~barry/ubiquity/bug-792652]

5268. By Barry Warsaw on 2012-03-19

Add a test for bug 911907 by ensuring that the backend dbfilter.ok_handler is
only called once on multiple clicks of the Try Ubuntu link.

One possibly questionable change is the coding: line, which is required to not
freak out Emacs.

[Colin Watson (cjwatson)]

Looks good, thanks!

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2012-03-19 16:54:03 +0000
+++ debian/changelog	2012-03-19 17:02:20 +0000
@@ -1,3 +1,4 @@
+<<<<<<< TREE
 ubiquity (2.9.30) UNRELEASED; urgency=low
 
   [ Evan Dandrea ]
@@ -18,6 +19,16 @@
 
  -- Stéphane Graber <[e-mail]>  Mon, 19 Mar 2012 12:22:59 -0400
 
+=======
+ubiquity (2.9.30) UNRELEASED; urgency=low
+
+  [ Barry Warsaw ]
+  * When Try Ubuntu has been clicked once, don't respond to subsequent
+    clicks.  (LP: #911907)
+
+ -- Barry Warsaw <[e-mail]>  Mon, 19 Mar 2012 10:34:45 -0400
+
+>>>>>>> MERGE-SOURCE
 ubiquity (2.9.29) precise; urgency=low
 
   [ Oliver Grawert ]

=== modified file 'tests/test_language.py'
--- tests/test_language.py	2012-02-15 02:51:13 +0000
+++ tests/test_language.py	2012-03-19 17:02:20 +0000
@@ -1,7 +1,8 @@
 #!/usr/bin/python
-# -*- coding: utf8; -*-
+# -*- coding: utf-8; -*-
 
 import unittest
+from test.test_support import EnvironmentVarGuard
 
 from gi.repository import Gtk
 import mock
@@ -18,7 +19,7 @@
             return real_method(path, *args, **kw)
     return side_effect
 
-class LanguageTests(unittest.TestCase):
+class OEMUserLanguageTests(unittest.TestCase):
     def setUp(self):
         for obj in ('ubiquity.misc.execute',
                 'ubiquity.misc.execute_root'):
@@ -61,5 +62,44 @@
                 longest_length = length
                 longest = choice
         pad = self.gtk.iconview.get_property('item-padding')
-        layout =  self.gtk.iconview.create_pango_layout(longest)
+        layout = self.gtk.iconview.create_pango_layout(longest)
         self.assertEqual(layout.get_pixel_size()[0] + pad * 2, width)
+
+
+class LanguageTests(unittest.TestCase):
+    def setUp(self):
+        
+        for obj in ('ubiquity.misc.execute',
+                'ubiquity.misc.execute_root'):
+            patcher = mock.patch(obj)
+            patcher.start()
+            self.addCleanup(patcher.stop)
+
+        ubi_language = plugin_manager.load_plugin('ubi-language')
+
+        self.controller = mock.Mock()
+        self.controller.oem_user_config = False
+        self.controller.oem_config = False
+        self.ubi_language = ubi_language
+        # Set the environment variable needed in order for PageGtk to hook up
+        # the Try Ubuntu button with the appropriate action.
+        with EnvironmentVarGuard() as environ:
+            environ['UBIQUITY_GREETER'] = '1'
+            self.gtk = self.ubi_language.PageGtk(self.controller)
+
+    def test_try_ubuntu_clicks(self):
+        from ubiquity import gtkwidgets
+        # Ensure that the mock changes state correctly.
+        self.controller.allowed_change_step.return_value = True
+        def side_effect(*args):
+            assert len(args) == 1 and type(args[0]) is bool
+            self.controller.allowed_change_step.return_value = args[0]
+        self.controller.allow_change_step.side_effect = side_effect
+        # Multiple clicks on Try Ubuntu crash the installer.  LP: #911907
+        self.gtk.try_ubuntu.clicked()
+        self.gtk.try_ubuntu.clicked()
+        # Process the clicks.
+        gtkwidgets.refresh()
+        # When the Try Ubuntu button is clicked, the dbfilter's ok_handler()
+        # methods should have been called only once.
+        self.assertEqual(self.controller.dbfilter.ok_handler.call_count, 1)

=== modified file 'ubiquity/plugins/ubi-language.py'
--- ubiquity/plugins/ubi-language.py	2012-03-15 21:55:47 +0000
+++ ubiquity/plugins/ubi-language.py	2012-03-19 17:02:20 +0000
@@ -129,6 +129,10 @@
 
     @plugin.only_this_page
     def on_try_ubuntu_clicked(self, *args):
+        if not self.controller.allowed_change_step():
+            # The button's already been clicked once, so stop reacting to it.
+            # LP: #911907.
+            return
         # Spinning cursor.
         self.controller.allow_change_step(False)
         # Queue quit.
@@ -444,6 +448,10 @@
 
     @plugin.only_this_page
     def on_try_ubuntu_clicked(self, *args):
+        if not self.controller.allowed_change_step():
+            # The button's already been clicked once, so stop reacting to it.
+            # LP: #911907.
+            return
         # Spinning cursor.
         self.controller.allow_change_step(False)
         # Queue quit.