Pytest框架 — 10、Pytest的標記（一）

1、標記跳過在自動化測試過程中，我們經常會遇到因為某些功能阻塞，未開發完成或者環境等問題，一些測試用例不能執行，如果人工去註釋掉，後面還需要再恢復才能繼續測試，pytest的標記跳過功能就可以實現暫時跳過。（一）無條件跳過skip 使用方法：通過@pytest.mark.skip(reason= ...

1、標記跳過
- （一）無條件跳過skip
- （二）有條件跳過skipif
2、標記實現參數化

1、標記跳過

在自動化測試過程中，我們經常會遇到因為某些功能阻塞，未開發完成或者環境等問題，一些測試用例不能執行，如果人工去註釋掉，後面還需要再恢復才能繼續測試，pytest的標記跳過功能就可以實現暫時跳過。

（一）無條件跳過skip

使用方法：通過@pytest.mark.skip(reason=跳過原因)裝飾器標記要跳過的測試用例

參數reason：跳過的原因，非必填

import pytest


@pytest.mark.skip
def test_register():
    # 測試註冊功能
    raise Exception("該功能尚未開發完成")


@pytest.mark.skip(reason="該功能尚未開發完成")
def test_logout():
    # 註銷
    raise Exception("該功能尚未開發完成")


def test_login():
    # 登錄功能
    assert True

"""
執行結果
mark/skip_mark.py::test_register SKIPPED (unconditional skip)
mark/skip_mark.py::test_logout SKIPPED (該功能尚未開發完成)
mark/skip_mark.py::test_login PASSED
"""

（二）有條件跳過skipif

使用方法：通過@pytest.mark.skipif(condition=跳過條件，reason=跳過原因)標記要跳過的測試用例。

參數condition：跳過的條件，值為True則跳過，值為False則繼續執行，預設值為True
參數reason：必填，跳過的原因

import pytest

version = 3.0


@pytest.mark.skipif(condition=version > 3.0 or version == 3.0, reason="3.0及以上版本不提供下載功能")
def test_download():
    print("下載功能")


def test_upload():
    print("上傳功能")


"""
執行結果
mark/skipif_mark.py::test_download SKIPPED (3.0及以上版本不提供下載功能)
mark/skipif_mark.py::test_upload 上傳功能
PASSED
"""

2、標記實現參數化

通過@pytest.mark.parametrize(argnames, argvalues, indirect=False, ids=None, scope=None)裝飾器來實現參數化。

參數說明：

argnames：參數名，使用逗號分隔的列表，或元祖，或字元串，表示一個或多個參數名，【常用】
argvalues：參數值，可以是列表、元祖、字典列表、字典元祖，【常用】
indirect：中文翻譯為中間人，為True時可以對argvalues的參數值進行處理，預設False，【不常用】
- indirect=True: 且argnames的值為fixture函數名，此時argnames的值變為可執行函數，會將argvalues的參數值當做參數傳遞給fixture函數進行處理，fixture函數返回處理結果給argnames
- indirect=False: argnames僅為參數名
ids：給用例起別名，字元串列表或數字列表，不設置會自動從測試數據中提取
scope：待理解【不常用】

示例1：單個參數

import pytest


phone_list = [
    "13881118888",
    "13012034288",
    "13234324188",
    "13231423288"
]

@pytest.mark.parametrize(argnames="phone_num", argvalues=phone_list)
def test_phone_number(phone_num):  # 註意，這裡的參數要和argnames參數名一致
    print(f"正在測試手機號{phone_num}")

"""
執行結果
mark/parametrize/single_param.py::test_phone_number[13881118888] 正在測試手機號13881118888
PASSED
mark/parametrize/single_param.py::test_phone_number[13012034288] 正在測試手機號13012034288
PASSED
mark/parametrize/single_param.py::test_phone_number[13234324188] 正在測試手機號13234324188
PASSED
mark/parametrize/single_param.py::test_phone_number[13231423288] 正在測試手機號13231423288
PASSED
"""

示例2：多個參數

import pytest

user_info = [
    ("張三", "18011111111"),
    ("李四", "18022222222"),
    ("王五", "18033333333")
]

@pytest.mark.parametrize(argnames="name,phonenum", argvalues=user_info)
def test_read_info(name, phonenum):
    print(f"正在讀取用戶{name}，手機號{phonenum}")

"""
執行結果
mark/parametrize/multiple_param.py::test_read_info[\u5f20\u4e09-18011111111] 正在讀取用戶張三，手機號18011111111
PASSED
mark/parametrize/multiple_param.py::test_read_info[\u674e\u56db-18022222222] 正在讀取用戶李四，手機號18022222222
PASSED
mark/parametrize/multiple_param.py::test_read_info[\u738b\u4e94-18033333333] 正在讀取用戶王五，手機號18033333333
PASSED
"""

由上面例子執行結果中可以看到中文參數值亂碼了，解決辦法如下
方法1. 在pytest.ini中加入disable_test_id_escaping_and_forfeit_all_rights_to_community_support=True
方法2. 在conftest.py中加入

# 收集每一個用例name和nodeid的中文顯示，轉化為utf-8形式
def pytest_collection_modifyitems(items):
    for item in items:
        item.name = item.name.encode("utf-8").decode("unicode_escape")
        item._nodeid = item.nodeid.encode("utf-8").decode("unicode_escape")

示例3：多個參數化（笛卡爾積）

import pytest


data1 = ['a', 'b', 'c']
data2 = [1, 2]


@pytest.mark.parametrize('test1', data1)
@pytest.mark.parametrize('test2', data2)
def test_param(test1, test2):
    print('\n測試數據：{}-{}'.format(test1, test2))
"""
執行結果
mark/parametrize/multiple_parameterization.py::test_param[1-a] 
測試數據：a-1
PASSED
mark/parametrize/multiple_parameterization.py::test_param[1-b] 
測試數據：b-1
PASSED
mark/parametrize/multiple_parameterization.py::test_param[1-c] 
測試數據：c-1
PASSED
mark/parametrize/multiple_parameterization.py::test_param[2-a] 
測試數據：a-2
PASSED
mark/parametrize/multiple_parameterization.py::test_param[2-b] 
測試數據：b-2
PASSED
mark/parametrize/multiple_parameterization.py::test_param[2-c] 
測試數據：c-2
PASSED
"""

示例4：ids參數給用例起別名

import pytest


user_info = [
    ("張三", "18011111111"),
    ("李四", "18022222222"),
    ("王五", "18033333333")
]

@pytest.mark.parametrize(argnames="name,phonenum", argvalues=user_info, ids=["用戶1","用戶2","用戶3"])
def test_read_info(name, phonenum):
    print(f"正在讀取用戶{name}，手機號{phonenum}")
    
"""
執行結果
mark/parametrize/ids.py::test_read_info[用戶1] 正在讀取用戶張三，手機號18011111111
PASSED
mark/parametrize/ids.py::test_read_info[用戶2] 正在讀取用戶李四，手機號18022222222
PASSED
mark/parametrize/ids.py::test_read_info[用戶3] 正在讀取用戶王五，手機號18033333333
PASSED
"""

示例5：使用indirect處理參數值

import pytest

@pytest.fixture()
def fixture_and_parametrize(request):  # request是關鍵字不能改變，用來接收參數
    print('郵箱賬號為：{}'.format(request.param))
    return request.param + "@qq.com"


@pytest.mark.parametrize('fixture_and_parametrize', ['100203', '466238894', '23942423'],
                         indirect=True)
def test_fixture_and_parametrize_2(fixture_and_parametrize):
    print('拼接後郵箱為：{}'.format(fixture_and_parametrize))

"""
執行結果
mark/parametrize/indirect.py::test_fixture_and_parametrize_2[100203] 郵箱賬號為：100203
拼接後郵箱為：[email protected]
PASSED
mark/parametrize/indirect.py::test_fixture_and_parametrize_2[466238894] 郵箱賬號為：466238894
拼接後郵箱為：[email protected]
PASSED
mark/parametrize/indirect.py::test_fixture_and_parametrize_2[23942423] 郵箱賬號為：23942423
拼接後郵箱為：[email protected]
PASSED
"""

示例6：標記數據

在參數化的過程中也可以標記數據進行跳過等

import pytest


@pytest.mark.parametrize("test_input,expected", [
    ("3+9", 12), ("5+4", 9),
    pytest.param("7 * 9", 42, marks=pytest.mark.xfail),
    pytest.param("8 * 6", 42, marks=pytest.mark.skip)
])
def test_mark(test_input, expected):
    assert eval(test_input) == expected
"""
執行結果
mark/parametrize/mark_data.py::test_mark[3+9-12] PASSED
mark/parametrize/mark_data.py::test_mark[5+4-9] PASSED
mark/parametrize/mark_data.py::test_mark[7 * 9-42] XFAIL
mark/parametrize/mark_data.py::test_mark[8 * 6-42] SKIPPED (unconditional skip)
"""

參考
https://www.cnblogs.com/miki-peng/p/14736332.html
https://zhuanlan.zhihu.com/p/515377205