當測試用例非常多的時候，一條條按順序執行測試用例，是很浪費測試時間的。這時候就可以用到 pytest-xdist，讓自動化測試用例可以分散式執行，從而大大節省測試時間。

pytest-xdist 是屬於程序級別的併發。

分散式測試用例的設計原則：

（1）獨立執行：用例之間是獨立的，並且沒有依賴關係，還可以完全獨立執行。

（2）隨機執行：用例執行不強制按順序執行，支援順序執行或隨機執行。

（3）不影響其他用例：每個用例都能重複執行，執行結果不會影響其他用例。

pytest-xdist 通過一些獨特的測試執行模式擴充套件了 pytest：

（1）測試執行並行化：如果有多個CPU或主機，則可以將它們用於組合的測試執行。這樣可以加快開發速度或使用遠端計算機的特殊資源。

（2）--looponfail：在子程序中重複執行測試。每次執行之後，pytest 都會等到專案中的檔案更改後再執行之前失敗的測試。重複此過程，直到所有測試通過，然後再次執行完整執行。

（3）跨平臺覆蓋：可以指定不同的 Python 直譯器或不同的平臺，並在所有這些平臺上並行執行測試。

1、安裝

在命令列中執行以下命令進行安裝：

pip install pytest-xdist

或者（使用國內的豆瓣源，資料會定期同步國外官網，速度快。）

pip install pytest-xdist -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com

2、示例

建立My_pytest_Demo3專案，並建立如下檔案。

如圖所示：專案目錄結構

根目錄下conftest.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import pytest

@pytest.fixture(scope="session")
def login():
    print("===登入，返回：name，token===")
    name = "AllTests"
    token = "123456qwe"
    yield
 
 name, token
    print("===退出===")

根目錄下test_case.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import pytest
from time import sleep

@pytest.mark.parametrize("n", list(range(5)))
def test_get_info(login, n):
    sleep(1)
    name, token = login
    print("===獲取使用者個人資訊===", n)
    print(f"使用者名稱:{name}, token:{token}")

test_baidu包下conftest.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import pytest

@pytest.fixture(scope="module")
def open_baidu(login):
    name, token = login
    print(f"===使用者 {name} 開啟baidu===")

test_baidu包下test_case1.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import pytest
from time import sleep

@pytest.mark.parametrize("n", list(range(5)))
def test_case1_1(open_baidu, n):
    sleep(1)
    print("===baidu 執行測試用例test_case1_1===", n)

@pytest.mark.parametrize("n", list(range(5)))
def test_case1_2(open_baidu, n):
    sleep(1)
    print("===baidu 執行測試用例test_case1_2===", n)

test_weibo包下test_case2.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import pytest
from time import sleep

@pytest.mark.parametrize("n", list(range(5)))
def test_case2_no_fixture(login, n):
    sleep(1)
    print("===weibo 沒有__init__測試用例，執行測試用例test_case2_no_fixture===", login)

test_douyin包下conftest.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import pytest

@pytest.fixture(scope="function")
def open_douyin(login):
    name, token = login
    print(f"===使用者 {name} 開啟douyin===")

test_douyin包下test_case3.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import pytest
from time import sleep

@pytest.mark.parametrize("n", list(range(5)))
class TestDouyin:
    def test_case3_1(self, open_douyin, n):
        sleep(1)
        print("===douyin 執行測試用例test_case3_1===", n)

    def test_case3_2(self, open_douyin, n):
        sleep(1)
        print("===douyin 執行測試用例test_case3_2===", n)

1、不使用分散式測試執行測試用例

開啟命令列，在該專案根目錄下，輸入執行命令

pytest -s

執行一條用例大概1s，因為每個用例都加了sleep(1)，一共30條用例，總共執行30.16s。

2、使用分散式測試執行測試用例

引數 -n auto：可以自動檢測到系統的CPU核數。

使用 auto 等於利用了所有CPU來跑用例，此時CPU佔用率會特別高。

開啟命令列，在該專案根目錄下，輸入執行命令

pytest -s -n auto

執行30條用例，只用了4.81s。

3、使用分散式測試執行測試用例（指定多少程序）

開啟命令列，在該專案根目錄下，輸入執行命令

pytest -s -n 5

指定5個程序同時執行30條用例，用時6.99s。

4、pytest-xdist 和 pytest-html 聯合使用

開啟命令列，在該專案根目錄下，輸入執行命令

pytest -s -n auto --html=report.html --self-contained-html

執行完成後自動生成的報告

5、按照一定順序執行

pytest-xdist 預設是無序執行的，可以通過 --dist 引數來控制執行順序。

--dist=loadscope：將按照同一個模組 module 下的函式和同一個測試類 class 下的方法來分組，然後將每個測試組發給可以執行的 worker，確保同一個組的測試用例在同一個程序中執行。目前無法自定義分組，按類 class 分組優先於按模組 module 分組。

--dist=loadfile：按照同一個檔名來分組，然後將每個測試組發給可以執行的 worker，確保同一個組的測試用例在同一個程序中執行。

6、使 scope=session 的 fixture 在 test session 中僅執行一次

pytest-xdist 是讓每個 worker 程序執行屬於自己的測試用例集下的所有測試用例。

這意味著在不同程序中，不同的測試用例可能會呼叫同一個 scope 範圍級別較高（例如session）的 fixture，該 fixture 則會被執行多次，這不符合 scope=session 的預期。

儘管 pytest-xdist 沒有內建的支援來確保會話範圍的 fixture 僅執行一次，但是可以通過使用鎖定檔案進行程序間通訊來實現。

示例：

（1）該示例只需要執行一次login（如只需要執行一次來定義配置選項等）。

（2）當第一次請求這個fixture時，則會利用FileLock僅產生一次fixture資料。需要安裝filelock包，安裝命令pip install filelock

（3）當其他程序再次請求這個fixture時，則會從檔案中讀取資料。

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import pytest
from filelock import FileLock

@pytest.fixture(scope="session")
def login():
    print("===登入，返回：name，token===")
    with FileLock("session.lock"):
        name = "AllTests"
        token = "123456qwe"

        # Web App UI自動化，宣告一個driver，再返回
        # 介面自動化，發起一個登入請求，將token返回

    yield name, token
    print("===退出===")

3、原理和流程

xdist 的分散式類似於一主多從的結構，master 機負責下發命令，控制 slave 機；slave 機根據 master 機的命令執行特定測試任務。

在 xdist 中，主是 master，從是 workers。

分散式測試的原理：

（1）xdist 會產生一個或多個 workers，workers 都通過 master 來控制；

（2）每個 worker 負責執行完整的測試用例集，然後按照 master 的要求執行測試，而 master 機不執行測試任務。

分散式測試的流程：

1、建立 worker

（1）master 會在總測試會話（test session）開始前產生一個或多個 worker；

（2）master 和 worker 之間是通過 execnet 和閘道器來通訊的；

（3）實際編譯執行測試程式碼的 worker 可能是本地機器也可能是遠端機器。

2、收集測試用例

（1）每個 worker 類似一個迷你型的 pytest 執行器；

（2）worker 會執行一個完整的 test collection 過程（收集所有測試用例的過程）；

（3）然後把測試用例的 ids 返回給 master；

（4）master 是不會執行任何測試用例集的。

注：所以為什麼指令碼程式碼裡有列印語句（print）通過分散式測試時結果沒有輸出用例的列印內容，因為主機並不執行測試用例，PyCharm 相當於一個 master。

3、master 檢測 workers 收集到的測試用例集

（1）master 接收到所有 worker 收集的測試用例集之後，master 會進行一些完整性檢查，以確保所有 worker 都收集到一樣的測試用例集（包括順序）；

（2）如果檢查通過，會將測試用例的 ids 列表轉換成簡單的索引列表，每個索引對應一個測試用例的在原來測試集中的位置；

（3）所有的節點都儲存著相同的測試用例集，並且使用這種方式可以節省頻寬，因為 master 只需要告知 workers 需要執行的測試用例對應的索引，而不用告知完整的測試用例資訊。

4、測試用例分發

--dist-mode 選項

each：master 將完整的測試索引列表分發到每個 worker。

load：master 將大約25%的測試用例以輪詢的方式分發到各個 worker，剩餘的測試用例則會等待 workers 執行完測試用例以後再分發。

注：可以使用 pytest_xdist_make_scheduler 這個 hook 來實現自定義測試分發邏輯。

5、測試用例的執行

（1）workers 重寫了 pytest_runtestloop（pytest 的預設實現是迴圈執行所有在 test session 這個物件裡面收集到的測試用例）；

（2）但是在 xdist 裡, workers 實際上是等待 master 為其傳送需要執行的測試用例；

（3）當 worker 收到測試任務, 就順序執行 pytest_runtest_protocol；

（4）值得注意的一個細節是：workers 必須始終保持至少一個測試用例在任務佇列裡, 以相容 pytest_runtest_protocol(item, nextitem)hook 的引數要求，為了將 nextitem 傳給 hook；

（5）worker 會在執行最後一個測試項前等待 master 的更多指令；

（6）如果它收到了更多測試項, 那麼就可以安全的執行 pytest_runtest_protocol，因為這時 nextitem 引數已經可以確定；

（7）如果它收到一個 "shutdown" 訊號, 那麼就將 nextitem 引數設為 None, 然後執行 pytest_runtest_protocol。

6、測試用例再分發

--dist-mode=load

（1）當 workers 開始/結束執行時，會把測試結果返回給 master，這樣其他 pytest hook 比如（pytest_runtest_protocol 和 pytest_runtest_protocol 就可以正常執行）；

（2）master 在 worker 執行完一個測試後，基於測試執行時長以及每個 work 剩餘測試用例綜合決定是否向這個 worker 傳送更多的測試用例。

7、測試結束

（1）當 master 沒有更多執行測試任務時，它會發送一個 "shutdown" 訊號給所有 worker；

（2）當 worker 將剩餘測試用例執行完後退出程序；

（3）master 等待所有 worker 全部退出；

（4）此時仍需要處理諸如 pytest_runtest_logreport 等事件。

4、解決：多程序執行次數

如何保證 scope=session 的 fixture 在多程序執行情況下仍然只執行一次。

1、建立My_pytest_Demo3_2專案，並建立如下檔案。

如圖所示：專案目錄結構，allure資料夾存放allure測試報告

根目錄下conftest.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import os
import pytest
from random import random

@pytest.fixture(scope="session")
def test():
    token = str(random())
    print("fixture：請求登入介面，獲取token", token)
    os.environ['token'] = token
    return token

根目錄下test_case1.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import os

def test_one(test):
    print("os 環境變數：", os.environ['token'])
    print("test_one 測試用例", test)

根目錄下test_case2.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import os

def test_two(test):
    print("os 環境變數：", os.environ['token'])
    print("test_two 測試用例", test)

根目錄下test_case3.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""

import os

def test_three(test):
    print("os 環境變數：", os.environ['token'])
    print("test_three 測試用例", test)

2、開啟命令列，在該專案根目錄下，輸入執行命令

pytest -n 3 --alluredir=./allure
allure serve allure

3、執行結果：

scope=session的fixture執行了三次，三個程序下的三個測試用例得到的資料不一樣。

一、解決 scope=session 的 fixture 在多程序執行情況下仍然只執行一次

1、修改根目錄下conftest.py檔案

指令碼程式碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
微信公眾號：AllTests軟體測試
"""
import json
import os
import pytest
from random import random
from filelock import FileLock

@pytest.fixture(scope="session")
def test(tmp_path_factory, worker_id):
    # 如果是單機執行，則執行這裡的程式碼塊【不可刪除、修改】
    if worker_id == "master":
        """
        【自定義程式碼塊】
        這裡就寫你要本身要做的操作，比如：登入請求、新增資料、清空資料庫歷史資料等
        """
        token = str(random())
        print("fixture：請求登入介面，獲取token", token)
        os.environ['token'] = token

        # 如果測試用例有需要，可以返回對應的資料，比如：token
        return token

    # 如果是分散式執行
    # 獲取所有子節點共享的臨時目錄，無需修改【不可刪除、修改】
    root_tmp_dir = tmp_path_factory.getbasetemp().parent
    # 【不可刪除、修改】
    fn = root_tmp_dir / "data.json"
    # 【不可刪除、修改】
    with FileLock(str(fn) + ".lock"):
        # 【不可刪除、修改】
        if fn.is_file():
            # 快取檔案中讀取資料，像登入操作的話就是token【不可刪除、修改】
            token = json.loads(fn.read_text())
            print(f"讀取快取檔案，token是：{token}")
        else:
            """
            【自定義程式碼塊】
            跟上面if的程式碼塊一樣就行
            """
            token = str(random())
            print("fixture：請求登入介面，獲取token", token)
            # 【不可刪除、修改】
            fn.write_text(json.dumps(token))
            print(f"首次執行，token是：{token}")

        # 最好將後續需要保留的資料存在某個地方，比如這裡是os的環境變數
        os.environ['token'] = token
    return token

2、開啟命令列，在該專案根目錄下，輸入執行命令

pytest -n 3 --alluredir=./allure
allure serve allure

3、執行結果：

可以看到fixture只執行了一次，不同程序下的測試用例共享一個數據token。

（1）讀取快取檔案並不是每個測試用例都會讀，它是按照程序來讀取的，比如 -n 3 指定三個程序執行，那麼有一個程序會執行一次 fixture（隨機），另外兩個程序會各讀一次快取。

（2）假設每個程序有很多個用例，那也只是讀一次快取檔案，而不會讀多次快取檔案。所以最好將從快取檔案讀出來的資料儲存在指定的地方，比如 os.environ 將資料儲存在環境變數中。

二、程序少測試用例多的情況下執行

例如：兩個程序跑三個測試用例

1、開啟命令列，在該專案根目錄下，輸入執行命令

pytest -n 2 --alluredir=./allure
allure serve allure

2、執行結果：

可以看到test_three的測試用例就沒有讀快取檔案，每個程序只會讀一次快取檔案。

本文來自部落格園，作者：AllTests軟體測試，轉載請註明原文連結：https://www.cnblogs.com/alltests/p/15493674.html