编写可重用（参数化）的unittest.TestCase方法

Question

可能的重复：
如何在 python 中生成动态（参数化）单元测试？

我正在使用 unittest 包编写测试，并且我想避免重复的代码。我将进行一系列测试，这些测试都需要非常相似的方法，但每次只有一个值不同。一个简单且无用的例子是：

class ExampleTestCase(unittest.TestCase):

    def test_1(self):
        self.assertEqual(self.somevalue, 1)

    def test_2(self):
        self.assertEqual(self.somevalue, 2)

    def test_3(self):
        self.assertEqual(self.somevalue, 3)

    def test_4(self):
        self.assertEqual(self.somevalue, 4)

有没有一种方法可以编写上面的示例，而不必每次都重复所有代码，而是编写一个通用方法，例如

    def test_n(self, n):
        self.assertEqual(self.somevalue, n)

并告诉 unittest 使用不同的输入尝试此测试？

Answer 1

可用于在 Python 中进行参数化测试的一些工具包括：

• Nose 测试生成器（仅适用于功能测试，不适用于 TestCase 类）
• nose-parametrized 作者：David Wolever（也适用于 TestCase 类）
• Unittest 模板，作者：Boris Feld
• py.test 中的参数化测试
• 参数化测试用例 作者：Austin Bingham
• DDT（数据驱动测试），作者：Carles Barrobés，用于单元测试

Answer 2

如果你真的想要多个单元测试，那么你需要多种方法。实现这一点的唯一方法是通过某种代码生成。您可以通过元类或在定义后调整类来做到这一点，包括（如果您使用的是 Python 2.6）通过类装饰器。

这是一个解决方案，它查找特殊的“multitest”和“multitest_values”成员，并使用它们来动态构建测试方法。不优雅，但它大致达到了您想要的效果：

import unittest
import inspect

class SomeValue(object):
    def __eq__(self, other):
        return other in [1, 3, 4]

class ExampleTestCase(unittest.TestCase):
    somevalue = SomeValue()

    multitest_values = [1, 2, 3, 4]
    def multitest(self, n):
        self.assertEqual(self.somevalue, n)

    multitest_gt_values = "ABCDEF"
    def multitest_gt(self, c):
        self.assertTrue(c > "B", c)


def add_test_cases(cls):
    values = {}
    functions = {}
    # Find all the 'multitest*' functions and
    # matching list of test values.
    for key, value in inspect.getmembers(cls):
        if key.startswith("multitest"):
            if key.endswith("_values"):
                values[key[:-7]] = value
            else:
                functions[key] = value

    # Put them together to make a list of new test functions.
    # One test function for each value
    for key in functions:
        if key in values:
            function = functions[key]
            for i, value in enumerate(values[key]):
                def test_function(self, function=function, value=value):
                    function(self, value)
                name ="test%s_%d" % (key[9:], i+1)
                test_function.__name__ = name
                setattr(cls, name, test_function)

add_test_cases(ExampleTestCase)

if __name__ == "__main__":
    unittest.main()

这是我运行它时的输出

% python stackoverflow.py
.F..FF....
======================================================================
FAIL: test_2 (__main__.ExampleTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "stackoverflow.py", line 34, in test_function
    function(self, value)
  File "stackoverflow.py", line 13, in multitest
    self.assertEqual(self.somevalue, n)
AssertionError: <__main__.SomeValue object at 0xd9870> != 2

======================================================================
FAIL: test_gt_1 (__main__.ExampleTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "stackoverflow.py", line 34, in test_function
    function(self, value)
  File "stackoverflow.py", line 17, in multitest_gt
    self.assertTrue(c > "B", c)
AssertionError: A

======================================================================
FAIL: test_gt_2 (__main__.ExampleTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "stackoverflow.py", line 34, in test_function
    function(self, value)
  File "stackoverflow.py", line 17, in multitest_gt
    self.assertTrue(c > "B", c)
AssertionError: B

----------------------------------------------------------------------
Ran 10 tests in 0.001s

FAILED (failures=3)

您可以立即看到代码生成时出现的一些问题。 “test_gt_1”来自哪里？我可以将名称更改为更长的“test_multitest_gt_1”，但哪个测试是 1？最好从 _0 而不是 _1 开始，也许在您的情况下您知道这些值可以用作 Python 函数名称。

我不喜欢这种方法。我研究过自动生成测试方法的代码库（在一种情况下使用元类），发现它比有用的更难理解。当测试失败时，很难找出失败案例的根源，也很难坚持调试代码来探究失败的原因。

（我在这里编写的示例中的调试失败并不像我必须使用的特定元类方法那么难。）

Answer 3

我猜你想要的是“参数化测试”。

我不认为unittest模块支持这个（不幸的是），
但如果我添加此功能，它看起来会像这样：

# Will run the test for all combinations of parameters
@RunTestWith(x=[0, 1, 2, 3], y=[-1, 0, 1])
def testMultiplication(self, x, y):
  self.assertEqual(multiplication.multiply(x, y), x*y)

使用现有的unittest模块，像这样的简单装饰器将无法多次“复制”测试，但我认为使用以下组合是可行的装饰器和元类（元类应该观察所有“test*”方法并复制（在不同的自动生成的名称下）应用了装饰器的方法）。

Answer 4

一种更加以数据为导向的方法可能比 Andrew Dalke 的 答案：

"""Parametrized unit test.

Builds a single TestCase class which tests if its
  `somevalue` method is equal to the numbers 1 through 4.

This is accomplished by
  creating a list (`cases`)
  of dictionaries which contain test specifications
  and then feeding the list to a function which creates a test case class.

When run, the output shows that three of the four cases fail,
  as expected:

>>> import sys
>>> from unittest import TextTestRunner
>>> run_tests(TextTestRunner(stream=sys.stdout, verbosity=9))
... # doctest: +ELLIPSIS
Test if self.somevalue equals 4 ... FAIL
Test if self.somevalue equals 1 ... FAIL
Test if self.somevalue equals 3 ... FAIL
Test if self.somevalue equals 2 ... ok
<BLANKLINE>
======================================================================
FAIL: Test if self.somevalue equals 4
----------------------------------------------------------------------
Traceback (most recent call last):
  ...
AssertionError: 2 != 4
<BLANKLINE>
======================================================================
FAIL: Test if self.somevalue equals 1
----------------------------------------------------------------------
Traceback (most recent call last):
  ...
AssertionError: 2 != 1
<BLANKLINE>
======================================================================
FAIL: Test if self.somevalue equals 3
----------------------------------------------------------------------
Traceback (most recent call last):
  ...
AssertionError: 2 != 3
<BLANKLINE>
----------------------------------------------------------------------
Ran 4 tests in ...s
<BLANKLINE>
FAILED (failures=3)
"""

from unittest import TestCase, TestSuite, defaultTestLoader

cases = [{'name': "somevalue_equals_one",
          'doc': "Test if self.somevalue equals 1",
          'value': 1},
         {'name': "somevalue_equals_two",
          'doc': "Test if self.somevalue equals 2",
          'value': 2},
         {'name': "somevalue_equals_three",
          'doc': "Test if self.somevalue equals 3",
          'value': 3},
         {'name': "somevalue_equals_four",
          'doc': "Test if self.somevalue equals 4",
          'value': 4}]

class BaseTestCase(TestCase):
    def setUp(self):
        self.somevalue = 2

def test_n(self, n):
    self.assertEqual(self.somevalue, n)

def make_parametrized_testcase(class_name, base_classes, test_method, cases):
    def make_parametrized_test_method(name, value, doc=None):
        def method(self):
            return test_method(self, value)
        method.__name__ = "test_" + name
        method.__doc__ = doc
        return (method.__name__, method)

    test_methods = (make_parametrized_test_method(**case) for case in cases)
    class_dict = dict(test_methods)
    return type(class_name, base_classes, class_dict)


TestCase = make_parametrized_testcase('TestOneThroughFour',
                                      (BaseTestCase,),
                                      test_n,
                                      cases)

def make_test_suite():
    load = defaultTestLoader.loadTestsFromTestCase
    return TestSuite(load(TestCase))

def run_tests(runner):
    runner.run(make_test_suite())

if __name__ == '__main__':
    from unittest import TextTestRunner
    run_tests(TextTestRunner(verbosity=9))

我不确定在确定顺序时涉及什么巫毒运行测试，但至少对我来说，文档测试始终通过。

对于更复杂的情况，可以将 cases 字典的 values 元素替换为包含参数列表和关键字参数字典的元组。虽然那时你基本上是在用 python 编写 lisp 代码。

Answer 5

编写一个执行所有测试并捕获所有结果的测试方法，将您自己的诊断消息写入 stderr，并在其任何子测试失败时使测试失败：

def test_with_multiple_parameters(self):
    failed = False
    for k in sorted(self.test_parameters.keys()):
        if not self.my_test(self.test_parameters[k]):
           print >> sys.stderr, "Test {0} failed.".format(k)
           failed = True
    self.assertFalse(failed)            

当然请注意 my_test() 的名称不能以 test 开头。

Answer 6

也许是这样的：

def test_many(self):
    for n in range(0,1000):
        self.assertEqual(self.somevalue, n)