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

[Eitan Isaacson]

[Eitan Isaacson (eeejay)]

Makes the application class factory a class attribute of the test suite.

[Javier Collado (javier.collado)]

The code change it's OK to me. I just think that the in the TestSuite class documentation string a comment should be added to state clearly what's the aim of the new APPLICATION_FACTORY class attribute.

review: Needs Information

[Ara Pulido (ara)]

Same thing here, I think that the code is OK, but apart of the comment Javier's suggested, I would also appreciate a comment on why it was decided to remove application as an init method parameter.
(commenting here in launchpad, I mean)

review: Needs Information

[Eitan Isaacson (eeejay)]

> Same thing here, I think that the code is OK, but apart of the comment
> Javier's suggested, I would also appreciate a comment on why it was decided to
> remove application as an init method parameter.
> (commenting here in launchpad, I mean)

It is hard (not clean) to subclass an Application class, and include it as the factory for the TestSuite class.

The specific use-case is the pidgin_messaging.py script overrides Application.open() and Application.close().

Before the app/suite split, it was an easy override, but now we need to:
1. Override Pidgin as PidginUseApp
2. Override PidginUseTest.__init__(), re-implement it without calling the superclass init, because it will provide (and use) the wrong factory. Here is what it looks like:

class PidginUseApp(Pidgin):
    def open(self):
        Pidgin.open(self)
        self.buddy_login()
        self.wait_for_account_connect(self.get_account_name('XMPP'), 'XMPP')
        self.wait_for_buddy(self.get_account_alias('OtherXMPP'))

    def close(self):
        self.buddy.disconnect()
        Pidgin.exit(self)

class PidginUseTest(PidginTestSuite):
    def __init__(self, clean_profile=True,
                 profile_template='',
                 credentials=''):
        self.clean_profile = clean_profile
        self.profile_template = profile_template
        self.credentials = credentials
        SingleApplicationTestSuite.__init__(self, PidginUseApp)

With my changes, besides overriding Pidgin, you just need to override a static class attribute.

Phew!!

[lp:~eeejay/mago/tweaks]

54. By Eitan Isaacson on 2009-05-27

add helpful docstring for SingleApplicationTestSuite.APPLICATION_FACTORY

[Eitan Isaacson (eeejay)]

> The code change it's OK to me. I just think that the in the TestSuite class
> documentation string a comment should be added to state clearly what's the aim
> of the new APPLICATION_FACTORY class attribute.

Added a docstring.

[Ara Pulido (ara)]

Thanks for the comments :-)

review: Approve

[Javier Collado (javier.collado)]

review: Approve

=== modified file 'desktoptesting/test_suite/deskex.py'
--- desktoptesting/test_suite/deskex.py	2009-05-06 09:37:46 +0000
+++ desktoptesting/test_suite/deskex.py	2009-05-27 10:45:38 +0000
@@ -10,9 +10,7 @@
     """
     Default test suite for Seahorse
     """
-    def __init__(self):
-        SingleApplicationTestSuite.__init__(self, IndicatorApplet)
-
+    APPLICATION_FACTORY = IndicatorApplet
     def setup(self):
         self.application.open()
 
@@ -26,9 +24,7 @@
     """
     Default test suite for Seahorse
     """
-    def __init__(self):
-        SingleApplicationTestSuite.__init__(self, NotifyOSD)
-
+    APPLICATION_FACTORY = NotifyOSD
     def setup(self):
         self.application.open()
 
 
=== modified file 'desktoptesting/test_suite/gnome.py'
--- desktoptesting/test_suite/gnome.py	2009-04-21 10:15:09 +0000
+++ desktoptesting/test_suite/gnome.py	2009-05-27 10:45:38 +0000
@@ -10,9 +10,7 @@
     """
     Default test suite for Seahorse
     """
-    def __init__(self):
-        SingleApplicationTestSuite.__init__(self, Seahorse)
-
+    APPLICATION_FACTORY = Seahorse
     def setup(self):
         self.application.open()
 
@@ -28,9 +26,7 @@
     """
     Default test suite for GEdit
     """
-    def __init__(self):
-        SingleApplicationTestSuite.__init__(self, GEdit)
-
+    APPLICATION_FACTORY = GEdit
     def setup(self):
         self.application.open()
 
 
=== modified file 'desktoptesting/test_suite/main.py'
--- desktoptesting/test_suite/main.py	2009-04-21 10:15:09 +0000
+++ desktoptesting/test_suite/main.py	2009-05-27 10:45:38 +0000
@@ -2,6 +2,8 @@
 test_suite module contains the definition of the TestSuite class that
 must be used by all test suites written for the desktoptesting package
 """
+from ..application.main import Application
+
 class TestSuite:
     """
     TestSuite that implements all the test suite methods desired in a
@@ -22,8 +24,9 @@
     Test suite intended to make sure that a single application is
     running
     """
-    def __init__(self, application_factory):
-        self.application = application_factory()
+    APPLICATION_FACTORY = Application
+    def __init__(self):
+        self.application = self.APPLICATION_FACTORY()
 
     def cleanup(self):
         self.application.set_name(self.application.WINDOW)
 
=== modified file 'desktoptesting/test_suite/ubuntu.py'
--- desktoptesting/test_suite/ubuntu.py	2009-04-21 09:58:40 +0000
+++ desktoptesting/test_suite/ubuntu.py	2009-05-27 10:45:38 +0000
@@ -6,9 +6,7 @@
 from ..application.ubuntu import UbuntuMenu, UpdateManager
 
 class UbuntuMenuTestSuite(SingleApplicationTestSuite):
-    def __init__(self):
-        SingleApplicationTestSuite.__init__(self, UbuntuMenu)
-
+    APPLICATION_FACTORY = UbuntuMenu
     def teardown(self):
         self.cleanup() 
 
@@ -18,5 +16,4 @@
 
 
 class UpdateManagerTestSuite(SingleApplicationTestSuite):
-    def __init__(self):
-        SingleApplicationTestSuite.__init__(self, UpdateManager)
+    APPLICATION_FACTORY = UpdateManager