Python Unittest简明教程
1 概述
单元测试框架是一种软件测试方法,通过来测试源代码中的各个单元,例如类,方法等,以确定它们是否符合要求。直观上来说,可以将单元视为最小的可测试部分。单元测试是程序员在开发过程中创建的短代码片段。 它构成了组件测试的基础。
2 unittest
unitest是python内置的用于测试代码的模块,它支持测试自动化,配置共享和关机代码测试。支持将测试样例聚合到测试集中,并将测试与报告框架独立。
为了实现这些,unittest 通过面向对象的方式支持了一些重要的概念。
- 测试脚手架(test fixture):表示为了开展一项或多项测试所需要进行的准备工作,以及所有相关的清理操作。举个例子,这可能包含创建临时或代理的数据库、目录,再或者启动一个服务器进程。
- 测试用例(test case):一个测试用例是一个独立的测试单元。它检查输入特定的数据时的响应。 unittest 提供一个基类:TestCase ,用于新建测试用例。
- 测试套件(test suite): 是一系列的测试用例,或测试套件,或两者皆有。它用于归档需要一起执行的测试。
- 测试运行器(test runner):是一个用于执行和输出测试结果的组件。这个运行器可能使用图形接口、文本接口,或返回一个特定的值表示运行测试的结果。
2.1 创建一个简单的单元测试:
步骤:
- 在程序中导入unittest模块。
- 定义一个需要测试的函数。在下面的例子中,add()函数将会被测试。
- 通过集成类unittest.TestCase创建一个测试用例类。
- 在类中定义一个测试方法,该方法以test作为前缀。
- 每个测试方法中都调用TestCase类的断言方法。里面有多种类型的断言。
- assertEquals()比较把add()函数的结果与第二个参数做比较。如果不想等,会抛出异常assertionError。
- 调用unittest模块中的main方法。
代码:(文件名为unittest01.py)
import unittest
def add(a, b):
return a+b
# 一个类是一个测试用例,测试指类中的测试方法,测试用力中可以有多个测试。
class SimpleTest(unittest.TestCase):
def test_add(self):
self.assertEqual(add(3, 7), 10)
def test_add2(self):
self.assertEqual(add(3, 5), 10)
# __name__是一个全局变量,它的值是模块的名称。该判断语句表示只运行当前文件中的代码。
if __name__ == "__main__":
unittest.main()
结果:
.F
======================================================================
FAIL: test_add2 (__main__.SimpleTest)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/hookind/Desktop/workspace/pythonTest/unittest01.py", line 13, in test_add2
self.assertEqual(add(3, 5), 10)
AssertionError: 8 != 10
----------------------------------------------------------------------
Ran 2 tests in 0.001s
FAILED (failures=1)
2.2 命令行界面:
可以在命令行使用unittest模块运行模块、类和独立测试方法中的测试(这里测试指指测试用例类中的测试方法):
python -m unittest test1
python -m unittest test_module.TestClass
python -m unittest test_module.TestClass.test_method
示例:对于上面的代码,可以通过下面这些命令运行。
python -m unittest unittest01
python3 -m unittest unittest01.SimpleTest
python3 -m unittest unittest01.SimpleTest.test_add
unittest支持一些命令行选项,可以通过下面的命令查看所有选项。
python3 -m unittest -h
3 API
这章只描述unittest模块中的类与方法。
3.1 TestCase类
该类的对象表示最小的可测试单元。
在TestCase类中的一些方法。
编号 | 方法 | 描述 |
---|---|---|
1 | setUp() | 用来准备测试脚手架的方法,在调用测试方法之前,该方法会被立即调用 |
2 | tearDown() | 测试方法被调用后,该方法会被立即调用,并且结果也会被记录。即使测试方法抛出异常,该方法也会被调用 |
3 | setUpClass() | 一个类方法,在类中所有的测试运行前被调用 |
4 | tearDownClass() | 一个类方法,在类中所有的测试运行后被调用 |
脚手架(Fixture)
在测试用例类中,可以有大量的测试。这些方法可能需要初始化数据库连接、临时文件或其它的资源。这些就是脚手架。测试用力需要一些特别的方法配置和清理测试需要的脚手架。为了配置脚手架,覆盖setUp()方法;为了清理,覆盖tearDown()方法。
类脚手架(Class Fixture)
TestCase类有一个setUpClass()方法,该方法可以在TestCase类中的测试执行之前被覆盖以执行。同样,tearDownClass() 方法将在类中的所有测试之后执行。这两种方法都是类方法。因此,它们必须@classmethod注解装饰。
示例:
import unittest
def add(a, b):
return a+b
class SimpleTest(unittest.TestCase):
@classmethod
def setUpClass(cls) -> None:
print("==========setUpClass=========")
return super().setUpClass()
@classmethod
def tearDownClass(cls) -> None:
print("\n==========tearDownClass=========")
return super().tearDownClass()
def setUp(self):
print("\n==========setUp=========")
return super().setUp()
def tearDown(self):
print("==========tearDown========")
return super().tearDown()
def test_add(self):
print("\n执行test_add")
self.assertEqual(add(3, 7), 10)
def test_add2(self):
print("\n执行test_add2")
self.assertEqual(add(3, 5), 10)
# __name__是一个全局变量,它的值是模块的名称。该判断语句表示只运行当前文件中的代码。
if __name__ == "__main__":
unittest.main()
结果:
==========setUpClass=========
==========setUp=========
执行test_add
==========tearDown========
.
==========setUp=========
执行test_add2
==========tearDown========
F
==========tearDownClass=========
======================================================================
FAIL: test_add2 (__main__.SimpleTest)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/hookind/Desktop/workspace/pythonTest/unittest01.py", line 34, in test_add2
self.assertEqual(add(3, 5), 10)
AssertionError: 8 != 10
----------------------------------------------------------------------
Ran 2 tests in 0.001s
FAILED (failures=1)
想了解更多,请参考unittest.TestCase
3.2 TestSuite类
Python 的测试框架提供了一种有用的机制,通过该机制可以根据它们测试的特性将测试用例实例组合在一起。该机制由unittest模块中的TestSuite类提供。
步骤:
- 创建一个TestSuite类的实例。
suite = unittest.TestSuite()
- 把测试(测试用例中的一个测试方法)加入TestSuite实例中。
# 添加测试用例类中的一个测试
suite.addTest(SimpleTest2("test_sub"))
# 添加测试用例类中的所有测试
suite.addTest(unittest.makeSuite(SimpleTest))
- 创建一个TextTestRunner类的对象。
runner = unittest.TextTestRunner()
- 调用run()方法去运行在套件中的测试。
runner.run(suite)
示例:
import unittest
def add(a, b):
return a+b
def sub(a, b):
return a-b
class SimpleTest(unittest.TestCase):
@classmethod
def setUpClass(cls) -> None:
print("==========setUpClass=========")
return super().setUpClass()
@classmethod
def tearDownClass(cls) -> None:
print("\n==========tearDownClass=========")
return super().tearDownClass()
def setUp(self):
print("\n==========setUp=========")
return super().setUp()
def tearDown(self):
print("==========tearDown========")
return super().tearDown()
def test_add(self):
print("\n执行test_add")
self.assertEqual(add(3, 7), 10)
def test_add2(self):
print("\n执行test_add2")
self.assertEqual(add(3, 5), 10)
class SimpleTest2(unittest.TestCase):
@classmethod
def setUpClass(cls) -> None:
print("==========setUpClass=========")
return super().setUpClass()
@classmethod
def tearDownClass(cls) -> None:
print("\n==========tearDownClass=========")
return super().tearDownClass()
def setUp(self):
print("\n==========setUp=========")
return super().setUp()
def tearDown(self):
print("==========tearDown========")
return super().tearDown()
def test_sub(self):
print("\n执行test_sub")
self.assertEqual(sub(3, 5), 10)
def test_sub2(self):
print("\n执行test_sub2")
self.assertEqual(sub(3, 5), -2)
# __name__是一个全局变量,它的值是模块的名称。该判断语句表示只运行当前文件中的代码。
if __name__ == "__main__":
suite = unittest.TestSuite()
suite.addTest(SimpleTest2("test_sub"))
suite.addTest(unittest.makeSuite(SimpleTest))
runner = unittest.TextTestRunner()
runner.run(suite)
结果:
==========setUpClass=========
==========setUp=========
执行test_sub
==========tearDown========
F
==========tearDownClass=========
==========setUpClass=========
==========setUp=========
执行test_add
==========tearDown========
.
==========setUp=========
执行test_add2
==========tearDown========
F
==========tearDownClass=========
======================================================================
FAIL: test_sub (__main__.SimpleTest2)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/hookind/Desktop/workspace/pythonTest/unittest01.py", line 61, in test_sub
self.assertEqual(sub(3, 5), 10)
AssertionError: -2 != 10
======================================================================
FAIL: test_add2 (__main__.SimpleTest)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/hookind/Desktop/workspace/pythonTest/unittest01.py", line 38, in test_add2
self.assertEqual(add(3, 5), 10)
AssertionError: 8 != 10
----------------------------------------------------------------------
Ran 3 tests in 0.001s
FAILED (failures=2)
想了解更多,可参考unittest.TestSuite
3.3 TestLoader类
unittest包具有TestLoader类,用于从类和模块创建测试套件。默认情况下,在调用unittest.main()方法时会自动创建unittest.defaultTestLoader实例。但是,显式实例允许自定义某些属性。
示例:
import unittest
def add(a, b):
return a+b
def sub(a, b):
return a-b
class SimpleTest(unittest.TestCase):
@classmethod
def setUpClass(cls) -> None:
print("==========setUpClass=========")
return super().setUpClass()
@classmethod
def tearDownClass(cls) -> None:
print("\n==========tearDownClass=========")
return super().tearDownClass()
def setUp(self):
print("\n==========setUp=========")
return super().setUp()
def tearDown(self):
print("==========tearDown========")
return super().tearDown()
def test_add(self):
print("\n执行test_add")
self.assertEqual(add(3, 7), 10)
def test_add2(self):
print("\n执行test_add2")
self.assertEqual(add(3, 5), 10)
class SimpleTest2(unittest.TestCase):
@classmethod
def setUpClass(cls) -> None:
print("==========setUpClass=========")
return super().setUpClass()
@classmethod
def tearDownClass(cls) -> None:
print("\n==========tearDownClass=========")
return super().tearDownClass()
def setUp(self):
print("\n==========setUp=========")
return super().setUp()
def tearDown(self):
print("==========tearDown========")
return super().tearDown()
def test_sub(self):
print("\n执行test_sub")
self.assertEqual(sub(3, 5), 10)
def test_sub2(self):
print("\n执行test_sub2")
self.assertEqual(sub(3, 5), -2)
# __name__是一个全局变量,它的值是模块的名称。该判断语句表示只运行当前文件中的代码。
if __name__ == "__main__":
testCaseList = [SimpleTest, SimpleTest2]
testLoad = unittest.TestLoader()
testSuiteList=[]
for testCase in testCaseList:
testSuite = testLoad.loadTestsFromTestCase(testCase)
testSuiteList.append(testSuite)
newSuite = unittest.TestSuite(testSuiteList)
runner = unittest.TextTestRunner()
runner.run(newSuite)
想了解更多,可参考unittest.TestLoader
3.4 TestResult类
此类用于编译有关已成功测试和已失败测试的信息。TestResult对象存储一组测试的结果。TextTestRunner.run() 方法返回一个 TestResult 实例。
可以在上面代码中使用下述代码获得TestResult对象。
result = runner.run(newSuite)
更多请参考unittest.TestResult
4 断言
Python测试框架使用Python的内置assert()函数来测试特定条件。如果断言失败,将引发AssertionError。然后测试框架会将测试标识为失败。其他异常被视为错误。
unittest模块中定义了以下三种断言函数:
- 基本布尔断言
- 比较断言
- 集合断言
基本断言函数评估操作的结果是 True 还是 False。所有断言方法都接受一个msg参数,如果指定,则用作失败时的错误消息。
示例:
import unittest
class TestCase01(unittest.TestCase):
def test_equal(self):
self.assertEqual(12,13,"不相等")
def test_equal2(self):
self.assertEqual(12,13)
def test_equal3(self):
self.assertEqual(12,12)
if __name__=="__main__":
unittest.main()
** 结果**:
FF.
======================================================================
FAIL: test_equal (__main__.TestCase01)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/hookind/Desktop/workspace/pythonTest/unittest03.py", line 6, in test_equal
self.assertEqual(12,13,"不相等")
AssertionError: 12 != 13 : 不相等
======================================================================
FAIL: test_equal2 (__main__.TestCase01)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/hookind/Desktop/workspace/pythonTest/unittest03.py", line 8, in test_equal2
self.assertEqual(12,13)
AssertionError: 12 != 13
----------------------------------------------------------------------
Ran 3 tests in 0.000s
FAILED (failures=2)
想了解更多,请参考assert-methods
5 参考
Python Unittest简明教程的更多相关文章
- 飘逸的python - yield简明教程
发现还有非常多人对yield不理解,云里雾里,于是试着用文字表述. 仅仅要函数含有yield语句,它就返回一个生成器.所以我们与其把其看成函数定义,不如看作是生成器定义.函数用return返回,而生成 ...
- 《Python简明教程》总结
Python经典教程<Python简明教程> 目录: 为什么Python 安装Python 体验Python Python数据类型 运算符与表达式 控制流 函数 模块 数据结构 解决问题 ...
- 【笔记】Python简明教程
Python简明教程,此资源位于http://woodpecker.org.cn/abyteofpython_cn/chinese/ s=u'中文字符' #u表示unicode,使用u之后能正常显示中 ...
- 2017-2018-2 20179207 《网络攻防技术》python简明教程(1-10)
Python3简明教程(一) 开始python之旅 使用交互模式的 Python3解释器 简单使用 vim 编写 Python3 脚本 执行 Python3 脚本 Python3 代码风格建议 Pyt ...
- python中global的用法——再读python简明教程
今天看了知乎@萧井陌的编程入门指南,想重温一下 <python简明教程>,对global的用法一直不太熟练,在此熟练一下,并实践一下python中list.tuple.set作为参数的区别 ...
- python简明教程
Python简明教程 MachinePlay关注 0.7072018.09.26 01:49:43字数 2,805阅读 9,287 Python一小时快速入门 1.Python简介 pylogo. ...
- Python的入门级试用(简明教程)
声明:借鉴Python 简明教程 用 Python 编写的传统的 'Hello World' 程序.使用 Python 运行你的程序的方法有两种:使用交互式解释器提示符或者使用源文件.现在我们来看一下 ...
- Python 简明教程 --- 3,Python 基础概念
微信公众号:码农充电站pro 个人主页:https://codeshellme.github.io 控制复杂性是计算机编程的本质. -- Brian Kernighan 了解了如何编写第一个Pytho ...
- Python 简明教程 --- 2,第一个Python 程序
微信公众号:码农充电站pro 个人主页:https://codeshellme.github.io 如果你发现特殊情况太多,那你肯定是用错方法了. -- Carig Zerouni 当你在自己的电脑上 ...
随机推荐
- 蓝牙mesh网络技术的亮点
蓝牙mesh网络技术的亮点 The highlights of Bluetooth mesh networking technology 导言 蓝牙是当今最主要的低功耗无线技术之一,对无线设备用户和开 ...
- python2向python3移植问题
问题: payload = "A"*140 # padding ropchain = p32(puts_plt) ropchain += p32(entry_point) ropc ...
- 狂神说JUC学习笔记(二)
狂神说JUC的原版笔记: 链接:https://pan.baidu.com/s/12zrGI4JyZhmkQh0cqEO4BA 提取码:d65c 我的笔记在狂神的笔记上增加了一些知识点或者做了些许补充 ...
- springboot异常错误处理
1.在有模板引擎的情况下: springboot会默认找 templates/error/错误状态码.html,所以我们要定制化错误页面就可以到templates/error下创建一个[对应错误状态码 ...
- Django(64)频率认证源码分析与自定义频率认证
前言 有时候我们发送手机验证码,会发现1分钟只能发送1次,这是做了频率限制,限制的时间次数,都由开发者自己决定 频率认证源码分析 def check_throttles(self, request): ...
- 练习(time.tick定时器监控数据库)
设立个定时器,监控数据库里fb_state(发布状态),并将数据库中一条记录的开始时间与截止时间和当前时间进行比对.若当前时间在开始时间与结束时间之间,则将发布状态设为1,否则为0. 同时,将此段代码 ...
- 《四大点,搞懂Redis到底快在哪里?》
一.开发语言 二.纯内存访问 三.单线程 四.非阻塞多路I/O复用机制 前言 Redis是一种基于键值对(Key-Value)的NoSQL数据库 ,Redis的Value可以由String,hash, ...
- CosId 1.0.3 发布,通用、灵活、高性能的分布式 ID 生成器
CosId 通用.灵活.高性能的分布式 ID 生成器 介绍 CosId 旨在提供通用.灵活.高性能的分布式系统 ID 生成器. 目前提供了俩大类 ID 生成器:SnowflakeId (单机 TPS ...
- .NetCore使用Docker安装ElasticSearch、Kibana 记录日志
前言 最近园子里看到一篇<.Net Core with 微服务 - Elastic APM> 的文章(主要用于对接口的调用链.性能进行监控),非常实用,这里讲解.NetCore将日志写入E ...
- BFS经典面试题——C++版
文章目录 蛇梯棋 单词接龙 青蛙过河 蛇梯棋 N x N 的棋盘 board 上,按从 1 到 N*N 的数字给方格编号,编号 从左下角开始,每一行交替方向. 例如,一块 6 x 6 大小的棋盘,编号 ...