1、介紹
pytest是一個非常成熟的全功能的Python測試框架,主要有以下幾個特點:
- 簡單靈活,容易上手
- 支持參數化
- 能夠支持簡單的單元測試和複雜的功能測試,還可以用來做selenium/appnium等自動化測試、接口自動化測試(pytest+requests)
- pytest具有很多第三方插件,並且可以自定義擴展,比較好用的如pytest-selenium(集成selenium)、pytest-html(完美html測試報告生成)、pytest-rerunfailures(失敗case重複執行)、pytest-xdist(多CPU分發)等
- 測試用例的skip和xfail處理
- 可以很好的和jenkins集成
- report框架----allure 也支持了pytest
2、安裝
# 安裝pytest
pip install pytest
# Pytest有個用於生成html測試結果報告的插件:pytest-html,可直接使用pip命令安裝
pip install pytest-html
# 在執行用例時,需要加上參數:--html,如
pytest -m pytestto --disable-pytest-warnings --html=report.html
# 指定報告的存放路徑,需使用如下格式,比如,指定到一個report的文件夾裏,這裏是當前運行文件下創建
pytest --html=./report/report.html
3、 運行
# 例子1
import pytest
# content of test_sample.py
def func(x):
return x + 1
def test_answer():
assert func(3) == 5
命令行切換到文件所在目錄,執行測試
# 例子2
# 當需要編寫多個測試樣例的時候,我們可以將其放到一個測試類當中,如
class TestClass:
def test_one(self):
x = "this"
assert 'h' in x
def test_two(self):
x = "hello"
assert hasattr(x, 'check')
從測試結果中可以看到,該測試共執行了兩個測試樣例,一個失敗一個成功。同樣,我們也看到失敗樣例的詳細信息,和執行過程中的中間結果。-q即-quiet,作用是減少冗長,具體就是不再展示pytest的版本信息。
3、如何編寫測試用例
通過上面2個實例,我們發現編寫pytest測試樣例非常簡單,只需要按照下面的規則:
- 測試文件以test_開頭(以_test結尾也可以)
- 測試類以Test開頭,並且不能帶有 init 方法
- 測試函數以test_開頭
- 斷言使用基本的assert即可
4、運行模型
Pytest的多種運行模式,讓測試和調試變得更加得心應手,下面介紹5種常用的模式。在介紹之前需要提醒一句,運行pytest時會找當前目錄及其子目錄中的所有test_*.py 或 *_test.py格式的文件以及以test開頭的方法或者class,不然就會提示找不到可以運行的case了。
py.test --version 查看版本
py.test --fixtures, --funcargs 查看可用的 fixtures
pytest --markers 查看可用的 markers
py.test -h, --help 命令行和配置文件幫助
# 失敗後停止
py.test -x 首次失敗後停止執行
py.test --maxfail=2 兩次失敗之後停止執行
# 調試輸出
py.test -l, --showlocals 在 traceback 中顯示本地變量
py.test -q, --quiet 靜默模式輸出
py.test -v, --verbose 輸出更詳細的信息
py.test -s 捕獲輸出, 例如顯示 print 函數的輸出
py.test -r char 顯示指定測試類型的額外摘要信息
py.test --tb=style 錯誤信息輸出格式
- long 默認的traceback信息格式化形式
- native 標準庫格式化形式
- short 更短的格式
- line 每個錯誤一行
# 運行指定 marker 的測試
pytest -m MARKEXPR
# 運行匹配的測試
py.test -k stringexpr
# 失敗時調用 PDB
py.test --pdb
a)運行後生成測試報告(htmlReport)
# 先安裝html報告
pytest --html=report.html
b)運行指定的case
當我們寫了較多的cases時,如果每次都要全部運行一遍,無疑是很浪費時間的,通過指定case來運行就很方便了。
# 例子代碼
class TestClassOne(object):
def test_one(self):
x = "this"
assert 't'in x
def test_two(self):
x = "hello"
assert hasattr(x, 'check')
class TestClassTwo(object):
def test_one(self):
x = "iphone"
assert 'p'in x
def test_two(self):
x = "apple"
assert hasattr(x, 'check')
# 運行模式:
# 模式1:直接運行test_se.py文件中的所有cases:
pytest test_se.py
# 模式2:運行test_se.py文件中的TestClassOne這個class下的兩個cases:
pytest test_se.py::TestClassOne
# 模式3:運行test_se.py文件中的TestClassTwo這個class下的test_one:
pytest test_se.py::TestClassTwo::test_one
# 注意:定義class時,需要以T開頭,不然pytest是不會去運行該class的。
c)多進程運行cases
當cases量很多時,運行時間也會變的很長,如果想縮短腳本運行的時長,就可以用多進程來運行。
安裝pytest-xdist:
pip install -U pytest-xdist
# 運行模式:
pytest test_se.py -n NUM
# 其中NUM填寫併發的進程數。
d)重試運行cases
在做接口測試時,有事會遇到503或短時的網絡波動,導致case運行失敗,而這並非是我們期望的結果,此時可以就可以通過重試運行cases的方式來解決。
# 安裝pytest-rerunfailures:
pip install -U pytest-rerunfailures
# 運行模式
pytest test_se.py --reruns NUM
# NUM填寫重試的次數。
e)顯示print內容
在運行測試腳本時,爲了調試或打印一些內容,我們會在代碼中加一些print內容,但是在運行pytest時,這些內容不會顯示出來。如果帶上-s,就可以顯示了。
# 運行模式:
pytest test_se.py -s
# 另外,pytest的多種運行模式是可以疊加執行的,比如說,你想同時運行4個進程,又想打印出print的內容。可以用:
pytest test_se.py -s -n 4