【python】自动化测试框架--unittest

一、简介

unittest 单元测试框架是受到 JUnit 的启发，与其他语言中的主流单元测试框架有着相似的风格。其支持测试自动化，配置共享和关机代码测试。支持将测试样例聚合到测试集中，并将测试与报告框架独立。

unittest中文文档

术语：

• 测试脚手架
  test fixture 表示为了开展一项或多项测试所需要进行的准备工作，以及所有相关的清理操作。举个例子，这可能包含创建临时或代理的数据库、目录，再或者启动一个服务器进程。

• 测试用例
  一个测试用例是一个独立的测试单元。它检查输入特定的数据时的响应。 unittest 提供一个基类： TestCase ，用于新建测试用例。

• 测试套件
  test suite 是一系列的测试用例，或测试套件，或两者皆有。它用于归档需要一起执行的测试。

• 测试运行器（test runner）
  test runner 是一个用于执行和输出测试结果的组件。这个运行器可能使用图形接口、文本接口，或返回一个特定的值表示运行测试的结果。

二、使用教程

2.1、简单的单元测试用例示例

import unittest

class MyTest(unittest.TestCase):
	def setUp(self):
		print("this is setUp")

	def test_func(self):
		print("this is test_func")
		self.assertTrue("HEELO".isupper())

	def tearDown(self):
		print("this is tearDown")

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

继承 unittest.TestCase 就创建了一个测试样例。类方法的命名都以 test 开头， 这个命名约定告诉测试运行者类的哪些方法表示测试。

通过 setUp() 和 tearDown() 方法，可以设置测试开始前与完成后需要执行的指令。

最后的代码块中，演示了运行测试的一个简单的方法。 unittest.main() 提供了一个测试脚本的命令行接口。当在命令行运行该测试脚本，上文的脚本生成如以下格式的输出:

2.2、测试分组，自定义测试套件TestSuite

根据用例所测试的功能将测试用 TestCase 分组。unittest 为此提供了 test suite：unittest 的 TestSuite 类是一个代表。通常情况下，调用 unittest.main() 就能正确地找到并执行这个模块下所有用 TestCase 分组的测试。

然而，如果你需要自定义你的测试套件的话，你可以参考以下方法组织你的测试：
test_001.py

import unittest

class MyTest(unittest.TestCase):
	def setUp(self):
		print("this is setUp")

	def test_func1(self):
		print("this is test_func1")
		self.assertTrue("HELLO".isupper())

	def test_func2(self):
		print("this is test_func2")
		self.assertTrue("HELLO".isupper())

	def tearDown(self):
		print("this is tearDown")

def suite():
    suite = unittest.TestSuite()
    suite.addTest(MyTest('test_func1'))
    suite.addTest(MyTest('test_func2'))
    return suite

if __name__ == '__main__':
    runner = unittest.TextTestRunner()
    runner.run(suite())

执行test_001.py，结果如下

2.3、加载和运行测试TestLoader

TestLoader 类可被用来基于类和模块创建测试套件。 通常，没有必要创建该类的实例；unittest 模块提供了一个可作为 unittest.defaultTestLoader 共享的实例。 但是，使用子类或实例允许对某些配置属性进行定制。

2.3.1、discover单层目录

test_run_001.py代码示例

import unittest

class MyTest_001(unittest.TestCase):
	def setUp(self):
		print("this is setUp")

	def test_func(self):
		print("this is test_func1")
		self.assertTrue("HELLO".isupper())


	def tearDown(self):
		print("this is tearDown")

single_run.py代码示例

import unittest

if __name__ == "__main__":
	test_dir = './testcase_single'
	discover = unittest.defaultTestLoader.discover(start_dir=test_dir, pattern="test*.py")

	runner = unittest.TextTestRunner(verbosity=2)
	runner.run(discover)

verbosity参数可以控制输出的错误报告的详细程度：

• 0 (quiet): 只显示执行的用例的总数和全局的执行结果。
• 1 (default): 默认值，显示执行的用例的总数和全局的执行结果，并对每个用例的执行结果（成功 T 或失败 F）有个标注。
• 2 (verbose): 显示执行的用例的总数和全局的执行结果，并输出每个用例的详细的执行结果。

执行single_run.py，则会执行testcase_single路径下所有的test开头的py文件

2.3.2、discover多层目录

通过从指定的开始目录向其子目录递归来找出所有测试模块，并返回一个包含该结果的 TestSuite 对象。 只有与 pattern 匹配的测试文件才会被加载。 （使用 shell 风格的模式匹配。） 只有可导入的模块名称（即有效的 Python 标识符）将会被加载。

如果需要引入多层目录下的测试用例，需要满足Python package格式放置用例，如下所示，需要引入__init__.py文件

run.py

import unittest

if __name__ == "__main__":
	test_dir = './testcase'
	discover = unittest.defaultTestLoader.discover(start_dir=test_dir, pattern="test*.py")

	runner = unittest.TextTestRunner(verbosity=2)
	runner.run(discover)

testcase层级下的__init__.py示例

Test_001/Test_002用例层级下的__init__.py用空文件即可

执行run.py，调用指定目录下的所有用例，执行结果如下所示：

2.3、结合HTMLTestRunner，生成测试报告

测试报告如下所示：

run.py代码如下，执行run.py即可：

import os
import time
import unittest
from HTMLTestRunner import HTMLTestRunner

if __name__ == "__main__":
	test_dir = './testcase'
	discover = unittest.defaultTestLoader.discover(start_dir=test_dir, pattern="test*.py")

	report_dir = './test_report'
	os.makedirs(report_dir, exist_ok=True)
	now = time.strftime("%Y-%m-%d %H-%M-%S")
	report_name = '{0}/{1}.html'.format(report_dir, now)

	with open(report_name, 'wb')as f:
		runner = HTMLTestRunner(stream=f, title="测试报告", description="本测试报告是unittest单元测试结果")
		runner.run(discover)

注意事项：HTMLTestRunner不能用pip安装，可以把文件放到python安装包的lib目录下，或者发在run.py同级目录下

HTMLTestRunner.py下载路径