Merge lp:~statik/testtools/skip-decorators into lp:~testtools-committers/testtools/trunk

[Elliot Murphy]

[Elliot Murphy (statik)]

Add skip, skipIf, and skipUnless decorators to make it easy to write unit tests which are forward-compatible with the skipping support in python2.7 stdlib.

[lp:~statik/testtools/skip-decorators]

16. By Elliot Murphy on 2009-04-16

Merged trunk.

[Elliot Murphy (statik)]

Merged with trunk to pick up the latest stuff from Robert. Rev16 of this branch is what is going through REVU now, to hopefully go into Karmic when the archives open.

[Robert Collins (lifeless)]

I did it by mail, it failed. so here is:
 status needsfixing

        @This has a test for the skip decorator, but could probably use some
        cleverness with clone_test_with_new_id in order to generate some
        tests for all three decorators.

        see testscenarios for glue to do this with much ease.

        I hope to get a patch into 2.7 to make skips take closures not evaluated
        conditions. Or something. Bah!

        Needs info in the manual about this.

        -Rob

review: Needs Fixing

[Jonathan Lange (jml)]

Sorry about the delay on this patch -- what's the story, is it still something we want to land?

[Elliot Murphy (statik)]

> Sorry about the delay on this patch -- what's the story, is it still something
> we want to land?

Yes please, I'd like to see it land. I can work on adding some other tests tonight, but I'm hesitant to add a dependency on testscenarios.

[Elliot Murphy (statik)]

> > Sorry about the delay on this patch -- what's the story, is it still
> something
> > we want to land?
>
> Yes please, I'd like to see it land. I can work on adding some other tests
> tonight, but I'm hesitant to add a dependency on testscenarios.

Oops, I actually already added the missing tests a while ago. I'm going to resubmit this merge proposal so the diff will be regenerated.

[lp:~statik/testtools/skip-decorators]

17. By Elliot Murphy on 2009-06-20

Reformatted imports per code review comments from jml.

Unmerged revisions

=== modified file 'testtools/__init__.py'
--- testtools/__init__.py	2008-10-04 03:59:24 +0000
+++ testtools/__init__.py	2009-04-09 17:24:49 +0000
@@ -8,8 +8,12 @@
     'MultiTestResult',
     'TestCase',
     'TestResult',
+    'skip',
+    'skipIf',
+    'skipUnless',
     ]
 
-from testtools.testcase import TestCase, clone_test_with_new_id
+from testtools.testcase import (TestCase, clone_test_with_new_id,
+    skip, skipIf, skipUnless)
 from testtools.testresult import MultiTestResult, TestResult
 from testtools.utils import iterate_tests
 
=== modified file 'testtools/testcase.py'
--- testtools/testcase.py	2009-03-05 04:38:11 +0000
+++ testtools/testcase.py	2009-04-09 17:24:49 +0000
@@ -6,9 +6,13 @@
 __all__ = [
     'change_test_id',
     'TestCase',
+    'skip',
+    'skipIf',
+    'skipUnless',
     ]
 
 from copy import deepcopy
+import functools
 import unittest
 
 
@@ -199,3 +203,35 @@
     newTest.id = lambda: new_id
     return newTest
 
+def skip(reason):
+    """A decorator to skip unit tests.
+
+    This is just syntactic sugar so users don't have to change any of their
+    unit tests in order to migrate to python 2.7, which provides the
+    @unittest.skip decorator.
+    """
+    def decorator(test_item):
+        @functools.wraps(test_item)
+        def skip_wrapper(*args, **kwargs):
+            raise TestCase.skipException(reason)
+        return skip_wrapper
+    return decorator
+
+
+def skipIf(condition, reason):
+    """Skip a test if the condition is true."""
+    if condition:
+        return skip(reason)
+    def _id(obj):
+        return obj
+    return _id
+
+
+def skipUnless(condition, reason):
+    """Skip a test unless the condition is true."""
+    if not condition:
+        return skip(reason)
+    def _id(obj):
+        return obj
+    return _id
+
 
=== modified file 'testtools/tests/test_testtools.py'
--- testtools/tests/test_testtools.py	2009-02-28 04:22:53 +0000
+++ testtools/tests/test_testtools.py	2009-04-09 17:34:30 +0000
@@ -3,7 +3,8 @@
 """Tests for extensions to the base test library."""
 
 import unittest
-from testtools import TestCase, clone_test_with_new_id
+from testtools import (TestCase, clone_test_with_new_id,
+    skip, skipIf, skipUnless)
 from testtools.tests.helpers import LoggingResult
 
 
@@ -428,6 +429,38 @@
         test.run(result)
         self.assertEqual(1, len(result.errors))
 
+    def test_skip_decorator(self):
+        class SkippingTest(TestCase):
+            @skip("skipping this test")
+            def test_that_is_decorated_with_skip(self):
+                self.fail()
+        result = unittest.TestResult()
+        test = SkippingTest("test_that_is_decorated_with_skip")
+        test.run(result)
+        self.assertEqual(1, len(result.errors))
+
+
+    def test_skipIf_decorator(self):
+        class SkippingTest(TestCase):
+            @skipIf(True, "skipping this test")
+            def test_that_is_decorated_with_skipIf(self):
+                self.fail()
+        result = unittest.TestResult()
+        test = SkippingTest("test_that_is_decorated_with_skipIf")
+        test.run(result)
+        self.assertEqual(1, len(result.errors))
+
+
+    def test_skipUnless_decorator(self):
+        class SkippingTest(TestCase):
+            @skipUnless(False, "skipping this test")
+            def test_that_is_decorated_with_skipUnless(self):
+                self.fail()
+        result = unittest.TestResult()
+        test = SkippingTest("test_that_is_decorated_with_skipUnless")
+        test.run(result)
+        self.assertEqual(1, len(result.errors))
+
 
 def test_suite():
     from unittest import TestLoader