Pytest - 使用介紹

1. 概述

pytest是一個非常成熟的全功能的Python測試框架吃引,主要特點有以下幾點:

  • 1蕊苗、簡單靈活沿后,容易上手,文檔豐富朽砰;
  • 2尖滚、支持參數(shù)化,可以細(xì)粒度地控制要測試的測試用例瞧柔;
  • 3漆弄、能夠支持簡單的單元測試和復(fù)雜的功能測試,還可以用來做selenium/appnium等自動化測試造锅、接口自動化測試(pytest+requests);
  • 4撼唾、pytest具有很多第三方插件,并且可以自定義擴(kuò)展哥蔚,比較好用的如pytest-selenium(集成selenium)倒谷、pytest-html(完美html測試報告生成)、pytest-rerunfailures(失敗case重復(fù)執(zhí)行)糙箍、pytest-xdist(多CPU分發(fā))等渤愁;
  • 5、測試用例的skip和xfail處理深夯;
  • 6抖格、可以很好的和CI工具結(jié)合,例如jenkins

2. 使用介紹

2.1. 安裝

pip install pytest

2.2. 示例代碼

編寫規(guī)則

編寫pytest測試樣例非常簡單,只需要按照下面的規(guī)則:

  • 測試文件以test_開頭(以_test結(jié)尾也可以)
  • 測試類以Test開頭雹拄,并且不能帶有 init 方法
  • 測試函數(shù)以test_開頭
  • 斷言使用基本的assert即可

pytest1.py

# -*- coding:utf-8 -*-
import pytest

@pytest.fixture(scope='function')
def setup_function(request):
    def teardown_function():
        print("teardown_function called.")
    request.addfinalizer(teardown_function)  # 此內(nèi)嵌函數(shù)做teardown工作
    print('setup_function called.')

@pytest.fixture(scope='module')
def setup_module(request):
    def teardown_module():
        print("teardown_module called.")
    request.addfinalizer(teardown_module)
    print('setup_module called.')

@pytest.mark.website
def test_1(setup_function):
    print('Test_1 called.')

def test_2(setup_module):
    print('Test_2 called.')

def test_3(setup_module):
    print('Test_3 called.')
    assert 2==1+1              # 通過assert斷言確認(rèn)測試結(jié)果是否符合預(yù)期

fixture的scope參數(shù)

scope參數(shù)有四種收奔,分別是'function','module','class','session',默認(rèn)為function滓玖。

  • function:每個test都運行筹淫,默認(rèn)是function的scope
  • class:每個class的所有test只運行一次
  • module:每個module的所有test只運行一次
  • session:每個session只運行一次

setup和teardown操作

  • setup,在測試函數(shù)或類之前執(zhí)行呢撞,完成準(zhǔn)備工作损姜,例如數(shù)據(jù)庫鏈接、測試數(shù)據(jù)殊霞、打開文件等
  • teardown摧阅,在測試函數(shù)或類之后執(zhí)行,完成收尾工作绷蹲,例如斷開數(shù)據(jù)庫鏈接棒卷、回收內(nèi)存資源等
  • 備注:也可以通過在fixture函數(shù)中通過yield實現(xiàn)setup和teardown功能

2.3. 測試結(jié)果

如何執(zhí)行

  • pytest # run all tests below current dir
  • pytest test_mod.py # run tests in module file test_mod.py
  • pytest somepath # run all tests below somepath like ./tests/
  • pytest -k stringexpr # only run tests with names that match the
    # the "string expression", e.g. "MyClass and not method"
    # will select TestMyClass.test_something
    # but not TestMyClass.test_method_simple
  • pytest test_mod.py::test_func # only run tests that match the "node ID",
    # e.g "test_mod.py::test_func" will be selected
    # only run test_func in test_mod.py

通過pytest.mark對test方法分類執(zhí)行

通過@pytest.mark控制需要執(zhí)行哪些feature的test,例如在執(zhí)行test前增加修飾@pytest.mark.website

  • 通過 -m "website" 執(zhí)行有website標(biāo)記的test方法
$ pytest  -v -m "website" pytest1.py
============================================================================== test session starts ===============================================================================
platform linux2 -- Python 2.7.14, pytest-3.0.0, py-1.5.2, pluggy-0.3.1 -- /home/kevin/soft/anaconda2/bin/python
cachedir: .cache
Using --randomly-seed=1522925202
rootdir: /home/kevin/learn/python-web/tox/case2, inifile:
plugins: randomly-1.0.0, mock-1.2, cov-2.0.0
collected 3 items

pytest1.py::test_1 PASSED

============================================================================= pytest-warning summary =============================================================================
WC1 None pytest_funcarg__cov: declaring fixtures using "pytest_funcarg__" prefix is deprecated and scheduled to be removed in pytest 4.0.  Please remove the prefix and use the @pytest.fixture decorator instead.
=============================================================================== 2 tests deselected ===============================================================================
=========================================================== 1 passed, 2 deselected, 1 pytest-warnings in 0.00 seconds ============================================================
  • 通過 -m "not website" 執(zhí)行沒有website標(biāo)記的test方法
$ pytest  -v -m "not website" pytest1.py
============================================================================== test session starts ===============================================================================
platform linux2 -- Python 2.7.14, pytest-3.0.0, py-1.5.2, pluggy-0.3.1 -- /home/kevin/soft/anaconda2/bin/python
cachedir: .cache
Using --randomly-seed=1522925192
rootdir: /home/kevin/learn/python-web/tox/case2, inifile:
plugins: randomly-1.0.0, mock-1.2, cov-2.0.0
collected 3 items

pytest1.py::test_3 PASSED
pytest1.py::test_2 PASSED

============================================================================= pytest-warning summary =============================================================================
WC1 None pytest_funcarg__cov: declaring fixtures using "pytest_funcarg__" prefix is deprecated and scheduled to be removed in pytest 4.0.  Please remove the prefix and use the @pytest.fixture decorator instead.
=============================================================================== 1 tests deselected ===============================================================================
=========================================================== 2 passed, 1 deselected, 1 pytest-warnings in 0.00 seconds ============================================================

Console參數(shù)介紹

  • -v 用于顯示每個測試函數(shù)的執(zhí)行結(jié)果
  • -q 只顯示整體測試結(jié)果
  • -s 用于顯示測試函數(shù)中print()函數(shù)輸出
  • -x, --exitfirst, exit instantly on first error or failed test
  • -h 幫助

Case 1

$ pytest -v pytest1.py
============================================================================== test session starts ===============================================================================
platform linux2 -- Python 2.7.14, pytest-3.0.0, py-1.5.2, pluggy-0.3.1 -- /home/kevin/soft/anaconda2/bin/python
cachedir: .cache
Using --randomly-seed=1522920341
rootdir: /home/kevin/learn/python-web/tox/case2, inifile:
plugins: randomly-1.0.0, mock-1.2, cov-2.0.0
collected 3 items

pytest1.py::test_1 PASSED
pytest1.py::test_3 PASSED
pytest1.py::test_2 PASSED

============================================================================= pytest-warning summary =============================================================================
WC1 None pytest_funcarg__cov: declaring fixtures using "pytest_funcarg__" prefix is deprecated and scheduled to be removed in pytest 4.0.  Please remove the prefix and use the @pytest.fixture decorator instead.
================================================================== 3 passed, 1 pytest-warnings in 0.01 seconds ===================================================================

Case 2

$ pytest -s pytest1.py
============================================================================== test session starts ===============================================================================
platform linux2 -- Python 2.7.14, pytest-3.0.0, py-1.5.2, pluggy-0.3.1
Using --randomly-seed=1522920508
rootdir: /home/kevin/learn/python-web/tox/case2, inifile:
plugins: randomly-1.0.0, mock-1.2, cov-2.0.0
collected 3 items

pytest1.py setup_function called.
Test_1 called.
.teardown_function called.
setup_module called.
Test_2 called.
.Test_3 called.
.teardown_module called.


============================================================================= pytest-warning summary =============================================================================
WC1 None pytest_funcarg__cov: declaring fixtures using "pytest_funcarg__" prefix is deprecated and scheduled to be removed in pytest 4.0.  Please remove the prefix and use the @pytest.fixture decorator instead.
================================================================== 3 passed, 1 pytest-warnings in 0.01 seconds ===================================================================

3. 擴(kuò)展插件

3.1. 測試報告

安裝與樣例

pip install pytest-cov # 計算pytest覆蓋率祝钢,支持輸出多種格式的測試報告
pytest --cov-report=html --cov=./ test_code_target_dir

Console參數(shù)介紹

  • --cov=[path], measure coverage for filesystem path (multi-allowed), 指定被測試對象比规,用于計算測試覆蓋率
  • --cov-report=type, type of report to generate: term, term-missing, annotate, html, xml (multi-allowed), 測試報告的類型
  • --cov-config=path, config file for coverage, default: .coveragerc, coverage配置文件
  • --no-cov-on-fail, do not report coverage if test run fails, default: False,如果測試失敗拦英,不生成測試報告
  • --cov-fail-under=MIN, Fail if the total coverage is less than MIN. 如果測試覆蓋率低于MIN蜒什,則認(rèn)為失敗

Console Result

---------------------------------------------------------------- coverage: platform linux2, python 2.7.14-final-0 ----------------------------------------------------------------
Name         Stmts   Miss  Cover
--------------------------------
pytest1.py      18      0   100%

Html Result

image.png

3.2. 測試順序隨機(jī)

pip install pytest-randomly

3.3. 分布式測試

pip install pytest-xdist

3.4. 出錯立即返回

pip install pytest-instafail

4. 參考

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市疤估,隨后出現(xiàn)的幾起案子灾常,更是在濱河造成了極大的恐慌,老刑警劉巖铃拇,帶你破解...
    沈念sama閱讀 207,113評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件钞瀑,死亡現(xiàn)場離奇詭異,居然都是意外死亡慷荔,警方通過查閱死者的電腦和手機(jī)雕什,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評論 2 381
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來显晶,“玉大人贷岸,你說我怎么就攤上這事“赡耄” “怎么了凰盔?”我有些...
    開封第一講書人閱讀 153,340評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長倦春。 經(jīng)常有香客問我户敬,道長落剪,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,449評論 1 279
  • 正文 為了忘掉前任尿庐,我火速辦了婚禮忠怖,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘抄瑟。我一直安慰自己凡泣,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 64,445評論 5 374
  • 文/花漫 我一把揭開白布皮假。 她就那樣靜靜地躺著鞋拟,像睡著了一般。 火紅的嫁衣襯著肌膚如雪惹资。 梳的紋絲不亂的頭發(fā)上贺纲,一...
    開封第一講書人閱讀 49,166評論 1 284
  • 那天,我揣著相機(jī)與錄音褪测,去河邊找鬼猴誊。 笑死,一個胖子當(dāng)著我的面吹牛侮措,可吹牛的內(nèi)容都是我干的懈叹。 我是一名探鬼主播,決...
    沈念sama閱讀 38,442評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼分扎,長吁一口氣:“原來是場噩夢啊……” “哼澄成!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起笆包,我...
    開封第一講書人閱讀 37,105評論 0 261
  • 序言:老撾萬榮一對情侶失蹤环揽,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后庵佣,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,601評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡汛兜,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,066評論 2 325
  • 正文 我和宋清朗相戀三年巴粪,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片粥谬。...
    茶點故事閱讀 38,161評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡肛根,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出漏策,到底是詐尸還是另有隱情派哲,我是刑警寧澤,帶...
    沈念sama閱讀 33,792評論 4 323
  • 正文 年R本政府宣布掺喻,位于F島的核電站芭届,受9級特大地震影響储矩,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜褂乍,卻給世界環(huán)境...
    茶點故事閱讀 39,351評論 3 307
  • 文/蒙蒙 一持隧、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧逃片,春花似錦屡拨、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,352評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至损离,卻和暖如春赠潦,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背草冈。 一陣腳步聲響...
    開封第一講書人閱讀 31,584評論 1 261
  • 我被黑心中介騙來泰國打工她奥, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人怎棱。 一個月前我還...
    沈念sama閱讀 45,618評論 2 355
  • 正文 我出身青樓哩俭,卻偏偏與公主長得像,于是被迫代替她去往敵國和親拳恋。 傳聞我的和親對象是個殘疾皇子凡资,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,916評論 2 344

推薦閱讀更多精彩內(nèi)容