UnitTest各属性组件的简要说明

lin0214hui

于 2024-08-21 16:23:32 发布

阅读量771

点赞数 11

文章标签： unit testing

本文链接：https://blog.csdn.net/lin0214hui/article/details/141395499

版权

unittest 是 Python 的标准单元测试框架，提供了一系列的类和函数来支持测试的编写、组织和执行。以下是您提供的 unittest 属性列表中一些主要组件的简要说明：

TestCase: 这是所有测试用例类的基类。您可以通过继承这个类并添加测试方法来创建自己的测试用例。
TestSuite: 用于组织多个测试用例或测试套件。您可以使用它来收集并运行一组测试。
- 使用 TestSuite 可以同时运行多个测试用例或测试套件，这对于构建需要执行大量测试的复杂测试场景非常有用。以下是 TestSuite 的一些关键用法和作用：
  
  创建 TestSuite 实例
  
  您可以创建一个 TestSuite 的实例，然后逐步向其中添加测试用例。
```
python

import unittest 

test1 = unittest.TestCase('test_method1') 
test2 = unittest.TestCase('test_method2') 
suite = unittest.TestSuite([test1, test2])
```
  添加测试用例
  
  您可以使用 addTest() 方法将单个测试用例添加到测试套件中。
```
suite.addTest(test1)
```
  添加其他 TestSuite
  
  如果存在嵌套的测试套件，您可以使用 addTests() 方法将它们添加到当前测试套件中。
```
another_suite = unittest.TestSuite([test3, test4])
suite.addTests(another_suite)
```
  运行 TestSuite
  
  要运行 TestSuite 中的测试，您需要一个测试运行器（TestRunner）。unittest 默认的 TextTestRunner 可以在控制台中输出测试结果。
```
unittest.TextTestRunner().run(suite)
```
  自动发现测试
  
  TestLoader 可以帮助您自动发现并添加测试用例到 TestSuite。您可以指定要搜索测试用例的模块或类。
```
loader = unittest.TestLoader()
suite = loader.loadTestsFromTestCase(YourTestCaseClass)
```
  使用 TestSuite 组织测试
  
  TestSuite 不仅可以包含单个测试用例，还可以包含其他 TestSuite 实例，这使得您可以灵活地组织和分组测试。
```
suite1 = unittest.TestSuite()
suite2 = unittest.TestSuite()
# 添加单个测试用例或测试套件
suite1.addTest(test1)
suite2.addTests(loader.loadTestsFromTestCase(AnotherTestCaseClass))
# 将两个套件组合到一个套件中
final_suite = unittest.TestSuite([suite1, suite2])
```
  处理测试结果
  
  测试完成后，TestSuite 实例会收集所有测试的结果。您可以访问 result 属性来获取测试结果的详细信息。
```
result = suite.run()
print(len(result.failures))  # 打印失败的测试数量
print(len(result.errors))   # 打印出错的测试数量
```
  注意事项
  - TestSuite 本身不负责测试的执行，它只负责组织和存储测试用例。
  - 您可以将不同类型的测试用例和测试套件混合添加到 TestSuite 中。
  - 使用 TestLoader 可以简化测试用例的发现和添加过程，特别是当测试类很多时。
  - 通过使用 TestSuite，您可以构建复杂的测试集合，将多个测试用例和测试套件组合在一起进行执行，从而提高测试的组织性和效率。
TestLoader: 负责发现和加载测试用例。它可以自动发现继承自 TestCase 的子类中以 test 开头的方法。
- TestLoader 能够遍历给定的模块、类或测试用例集合，找出所有符合特定规则的测试方法，并将它们组织成 TestSuite 对象。以下是 TestLoader 的一些关键用法和作用：
  
  创建 TestLoader 实例
  
  TestLoader 类可以创建实例，但通常使用其类方法。
```
loader = unittest.TestLoader()
```
  加载测试用例
  
  TestLoader 提供了几种方法来加载测试用例：
- loadTestsFromTestCase(): 从指定的 TestCase 子类中加载所有测试方法。
- ```
suite = loader.loadTestsFromTestCase(YourTestCaseClass)
```
- loadTestsFromModule(): 从指定的模块中加载所有测试用例。
- ```
suite = loader.loadTestsFromModule(your_module)
```
- loadTestsFromName(): 从指定的测试名称字符串中加载测试用例。这可以是类名、模块名或包含测试用例的表达式。
- ```
suite = loader.loadTestsFromName('module.ClassName')
```
- loadTestsFromNames(): 从多个名称字符串列表中加载测试用例。
- ```
names = ['module.ClassName.test_method1', 'module.ClassName.test_method2']
suite = loader.loadTestsFromNames(names, your_module)
```
  自动发现测试方法
  
  TestLoader 可以自动发现继承自 unittest.TestCase 的类中所有以 test 开头的方法作为测试用例。
  
  测试选择器
  
  TestLoader 还具有测试选择器的功能，允许您根据模式选择测试用例：
  - getTestCaseNames(): 获取特定测试用例类中所有测试方法的名称列表。
```
test_case_names = loader.getTestCaseNames(YourTestCaseClass)
```
这个方法接受一个测试用例类和一个可选的筛选模式，如果提供模式，则只有匹配该模式的测试方法名称会被返回。

测试套件构建

使用 TestLoader 加载的测试用例可以构建成 TestSuite 对象，然后由测试运行器执行。
```
suite = unittest.TestSuite()
suite.addTests(loader.loadTestsFromTestCase(YourTestCaseClass))
runner = unittest.TextTestRunner()
runner.run(suite)
```
使用 TestLoader 的好处
- 自动化: 自动发现和加载测试用例，减少手动添加的繁琐。
- 灵活性: 支持从模块、类或方法名称加载测试用例。
- 组织性: 可以轻松地构建包含多个测试用例的测试套件。
注意事项
- TestLoader 默认加载所有以 test 开头的公共方法作为测试用例。
- 如果需要加载具有特定模式的测试方法，可以在 getTestCaseNames() 中使用正则表达式。
- 可以通过继承 TestLoader 类并重写其方法来自定义测试用例的发现和加载逻辑。
- TestLoader 是 unittest 框架中一个非常有用的工具，它使得测试的组织和执行更加方便和自动化。

TextTestRunner: 默认的测试运行器，用于运行测试套件并在控制台输出结果。

以下是 TextTestRunner 的详细说明：

基本用法

创建 TextTestRunner 实例：您可以创建 TextTestRunner 的实例，并传递一些选项以自定义其行为。

运行测试：使用 TextTestRunner 实例的 run() 方法来运行 TestSuite 或 TestCase。
import unittest

class MyTestCase(unittest.TestCase):
    def test_example(self):
        self.assertEqual(1, 1)

if __name__ == '__main__':
    suite = unittest.TestLoader().loadTestsFromTestCase(MyTestCase)
    runner = unittest.TextTestRunner()
    runner.run(suite)
自定义选项

TextTestRunner 接受一些关键字参数，用于自定义输出格式和行为：

verbosity: 控制输出的详细程度。级别可以是 1、2 或 3，级别越高，输出的信息越详细。

stream: 指定输出流，默认为 sys.stderr。您可以将其设置为其他文件对象或 sys.stdout。

descriptions: 布尔值，决定是否在测试运行时打印测试描述。

failfast: 布尔值，如果设置为 True，一旦测试失败，将立即停止执行剩余测试。

buffer: 布尔值，如果设置为 True，则将输出缓冲到 stream 对象。

resultclass: 允许指定一个自定义的 TestResult 类，以自定义测试结果的收集方式。

示例：使用自定义选项
runner = unittest.TextTestRunner(verbosity=2, failfast=True, buffer=False)
runner.run(suite)
输出格式

TextTestRunner 的输出包括：

测试开始：显示开始运行测试的提示。
测试结果：每个测试方法的执行结果，包括成功、失败或错误。
失败详情：失败测试的错误信息和堆栈跟踪。
总结：测试运行结束后，显示成功、失败和错误的数量。

注意事项

TextTestRunner 是 unittest 默认的测试运行器，如果您没有指定测试运行器，它将自动使用 TextTestRunner。
如果您需要更高级的测试报告，可以考虑使用第三方库，如 HtmlTestRunner 或 Allure。
TextTestRunner 的输出可以很容易地集成到持续集成/持续部署（CI/CD）流程中。

TextTestRunner 提供了一个简单而有效的方式来在控制台中运行和查看测试结果，是进行单元测试和快速反馈的有用工具。

TestResult: 收集测试执行结果的类。它可以被 TestRunner 使用来收集信息并报告测试结果。
TextTestResult: TextTestRunner 使用的 TestResult 类的实现，用于在控制台输出文本格式的测试结果。
TestProgram: 用于启动测试运行器的类。它处理命令行参数并初始化测试运行器。
main(): 一个方便的函数，用于从命令行启动测试。它可以作为脚本的入口点。
installHandler(), removeHandler(), registerResult(), removeResult(): 这些函数用于管理信号和结果的注册，它们通常在测试框架的内部使用。
skip(), skipIf(), skipUnless(): 这些装饰器用于标记测试用例，当满足特定条件时跳过测试。
expectedFailure(): 一个装饰器，用于标记已知失败的测试，即使测试失败也不会使测试套件失败。
defaultTestLoader: 默认的 TestLoader 实例，用于加载和发现测试。
findTestCases(): 一个函数，用于在指定的模块或类中查找测试用例。
getTestCaseNames(): 一个方法，用于获取测试用例类中所有测试方法的名字。
makeSuite(): 一个函数，用于根据测试用例的名字创建一个 TestSuite 对象。
suite: 一个变量，通常用于存储当前的测试套件。
case: 一个变量，通常用于引用 TestCase 类。
runner: 一个变量，通常用于引用 TestRunner 对象。
result: 一个变量，用于存储测试结果。
__unittest__: 是一个专门为 unittest 框架设计的内部模块，包含 unittest 扩展功能的实现，一些私有类和函数，这些通常不推荐在测试代码中直接使用。。
__all__: 一个列表，包含模块中所有公开的属性名称。
__builtins__, __doc__, __file__, __name__, __package__, __path__: 这些是 Python 模块的内置属性，提供有关模块的信息。
- __builtins__
- 包含一个字典，该字典引用了Python内置函数和变量。
- 它允许您访问所有内置函数和异常，例如：__builtins__.open 或 __builtins__.Exception。
- 这在编写需要与内置命名空间交互的元编程或框架时非常有用。
- __doc__
- 包含模块的文档字符串（docstring），这是一个多行字符串，通常位于模块的开头，用于描述模块的功能。
- 可以通过 __doc__ 属性获取模块的文档，例如：print(mymodule.__doc__)。
- __file__
- 包含模块文件的路径，即模块的源代码文件的完整路径。
- 如果模块是编译的，它可能指向 .pyc 文件或原始 .py 文件。
- 这个属性常用于确定模块的位置或用于加载资源文件。
- __name__
- 包含模块的名称。
- 当模块被直接运行时（不是被导入），__name__ 将被设置为 "__main__"。
- 这常用于区分模块是作为脚本运行还是被导入。
- __package__
- 包含模块所在的包的名称，如果模块不在任何包中，它可能是空字符串或 None。
- 这个属性在包的内部模块中很有用，用于确定包的层次结构。
- 如果模块是一个包，__path__ 将是一个包含包路径的列表。
- 对于普通模块，这个属性可能不存在或未定义。
- 这在需要遍历包内所有模块或子包时很有用。
- 示例代码
  python
  
  # 假设我们有一个名为 mymodule 的模块 # 打印模块的文档字符串 print(mymodule.__doc__) # 打印模块的文件路径 print(mymodule.__file__) # 打印模块的名称 print(mymodule.__name__) # 如果 mymodule 是一个包，打印包的路径 if hasattr(mymodule, '__path__'): print(mymodule.__path__) # 访问内置函数 print(__builtins__.sum([1, 2, 3]))
  
  注意事项
- 这些属性是特殊的，由Python解释器在模块初始化时自动设置。
- 它们提供了关于模块和Python环境的元数据，对于编写自省代码、插件系统或框架非常有用。
- 在编写代码时，应谨慎使用这些属性，因为它们可能会使代码依赖于特定的模块结构或环境。
- 通过这些属性，您可以获取有关当前模块和Python环境的重要信息，这有助于编写更灵活和可维护的代码。
  
  __path__

这些组件共同构成了 unittest 框架的基础，使得编写和组织单元测试变得简单和高效。通过继承 TestCase 类并使用断言方法，您可以创建测试用例来验证代码的正确性。使用 TestLoader 和 TestRunner，您可以加载和执行测试用例，并通过 TestResult 收集测试结果。此外，skip 装饰器和 expectedFailure 装饰器提供了额外的灵活性来处理特殊情况。