自动化测试框架pytest教程4-内置Fixture(夹具)

pytest的开发者在pytest中包含了一些常用的Fixture。pytest预包装的Fixture可以帮助你在测试中轻松而一致地做一些非常有用的事情。例如pytest包含的内置Fixture可以处理临时目录和文件,访问命令行选项,在测试会话之间通信,验证输出流,修改环境变量,以及询问警告。内置固定程序是对pytest的核心功能的扩展。

tmp_path和tmp_path_factory

tmp_path 和 tmp_path_factory Fixture用于创建临时目录。tmp_path返回一个pathlib.Path实例,该实例指向一个临时目录,在你的测试期间和更长的时间内一直存在。tmp_path_factory session-scope fixture返回一个TempPathFactory对象。这个对象有一个mktemp()函数来返回Path对象。你可以使用mktemp()来创建多个临时目录。

ch4/test_tmp.py

def test_tmp_path(tmp_path):
    file = tmp_path / "file.txt"
    file.write_text("Hello")
    assert file.read_text() == "Hello"


def test_tmp_path_factory(tmp_path_factory):
    path = tmp_path_factory.mktemp("sub")
    file = path / "file.txt"
    file.write_text("Hello")
    assert file.read_text() == "Hello"

使用tmp_path_factory,你必须调用mktemp()来获得一个目录。tmp_path_factory是session 范围。tmp_path是function 范围。

在上一章中,我们使用标准库中的tempfile.TemporaryDirectory作为我们的db夹具。

import cards
import pytest


@pytest.fixture(scope="session")
def db(tmp_path_factory):
    """CardsDB object connected to a temporary database"""
    db_path = tmp_path_factory.mktemp("cards_db")
    db_ = cards.CardsDB(db_path)
    yield db_
    db_.close()

很好。注意,这也允许我们删除两个导入语句,因为我们不需要导入 pathlib 或 tempfile。

下面是两个相关的内置固定程序。

*tmpdir-类似于tmp_path,但返回一个py.path.local对象。py.path.local比pathlib更早,pathlib是在Python 3.4中加入的。py.path.local在pytest中被慢慢淘汰,而采用pathlib版本。因此,我推荐使用 tmp_path。

tmpdir_factory-类似于tmp_path_factory,只是它的mktemp函数返回py.path.local对象而不是pathlib.Path对象。

所有pytest临时目录固定的基础目录是由系统和用户决定的,包括一个pytest-NUM部分,其中NUM在每个会话中递增。基准目录在会话结束后立即保持原样,以便在测试失败时进行检查。pytest最终会对其进行清理。只有最近的几个临时基础目录被留在系统中。

如果需要,你也可以用pytest --basetemp=mydir指定你自己的基础目录。

使用capsys

有时应用程序代码向stdout、stderr等输出一些东西。

$ cards version
1.0.0
$ python -i
>>> import cards
>>> cards.__version__
'1.0.0'

测试的一个方法是用subprocess.run()实际运行命令,抓取输出,并与API中的版本进行比较。

import subprocess


def test_version_v1():
    process = subprocess.run(
        ["cards", "version"], capture_output=True, text=True
    )
    output = process.stdout.rstrip()
    assert output == cards.__version__

def test_version_v2(capsys):
    cards.cli.version()
    output = capsys.readouterr().out.rstrip()
    assert output == cards.__version__

capsys能够捕获写到stdout和stderr的数据。我们可以直接调用CLI中实现这一功能的方法,并使用capsys来读取输出。

capsys的另一个特点是能够暂时禁用pytest的正常输出捕获。pytest通常捕获你的测试和应用程序代码的输出。这包括打印语句。

ch4/test_print.py

def test_normal():
    print("\nnormal print")


def test_fail():
    print("\nprint in failing test")
    assert False

# 另一种总是包括输出的方法是使用 capsys.disabled()
def test_disabled(capsys):
    with capsys.disabled():
        print("\ncapsys disabled print")

如果我们运行它,没有看到任何输出。

# pytest捕获了所有的输出。这有助于保持命令行会话的清洁。
$ pytest test_print.py::test_normal
============================= test session starts =============================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\code\pytest_quick, configfile: pytest.ini
plugins: allure-pytest-2.12.0, Faker-4.18.0, tep-0.8.2, anyio-3.5.0
collected 1 item

test_print.py .                                                          [100%]

============================== 1 passed in 0.10s ==============================

# 有时我们希望看到所有的输出,即使是在通过测试时。我们可以使用-s或-capture=no标志来实现。

$ pytest -s test_print.py::test_normal
============================= test session starts =============================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\code\pytest_quick, configfile: pytest.ini
plugins: allure-pytest-2.12.0, Faker-4.18.0, tep-0.8.2, anyio-3.5.0
collected 1 item

test_print.py
normal print
.

============================== 1 passed in 0.07s ==============================

$ pytest test_print.py::test_fail
============================= test session starts =============================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\code\pytest_quick, configfile: pytest.ini
plugins: allure-pytest-2.12.0, Faker-4.18.0, tep-0.8.2, anyio-3.5.0
collected 1 item

test_print.py F                                                          [100%]

================================== FAILURES ===================================
__________________________________ test_fail __________________________________

    def test_fail():
        print("\nprint in failing test")
>       assert False
E       assert False

test_print.py:7: AssertionError
---------------------------- Captured stdout call -----------------------------

print in failing test
=========================== short test summary info ===========================
FAILED test_print.py::test_fail - assert False
============================== 1 failed in 0.13s ==============================

$ pytest test_print.py::test_disabled
============================= test session starts =============================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\code\pytest_quick, configfile: pytest.ini
plugins: allure-pytest-2.12.0, Faker-4.18.0, tep-0.8.2, anyio-3.5.0
collected 1 item

test_print.py
capsys disabled print
.                                                          [100%]

============================== 1 passed in 0.08s ==============================


以下是相关的内置Fixture。

  • capfd-类似于capsys,但捕获文件描述符1和2,通常与stdout和stderr相同。
  • capsysbinary- capsys捕捉文本,capsysbinary捕捉字节。
  • capfdbinary-捕获文件描述符1和2上的字节。
  • caplog-捕获用日志包编写的输出。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容