Commiting fixes for running our test suite using trial and nose.

We are moving towards a model that allows trial and nose to each run
different parts of our test suite.  I have added __test__ = {} to 
modules that nose should skip.  I have added new decorators that trial
can use to skip tests.  See this ticket for more information:

https://bugs.launchpad.net/bugs/362142

IPython/testing/decorators_trial.py

@@ -0,0 +1,132 b''
+# encoding: utf-8
+"""
+Testing related decorators for use with twisted.trial.
+
+The decorators in this files are designed to follow the same API as those
+in the decorators module (in this same directory).  But they can be used
+with twisted.trial
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2009  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+import os
+import sys
+
+from IPython.testing.decorators import make_label_dec
+
+#-----------------------------------------------------------------------------
+# Testing decorators
+#-----------------------------------------------------------------------------
+
+
+def skipif(skip_condition, msg=None):
+    """Create a decorator that marks a test function for skipping.
+
+    The is a decorator factory that returns a decorator that will 
+    conditionally skip a test based on the value of skip_condition.  The
+    skip_condition argument can either be a boolean or a callable that returns
+    a boolean.
+
+    Parameters
+    ----------
+    skip_condition : boolean or callable
+        If this evaluates to True, the test is skipped.
+    msg : str
+        The message to print if the test is skipped.
+
+    Returns
+    -------
+    decorator : function
+        The decorator function that can be applied to the test function.
+    """
+
+    def skip_decorator(f):
+
+        # Allow for both boolean or callable skip conditions.
+        if callable(skip_condition):
+            skip_val = lambda : skip_condition()
+        else:
+            skip_val = lambda : skip_condition
+
+        if msg is None:
+            out = 'Test skipped due to test condition.'
+        else: 
+            out = msg
+        final_msg = "Skipping test: %s. %s" % (f.__name__,out)
+
+        if skip_val():
+            f.skip = final_msg
+
+        return f
+    return skip_decorator
+
+
+def skip(msg=None):
+    """Create a decorator that marks a test function for skipping.
+
+    This is a decorator factory that returns a decorator that will cause
+    tests to be skipped.
+
+    Parameters
+    ----------
+    msg : str
+        Optional message to be added.
+
+    Returns
+    -------
+    decorator : function
+        Decorator, which, when applied to a function, sets the skip
+        attribute of the function causing `twisted.trial` to skip it.
+    """
+
+    return skipif(True,msg)
+
+
+def numpy_not_available():
+    """Can numpy be imported?  Returns true if numpy does NOT import.
+
+    This is used to make a decorator to skip tests that require numpy to be
+    available, but delay the 'import numpy' to test execution time.
+    """
+    try:
+        import numpy
+        np_not_avail = False
+    except ImportError:
+        np_not_avail = True
+
+    return np_not_avail
+
+#-----------------------------------------------------------------------------
+# Decorators for public use
+#-----------------------------------------------------------------------------
+
+# Decorators to skip certain tests on specific platforms.
+skip_win32 = skipif(sys.platform == 'win32',
+                    "This test does not run under Windows")
+skip_linux = skipif(sys.platform == 'linux2',
+                    "This test does not run under Linux")
+skip_osx = skipif(sys.platform == 'darwin',"This test does not run under OS X")
+
+# Decorators to skip tests if not on specific platforms.
+skip_if_not_win32 = skipif(sys.platform != 'win32',
+                           "This test only runs under Windows")
+skip_if_not_linux = skipif(sys.platform != 'linux2',
+                           "This test only runs under Linux")
+skip_if_not_osx = skipif(sys.platform != 'darwin',
+                         "This test only runs under OSX")
+
+# Other skip decorators
+skipif_not_numpy = skipif(numpy_not_available,"This test requires numpy")
+
+skipknownfailure = skip('This test is known to fail')
+
+

IPython/testing/tests/test_decorators_trial.py

@@ -0,0 +1,52 b''
+# encoding: utf-8
+"""
+Tests for decorators_trial.py
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2009  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+# Tell nose to skip this module
+__test__ = {}
+
+import os
+import sys
+
+from twisted.trial import unittest
+import IPython.testing.decorators_trial as dec
+
+#-----------------------------------------------------------------------------
+# Tests
+#-----------------------------------------------------------------------------
+
+class TestDecoratorsTrial(unittest.TestCase):
+    
+    @dec.skip()
+    def test_deliberately_broken(self):
+        """A deliberately broken test - we want to skip this one."""
+        1/0
+
+    @dec.skip('Testing the skip decorator')
+    def test_deliberately_broken2(self):
+        """Another deliberately broken test - we want to skip this one."""
+        1/0
+
+    @dec.skip_linux
+    def test_linux(self):
+        self.assertNotEquals(sys.platform,'linux2',"This test can't run under linux")
+
+    @dec.skip_win32
+    def test_win32(self):
+        self.assertNotEquals(sys.platform,'win32',"This test can't run under windows")
+
+    @dec.skip_osx
+    def test_osx(self):
+        self.assertNotEquals(sys.platform,'darwin',"This test can't run under osx")
  No newline at end of file

IPython/kernel/core/tests/test_interpreter.py

@@ -1,64 +1,62 b''
 # encoding: utf-8
 
 """This file contains unittests for the interpreter.py module."""
 
-__docformat__ = "restructuredtext en"
-
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2008-2009  The IPython Development Team                           
-#                                                                             
-#  Distributed under the terms of the BSD License.  The full license is in    
-#  the file COPYING, distributed as part of this software.                    
+#  Copyright (C) 2008-2009  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is
+#  in the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
-# Imports                                                                     
+# Imports
 #-----------------------------------------------------------------------------
 
-import unittest
+# Tell nose to skip this module
+__test__ = {}
+
+from twisted.trial import unittest
 from IPython.kernel.core.interpreter import Interpreter
 
 #-----------------------------------------------------------------------------
-# Tests 
+# Tests
 #-----------------------------------------------------------------------------
 
-# Tell nose to skip this module
-__test__ = {}
-
 class TestInterpreter(unittest.TestCase):
 
     def test_unicode(self):
         """ Test unicode handling with the interpreter."""
         i = Interpreter()
         i.execute_python(u'print "ù"')
         i.execute_python('print "ù"')
 
     def test_ticket266993(self):
         """ Test for ticket 266993."""
         i = Interpreter()
         i.execute('str("""a\nb""")')
 
     def test_ticket364347(self):
         """Test for ticket 364347."""
         i = Interpreter()
         i.split_commands('str("a\\nb")')
 
     def test_split_commands(self):
         """ Test that commands are indeed individually split."""
         i = Interpreter()
         test_atoms = [('(1\n + 1)', ),
                       ('1', '1', ),
                       ]
         for atoms in test_atoms:
             atoms = [atom.rstrip() + '\n' for atom in atoms]
             self.assertEquals(i.split_commands(''.join(atoms)),atoms)
 
     def test_long_lines(self):
         """ Test for spurious syntax error created by the interpreter."""
         test_strings = [u'( 1 +\n 1\n )\n\n',
                         u'(1 \n + 1\n )\n\n',
                        ]
         i = Interpreter()
         for s in test_strings:
             i.execute(s)
 

IPython/kernel/core/tests/test_notification.py

@@ -1,174 +1,161 b''
 # encoding: utf-8
 
 """This file contains unittests for the notification.py module."""
 
-__docformat__ = "restructuredtext en"
-
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2008  The IPython Development Team                           
-#                                                                             
-#  Distributed under the terms of the BSD License.  The full license is in    
-#  the file COPYING, distributed as part of this software.                    
+#  Copyright (C) 2008-2009  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is
+#  in the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
-                                                                              
+
 #-----------------------------------------------------------------------------
-# Imports                                                                     
+# Imports
 #-----------------------------------------------------------------------------
 
 # Tell nose to skip this module
 __test__ = {}
 
-import unittest
+from twisted.trial import unittest
 import IPython.kernel.core.notification as notification
-from nose.tools import timed
 
-#
-# Supporting test classes
-#
+#-----------------------------------------------------------------------------
+# Support Classes
+#-----------------------------------------------------------------------------
 
 class Observer(object):
     """docstring for Observer"""
     def __init__(self, expectedType, expectedSender, 
                     center=notification.sharedCenter, **kwargs):
         super(Observer, self).__init__()
         self.expectedType = expectedType
         self.expectedSender = expectedSender
         self.expectedKwArgs = kwargs
         self.recieved = False
         center.add_observer(self.callback, 
                             self.expectedType, 
                             self.expectedSender)
     
-    
     def callback(self, theType, sender, args={}):
         """callback"""
         
         assert(theType == self.expectedType or
                 self.expectedType == None)
         assert(sender == self.expectedSender or
                 self.expectedSender == None)
         assert(args == self.expectedKwArgs)
         self.recieved = True
     
-    
     def verify(self):
         """verify"""
         
         assert(self.recieved)
     
     def reset(self):
         """reset"""
         
         self.recieved = False
-    
 
 
 class Notifier(object):
     """docstring for Notifier"""
     def __init__(self, theType, **kwargs):
         super(Notifier, self).__init__()
         self.theType = theType
         self.kwargs = kwargs
     
     def post(self, center=notification.sharedCenter):
         """fire"""
         
         center.post_notification(self.theType, self,
             **self.kwargs)
-    
 
-#
-# Test Cases
-#
+#-----------------------------------------------------------------------------
+# Tests
+#-----------------------------------------------------------------------------
 
 class NotificationTests(unittest.TestCase):
     """docstring for NotificationTests"""
     
     def tearDown(self):
         notification.sharedCenter.remove_all_observers()
     
     def test_notification_delivered(self):
         """Test that notifications are delivered"""
         expectedType = 'EXPECTED_TYPE'
         sender = Notifier(expectedType)
         observer = Observer(expectedType, sender)
         
         sender.post()
         
         observer.verify()
     
-    
     def test_type_specificity(self):
         """Test that observers are registered by type"""
         
         expectedType = 1
         unexpectedType = "UNEXPECTED_TYPE"
         sender = Notifier(expectedType)
         unexpectedSender = Notifier(unexpectedType)
         observer = Observer(expectedType, sender)
     
         sender.post()
         unexpectedSender.post()
     
         observer.verify()
     
-    
     def test_sender_specificity(self):
         """Test that observers are registered by sender"""
         
         expectedType = "EXPECTED_TYPE"
         sender1 = Notifier(expectedType)
         sender2 = Notifier(expectedType)
         observer = Observer(expectedType, sender1)
         
         sender1.post()
         sender2.post()
         
         observer.verify()
     
-    
     def test_remove_all_observers(self):
         """White-box test for remove_all_observers"""
         
         for i in xrange(10):
             Observer('TYPE', None, center=notification.sharedCenter)
         
         self.assert_(len(notification.sharedCenter.observers[('TYPE',None)]) >= 10, 
             "observers registered")
         
         notification.sharedCenter.remove_all_observers()
         
         self.assert_(len(notification.sharedCenter.observers) == 0, "observers removed")
-    
-    
+
     def test_any_sender(self):
         """test_any_sender"""
         
         expectedType = "EXPECTED_TYPE"
         sender1 = Notifier(expectedType)
         sender2 = Notifier(expectedType)
         observer = Observer(expectedType, None)
         
         
         sender1.post()
         observer.verify()
         
         observer.reset()
         sender2.post()
         observer.verify()
-        
-    
-    @timed(.01)
+
     def test_post_performance(self):
         """Test that post_notification, even with many registered irrelevant
         observers is fast"""
         
         for i in xrange(10):
             Observer("UNRELATED_TYPE", None)
         
         o = Observer('EXPECTED_TYPE', None)
         
         notification.sharedCenter.post_notification('EXPECTED_TYPE', self)
         
         o.verify()
-    
+

IPython/kernel/core/tests/test_redirectors.py

@@ -1,70 +1,78 b''
 # encoding: utf-8
 """
 Test the output capture at the OS level, using file descriptors.
 """
-
-__docformat__ = "restructuredtext en"
-
-#-------------------------------------------------------------------------------
-#  Copyright (C) 2008  The IPython Development Team
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2009  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is
 #  in the file COPYING, distributed as part of this software.
-#-------------------------------------------------------------------------------
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 # Tell nose to skip this module
 __test__ = {}
 
-import os
 from cStringIO import StringIO
+import os
+
+from twisted.trial import unittest
 
-from IPython.testing import decorators as dec
+from IPython.testing import decorators_trial as dec
 
 #-----------------------------------------------------------------------------
-# Test functions
+# Tests
+#-----------------------------------------------------------------------------
 
[e-mail]_win32
-def test_redirector():
-    """ Checks that the redirector can be used to do synchronous capture.
-    """
-    from IPython.kernel.core.fd_redirector import FDRedirector
-    r = FDRedirector()
-    out = StringIO()
-    try:
-        r.start()
-        for i in range(10):
-            os.system('echo %ic' % i)
-            print >>out, r.getvalue(),
-            print >>out, i
-    except:
-        r.stop()
-        raise
-    r.stop()
-    result1 = out.getvalue()
-    result2 = "".join("%ic\n%i\n" %(i, i) for i in range(10))
-    assert result1 == result2
 
+class TestRedirector(unittest.TestCase):
 
[e-mail]_win32
-def test_redirector_output_trap():
-    """ This test check not only that the redirector_output_trap does
+    @dec.skip_win32
+    def test_redirector(self):
+        """Checks that the redirector can be used to do synchronous capture.
+        """
+        from IPython.kernel.core.fd_redirector import FDRedirector
+        r = FDRedirector()
+        out = StringIO()
+        try:
+            r.start()
+            for i in range(10):
+                os.system('echo %ic' % i)
+                print >>out, r.getvalue(),
+                print >>out, i
+        except:
+            r.stop()
+            raise
+        r.stop()
+        result1 = out.getvalue()
+        result2 = "".join("%ic\n%i\n" %(i, i) for i in range(10))
+        self.assertEquals(result1, result2)
+
+    @dec.skip_win32
+    def test_redirector_output_trap(self):
+        """Check the greedy trapping behavior of the traps.
+        
+        This test check not only that the redirector_output_trap does
         trap the output, but also that it does it in a gready way, that
         is by calling the callback ASAP.
-    """
-    from IPython.kernel.core.redirector_output_trap import RedirectorOutputTrap
-    out = StringIO()
-    trap = RedirectorOutputTrap(out.write, out.write)
-    try:
-        trap.set()
-        for i in range(10):
-            os.system('echo %ic' % i)
-            print "%ip" % i
-            print >>out, i
-    except:
+        """
+        from IPython.kernel.core.redirector_output_trap import RedirectorOutputTrap
+        out = StringIO()
+        trap = RedirectorOutputTrap(out.write, out.write)
+        try:
+            trap.set()
+            for i in range(10):
+                os.system('echo %ic' % i)
+                print "%ip" % i
+                print >>out, i
+        except:
+            trap.unset()
+            raise
         trap.unset()
-        raise
-    trap.unset()
-    result1 = out.getvalue()
-    result2 = "".join("%ic\n%ip\n%i\n" %(i, i, i) for i in range(10))
-    assert result1 == result2
-    
+        result1 = out.getvalue()
+        result2 = "".join("%ic\n%ip\n%i\n" %(i, i, i) for i in range(10))
+        self.assertEquals(result1, result2)
+

IPython/testing/tests/test_decorators.py

@@ -1,161 +1,161 b''
 """Tests for the decorators we've created for IPython.
 """
 
 # Module imports
 # Std lib
 import inspect
 import sys
 
 # Third party
 import nose.tools as nt
 
 # Our own
 from IPython.testing import decorators as dec
 
 
 #-----------------------------------------------------------------------------
 # Utilities
 
 # Note: copied from OInspect, kept here so the testing stuff doesn't create
 # circular dependencies and is easier to reuse.
 def getargspec(obj):
     """Get the names and default values of a function's arguments.
 
     A tuple of four things is returned: (args, varargs, varkw, defaults).
     'args' is a list of the argument names (it may contain nested lists).
     'varargs' and 'varkw' are the names of the * and ** arguments or None.
     'defaults' is an n-tuple of the default values of the last n arguments.
 
     Modified version of inspect.getargspec from the Python Standard
     Library."""
 
     if inspect.isfunction(obj):
         func_obj = obj
     elif inspect.ismethod(obj):
         func_obj = obj.im_func
     else:
         raise TypeError, 'arg is not a Python function'
     args, varargs, varkw = inspect.getargs(func_obj.func_code)
     return args, varargs, varkw, func_obj.func_defaults
 
 #-----------------------------------------------------------------------------
 # Testing functions
 
 @dec.skip
 def test_deliberately_broken():
     """A deliberately broken test - we want to skip this one."""
     1/0
 
[e-mail]('foo')
[e-mail]('Testing the skip decorator')
 def test_deliberately_broken2():
     """Another deliberately broken test - we want to skip this one."""
     1/0
 
 
 # Verify that we can correctly skip the doctest for a function at will, but
 # that the docstring itself is NOT destroyed by the decorator.
 @dec.skip_doctest
 def doctest_bad(x,y=1,**k):
     """A function whose doctest we need to skip.
 
     >>> 1+1
     3
     """
     print 'x:',x
     print 'y:',y
     print 'k:',k
 
 
 def call_doctest_bad():
     """Check that we can still call the decorated functions.
     
     >>> doctest_bad(3,y=4)
     x: 3
     y: 4
     k: {}
     """
     pass
 
 
 def test_skip_dt_decorator():
     """Doctest-skipping decorator should preserve the docstring.
     """
     # Careful: 'check' must be a *verbatim* copy of the doctest_bad docstring!
     check = """A function whose doctest we need to skip.
 
     >>> 1+1
     3
     """
     # Fetch the docstring from doctest_bad after decoration.
     val = doctest_bad.__doc__
     
     assert check==val,"doctest_bad docstrings don't match"
 
 # Doctest skipping should work for class methods too
 class foo(object):
     """Foo
 
     Example:
 
     >>> 1+1
     2
     """
 
     @dec.skip_doctest
     def __init__(self,x):
         """Make a foo.
 
         Example:
 
         >>> f = foo(3)
         junk
         """
         print 'Making a foo.'
         self.x = x
         
     @dec.skip_doctest
     def bar(self,y):
         """Example:
 
         >>> f = foo(3)
         >>> f.bar(0)
         boom!
         >>> 1/0
         bam!
         """
         return 1/y
 
     def baz(self,y):
         """Example:
 
         >>> f = foo(3)
         Making a foo.
         >>> f.baz(3)
         True
         """
         return self.x==y
 
 
 
 def test_skip_dt_decorator2():
     """Doctest-skipping decorator should preserve function signature.
     """
     # Hardcoded correct answer
     dtargs = (['x', 'y'], None, 'k', (1,))
     # Introspect out the value
     dtargsr = getargspec(doctest_bad)
     assert dtargsr==dtargs, \
            "Incorrectly reconstructed args for doctest_bad: %s" % (dtargsr,)
 
 
 @dec.skip_linux
 def test_linux():
     nt.assert_not_equals(sys.platform,'linux2',"This test can't run under linux")
 
 @dec.skip_win32
 def test_win32():
     nt.assert_not_equals(sys.platform,'win32',"This test can't run under windows")
 
 @dec.skip_osx
 def test_osx():
     nt.assert_not_equals(sys.platform,'darwin',"This test can't run under osx")