Python unittest 学习

[[toc]]

前言

由于目前项目需要做接口测试，故特意去学习了Python中的unittest测试框架，以下是个人的一些学习经验，如有错误之处，请不吝指出。

一、什么是unittest

unittest翻译过来就是“单元测试”，单元测试负责对最小的软件设计单元（模块）进行验证。而引用python官方文档：

unittest是python自带的单元测试框架，有时候又被称为”PyUnit”，是 python版本的JUint实现。该框架的作者是 Kent Beck和Erich Gamma。

二、基本概念

在开始运用unittest框架进行测试前，我们需要先学习unittest框架中4个重要的概念：test fixture、test case、test suite、test runner。
官方文档：

1. test fixture ：表示执行一个或多个测试所需的准备, 以及任何关联的清理操作。例如, 这可能涉及创建临时或代理数据库、目录或启动服务器进程。
2. test case ：测试用例是最小的测试单元。它检查特定的输入集的响应。单元测试提供了一个基类测试用例, 可用于创建新的测试用例。
3. test suite ：测试套件是测试用例、测试套件或两者的集合。它用于聚合应一起执行的测试。
4. test runner ：测试运行程序是协调测试执行并向用户提供结果的组件。运行程序可以使用图形界面、文本界面或返回特殊值来指示执行测试的结果。

而我们可以这样简单的去理解这4个概念：

• test fixture:是初始化和清理测试数据及环境，通过覆盖TestCase的setUp（）和tearDown（）方法来实现
• test case:是测试用例
• test suite:是用例集合，即测试套件，通过addTest加载TestCase到TestSuite中，从而返回一个TestSuite实例。
• test runner:的作用是运行用例并返回结果，通过TextTestRunner类提供的run（）方法来执行test suite/test case。

三、基本用法

在理解了4个基本概念（test fixture、test case、test suite、test runner）之后，我们通过以下的“加法”例子学习：
首先建立一个加法类： calculator.py

# 计算器类
class Count:
    def __init__(self, a, b):
        self.a = int(a)
        self.b = int(b)

    # 计算加法
    def add(self):
        return self.a + self.b

接着写test.py去测试“加法类：calculator.py”:

from testpro.calculator import Count
import unittest


class TestAdd(unittest.TestCase):
    def setUp(self):
        print('test start')

    def test_add(self):
        j = Count(2, 3)
        self.assertEqual(j.add(), 5, '计算错误！')

    def tearDown(self):
        print('test end')


if __name__ == '__main__':
    # 构造测试集
     suite = unittest.TestSuite()
     suite.addTest(TestAdd('test_add'))

     # 执行测试集合
     runner = unittest.TextTestRunner()
     runner.run(suite)

在 test.py 中，首先引入unittest模块，创建TestAdd类继承unittest的TestCase类。
setUp（）方法用于测试用例执行前的初始化工作，而这里用来打印“test start”信息。
tearDow（）方法与setUp（）相对应，用于测试用例之后的工作，这里打印“test end”信息。
asserEqual（）方法对add（）的返回值进行断言，判断两者是否相等，assertEqual（）方法由TestCase类继承而来。
TestSuite（）类来创建测试套件，通过它提供的addTest（）方法来添加测试用例test_add（）。
TextTestRunner（）类的run（）方法来运行suite所组装的测试用例。

四、执行用例的方法

目前学习中，发现有3种执行项目中测试用例的方法（ps：应该还有很多方法）：

• main（） ：unittest提供的全局方法，可以方便地将一个单元测试模块变成可以直接运行的测试脚本。main（）方法使用TestLoader类来搜索所有包含在该模块中以“test”命名开头的测试方法，并自动执行它们。
• run（） ：是unittest的TextTestRunner（）类的方法，用来运行suite套件中的测试用例集。
• discover（） ：TestLoader类中提供的方法，用来自动识别项目中的测试用例

例子：

from testpro.calculator import Count
import unittest


class TestAdd(unittest.TestCase):
    def setUp(self):
        print('test start')

    def test_add(self):
        j = Count(2, 3)
        self.assertEqual(j.add(), 5, '计算错误！')

    def tearDown(self):
        print('test end')


if __name__ == '__main__':
    # main（）方法
     unittest.main()

    # run()方法
    # 构造测试集
    #suite = unittest.TestSuite()
    # suite.addTest(TestAdd('test_add'))
     
     # 执行测试集合
     #runner = unittest.TextTestRunner()
     #runner.run(suite)

# discover方法
#test_dir = './test_case'
#discover = unittest.defaultTestLoader.discover(test_dir, pattern='test*.py')

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

五、断言的方法

在执行用例的过程中，最终用例是否执行通过，是通过判断测试得到的实际结果与预期结果是否相等决定的。unittest框架的TestCase类提供下面这些方法用于测试结果的判断。
常用的：

• assertEqual(first, second, msg=None):断言第一个参数和第二个参数是否相等，如果不相等则测试失败。msg为可选参数，用于定义测试时打印想信息。
• assertTure(expr, msg=None):判断测试表达式是true或false
• assertIN（first, second, msg=None）:断言第一个参数是否在第二个参数中，反过来讲，第二个参数是否包含在第一个参数。

官方文档

六、用例失败如何重跑

目前在unittest中并没有可以用来失败用例重跑的方法或插件，只能自己去封装一个方法。但通过资料查找，发现python下另一个测试框架pytest中就有2个方法可以进行失败用例重跑的，分别是flaky和rerunfailures。目前没有去深入学习pytest框架，就不详写了。

七、知识点补充

1. 测试用例分类
通过前面对unittest单元测试框架的学习，我们来用它运行web自动化测试脚本。在 开始之前，需要规划好测试目录，因为一旦测试用例多起来之后，后期维护就很麻烦。所以用例需要按照所测试的功能进行拆分，分散到不同的测试文件中。但通过addTest（）添加/删除测试用例变得很麻烦，所以我们要用TestLoder类中提供的discover（）方法解决:

discover(start_dir, pattern='test*.py, top_level_dir=None)

• start_dir:要测试的模块名称或测试用例目录。
• pattern='test.py':表示用例文件名的匹配原则。以“test”开头的 ‘,py’类型的文件，星号“”表示任意多个字符。
• top_level_dir=None:测试模块的顶层目录，如果没有顶层目录，默认为None。

让unittest框架查找到子目录中的测试文件，需要在每个子目录下放一个“\__init__.py”文件，文件可以为空。


2.if _name_ == '_main_'语句说明
if代表此句子为条件语句。_name_作为模块的内置属性，即是.py文件的调用方式。如果_name_ 等于 '_main_'就表示可以直接调用。


3.用例执行的顺序
unittest框架默认根据ASCII码的顺序加载测试用例的，数字与字母的顺序为：“0-9”，“A-Z”，“a-z”。而想要用例按顺序执行，需要通过TestSuite类的addTest（）方法按照一定的顺序来加载。


4.跳过测试和预期失败
在运行测试时，有时需要直接跳过某些测试用例，或者当用例符合某个条件跳过测试，又或者直接将测试用例设置为失败。unittest提供了实现这些需求的装饰器

• unittest.skip(reason):无条件跳过装饰的测试，说明跳过的原因
• unittest.skipIf(condition, reason)：跳过装饰的测试，如果条件为真
• unittest.skipUnless(condition, reason):跳过装饰的测试，除非条件为真
• unittest.expectedFailure()：测试标记为失败。不管执行结果是否失败，同意标记失败。