python-pytest学习（五）-yield操作

一、前言

　　fixture的teardown操作并不是独立的函数，用yield关键字呼唤teardown操作。上一次实现了在每个用例之前执行初始化操作，那么用例执行完之后，如需要清除数据（或还原）操作，可以使用yield来实现。fixture通过scope参数控制setup级别，既然有setup作为用例之前的操作，用例执行完之后那肯定也有teardown操作。

　　这里用到fixture的teardown操作并不是独立的函数，用yield关键字呼唤teardown操作。fixture的teardown操作并不是独立的函数，可以用yield关键字呼唤teardown操作。

　　我们之前学习的都是测试用例的前置固件，也就是相当于“setup”。那自然就引申出一个问题“teardown”？这就是我们今天学习的yield和addfinalizer。

（1）yield

　　yield是一个关键字，它不是单独存在的，要写在fixture标记的固件中。

　　我们在声明的固件myfixture中加入yield关键字，在它下面写测试用例执行后想要运行的代码；其他有关于固件的使用没有任何差别。需要说明的一点是我们在pytest主函数中增加一个参数“-setup-show”，它会显示出固件的执行情况。

　　fixture里面的teardown用yield来唤醒teardown的执行。

　　如果测试用例中的代码出现异常或者断言失败，并不会影响他的固件中yield后的代码执行；但是如果固件中的yield之前的代码也是相当于setup部分的代码，出现错误或断言失败，那么yield后的代码将不会再执行，当然测试用例中的代码也不会执行。

　　我们也可以通过request.addfinalizer()的方式实现“teardown”。

　　我们在固件中传入request参数；又在固件中定义了一个内置函数；最后将定义的内置函数添加到request的addfinalize中。

二、scope="function"

　　当pytest.fixture(scope="function")时，pytest的yield类似unittest的teardown。每个方法（函数）都会执行一次。

　　1.新建test_function1.py文件

import pytest

@pytest.fixture(scope="function")
def login():
    print("登录成功")
    yield
    print("用例执行完成，收尾")

def test1(login):
    print("操作1")
    print("---------------------------------------------------")

def test2(login):
    print("操作2")
    print("---------------------------------------------------")

def test3(login):
    print("操作3")
    print("---------------------------------------------------")

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

运行结果：

　　从结果看错，虽然test1，test2，test3三个地方都调用了login函数，并且它会在每一个用例前执行一次。

　　2.如果test1不调用，test2（调用login），test3不调用，运行顺序会是怎样的？

import pytest

@pytest.fixture(scope="function")
def login():
    print("登录成功")
    yield
    print("用例执行完成，收尾")

def test1():
    print("操作1")
    print("---------------------------------------")

def test2(login):
    print("操作2")
    print("---------------------------------------")

def test3():
    print("操作3")
    print("---------------------------------------")

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

运行结果：

　　 从结果看出，function级别的fixture在当前.py模块里，只会在用例（test_s2）第一次调用前执行一次。

三、scope=“module”

　　（1）fixture参数scope=“module”，module作用是整个.py文件都会生效（整个文件只会执行一次），用例调用时，参数写上函数名称就行。

import pytest

@pytest.fixture(scope="module")
def login():
    print("登录成功")
    yield
    print("用例执行完成，收尾")

def test1(login):
    print("操作1")
    print("-------------------------------------------")

def test2(login):
    print("操作2")
    print("-------------------------------------------")

def test3(login):
    print("操作3")
    print("-------------------------------------------")

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

运行结果：

 　　从结果看出，虽然test1，test2，test3三个地方都调用了login函数，但是它只会在第一个用例前执行一次。

　　（2）如果test1,不调用，test2（调用login），test3不调用，运行顺序会是怎样的？

import pytest

@pytest.fixture(scope="module")
def login():
    print("登录成功")
    yield
    print("用例执行完成，收尾")

def test1():
    print("操作1")
    print("-------------------------------------------")

def test2(login):
    print("操作2")
    print("-------------------------------------------")

def test3():
    print("操作3")
    print("-------------------------------------------")

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

运行结果：

 　　从结果看出，module级别的fixture在当前.py模块里，只会在用例（test_s2）第一次调用前执行一次。

四、yield执行teardown

　　有个问题前面的代码中有一个yield关键字是用来干什么的？其实是用来唤醒teardown。

　　1.fixture里面的teardown用yield来唤醒teardown的执行

import pytest

@pytest.fixture(scope="module")
def login():
    print("登录成功")
    yield
    print("执行teardown！")
    print("用例执行完成，收尾")

def test1(login):
    print("操作1")
    print("--------------------------------------")

def test2(login):
    print("操作2")
    print("--------------------------------------")

def test3(login):
    print("操作3")
    print("--------------------------------------")

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

运行结果：

五、yield遇到异常

　　1.如果其中一个用例出现异常，不影响yield后面的teardown执行，运行结果互不影响，并且在用例全部执行完之后，会唤醒teardown的内容。

import pytest

@pytest.fixture(scope="module")
def login():
    print("登录成功")
    yield
    print("执行teardown！")
    print("用例执行完成，收尾")

def test1(login):
    print("操作1")
    print("----------------------------------")
    # 如果第一个用例异常了，不影响其他用例执行
    raise NameError # 模拟异常

def test2(login):
    print("操作2")
    print("----------------------------------")

def test3(login):
    print("操作3")
    print("----------------------------------")

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

运行结果：

　　2.如果在setup就异常了，那么是不会去执行yield后面的teardown内容了

　　3.yield也可以配合with语句使用，以下是官方案例：

import smtplib
import pytest

@pytest.fixture(scope="module")
def smtp():
    with smtplib.SMTP("smtp.gmail.com") as smtp:
        yield smtp # provide the fixture value
        

六、addfinalizer终结函数

　　1.除了yield可以实现teardown，在request-context对象中注册addfinalizer方法也可以实现终结函数。

import smtplib
import pytest

@pytest.fixture(scope="module")
def smtp_connection(request):
    smtp_connection = smtplib.SMTP("smtp.gmail.com",587,timeout=5)
    def fin():
        print("teardown smpt_connection")
        smtp_connection.close()
    request.addfinalizer(fin)
    return smtp_connection # provide the fixture value

　　2.yield和addfinalizer方法都是在测试完成后呼叫相应的代码。但是addfinalizer不同的是：

　　（1）它可以注册多个终结函数；

　　（2）这些终结方法总是会被执行，无论在之前的setup code有没有抛出错误。这个方法对于正确关闭所有的fixture创建的资源非常便利，即使其一在创建或获取时失败。

参考文章：https://mp.weixin.qq.com/s/QcmjhOhWvdcMFL0sOpaiDA