python自动化框架pytest(二)--fixture

本文介绍pytest 的fixture的详细用法，下文介绍pytest的数据驱动实现。

四、pytest之fixture

fixture通过@pytest.fixture()装饰器装饰一个函数，那么这个函数就是一个fixture

4.1、fixture优势

• 命名方式灵活，不局限于 setup 和teardown 这几个命名
• conftest.py 配置里可以实现数据共享，不需要 import 就能自动找到fixture
• scope="module" 可以实现多个.py 跨文件共享前置
• scope="session" 以实现多个.py 跨文件使用一个 session 来完成多个用例

4.2、fixture源码详解

@pytest.fixture(scope="function", params=None, autouse=False, ids=None, name=None)

参数说明：
scope：被标记方法的作用域

• function" (default)：作用于每个测试方法，每个test都运行一次
• "class"：作用于整个类，每个class的所有test只运行一次
• "module"：作用于整个模块，每个module的所有test只运行一次
• "session：作用于整个session(慎用)，每个session只运行一次

params：一个可选的参数列表，它将导致多个参数调用fixture功能和所有测试使用它。

autouse：默认：False，需要用例手动调用该fixture；如果是True，所有作用域内的测试用例都会自动调用该fixture

ids：每个字符串id的列表，每个字符串对应于params这样他们就是测试ID的一部分。如果没有提供ID它们将从params自动生成

name：fixture的名称。这默认为装饰函数的名称。如果fixture在定义它的统一模块中使用，夹具的功能名称将被请求夹具的功能arg遮蔽，解决这个问题的一种方法时将装饰函数命令"fixture_"然后使用"@pytest.fixture（name=''）"。

注意：
session的作用域：是整个测试会话，即开始执行pytest到结束测试

4.3、测试用例调用fixture的三种方式

• 1、将fixture名称作为测试用例函数的输入参数
• 2、测试用例加上装饰器：@pytest.mark.usefixtures(fixture_name)
• 3、fixture设置autouse=True，每个用例执行前都会去调用

import pytest

@pytest.fixture
def login():
    print("调用了fixture1-----------")

@pytest.fixture
def login2():
    print("调用了fixture2----------")

# 调用方式一,以参数传递
def test_0001(login):
    print("用例 1：登录之后其它动作 111")

def test_0002():  # 不传 login
    print("用例 2：不需要登录，操作 222")


# 调用方式二 测试用例加上装饰器：@pytest.mark.usefixtures(fixture_name)，调用多个fixture用，隔开
@pytest.mark.usefixtures("login2", "login")
def test_0003():
    print("用例3：登录之后其它动作 111")

# 调用方式三 fixture设置autouse=True
@pytest.fixture(autouse=True)
def login3():
    print("调用了fixture3====auto===")

# 不是test开头，加了装饰器也不会执行fixture
@pytest.mark.usefixtures("login2")
def loginss():
    print(123)

if __name__ == '__main__':
    pytest.main(["-s", "test_002.py"])

输出结果：

test_002.py 调用了fixture3====auto===
调用了fixture1-----------
用例 1：登录之后其它动作 111
.调用了fixture3====auto===
用例 2：不需要登录，操作 222
.调用了fixture3====auto===
调用了fixture2----------
调用了fixture1-----------
用例3：登录之后其它动作 111

.

============================== 3 passed in 0.06s ==============================

fixture返回值

注意： 如果fixture有返回值，那么usefixture就无法获取到返回值，这个是装饰器usefixture与用例直接传fixture参数的区别。
当fixture需要用到return出来的参数时，只能将参数名称直接当参数传入，不需要用到return出来的参数时，两种方式都可以。

import pytest

@pytest.fixture
def login():
    print("调用了fixture1-----------")
    return "这是login"

def test_0001(login):
    print(login)

if __name__ == '__main__':
    pytest.main(["-s", "test_002.py"])

fixuer的params参数，用request获取并返回

@pytest.fixture有一个params参数，接受一个列表，列表中每个数据都可以作为用例的输入。也就说有多少数据，就会形成多少用例。
每次传入的参数用request.param来获取

import pytest
@pytest.fixture(params=[1, 2, 3])
def need_data(request): # 传入参数request 系统封装参数
    return request.param # 取列表中单个值，默认的取值方式
class Test_ABC:
 
    def test_a(self,need_data):
        print("------->test_a")
        assert need_data != 3 # 断言need_data不等于3
 
if __name__ == '__main__':
    pytest.main(["-s","test_abc.py"])
 
 执行结果：
      # 可以发现结果运行了三次
collecting ... collected 3 items
demo.py::Test_ABC::test_a[1] ------->test_a
PASSED
demo.py::Test_ABC::test_a[2] ------->test_a
PASSED
demo.py::Test_ABC::test_a[3] ------->test_a
FAILED

4.4、fixture作用范围

上面所有的实例默认都是函数级别的，所以测试函数只要调用了fixture，那么在测试函数执行前都会先指定fixture。
scope参数可以定义fixture的作用范围
下面我们通过一个实例具体看一下 fixture的作用范围

# test_002.py
import pytest

@pytest.fixture(scope='module', autouse=True)
def module_fixture():
    print('\n-----------------')
    print('我是module fixture')
    print('-----------------')

@pytest.fixture(scope='class')
def class_fixture():
    print('\n-----------------')
    print('我是class fixture')
    print('-------------------')

@pytest.fixture(scope='function', autouse=True)
def func_fixture():
    print('\n-----------------')
    print('我是function fixture')
    print('-------------------')

def test_1():
    print('\n 我是test1')

@pytest.mark.usefixtures('class_fixture')
class TestFixture1(object):
    def test_2(self):
        print('\n我是class1里面的test2')
    def test_3(self):
        print('\n我是class1里面的test3')

@pytest.mark.usefixtures('class_fixture')
class TestFixture2(object):
    def test_4(self):
        print('\n我是class2里面的test4')
    def test_5(self):
        print('\n我是class2里面的test5')
if __name__=='__main__':
    pytest.main(['-s', '-v', 'test_002.py'])

输出结果:

test_002.py::test_1 
-----------------
我是module fixture
-----------------

-----------------
我是function fixture
-------------------

 我是test1
PASSED
test_002.py::TestFixture1::test_2 
-----------------
我是class fixture
-------------------

-----------------
我是function fixture
-------------------

我是class1里面的test2
PASSED
test_002.py::TestFixture1::test_3 
-----------------
我是function fixture
-------------------

我是class1里面的test3
PASSED
test_002.py::TestFixture2::test_4 
-----------------
我是class fixture
-------------------

-----------------
我是function fixture
-------------------

我是class2里面的test4
PASSED
test_002.py::TestFixture2::test_5 
-----------------
我是function fixture
-------------------

我是class2里面的test5
PASSED

============================== 5 passed in 0.10s ==============================

我们可以很清楚的看到 整个模块只执行了一次module级别的fixture ， 每个类分别执行了一次class级别的fixture， 而每一个函数之前都执行了一次function级别的fixture

4.5 fixture实现teardown

前面的所有实例都只是做了测试用例执行之前的准备工作，那么用例执行之后该如何实现环境的清理工作呢？这不得不说yield关键字了，相比大家都或多或少的知道这个关键字，他的作用其实和return差不多，也能够返回数据给调用者，唯一的不同是被掉函数执行遇到yield会停止执行，接着执行调用处的函数，调用出的函数执行完后会继续执行yield关键后面的代码

import pytest

@pytest.fixture
def login():
    print("调用了fixture1-----------执行用例前的操作")
    yield "这里是fixture的返回值"
    print("调用了fixture1-----------执行用例后的操作")

def test_0001(login):
    print(login)

if __name__ == '__main__':
    pytest.main(["-s", "test_002.py"])

执行结果：

test_002.py 调用了fixture1-----------执行用例前的操作
这里是fixture的返回值
.调用了fixture1-----------执行用例后的操作


============================== 1 passed in 0.09s ==============================

可以看出，用例执行前先执行了fixture的yield前面的代码，用例执行后执行了fixture函数yield后面的代码
值得注意的是：

• 如果yield前面的代码，即setup部分已经抛出异常了，则不会执行yield后面的teardown内容
• 如果测试用例抛出异常，yield后面的teardown内容还是会正常执行

4.6 pytest搜索fixture的顺序

pytest是按照fixture的名称搜索fixture。
搜索顺序是：

优先搜索当前测试所在类
再搜索当前测试所在的模块
然后搜索conftest.py
接下来搜索内置fixture
最后搜索第三方插件

下一篇：python自动化框架pytest(三)--数据驱动（参数化）