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

[Eitan Isaacson]

[Eitan Isaacson (eeejay)]

I came to this modification because I needed to run the notify-osd test outside of the Mago directory. I think it would be useful for all tests that have data they need to refer to.

[Nagappan Alagappan (nagappan)]

review: Approve

[Ara Pulido (ara)]

Hello Eitan,

The change looks good to me, but it would be great if you could update the documentation at http://mago.ubuntu.com/ to match the new requirements.

I would like the documentation to be as updated as possible.

Thanks,
Ara.

review: Needs Information

[Javier Collado (javier.collado)]

Hello,

The change looks great since it's indeed better to get the path from the the test suite file itself than from the current working directory.

Looking into the code even before the change, I've seen the usage of '|' as a separator to specify multiple oracle files. Wouldn't it be better to specify multiple <oracle> tags for that purpose?

Best regards,
    Javier

> I came to this modification because I needed to run the notify-osd test
> outside of the Mago directory. I think it would be useful for all tests that
> have data they need to refer to.

[Eitan Isaacson (eeejay)]

> Looking into the code even before the change, I've seen the usage of '|' as a
> separator to specify multiple oracle files. Wouldn't it be better to specify
> multiple <oracle> tags for that purpose?

Yeah, that is probably not pretty. It is a separate issue, though. Just an arbitrary separator I defined. Multiple 'oracle' tags are not possible because the tag names align to key word args, and you can't have two identical key word args.

It is a separate problem, unrelated to this branch. The proper behavior would probably be appending all identical tag's children to a list, and pass that list with the common tag name.

=== modified file 'gedit/gedit_chains.py'
--- gedit/gedit_chains.py	2009-06-24 16:45:51 +0000
+++ gedit/gedit_chains.py	2009-07-22 19:11:47 +0000
@@ -15,8 +15,7 @@
 
         # oracle file path is assumed to be relative
         # to test case code
-        oracle = os.path.join(os.path.dirname(__file__),
-                              oracle)
+        oracle = os.path.join(self.get_test_dir(), oracle)
 
         testcheck = FileComparison(oracle, test_file)
 
 
=== modified file 'mago/test_suite/main.py'
--- mago/test_suite/main.py	2009-06-23 13:26:34 +0000
+++ mago/test_suite/main.py	2009-07-22 18:58:59 +0000
@@ -3,6 +3,8 @@
 must be used by all test suites written for the mago package
 """
 from ..application.main import Application
+from inspect import getsourcefile
+from os.path import dirname
 
 class TestSuite:
     """
@@ -18,6 +20,10 @@
     def cleanup(self):
         pass
 
+    def get_test_dir(cls):
+        return dirname(getsourcefile(cls))
+    get_test_dir = classmethod(get_test_dir)
+
 
 class SingleApplicationTestSuite(TestSuite):
     """
 
=== modified file 'notify-osd/notify_osd.py'
--- notify-osd/notify_osd.py	2009-06-23 13:26:34 +0000
+++ notify-osd/notify_osd.py	2009-07-22 19:08:16 +0000
@@ -4,12 +4,14 @@
 import ldtputils
 
 from time import time, gmtime, strftime, sleep
+from os.path import join as path_join
 
 from mago.test_suite.deskex import NotifyOSDTestSuite
 from mago.check import ScreenshotCompare, FAIL
 
 class NotifyOSDTest(NotifyOSDTestSuite):
     def layoutTest(self, oracle=None, summary=None, body=None, icon=None):
+        oracle = path_join(self.get_test_dir(), oracle)
         self.application.notify(summary, body, icon)
         elapsed, screeny = self.application.grab_image_and_wait(summary)
 
@@ -25,7 +27,8 @@
             raise AssertionError('screenshots differ', screeny)
 
     def queueTest(self, oracle=None, summary=None, body=None, icon=None):
-        oracles = oracle.split('|')
+        oracles = [path_join(self.get_test_dir(), o) \
+                       for o in oracle.split('|')]
         summaries = summary.split('|')
         bodies = body.split('|')
         icons = icon.split('|')
 
=== modified file 'notify-osd/notify_osd.xml'
--- notify-osd/notify_osd.xml	2009-03-22 23:36:18 +0000
+++ notify-osd/notify_osd.xml	2009-07-22 19:08:16 +0000
@@ -8,7 +8,7 @@
       Test the layout of a bubble with an icon, summary and body
     </description>
     <args>
-      <oracle>./notify-osd/data/icons_summary_body.png</oracle>
+      <oracle>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>
@@ -20,7 +20,7 @@
       Test the layout of a bubble with an icon and summary.
     </description>
     <args>
-      <oracle>./notify-osd/data/icons_summary.png</oracle>
+      <oracle>data/icons_summary.png</oracle>
       <summary>WiFi connection lost</summary>
       <body></body>
       <icon>notification-network-wireless-disconnected</icon>
@@ -32,7 +32,7 @@
       Test the layout of a bubble with a summary only.
     </description>
     <args>
-      <oracle>./notify-osd/data/summary_body.png</oracle>
+      <oracle>data/summary_body.png</oracle>
       <summary>Totem</summary>
       <body>This is a superfluous notification</body>
       <icon></icon>
@@ -44,7 +44,7 @@
       Test the layout of a bubble with a summary only.
     </description>
     <args>
-      <oracle>./notify-osd/data/summary.png</oracle>
+      <oracle>data/summary.png</oracle>
       <summary>Summary-only</summary>
       <body></body>
       <icon></icon>
@@ -56,7 +56,7 @@
       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>
+      <oracle>data/icons_summary_body.png|data/icons_summary.png|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>