Pytest快速体验

redrose2100

已于 2022-10-13 10:24:08 修改

阅读量2.5k

点赞数 3

分类专栏： Pytest 文章标签： python pytest 自动化测试 pytest最佳实践

于 2021-12-28 10:33:47 首次发布

本文链接：https://blog.csdn.net/redrose2100/article/details/122186909

版权

Pytest 专栏收录该内容

62 篇文章 4 订阅

订阅专栏

【原文链接】Pytest快速体验

文章目录

一、Pytest简介
二、Pytest的安装与升级
三、创建并执行第一个测试脚本
四、pytest命令的默认行为
五、对产生的异常进行断言
六、在类中编写测试脚本
七、测试脚本请求创建一个临时目录

一、Pytest简介

Pytest是一款基于python开源的自动化测试框架，具体来说它有以下特点：

使用简单，非常容易上手
功能强大，几乎可所有测试活动的自动化
开源生态健康，文档丰富
插件化架构，可扩展性强
拥有非常丰富的插件库，几乎可覆盖现有的大部分自动化需求
支持多种执行方式，执行调度灵活
支持参数化，支持数据驱动测试
能够兼容其他自动化测试框架编写的脚本
结合allure插件生成非常漂亮的测试报告
方便地与jenkins进行持续集成

二、Pytest的安装与升级

(1) 安装

pip install pytest

(2)查看版本，如下表示安装OK

$ pytest --version
pytest 7.1.2

(3)升级

pip install -U pytest

三、创建并执行第一个测试脚本

(1)四行代码即可写一个测试脚本，如下，文件命名为 test_sample.py

def func(x):
    return x + 1

def test_answer():
    assert func(3) == 5

(2)直接使用pytest命令即可执行

$ pytest
========================================================================= test session starts ==========================================================================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\redrose2100-book\ebooks\Pytest企业级应用实战\src
collected 1 item

test_demo.py F                                                                                                                                                    [100%]

=============================================================================== FAILURES =============================================================================== 
_____________________________________________________________________________ test_answer ______________________________________________________________________________ 

    def test_answer():
>       assert func(3) == 5
E       assert 4 == 5
E        +  where 4 = func(3)

test_demo.py:5: AssertionError
======================================================================= short test summary info ======================================================================== 
FAILED test_demo.py::test_answer - assert 4 == 5
========================================================================== 1 failed in 0.13s ===========================================================================

执行结果中100%表示测试脚本执行进度，即所有用例均已执行完成，此外在执行结果最后，pytest打印出了执行测试报告，即有一个用例失败，func(3)的值为4，与期望值5不相等。

断言这里使用了assert语句，关于assert断言语句的高级应用在后续文章中继续深入讲解，这里仅仅体验一下。

四、pytest命令的默认行为

pytest命令这里暂时知道会执行当前目录以及当前目录的所有子目录中的test_*.py 文件和 *_test.py 文件中的测试脚本，关于更多规则细节也将在后续篇章中详细展开讲解。

五、对产生的异常进行断言

通过raise可以对代码产生的异常进行断言，如下代码

import pytest


def f():
    raise SystemExit(1)


def test_mytest():
    with pytest.raises(SystemExit):
        f()

执行pytest命令，结果如下：

pytest
========================================================================= test session starts ==========================================================================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\redrose2100-book\ebooks\Pytest企业级应用实战\src
collected 1 item

test_demo.py .                                                                                                                                                    [100%]

========================================================================== 1 passed in 2.03s ===========================================================================

关于断言的更多的内容，将在后续篇章中详细展开讲解。

六、在类中编写测试脚本

当编写多个测试脚本时，可以考虑使用类将他们组织起来，这样便于管理。如下创建测试文件test_demo.py，并编写类TestClass，注意类名不要Test开头，此外，类中不能有_init__(self) 方法。如下，测试类TestClass2中有__init__(self)方法。

class TestClass:
    def test_one(self):
        x = "this"
        assert "h" in x

    def test_two(self):
        x = "hello"
        assert hasattr(x, "check")

class TestClass2:
    def __init__(self):
        pass

    def test_one(self):
        x = "this"
        assert "h" in x

    def test_two(self):
        x = "hello"
        assert hasattr(x, "check")

然后使用pytest命令执行，结果如下：

$ pytest
========================================================================= test session starts ==========================================================================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\redrose2100-book\ebooks\Pytest企业级应用实战\src
collected 2 items                                                                                                                                                        

test_demo.py .F                                                                                                                                                   [100%]

=============================================================================== FAILURES =============================================================================== 
__________________________________________________________________________ TestClass.test_two __________________________________________________________________________ 

test_demo.py:10
  D:\redrose2100-book\ebooks\Pytest企业级应用实战\src\test_demo.py:10: PytestCollectionWarning: cannot collect test class 'TestClass2' because it has a __init__ construc
tor (from: test_demo.py)
    class TestClass2:

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
======================================================================= short test summary info ======================================================================== 
FAILED test_demo.py::TestClass::test_two - AssertionError: assert False
================================================================ 1 failed, 1 passed, 1 warning in 0.08s ================================================================

可以发现这里有一个用例通过，一个失败，其中还有一个告警，"cannot collect test class ‘TestClass2’ because it has a init construc
tor"即TestClass2中无法采集用例，因为它有__init__构造方法。

使用类组织测试函数有许多好处，如：

可以有效的组织用例
可以仅在类中共享fixture
可以在类上打标签从而对类中的所有用例打标签

但是在使用类组织测试函数时需要特别注意，测试类中的每个用例都是测试类的一个独立的对象，类中的用例如果通过类属性共享变量将是非常糟糕的设计，如下，value是类变量，在test_one和test_two两个测试用例中共享，但是在test_one对value进行了修改，通过后续的执行pytest命令的时候发现在test_one中的修改并未修改test_two中的value的值，因此这种很容易引起误解的设计师非常糟糕的。在自动化实践中要尽量避免这类设计。

class TestClassDemoInstance:
    value = 0

    def test_one(self):
        self.value = 1
        assert self.value == 1

    def test_two(self):
        assert self.value == 1

执行pytest命令，结果如下：

$ pytest
========================================================================= test session starts ==========================================================================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\redrose2100-book\ebooks\Pytest企业级应用实战\src

self = <test_demo.TestClassDemoInstance object at 0x0000019A1F59A8B0>

    def test_two(self):
>       assert self.value == 1
E       assert 0 == 1
E        +  where 0 = <test_demo.TestClassDemoInstance object at 0x0000019A1F59A8B0>.value

test_demo.py:9: AssertionError
======================================================================= short test summary info ======================================================================== 
FAILED test_demo.py::TestClassDemoInstance::test_two - assert 0 == 1
===================================================================== 1 failed, 1 passed in 2.15s ======================================================================

七、测试脚本请求创建一个临时目录

pytest提供了许多内置的fixture，比如tmp_path，将fixture名字写入测试函数的参数位置，就会在执行测试函数之前，率先执行fixture的动作，比如tmp_path，就会在执行测试函数之前创建一个临时目录，如下代码：

def test_needsfiles(tmp_path):
    print(tmp_path)
    assert 0

使用pytest -q，即输出简要信息，执行结果如下：

pytest -q
F                                                                                                                                                                 [100%]
=============================================================================== FAILURES =============================================================================== 
___________________________________________________________________________ test_needsfiles ____________________________________________________________________________ 

tmp_path = WindowsPath('C:/Users/hitre/AppData/Local/Temp/pytest-of-hitre/pytest-4/test_needsfiles0')

    def test_needsfiles(tmp_path):
        print(tmp_path)
>       assert 0
E       assert 0

test_demo.py:3: AssertionError
------------------------------------------------------------------------- Captured stdout call ------------------------------------------------------------------------- 
C:\Users\hitre\AppData\Local\Temp\pytest-of-hitre\pytest-4\test_needsfiles0
======================================================================= short test summary info ======================================================================== 
FAILED test_demo.py::test_needsfiles - assert 0
1 failed in 0.07s