? ? ? Pytest提供了豐富的插件來擴展其功能,本章介紹下pytest-cov插件,用于生成測試覆蓋率報告,幫助開發者了解哪些部分的代碼被測試覆蓋,哪些部分還需要進一步的測試。
pytest-cov 支持多種報告格式,包括純文本、HTML、XML 等,開發者可以根據需要選擇合適的報告格式。
并且可以配合之前文章介紹的pytest-xdist插件進行分布式測試。
官方文檔:
https://pytest-cov.readthedocs.io/en/latest/index.html
適配版本說明:
python >= 3.6
pytest-cov安裝
使用pip命令安裝: pip install pytest-cov (安裝在pytest工程所運行的python環境,python的安裝目錄或者虛擬環境目錄,可以參考之前文章查看運行環境pycharm配置pytest運行環境)
通過pycharm安裝:打開設置,按照如下圖中安裝插件(windows系統)
pytest-cov運行
使用時無需導入,直接在pytest運行命令中添加參數即可。主要有以下參數:
--cov=PATH:需要分析的代碼路徑。
--cov-report=type:要生成的報告類型:html,xml,json,lcov,term,term-missing等。
--cov-config=path覆蓋范圍的配置文件。默認.coveragerc。
--no-cov-on-fail:如果測試運行失敗,不要報告覆蓋范圍。
--no-cov:完全禁用覆蓋報告。
--cov-reset:重置迄今為止在選項中積累的cov源。
--cov-fail-under=MIN如果總覆蓋率小于MIN,則失敗。
--cov-append:結果附加到現有的數據文件中,而不是覆蓋它。
--cov-branch啟用分支覆蓋。
--cov-context選擇設置動態上下文的方法。
生成測試覆蓋率報告
舉例:我們的測試工程目錄如下:src目錄有兩個python程序文件,testcase目錄是測試用例。testcode.py和testclass.py中的內容如下:簡單的比較函數
在test_case2.py文件中導入兩個python模塊,設計2條用例分別覆蓋函數功能,通過參數化又不完全覆蓋函數的所有代碼。test_case_1傳入2組參數,test_case_2傳入1組參數。
import pytest
import sys
sys.path.append('..')
from src import testcode,testclass@pytest.mark.parametrize('a,b',((1,1),(2,1)))
def test_case_1(a,b):testcode.compare(a,b)@pytest.mark.parametrize('a,b',((1,1),(3,3)))
def test_case_2(a,b):testclass.testclass().compare(a,b)
在pytest執行語句中添加參數-cov=../src --cov-report=html,分析src目錄的代碼覆蓋率,并生成html測試報告。
執行后默認在測試用例目錄下創建htmlcov的目錄,并生成html測試報告。
在瀏覽器下打開index.html報告,報告內容如下:
Files顯示的是模塊的覆蓋率信息。
點擊Functions查看函數覆蓋率:
點擊Classes查看類的覆蓋率:
點進某個文件查看文件內的行覆蓋詳細信息:綠色表示覆蓋,紅色未覆蓋
testclass文件:
testcode文件:
在一些大型的pytest工程中,用例很多,一般會使用分布式執行,比如開頭提到的使用pytest-xdist插件的分布式執行功能,參數中添加-n 2可以起兩個進程執行等。
其他參數的簡要介紹
--no-cov-on-fail:如果測試運行失敗,不要報告覆蓋范圍。
舉例:設置用例會執行失敗(比如上面的用例中加上assert False),當執行參數帶上--no-cov-on-fail時,用例執行有失敗時,就不會產生覆蓋率報告。
--no-cov:完全禁用覆蓋報告。
當執行命令加上該參數后,不會生成代碼覆蓋率報告。
--cov-fail-under=MIN如果總覆蓋率小于MIN,則認為不達標。
舉例:執行命令增加參數--cov-fail-under=90要求覆蓋率不低于90%
當執行后結果如下:覆蓋率不達標,會有報錯信息。
--cov-context:當我們在多個執行用例時希望累積這些代碼覆蓋率時我們可以加上該參數--cov-context=test(參數設置其他值會報錯)。
共勉: 東漢·班固《漢書·枚乘傳》:“泰山之管穿石,單極之綆斷干。水非石之鉆,索非木之鋸,漸靡使之然也。”
-----指水滴不斷地滴,可以滴穿石頭;
-----比喻堅持不懈,集細微的力量也能成就難能的功勞。
----感謝讀者的閱讀和學習,謝謝大家。
---祝愿大家都能夠龍騰虎躍,步步高升!!!