自动化测试之十：pytest单元测试框架

柔情只为你懂 2023-01-10 09:43 179阅读 0赞

### **pytest是一个第三方单元测试框架，更加简单，灵活，而且提供了更加丰富的扩展，弥补了unittest在做web自动化测试时的一些不足。** ###

### **1, pytest简单例子** ###

**pytest支持pip安装**

**①：创建以test开头的文件名test\_pytest.py**

def inc(x):
        return x + 1
    
    
    def test_answer():
        assert inc(3) == 5

**②：切换到test\_pytest.py所在目录，执行命令pytest**

**结果如下（分为两部分截图）：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 1][]

**通过上面的例子，是不是可以感受到pytest的优点，它更加简单。首先，不必像unittest一样必须创建测试类；其次，使用assert断言也比使用unittest提供的断言方法更加简单。**

**不过，它也有自己的规则：测试文件必须以"test"开头，这也是在执行pytest命令时并没有指定测试文件也可以执行test\_pytest.py文件的原因，因为该文件以“test”开头。**

**那么能否可以通过main()方法执行测试呢？当然可以，pytest也提供了main()方法，如下创建test\_pytest1.py：**

import pytest
    
    def inc(x):
        return x + 1
    
    
    def test_answer():
        assert inc(3) == 5
    
    
    if __name__ == '__main__':
        pytest.main()

**结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 3][]

**这里可以看到有两个测试结果，一个是test\_pytest.py中的，一个是test\_pytest1.py中的，那么我只是直接执行了test\_pytest1.py（没有使用pytest xxx.py方法执行文件），那么为什么会两个测试文件都会执行呢？？？？？？？？？？？？？？？？？**

**因为main()方法默认执行当前文件夹内所有以“test”开头的文件内的以test开头函数**

### 2 pytest的基本使用方法 ###

**这里我们主要介绍pytest与unittest之间的不同**

**2.1 断言**

**    在unittest单元测试框架中提供了丰富的断言方法，如：assertEqual()，assertIn()，assertTrue()，assertIs()等方法。pytest单元测试框架并没有提供专门的断言方法，而是直接使用Python的assert进行断言。**

**创建test\_assert.py**

import pytest
    
    
    # 计算两个数的和
    def add(a, b):
        return a + b
    
    
    # 判断素数
    def is_prime(n):
        if n < 1:
            return False
        for i in range(2, n):
            if n % i == 0:
                return False
            return True
    
    
    # 测试相等
    def test_add_1():
        assert add(3, 4) == 7
    
    
    # 测试不相等
    def test_add_2():
        assert add(17, 22) != 50
    
    
    # 测试大于或等于
    def test_add_3():
        assert add(17, 22) <= 50
    
    
    # 测试小于或等于
    def test_add_4():
        assert add(17, 22) >= 38
    
    
    # 测试包含
    def test_in():
        a = "hello"
        b = "he"
        assert b in a
    
    
    # 测试不包含
    def test_not_in():
        a = "hello"
        b = "hi"
        assert b not in a
    
    
    # 判断是否为True
    def test_true_1():
        assert is_prime(13)
    
    
    # 判断是否为True
    def test_true_2():
        assert is_prime(7)
    
    
    # 判断是否不为True
    def test_true_3():
        assert not is_prime(4)
    
    
    # 判断是否不为True
    def test_true_4():
        assert is_prime(6) is not True
    
    
    # 判断是否为False
    def test_false_1():
        assert is_prime(8) is False
    
    
    if __name__ == '__main__':
        pytest.main()

** 以上例子展示了pytest断言的方法，借助python的运算符号和关键字即可轻松实现不同数据类型的断言**

**2.2 Fixture**

**    Fixture通常用来对测试方法，测试函数，测试类和整个测试文件进行初始化或还原测试环境。创建test\_fixture.py文件。**

def mul(a, b):
        return a * b
    
    
    # ==============Fixture================
    def setup_module(module):
        print("setup_module---------->")
    
    def teardown_module(module):
        print("teardown_module-------->")
    
    def setup_function(function):
        print("setup_function--------->")
    
    def teardown_function(function):
        print("teardown_function------>")
    
    def setup():
        print("setup----------->")
    
    def teardown():
        print("teardown-------->")
    
    
    # =======测试用例=======
    def test_mul_3_4():
        print("test_mul_3_4")
        assert mul(3, 4) == 12
    
    def test_mul_a_3():
        print("test_mul_a_3")
        assert mul("a", 3) == "aaa"
    
    if __name__ == '__main__':
        import pytest
        pytest.main()

**这里主要用到的是模块级别和函数级别的Fixture**

**    ① setup\_module/teardown\_module:在当前文件中，在所有测试用例执行之前与之后执行**

**    ② setup\_function/teardown\_function:在每个测试函数之前与之后执行**

**    ③ setup/teardown:在每个测试函数之前与之后执行。这两个方法同样可以作用于类方法**

**结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 4][]

![20210123144548656.png][]

**pytest是支持使用测试类的，同样必须以"Test"开头，注意首字母要大写。在引入测试类的情况下，Fixture的用法如下：创建test\_fixture1.py**

def mul(a, b):
        return a * b
    
    
    class TestMul():
    
        # ====fixture====
        @classmethod
        def setup_class(cls):
            print("setup_class--------->")
    
        @classmethod
        def teardown_class(cls):
            print("teardown_class-------->")
    
        def setup_method(self, method):
            print("setup_method--------->")
    
        def teardown_method(self, method):
            print("teardown_method------>")
    
        def setup(self):
            print("setup------->")
    
        def teardown(self):
            print("teardown------>")
    
        # 测试用例
        def test_num_7_8(self):
            print("test_num_7-8")
            assert mul(7, 8) == 56
    
        def test_num_d_5(self):
            print("test_num_d_5")
            assert mul("d", 5) == "ddddd"

**这里主要用到类级别和方法级别的Fixture：**

**    ①：setup\_class/teardown\_class：在当前测试类的开始和结束时执行**

**    ②：setup\_method/teardown\_method：在每个测试方法开始与结束时执行**

**    ③：setup/teardown：在每个测试方法开始与结束时执行，同样可以作用于测试函数**

**结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 5][]

**2.3 参数化**

**当一组测试用例有固定的测试数据时，就可以通过参数化的方式简化测用例的编写。pytest本身是支持参数化的，不需要额外安装插件。创建test\_parameterize.py**

import pytest
    import math
    
    # pytest参数化
    
    @pytest.mark.parametrize(
        "base, exponent, expected",
        [
            (2, 2, 4),
            (2, 3, 8),
            (1, 9, 1),
            (0, 9, 0)
        ],
        ids=["case1", "case2", "case3", "case4"]
    )
    def test_pow(base, exponent, expected):
        assert math.pow(base, exponent) == expected

**其用法与unittest的参数化插件类似，通过pytest.mark.parametrize()方法设置参数。**

**"base, exponent, expected" 用来定义参数的名称。通过数组定义参数时，每一个元组都是一条测试用例使用的测试数据。ids参数默认为None，用于定义测试用例的名称。**

**pow用来计算x的y次方的值。**

**运行结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 6][]

**"-v"参数增加了测试用例冗长。不设置id参数的结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 7][]

**2.4 运行测试**

**pytest提供了丰富的参数运行测试用例，在前面的例子中已经使用到了一些参数，例如，“-s”参数用于关闭捕捉，从而打印输出信息，“-v”参数用于增加测试用例冗长。**

**pytest提供的参数比较多，下面只介绍常用的参数**

**2.4.1 运行名称中包含某字符串的测试用例**

![20210123153735342.png][]

**这里使用-k参数指定测试用例中包含add字符串的用例**

**2.4.2 减少测试运行冗长**

![20210123153908291.png][]

**这次运行减少了很多日志的输出，“-q”用来减少测试运行的冗长，也可以使用“-quiet”代替**

**2.4.3 如果出现一条测试用例失败，则退出测试**

**在test\_assert.py文件中添加了如下测试用例，放到第一个测试用例之后，只为了看到效果：**

def test_fail():
        assert is_prime(9) is False

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 8][]

**这个参数一般用于测试调试阶段，当出现一条失败的测试用例时，应该先通过调试让这条测试用例运行通过，而不是继续执行后面的测试用例**

**2.4.4 运行测试目录**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 9][]

**测试目录既可以指定相对路径，如上，也可以执行绝对路径**

**2.4.5 指定特定类或方法执行**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 10][]

**这里指定运行test\_fixture1.py文件中TestMul类下的test\_num\_7\_8()方法，文件名、类名和方法名之间使用双冒号"::"分割开**

**2.4.6 通过main()方法运行测试**

**创建test\_main.py文件，在文件中通过数组指定参数，每个参数为数组中的一个元素如下：**

import pytest
    
    if __name__ == '__main__':
        pytest.main(["-s", "./test_assert"])

**结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 11][]

![2021012315555126.png][]

**2.5 生成测试报告**

**pytest支持生成多种格式的测试报告**

**2.5.1 生成JUnit XML文件**

**XML类型的日志主要用于存放测试结果，方便我们利用里面的数据定制自己的测试报告。**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 12][]

**结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 13][]

**2.5.2 生成在线测试报告**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 14][]

**我测试时一直有出现一直卡在 “sending information to Paste Service”这里的情况，多测试几次。。。**

**打开链接，结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 15][]

**你可以只将失败的报告发送到pastebin服务器， pytest ./test\_assert --pastebin=failed**

**2.5.3 生成html测试报告文件**

**需要安装pytest的插件，pytest-html，支持pip安装**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 16][]

**结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 17][]

**2.6 conftest.py**

**conftest.py是pytest特有的本地测试配置文件，既可以用来设置项目级别的Fixture，也可以用来导入外部插件，还可以用来指定钩子函数。**

**①：创建test\_config/conftest.py测试配置文件如下：**

import pytest
    
    # 设置测试钩子
    
    @pytest.fixture()
    def test_url():
        return "http://www.baidu.com"

**②：创建test\_config/test\_sub.py测试用例文件**

def test_baidu(test_url):
        print(test_url)

**这里创建的函数可以直接调用conftest文件中的test\_url()钩子函数，结果如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 18][]

注意：conftest值作用于其所在的目录以及子目录

### 3 pytest扩展 ###

**pytest可以扩展非常多的插件来实现各种功能，这里介绍几个对做web自动化非常有用的插件 **

**3.1 pytest-html**

**前面已经介绍过，在这里不做说明了**

**3.2 pytest-returnfailures**

**需要使用pip安装**

**创建test\_returnfailures文件**

def test_fail_return():
        assert 2 + 2 == 5

结果如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 19][]

**通过 --reruns参数设置测试用例运行失败后的重试次数**

**3.3 pytest-parallel扩展**

**首先pip安装**

**pytest-parallel扩展可以实现测试用例的并行执行**

**创建文件如下：**

from time import sleep
    
    def test_1():
        sleep(3)
    
    def test_2():
        sleep(4)
    
    def test_3():
        sleep(7)

**不使用线程运行测试用例时间如下**

![20210123173238727.png][]

**使用多线程方式：pytest -q test\_parallel.py --tests-per-worker auto,             "auto"表示自动分配，但是测试不能在windows上执行，故不做结果展示**

**pytest-parallel的更多用法**

pytest --worker 2
    
    
    pytest --worker auto
    
    
    pytest --tests-per-worker 4
    
    
    pytest --tests-per-worker auto
    
    
    pytest --workers 2 --tests-per-worker auto

## ##

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70]: /images/20221119/210d8d57903c4d7aa9c9ece8332dde7d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 1]: /images/20221119/550f63818c7449709c4c908970ae6534.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 2]: /images/20221119/cfc6ef83fe604d73b56f85535ed46a73.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 3]: /images/20221119/15fc086da985466593e2106a7f0a974b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 4]: /images/20221119/8b76394f150e4abe81de1ce2bd181b8e.png
[20210123144548656.png]: /images/20221119/6b813cc9b2464dec9de14fd576139ff3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 5]: /images/20221119/6f3f28bff38a49e6ac702f6056b1454e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 6]: /images/20221119/0bd751fc58bc4066bf5f7715683fc29f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 7]: /images/20221119/35752c4a6f07429d83a6e90437ba29bc.png
[20210123153735342.png]: /images/20221119/2a1e544711434750a45a601e8ef76d03.png
[20210123153908291.png]: /images/20221119/087c6f2d75284f3bb2c9d23145758019.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 8]: /images/20221119/54af5e7cb3234f1bb626df3d66d56054.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 9]: /images/20221119/692036af4cdd4b538315b9674775209d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 10]: /images/20221119/f79c7752814f4b65af4c18de8bdb858d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 11]: /images/20221119/07bd530101934ae3bff5473bab500b6c.png
[2021012315555126.png]: /images/20221119/72692ed1980548a682b725b5494f76fc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 12]: /images/20221119/066e896dbe804310ac34e23ec41ddaec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 13]: /images/20221119/9466985e473643fa83b9abd519e354d2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 14]: /images/20221119/b560ae320bb64835bfd3af924c598960.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 15]: /images/20221119/9c26b331b6194ab180b91893d44e5f97.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 16]: /images/20221119/5b14fb0c16de47bfbbdf41ddd79238e9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 17]: /images/20221119/94fe1ab1c5314b9b852c38ab9fa4c0e0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 18]: /images/20221119/2e7fd4d463474f57bab2e1428215c19f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215bGlfYmluYmlu_size_16_color_FFFFFF_t_70 19]: /images/20221119/c1de84db458544548aa0a07433f1bcad.png
[20210123173238727.png]: /images/20221119/8853d6567594431a9760c7c890b02927.png