Merge lp:~diegosarmentero/ubuntu-sso-client/main-moved into lp:ubuntu-sso-client

[Diego Sarmentero]

- Fixed the backend getting stuck installing the qtreactor before the qt process is executed and running the application in the twisted process. (This fix affects only Windows OS)

[lp:~diegosarmentero/ubuntu-sso-client/main-moved]

933. By Diego Sarmentero on 2012-03-21

Installing qtreactor

934. By Diego Sarmentero on 2012-03-21

main updated

935. By Diego Sarmentero on 2012-03-21

Linking bug number.

[Natalia Bidart (nataliabidart)]

* By popping the 'close_callback' param, you're no longer testing that the proper close_callback is passed to the GUI. Can you please restore that?

* Is better to have self.called to be a list so you can test that a given method (and only a given method) was called.

* These two tests have a lot of code duplication:

def test_main_source_main(self):
def test_main_source_main_start(self):

You could improve all the above by doing something like:

class BasicTestCase(TestCase):
    """Test case with a helper tracker."""

    @defer.inlineCallbacks
    def setUp(self):
        yield super(BasicTestCase, self).setUp()
        self.called = []

        def called_ui(**kw):
            """record ui call."""
            kw.pop('close_callback')
            self.called['called_ui'] = ('GUI', kw)
            return FakeUi()

        self.patch(main.QtGui, 'QApplication', FakeApplication)
        self.patch(main, 'UbuntuSSOClientGUI',
                   lambda *a, **kw: self.called.append(('GUI', a, kw)))
        self.patch(main.source, 'main',
                   lambda *a, **kw: self.called.append(('source.main', a, kw)))
        self.patch(main.source, 'main_start',
                   lambda *a, **kw: self.called.append(('source.main_start', a, kw)))

    def test_main(self):
        """Calling main.main() a UI instance is created."""
        kwargs = dict(app_name='APP_NAME', foo='foo', bar='bar',
            baz='yadda', yadda=0)
        main.main(**kwargs)

        kwargs['close_callback'] = main.source.main_quit
        self.assertEqual(self.called, [('GUI', (), kwargs), ('source.main', ...), ('source.main_start', ...)])

and thus you can safely remove:

    def test_main_source_main(self):
    def test_main_source_main_start(self):

* You're adding old copyright notices (new files say 2011 or 2011-2012, they should be only 2012).

review: Needs Fixing

[lp:~diegosarmentero/ubuntu-sso-client/main-moved]

936. By Diego Sarmentero on 2012-03-22

Fixing tests.

937. By Diego Sarmentero on 2012-03-22

Adding a python to ignore during gtk tests

[Natalia Bidart (nataliabidart)]

The refactored test is not testing that the proper methods were called, since, having this list:

        expected = [((FakeApplication.instance(),), {}),
            ((), kwargs), ((FakeApplication.instance(),), {})]

how can you tell that the first item ((FakeApplication.instance(),), {}) was added by the proper call, and not by the call that adds the last ((FakeApplication.instance(),), {})? (or viceversa).

In my proposal the name of the method is added to the 'called' list, so you can ensure the desired methods were called when needed and in the right order.

On the other hand, I liked how you solved the close_callback issue :-).

review: Needs Fixing

[lp:~diegosarmentero/ubuntu-sso-client/main-moved]

938. By Diego Sarmentero on 2012-03-23

fixing tests.

[Natalia Bidart (nataliabidart)]

Looks great, thanks!

review: Approve

=== modified file 'bin/ubuntu-sso-login-qt'
--- bin/ubuntu-sso-login-qt	2012-03-15 20:16:16 +0000
+++ bin/ubuntu-sso-login-qt	2012-03-23 15:33:17 +0000
@@ -21,14 +21,13 @@
 # Access to a protected member, pylint: disable=W0212
 
 import sys
+if sys.platform == 'win32':
+    import qt4reactor
+    qt4reactor.install()
 
 from ubuntu_sso.qt.main import main
 from ubuntu_sso.utils.ui import parse_args
 
-if sys.platform.startswith('linux'):
-    from dbus.mainloop.qt import DBusQtMainLoop
-    DBusQtMainLoop(set_as_default=True)
-
 
 if __name__ == "__main__":
     args = parse_args()

=== modified file 'run-tests'
--- run-tests	2012-03-13 03:10:00 +0000
+++ run-tests	2012-03-23 15:33:17 +0000
@@ -16,7 +16,7 @@
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-QT_TESTS_PATH=ubuntu_sso/qt/tests
+QT_TESTS_PATH="ubuntu_sso/qt/tests, ubuntu_sso/qt/main/tests"
 GTK_TESTS_PATH=ubuntu_sso/gtk/tests
 WINDOWS_TESTS=test_windows.py
 

=== added directory 'ubuntu_sso/qt/main'
=== renamed file 'ubuntu_sso/qt/main.py' => 'ubuntu_sso/qt/main/__init__.py'
--- ubuntu_sso/qt/main.py	2012-03-19 20:10:32 +0000
+++ ubuntu_sso/qt/main/__init__.py	2012-03-23 15:33:17 +0000
@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Main module to open the GTK UI."""
+"""Main module to open the QT UI."""
 
 import sys
 
@@ -28,12 +28,21 @@
 from ubuntu_sso.utils import PLATFORM_QSS
 
 
+# Invalid name "source", pylint: disable=C0103
+if sys.platform == 'win32':
+    from ubuntu_sso.qt.main import windows
+    source = windows
+else:
+    from ubuntu_sso.qt.main import linux
+    source = linux
+# pylint: enable=C0103
+
+
 def main(**kwargs):
     """Start the QT mainloop and open the main window."""
     app = QtGui.QApplication(sys.argv)
 
-    QtGui.QFontDatabase.addApplicationFont(':/Ubuntu-R.ttf')
-    QtGui.QFontDatabase.addApplicationFont(':/Ubuntu-B.ttf')
+    source.main(app)
 
     data = []
     for qss_name in (PLATFORM_QSS, ":/stylesheet.qss"):
@@ -48,10 +57,12 @@
             kwargs[key] = value.decode('utf-8')
 
     # Unused variable 'ui', pylint: disable=W0612
-    ui = UbuntuSSOClientGUI(close_callback=app.exit, **kwargs)
+    close_callback = lambda: source.main_quit(app)
+    ui = UbuntuSSOClientGUI(close_callback=close_callback, **kwargs)
     style = QtGui.QStyle.alignedRect(
                     QtCore.Qt.LeftToRight, QtCore.Qt.AlignCenter,
                     ui.size(), app.desktop().availableGeometry())
     ui.setGeometry(style)
     ui.show()
-    app.exec_()
+
+    source.main_start(app)

=== added file 'ubuntu_sso/qt/main/linux.py'
--- ubuntu_sso/qt/main/linux.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/qt/main/linux.py	2012-03-23 15:33:17 +0000
@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>.
+
+"""Main method to be used on linux."""
+
+
+def main(app):
+    """Apply style sheet."""
+    from dbus.mainloop.qt import DBusQtMainLoop
+    DBusQtMainLoop(set_as_default=True)
+
+
+def main_start(app):
+    """Start the mainloop."""
+    app.exec_()
+
+
+def main_quit(app):
+    """Stop the mainloop."""
+    app.exit()
+
+PLATFORM_QSS = ":/linux.qss"

=== added directory 'ubuntu_sso/qt/main/tests'
=== added file 'ubuntu_sso/qt/main/tests/__init__.py'
--- ubuntu_sso/qt/main/tests/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/qt/main/tests/__init__.py	2012-03-23 15:33:17 +0000
@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>.
+
+"""The test suite for the Qt UI for SSO."""

=== renamed file 'ubuntu_sso/qt/tests/test_main.py' => 'ubuntu_sso/qt/main/tests/test_main.py'
--- ubuntu_sso/qt/tests/test_main.py	2012-03-19 20:17:49 +0000
+++ ubuntu_sso/qt/main/tests/test_main.py	2012-03-23 15:33:17 +0000
@@ -91,13 +91,22 @@
     def setUp(self):
         yield super(BasicTestCase, self).setUp()
         self.called = []
+        self._close_callback = None
+        self._app = None
 
-        def called_ui(**kw):
+        def called_ui(method, *args, **kw):
             """record ui call."""
-            self.called.append(('GUI', kw))
+            if 'close_callback' in kw:
+                self._close_callback = kw.pop('close_callback')
+            self.called.append((method, args, kw))
             return FakeUi()
 
-        self.patch(main, 'UbuntuSSOClientGUI', called_ui)
+        self.patch(main, 'UbuntuSSOClientGUI',
+            lambda *arg, **kw: called_ui('GUI', *arg, **kw))
+        self.patch(main.source, 'main',
+            lambda *arg, **kw: called_ui('main', *arg, **kw))
+        self.patch(main.source, 'main_start',
+            lambda *arg, **kw: called_ui('main_start', *arg, **kw))
         self.patch(main.QtGui, 'QApplication', FakeApplication)
 
     def test_main(self):
@@ -106,8 +115,30 @@
             baz='yadda', yadda=0)
         main.main(**kwargs)
 
-        kwargs['close_callback'] = main.QtGui.QApplication.instance().exit
-        self.assertEqual(self.called, [('GUI', kwargs)])
+        expected = [('main', (FakeApplication.instance(),), {}),
+            ('GUI', (), kwargs),
+            ('main_start', (FakeApplication.instance(),), {})]
+        self.assertEqual(self.called, expected)
+
+    def test_check_close_callback(self):
+        """Check that the close callback is main_quit."""
+
+        def called_quit(app):
+            """Record the call to quit."""
+            self._app = app
+
+        self.patch(main.source, 'main_quit', called_quit)
+
+        kwargs = dict(app_name='APP_NAME', foo='foo', bar='bar',
+            baz='yadda', yadda=0)
+        main.main(**kwargs)
+
+        expected = [('main', (FakeApplication.instance(),), {}),
+            ('GUI', (), kwargs),
+            ('main_start', (FakeApplication.instance(),), {})]
+        self._close_callback()
+        self.assertEqual(self.called, expected)
+        self.assertEqual(self._app, FakeApplication.instance())
 
     def test_main_args(self):
         """Calling main.main() a UI instance is created."""
@@ -119,11 +150,12 @@
             baz=arg_list[3].encode('utf-8'))
         main.main(**kwargs)
 
-        kwargs['close_callback'] = main.QtGui.QApplication.instance().exit
-        expected = dict(app_name=arg_list[0], foo=arg_list[1],
-            bar=arg_list[2], baz=arg_list[3],
-            close_callback=main.QtGui.QApplication.instance().exit)
-        self.assertEqual(self.called, [('GUI', expected)])
+        args_unicode = dict(app_name=arg_list[0], foo=arg_list[1],
+            bar=arg_list[2], baz=arg_list[3])
+        expected = [('main', (FakeApplication.instance(),), {}),
+            ('GUI', (), args_unicode),
+            ('main_start', (FakeApplication.instance(),), {})]
+        self.assertEqual(self.called, expected)
 
     def test_styles_load(self):
         """Test that all stylesheets load."""

=== added file 'ubuntu_sso/qt/main/windows.py'
--- ubuntu_sso/qt/main/windows.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/qt/main/windows.py	2012-03-23 15:33:17 +0000
@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>.
+
+"""Main method to be used on windows."""
+
+from PyQt4 import QtGui
+
+
+def main(app):
+    """Apply style sheet and fonts."""
+    # Apply font to the entire application
+    QtGui.QFontDatabase.addApplicationFont(':/Ubuntu-R.ttf')
+    QtGui.QFontDatabase.addApplicationFont(':/Ubuntu-B.ttf')
+
+
+# Module 'reactor' has no 'run'/'stop' member, pylint: disable=E1101
+
+
+def main_start(app):
+    """Start the mainloop."""
+    from twisted.internet import reactor
+    reactor.run()
+
+
+def main_quit(app):
+    """Stop the mainloop."""
+    from twisted.internet import reactor
+    reactor.stop()
+
+
+# pylint: enable=E1101
+
+PLATFORM_QSS = ":/windows.qss"