【pytest】Hook 方法之 pytest_collection_modifyitems：修改測試用例執行順序

Hook 方法之 pytest_collection_modifyitems：

pytest_collection_modifyitems 是在用例收集完畢之後被調用，可以用來調整測試用例執行順序；
它有三個參數，分別是：

1. session：會話對象；
2. config：配置對象；
3. items：用例對象列表；

這三個參數分別有不同的作用，都可以拿來單獨使用，修改用例執行順序主要是使用 items 參數！

def pytest_collection_modifyitems(session, config, items):
    """ called after collection has been performed, may filter or re-order
    the items in-place.

    :param _pytest.main.Session session: the pytest session object
    :param _pytest.config.Config config: pytest config object
    :param List[_pytest.nodes.Item] items: list of item objects
    """

 修改測試用例執行順序：

首先準備三個測試用例：

import pytest

class TestDemoA:

    def test_A_001(self):
        pass

    def test_A_002(self):
        pass

    def test_A_003(self):
        pass

if __name__ == '__main__':
    pytest.main(['-s'])

 普通情況下pytest 會按照從上到下的順序依次執行（模塊級會先以模塊名按ascii編碼進行排序）：

# 控制檯輸出結果：
============================= test session starts =============================
collected 3 items
test_Z.py::TestDemoA::test_A_001 PASSED
test_Z.py::TestDemoA::test_A_002 PASSED
test_Z.py::TestDemoA::test_A_003 PASSED
============================== 3 passed in 0.03s ==============================

使用 pytest_collection_modifyitems ：

在 conftest.py 文件中 使用 pytest_collection_modifyitems 鉤子方法：

# conftest.py

# 在收集完測試用例後纔會執行
def pytest_collection_modifyitems(items):
    print('pytest 收集到的所有測試用例：\n',items)

if __name__ == '__main__':
    pytest.main(['-s'])

 我們可以看到控制檯中打印出來了收集到的三個測試用例的對象，而且是在測試用例收集之前便已經執行，在執行完 pytest_collection_modifyitems 之後才顯示收集到了 3 個用例，如果我們在 pytest_collection_modifyitems 中對用例進行調整，便會影響用例是否執行和執行順序；

# 控制檯輸出結果：
============================= test session starts =============================

pytest 收集到的所有測試用例：
 [<Function test_A_001>, <Function test_A_002>, <Function test_A_003>]

collected 3 items
test_Z.py::TestDemoA::test_A_001 PASSED
test_Z.py::TestDemoA::test_A_002 PASSED
test_Z.py::TestDemoA::test_A_003 PASSED

============================== 3 passed in 0.02s ==============================

利用 items 獲取收集到的用例名和用例節點：

# conftest.py

def pytest_collection_modifyitems(items):
    print('pytest 收集到的所有測試用例：\n', items)
    for item in items:
        print('---' * 10)
        print('用例名：', item.name)
        print('用例節點：', item.nodeid)

if __name__ == '__main__':
    pytest.main(['-s'])

# 控制檯輸出結果：
============================= test session starts =============================

pytest 收集到的所有測試用例：
 [<Function test_A_001>, <Function test_A_002>, <Function test_A_003>]
------------------------------
用例名： test_A_001
用例節點： pytestDemo/pytest_hook_demo/test_Z.py::TestDemoA::test_A_001
------------------------------
用例名： test_A_002
用例節點： pytestDemo/pytest_hook_demo/test_Z.py::TestDemoA::test_A_002
------------------------------
用例名： test_A_003
用例節點： pytestDemo/pytest_hook_demo/test_Z.py::TestDemoA::test_A_003

collected 3 items
test_Z.py::TestDemoA::test_A_001 PASSED
test_Z.py::TestDemoA::test_A_002 PASSED
test_Z.py::TestDemoA::test_A_003 PASSED

============================== 3 passed in 0.02s ==============================

修改用例執行順序和剔除測試用例：

# conftest.py

def pytest_collection_modifyitems(items):
    # 將用例名拿出來存入新列表
    new_items = []
    for item in items:
        new_items.append(item.name)

    # 1. 刪除 test_A_002 用例
    # 獲取 test_A_002 在新列表的索引
    index_2 = new_items.index('test_A_002')
    # 在老列表中刪除這個索引
    del items[index_2]
    del new_items[index_2]  # 新列表同步刪除，和老列表保持同步

    # 2. 調換 1 和 3 的順序
    # 獲取 1 和 3 在新列表的索引
    index_1 = new_items.index('test_A_001')
    index_3 = new_items.index('test_A_003')
    # 根據索引在老列表中調換位置
    items[index_1], items[index_3] = items[index_3], items[index_1]

 可以看到控制檯輸出的結果中，用例3 和 用例1 的順序調換了，用例2 被刪除沒有執行；

代碼寫的比較粗糙，但是思路就是這樣：想辦法干涉 items 中用例對象的排序；

# 控制檯輸出結果：
============================= test session starts =============================
collected 3 items
test_Z.py::TestDemoA::test_A_003 PASSED
test_Z.py::TestDemoA::test_A_001 PASSED

============================== 2 passed in 0.02s ==============================