Merge lp:~julian+/testscenarios/testscenarios into lp:~testtools-committers/testscenarios/trunk

[Julian Berman]

Add with_scenarios, a (class) decorator to create individual test methods out of test scenarios.

[lp:~julian+/testscenarios/testscenarios]

23. By Julian Berman <email address hidden> on 2015-01-08

Use setuptools and declare the testtools dependency.

24. By Julian Berman <email address hidden> on 2015-02-19

Use dir directly to avoid inspect.getmembers issues on python2.6

[John Vandenberg (jayvdb)]

the setup.py patch means this doesnt merge nicely on top of the latest released version 4.0.

I initially used @with_scenarios on a TestCase that subclassed TestWithScenarios, which works but causes all tests to be done many times. It would be good to cause an error when cls is a subclass of TestWithScenarios.

review: Needs Fixing

[Robert Collins (lifeless)]

Hi, sorry for the disruption, but I've finally moved testscenarios to github: https://github.com/testing-cabal/testscenarios/

@jayvdb if you're interested in this patch, perhaps you could turn it into a PR on github?

Unmerged revisions

24. By Julian Berman <email address hidden> on 2015-02-19

Use dir directly to avoid inspect.getmembers issues on python2.6

23. By Julian Berman <email address hidden> on 2015-01-08

Use setuptools and declare the testtools dependency.

22. By Julian Berman <email address hidden> on 2013-08-27

Add with_scenarios, generating test methods for each scenario.

=== modified file 'lib/testscenarios/__init__.py'
--- lib/testscenarios/__init__.py	2012-04-04 10:46:52 +0000
+++ lib/testscenarios/__init__.py	2015-02-19 17:21:31 +0000
@@ -49,6 +49,7 @@
     'load_tests_apply_scenarios',
     'multiply_scenarios',
     'per_module_scenarios',
+    'with_scenarios',
     ]
 
 
@@ -60,6 +61,7 @@
     load_tests_apply_scenarios,
     multiply_scenarios,
     per_module_scenarios,
+    with_scenarios,
     )
 from testscenarios.testcase import TestWithScenarios, WithScenarios
 

=== modified file 'lib/testscenarios/scenarios.py'
--- lib/testscenarios/scenarios.py	2012-04-04 10:02:46 +0000
+++ lib/testscenarios/scenarios.py	2015-02-19 17:21:31 +0000
@@ -23,10 +23,13 @@
     'multiply_scenarios',
     ]
 
+from functools import wraps
 from itertools import (
     chain,
     product,
     )
+from operator import methodcaller
+import inspect
 import sys
 import unittest
 
@@ -164,3 +167,52 @@
             short_name, 
             {attribute_name: mod}))
     return scenarios
+
+
+def with_scenarios(prefix="test"):
+    """Mutate the decorated TestCase, producing methods for each scenario.
+
+    :param str prefix: the prefix to match for test methods
+
+    """
+    def _populate_scenarios(cls):
+        scenarios = getattr(cls, "scenarios", None)
+        if scenarios is None:
+            return cls
+
+        tests = [
+            (name, getattr(cls, name, None))
+            for name in dir(cls) if name.startswith(prefix)
+        ]
+
+        for name, test in tests:
+            # Sometimes dir lies, which we caught by using None above
+            if test is None:
+                continue
+
+            delattr(cls, name)
+            for scenario_name, scenario_params in scenarios:
+                _test = _make_test(name, test, scenario_name, scenario_params)
+                setattr(cls, _test.__name__, _test)
+        return cls
+    return _populate_scenarios
+
+
+def _make_test(name, test, scenario_name, scenario_params):
+    """Create a test that wraps the given test under the given scenario.
+
+    :param str name: the name of the test
+    :param callable test: the test method
+    :param str scenario_name: the scenario
+    :param dict scenario_params: the scenario's parameters
+
+    """
+
+    @wraps(test)
+    def _test(self, *args, **kwargs):
+        for k, v in scenario_params.iteritems():
+            setattr(self, k, v)
+        return test(self, *args, **kwargs)
+
+    _test.__name__ = "%s_%s" % (name, scenario_name)
+    return _test

=== modified file 'lib/testscenarios/tests/test_scenarios.py'
--- lib/testscenarios/tests/test_scenarios.py	2012-04-04 10:02:46 +0000
+++ lib/testscenarios/tests/test_scenarios.py	2015-02-19 17:21:31 +0000
@@ -24,6 +24,7 @@
     generate_scenarios,
     load_tests_apply_scenarios,
     multiply_scenarios,
+    with_scenarios,
     )
 import testtools
 from testtools.tests.helpers import LoggingResult
@@ -259,3 +260,63 @@
             ('unittest', {'the_module': unittest}),
             ('nonexistent', {'the_module': None}),
             ])
+
+
+class TestWithScenariosDecorator(testtools.TestCase):
+    def test_with_scenarios(self):
+        @with_scenarios()
+        class TestFoo(object):
+            scenarios = [
+                ("first", {"a" : 1}),
+                ("second", {"a" : 2}),
+            ]
+
+            def test_bar(self):
+                if self.a == 2:
+                    raise ImportError("Yup, it's 2")
+
+            def test_baz(self):
+                if self.a == 1:
+                    raise ImportError("Yup, it's 1")
+
+        self.assertEqual(
+            sorted(name for name in dir(TestFoo) if name.startswith("test")),
+            [
+                "test_bar_first",
+                "test_bar_second",
+                "test_baz_first",
+                "test_baz_second",
+            ],
+        )
+
+        TestFoo().test_bar_first()
+        TestFoo().test_baz_second()
+
+        self.assertRaises(ImportError, TestFoo().test_bar_second)
+        self.assertRaises(ImportError, TestFoo().test_baz_first)
+
+    def test_with_scenarios_prefix(self):
+        @with_scenarios(prefix="test_")
+        class TestFoo(object):
+            scenarios = [("a", {})]
+            def testBar(self):
+                pass
+
+            def test_foo(self):
+                pass
+
+        self.assertEqual(
+            sorted(name for name in dir(TestFoo) if name.startswith("test")),
+            ["testBar", "test_foo_a"],
+        )
+
+    def test_with_scenarios_no_scenarios(self):
+        @with_scenarios()
+        class TestFoo(object):
+            def test_bar(self):
+                pass
+
+        self.assertEqual(
+            sorted(name for name in dir(TestFoo) if name.startswith("test")),
+            ["test_bar"],
+        )

=== modified file 'lib/testscenarios/tests/test_testcase.py'
--- lib/testscenarios/tests/test_testcase.py	2012-04-04 10:45:22 +0000
+++ lib/testscenarios/tests/test_testcase.py	2015-02-19 17:21:31 +0000
@@ -21,7 +21,7 @@
 from testtools.tests.helpers import LoggingResult
 
 
-class TestTestWithScenarios(testtools.TestCase):
+class TestTestWithScenarios(testscenarios.WithScenarios, testtools.TestCase):
 
     scenarios = testscenarios.scenarios.per_module_scenarios(
         'impl', (('unittest', 'unittest'), ('unittest2', 'unittest2')))

=== modified file 'setup.py'
--- setup.py	2012-04-04 10:46:52 +0000
+++ setup.py	2015-02-19 17:21:31 +0000
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-from distutils.core import setup
+from setuptools import setup
 import os.path
 
 description = file(os.path.join(os.path.dirname(__file__), 'README'), 'rb').read()
@@ -12,6 +12,7 @@
       maintainer="Robert Collins",
       maintainer_email="[e-mail]",
       url="https://launchpad.net/testscenarios",
+      install_requires=["testtools"],
       packages=['testscenarios', 'testscenarios.tests'],
       package_dir = {'':'lib'},
       classifiers = [