前言

除了框架本身提供的功能外，Pytest還支持上百種第三方插件，良好的擴(kuò)展性可以更好的滿足大家在用例設(shè)計(jì)時(shí)的不同需求。本文將為大家詳細(xì)介紹下面5項(xiàng)常用的插件。

1. 用例依賴

編寫用例的時(shí)候，我們會(huì)注意用例之間的獨(dú)立性，但部分用例之間確實(shí)存在關(guān)聯(lián)，無法做到徹底獨(dú)立，那么我們就可以通過使用插件pytest-dependency設(shè)置用例之間的依賴關(guān)系。當(dāng)用例A依賴于用例B時(shí)，若用例B執(zhí)行失敗，則用例A將會(huì)自動(dòng)跳過不執(zhí)行。如此，就可以避免去執(zhí)行一個(gè)必定會(huì)失敗的用例，相當(dāng)于pytest.mark.skip。

（1）安裝：

pip install pytest-dependency

（2）使用說明：

首先，在標(biāo)記被依賴用例時(shí)，需要在被依賴的用例上添加裝飾器pytest.mark.dependency()，且被依賴用例需要在關(guān)聯(lián)用例前執(zhí)行。也可以給被依賴用例設(shè)置別名，通過添加參數(shù)name實(shí)現(xiàn)。

在關(guān)聯(lián)的依賴用例上，同樣需要添加裝飾器pytest.mark.dependency(depends=['用例名稱'])，與之前不同的是，裝飾器必須要填寫depends參數(shù)完成用例的關(guān)聯(lián)，關(guān)聯(lián)的被依賴用例存在多個(gè)時(shí)可以使用“,”隔開。

此外，還可以通過scope參數(shù)指定用例依賴的范圍，同樣是session、package、module、class這四種類型，此處不詳細(xì)展開。

具體通過下方的示例以及執(zhí)行結(jié)果來進(jìn)一步說明。

（3）示例及執(zhí)行結(jié)果分析

示例：

import pytest
class TestCase:
    # 通過裝飾器@pytest.mark.dependency()標(biāo)記當(dāng)前用例為被依賴用例，被依賴用例需要優(yōu)先關(guān)聯(lián)用例執(zhí)行
    @pytest.mark.dependency()
    def test_01(self):
        print("測試用例01，執(zhí)行失敗")
        assert 1 == 2
    # 通過使用裝飾器關(guān)聯(lián)被依賴用例，通過depends參數(shù)指定用例名稱關(guān)聯(lián)用例
    @pytest.mark.dependency(depends=['test_01'])
    def test_02(self):
        print("測試用例02，跳過")
    # 標(biāo)記被依賴用例時(shí)，可以通過name參數(shù)指定別名
    @pytest.mark.dependency(name="func_2")
    def test_03(self):
        print("測試用例03，執(zhí)行成功！")
    # 使用depends參數(shù)指定定義的別名關(guān)聯(lián)用例
    @pytest.mark.dependency(depends=['func_2'])
    def test_04(self):
        print("測試用例04，執(zhí)行成功！")
    # depends參數(shù)可以關(guān)聯(lián)多個(gè)測試用例，使用“,”分隔即可
    @pytest.mark.dependency(depends=['test_01', 'func_2'])
    def test_05(self):
        print("測試用例05，跳過")
if __name__ == '__main__':
    pytest.main(['-vs'])

執(zhí)行結(jié)果如下：

我們可以看出，只有依賴用例執(zhí)行成功時(shí)，當(dāng)前用例才會(huì)被執(zhí)行，否則會(huì)被跳過。依賴多個(gè)用例時(shí)，只有全部成功，才會(huì)執(zhí)行，否則一樣會(huì)跳過。

2. 失敗重跑

有些情況下，用例在執(zhí)行過程中可能會(huì)受到一些客觀因素的影響，導(dǎo)致用例執(zhí)行失敗，通過使用pytest-rerunfailures插件，可以在失敗后重新執(zhí)行用例，并設(shè)置重新運(yùn)行的最大次數(shù)。以此保證用例執(zhí)行結(jié)果的準(zhǔn)確性。

（1）安裝：

pip install pytest-rerunfailures

（2）使用說明：

失敗重跑共有兩種使用方式，分別是通過裝飾器執(zhí)行和命令行執(zhí)行。

使用裝飾器時(shí)，需要在用例上添加裝飾器pytest.mark.flaky(reruns=重新執(zhí)行最大次數(shù), reruns_delay=執(zhí)行間隔時(shí)間（單位：秒）)，在執(zhí)行過程中，添加了裝飾器的用例在執(zhí)行失敗后會(huì)按照設(shè)置的次數(shù)和時(shí)間重新執(zhí)行。

通過在命令行執(zhí)行時(shí)，同樣需要指定"rerun"和"rerun-delay"兩個(gè)參數(shù)來實(shí)現(xiàn)，如：pytest --reruns 重新執(zhí)行最大次數(shù) --reruns-delay 間隔時(shí)間。

注意：reruns是重新執(zhí)行的最大次數(shù)，如果在達(dá)到這一數(shù)量前用例執(zhí)行成功，則不會(huì)繼續(xù)重跑，判斷用例執(zhí)行通過；否則執(zhí)行到最大次數(shù)后，用例仍失敗，則判斷用例執(zhí)行失敗。

具體通過下方的示例和執(zhí)行結(jié)果進(jìn)一步說明。

（3）示例及執(zhí)行結(jié)果分析

示例：

import pytest
import random
class TestCase:
    # 使用裝飾器設(shè)置用例失敗后的重新執(zhí)行最大次數(shù)和每次執(zhí)行的間隔時(shí)間（單位：秒）
    @pytest.mark.flaky(reruns=3, reruns_delay=1)
    def test_01(self):
        result = random.choice(['a', 'b', 'c', 'd', 'e'])
        print(f"result={result}")
        assert result == 'c'
if __name__ == '__main__':
    pytest.main(['-vs'])

執(zhí)行結(jié)果如下：

我們可以看出，當(dāng)用例斷言失敗后，會(huì)重新執(zhí)行，直到達(dá)到設(shè)置的最大次數(shù)或執(zhí)行成功為止。

3. 指定用例執(zhí)行順序

pytest在執(zhí)行用例的時(shí)候，默認(rèn)是按照文件中用例的先后順序執(zhí)行，有時(shí)我們可能在維護(hù)測試用例時(shí)遇到需要修改用例執(zhí)行順序的情況，但是如果每次都通過修改大段的用例代碼先后位置來控制，并不利于維護(hù)。因此，使用插件pytest-ordering可以快速實(shí)現(xiàn)用例執(zhí)行順序的設(shè)置，后期維護(hù)時(shí)，也只需要修改對(duì)應(yīng)的執(zhí)行順序參數(shù)即可。

（1）安裝：

pip install pytest-ordering

（2）使用說明：

通過給用例添加裝飾器pytest.mark.run(order=執(zhí)行順序)設(shè)置用例的執(zhí)行順序。在執(zhí)行的時(shí)候，使用裝飾器pytest.mark.run的用例會(huì)優(yōu)先沒有裝飾器的用例執(zhí)行，設(shè)置了執(zhí)行順序的用例則按照order參數(shù)設(shè)置的大小升序執(zhí)行。

具體通過下方的示例和執(zhí)行結(jié)果進(jìn)一步說明。

（3）示例及執(zhí)行結(jié)果分析

示例：

import pytest
class TestCase:
    def test_01(self):
        print("測試用例01")
    def test_02(self):
        print("測試用例02")
    # 使用裝飾器設(shè)置執(zhí)行順序?yàn)?
    @pytest.mark.run(order=2)
    def test_03(self):
        print("測試用例03")
    # 使用裝飾器設(shè)置執(zhí)行順序?yàn)?
    @pytest.mark.run(order=1)
    def test_04(self):
        print("測試用例04")
if __name__ == "__main__":
    pytest.main(['-vs'])

執(zhí)行結(jié)果：

我們可以看出，執(zhí)行的順序和預(yù)期一致。優(yōu)先執(zhí)行標(biāo)明了執(zhí)行順序的用例，并按照order的值由小到大執(zhí)行。

4. 分布式運(yùn)行

當(dāng)項(xiàng)目的用例很多的時(shí)候，執(zhí)行通常會(huì)耗時(shí)頗久，通過分布式運(yùn)行，則可以大量縮短整體用例的執(zhí)行時(shí)間。pytest-xdist插件就可以幫助我們完成測試用例的分布式運(yùn)行。

（1）安裝：

pip install pytest-xdist

（2）使用說明：

在命令行執(zhí)行用例時(shí)，通過參數(shù)-n設(shè)置并行啟動(dòng)的進(jìn)程數(shù)量。除了設(shè)置具體的數(shù)量外，還可以設(shè)置為auto，這種情況下，會(huì)依據(jù)當(dāng)前設(shè)備的cpu數(shù)量執(zhí)行。

此外，還可以通過--dist參數(shù)，設(shè)置用例分組，同一個(gè)組內(nèi)的用例會(huì)在同一個(gè)進(jìn)程中執(zhí)行。

• --dist=loadscope 同一個(gè)module或同一個(gè)class下的用例會(huì)分配為同一組，按class分組優(yōu)先于module。
• --dist=loadfile 同一個(gè).py文件中的用例會(huì)分配為同一組。

具體通過下方的示例和執(zhí)行結(jié)果進(jìn)一步說明。

（3）示例及執(zhí)行結(jié)果分析

示例：

import pytest
from time import sleep
class TestCase1:
    @pytest.mark.parametrize('keyword', ['a', 'b', 'c', 'd', 'e',                                        'f', 'g', 'h', 'i', 'j'])
    def test_baidu_search(self, keyword):
        sleep(1)
        print(f'搜索關(guān)鍵字{keyword}')
class TestCase2:
    @pytest.mark.parametrize('user', ['user1', 'user2', 'user3', 'user4', 'user5',                                    'user6', 'user7', 'user8', 'user9', 'user10'])    def test_login(self, user):
        sleep(1)
        print(f'用戶{user}登錄成功')
if __name__ == '__main__':
    # pytest.main(['-vs']) # 不使用pytest-xdist運(yùn)行
    pytest.main(['-vs', '-n', '2']) # 使用pytest-xdist運(yùn)行

執(zhí)行結(jié)果：

從上方的兩次執(zhí)行結(jié)果中可以看出，使用分布式運(yùn)行后，用例的運(yùn)行時(shí)間明顯縮短。示例中的用例彼此之間沒有關(guān)聯(lián)，如果實(shí)際使用時(shí)用例之間存在依賴關(guān)系，可以使用--dist參數(shù)為用例分組，確保關(guān)聯(lián)的用例在同一組內(nèi)。

5. 多重?cái)嘌?/h2>

有時(shí)，在一個(gè)用例中，我們需要對(duì)結(jié)果進(jìn)行不同維度的多個(gè)斷言，但是使用assert斷言時(shí)，只要有一個(gè)斷言失敗，后續(xù)的斷言就不會(huì)繼續(xù)執(zhí)行。現(xiàn)在，我們可以通過使用pytest-assume插件來解決這個(gè)問題，當(dāng)斷言失敗后，仍會(huì)繼續(xù)執(zhí)行后續(xù)的斷言。

（1）安裝：

pip install pytest-assume

（2）使用說明：

在用例中，把使用assert進(jìn)行的斷言，改為使用pytest.assume()進(jìn)行斷言即可。

具體通過下方的示例和執(zhí)行結(jié)果進(jìn)一步說明。

（3）示例及執(zhí)行結(jié)果分析

示例：

import pytest
class TestCase:
    # 使用assert斷言
    def test_01(self):
        print("斷言1")
        assert 1 == 1
        print('斷言2')
        assert 2 == 1
        print("斷言3")
        assert 3 == 3
        print('用例結(jié)束')
    # 使用pytest.assume()斷言
    def test_02(self):
        print('斷言1')
        pytest.assume(1 == 1)
        print('斷言2')
        pytest.assume(2 == 1)
        print('斷言3')
        pytest.assume(3 == 3)
        print('用例結(jié)束')
if __name__ == '__main__':
    pytest.main(['-vs'])

執(zhí)行結(jié)果：

從執(zhí)行結(jié)果中可以看出，使用assert斷言時(shí)，斷言失敗不會(huì)再執(zhí)行后續(xù)的內(nèi)容；而使用pytest.assume()斷言時(shí)，斷言失敗仍會(huì)執(zhí)行至用例結(jié)束。這樣更有利于我們一次性獲取用例執(zhí)行中全部錯(cuò)誤信息。

6. 小結(jié)

本文為大家介紹了一些常用的pytest框架的插件，可以幫助我們解決一些實(shí)際使用過程中遇到的問題。目前，pytest支持的插件已經(jīng)多達(dá)868個(gè)，除了本文介紹的5個(gè)常用插件外，還有很多支持其它需求的插件，大家可以根據(jù)自己的需要嘗試查找使用相關(guān)的插件，以便能夠更好的設(shè)計(jì)出符合業(yè)務(wù)場景的測試用例。