Python unittest框架：测试说明

Question

在python中提供测试脚本描述的最佳实践是什么？

显然，我可以将注释放在测试用例的下面，但想知道是否有任何标准实践（我应该写任何方法）来提供测试用例的描述（有关测试用例应做的详细信息）？

这是您放置测试说明的方式吗？：

Class TestFoo:
    def testfoo1():
    """
    test description:
    step1:
    step2: 
    """

任何建议/参考将不胜感激。

Answer 1

在unittest框架中，您可以使用以下 shortDecription方法：

shortDescription()

返回测试的描述，或者None没有提供描述。此方法的默认实现返回测试方法的文档字符串的第一行（如果有）。

因此，实际上，使用docstring方法是一个很好的地方。不过，您可能必须从TestCase类声明中继承，以便运行程序能够像这样运行。

对于最佳实践：命名测试用例（类），并在测试方法简洁而实用的时尚，这足以为开发具有地方事情错了高水平的想法，应该是特定的测试失败。这样做的先决条件是每种测试方法只能测试一件事，而不是对一堆不同的东西进行断言。

对于明智的测试名称，通常不需要带有“有关测试用例应该做什么的详细信息”的文档字符串。如果您有现有的大型测试可以检查很多事情，则可能需要将它们拆分为一堆较小的测试，每个测试都仅针对一个单独的事物进行断言。

Answer 2

如果使用的是python unittest模块，则测试方法docstring是放置该信息的标准位置。 unittest将使用该文档字符串格式化输出等。