python - 在 Python 中对不同函数重用单元测试的良好实践

Question

我是单元测试的新手，想从 nose framework 开始.但使用 unittest 回答, pytest也欢迎。当然，还有一般性建议。

我想我已经掌握了基本概念，但我缺乏设置良好测试的实践。我也在为如何布置测试而苦恼。 我特别不确定如何处理我想在模块的不同功能上运行几个测试用例的情况:

例如:我可能有一个名为diceroller.py 的模块，它包含一些模拟掷骰子、修改和测试结果等功能。掷骰子的所有函数都应该通过相同的测试运行(它们是否返回整数列表、具有正确数量的值、值是否在范围内等)。但其中一些也应该针对一些额外的案例运行。

所以我得到了一个子目录 test 并且想在那里设置我的测试代码。我该如何处理？

# a section of `diceroller.py`

def roll_a_dice(sides=6):
  """Return an integer x where `x >= 1 <= sides`"""
  return random.randint(1, sides)

def roll_dice(sides=6, count=1):
  """Return a list of integers (most function except this)"""
  rolls = list()
  while count:
    rolls.append(random.randint(1, sides))
    count -= 1
  return rolls

def roll_some_dice(sides=6, count=1, times=1):
  """Return a list of list containing integers"""
  some_rolls = list()
  while times:
    some_rolls.append(roll_dice(sides, count))
    times -= 1
  return some_rolls

def rolling_dice(sides=6, count=1):
  """Yielding integers `count` times"""
  while count:
    count -= 1
    yield random.randint(1, sides)

小更新

Simeon Visser 的观点很好。但是上面的代码也为我的问题添加了一些上下文，这就是:我如何(重新)在不同的函数上使用测试用例？

我想编写像 check_xyz 这样的测试，然后从 test_a 和 test_b 调用它，是最简单的解决方案吗？或者这是不好的做法？

Rik Poggi 的解决方案似乎完全符合预期的目的(在输入此内容后会立即使用它)。但我有点觉得它使事情“复杂化”了很多......可能不是在技术方面，但它可能“太多了”。

Answer 1

我不会解决您要测试的示例代码明显存在的问题。我将重点关注您关于重用测试代码的问题。

开始之前要牢记的重要事项:

1. 测试必须简单(内部没有任何逻辑，或者非常非常少)。
2. 测试应该是可读的(它们就像代码文档)。
3. 测试应该是可维护的。

测试的简单性是必须的，在保持这一点的同时，您需要在最后两点之间找到正确的平衡。

最后一个警告:重用您的测试代码时要非常非常小心，因为如果您做错了，您的测试就会出现错误。测试错误很难发现，但一年后您可能会发现一个，怀疑的种子就会埋下，对您的测试的信任度可能会降低。您不信任的测试(“哦，那个失败了，但没关系，因为另一个也失败了，等等……”)完全没有值(value)。

---

既然我们扫清了障碍，让我们看看您的代码。通常，测试的动态部分是通过上下文(setUp 和 tearDown 方法)实现的，但在您的情况下，事情要复杂一些。

I want to run a couple of test cases on different function of a module.

您实际上并不希望相同 测试用例以不同的功能运行，而只是希望使用相同的代码。一个好的测试环境将(至少)为每个功能提供一个测试用例。

由于您正在寻找针对另一个函数的部分输出运行先前测试用例/套件的能力，因此您需要 functools.partial这将使您可以使用默认参数包装您的函数。

这意味着你应该从底部开始，从最简单的测试开始:

def check_valid_range(value, sides):
    """Check that value is a valid dice rolling"""
    assert 0 < value <= sides

def check_is_int(value):
    """Check that value is an integer"""
    assert type(value) is int

然后在它们之上构建(具有一点可插性):

class TestRollADice:
   """roll_a_dice basic tests"""

    @staticmethod
    def func_to_test(*args, **kwargs):
        return diceroller.roll_a_dice(*args, **kwargs)

    @staticmethod    
    def check_valid_output(value, sides):
        """Check that value is the self.function is valid"""
        yield check_valid_range, value, sides
        yield check_is_int, value

    def test_3sides(self):
        """Check valid result for a 3 sides dice"""
        yield self.check_valid_output, self.func_to_test(3), 3

    def test_list_valid_sides(self):
        """Check valid result for a list of valid sides (sides >= 3)"""
        sides = list(range(3, 13))
        for s in sides:
            yield self.check_valid_output, self.func_to_test(s), s

    def test_0_sides_raises_ValueError(self):
        """0 side dice raise ValueError"""
        assert_raises(ValueError, self.func_to_test, 0)

    def test_1_sides_raises_ValueError(self):
        """1 side dice raise ValueError"""
        assert_raises(ValueError, self.func_to_test, 1)

    def test_2_sides_raises_ValueError(self):
        """2 sides dice raise ValueError"""
        assert_raises(ValueError, self.func_to_test, 2)

    def test_minus1_sides_raises_ValueError(self):
        """-1 side dice raise ValueError"""
        assert_raises(ValueError, self.func_to_test, -1)

这些是您的roll_a_dice 函数应该进行的最少测试。尝试在你的包中运行 nosetests，你会看到其中两个失败，看看测试是多么重要!! :)

我相信您已经注意到测试名称是多么冗长，这是为了提高可读性。

现在对于 roll_dice 主测试类应该测试这三个、四个基本值和基本错误，因为好的应该是简单的并且控制正在测试的内容，我会说您可能需要一些功能，例如:

def check_list_length(self, lst, count):
    """Check that the len(lst) == count"""
    assert len(lst) == count

def check_valid_count(self, count):
    """Check count > 0"""
    assert count > 0

class TestRollDice:
    # ...

现在如果你想重用旧代码，你可以子类化 TestRollADice:

from functools import partial

class TestRollDice_Count1(TestRollADice):

    @staticmethod
    def func_to_test(*args, **kwargs):
        return partial(diceroller.roll_dice, count=1)(*args, **kwargs) 

瞧，几乎是免费的，你将有两倍于以前的测试:)

注意:

1. 上面的所有代码都可以用 unittest 语言编写，但是既然你问了关于 nose 的问题，我就用它来写了。
2. 有一个小问题:通过测试的文档字符串是相同的，所以在详细的输出中它们出现了两次。这不是一个大问题，因为如果其中一个测试失败，系统会提示您输入测试地址，并且该地址是唯一的(而且很清楚，幸运的是我们的测试名称很冗长)。我似乎还记得文档字符串可能被禁用或类似的东西。因此，再次重申，这不是什么大问题，如果需要的话，应该很容易找到解决方法。