1. setUp()和tearDown()
setup()函数主要是进行测试前的初始化工作,比如:在接口测试前面做一些前置的参数赋值,数据库操作等等。
teardown()函数是测试后的清除工作,比如:参数还原或销毁,数据库的还原恢复等。
总结:
setup()函数表示测试类中每个测试方法执行前都需要执行的操作,
teardown()函数表示每个测试方法执行后都需要执行的操作。
说明每个级别的含义:
模块级:指的是一个.py文件。
类级:一个.py文件中可以写多个类。(一般情况下只写一个类)
方法级:类中定义的方法叫方法。
函数级:类外定义的方法叫函数。
Pytest框架setUp()函数和tearDown()函数主要分为:模块级,类级,方法级,函数级。
Pytest框架提供的setUp()函数和tearDown()函数如下:
模块级与函数级,不定义在测试类中。
模块级:setup_module()/teardown_module():开始于模块始末,全局的。
函数级:setup_function()/teardown_function():只对函数用例生效(不在类中)。
类级与方法级,定义在类中
类级:setup_class()/teardown_class():只在类中前后运行一次(在类中)。
方法级:setup_method()/teardown_method():开始于方法始末(在类中)。
自由的:setup()/teardown():直接使用感觉和方法级前后置函数一样。
示例
(1)方法级
"""
test_01.py
setup_method()和 teardown_method()函数
需要定义在测试类中,定义在类外不起作用。
setup_method()定义场景,如:打开浏览器,加载网页等
teardown_method()场景,如:关闭浏览器等
"""
import pytest# 测试类
class Test_setUp_tearDown:# 方法级,前置函数def setup_method(self):print("setup_method(self):在每个测试方法之前执行")# 方法级,后置函数def teardown_method(self):print("teardown_method(self):在每个测试方法之后执行\n")# 测试用例adef test_a(self):print("test_a方法")assert True# 测试用例bdef test_b(self):print("test_b方法")assert Trueif __name__ == '__main__':pytest.main()"""
执行结果:
test_a setup_method(self):在每个测试方法之前执行
PASSED [ 50%]test_a方法
teardown_method(self):在每个测试方法之后执行test_b setup_method(self):在每个测试方法之前执行
PASSED [100%]test_b方法
teardown_method(self):在每个测试方法之后执行
"""
(2)类级
"""
test_02.py
setup_class()和 teardown_class()函数
需要定义在测试类中,定义在类外不起作用。
setup_class()定义场景,比如:创建日志对象,创建数据库的连接,创建接口的请求对象等。
teardown_class()定义场景,比如:销毁日志对象,销毁数据库的连接,销毁接口的请求对象。
"""
import pytestclass Test_setUp_tearDown:# 方法级,前置函数def setup_method(self):print("setup_method(self):在每个测试方法之前执行")# 方法级,后置函数def teardown_method(self):print("teardown_method(self):在每个测试方法之后执行\n")# 类级,前置函数def setup_class(self):print("setup_class(self):每个测试类之前执行一次\n")# 类级,后置函数def teardown_class(self):print("teardown_class(self):每个测试类之后执行一次")# 测试用例adef test_a(self):print("test_a方法")assert True# 测试用例bdef test_b(self):print("test_b方法")assert Trueif __name__ == '__main__':pytest.main()
"""
执行结果:
setup_class(self):每个测试类之前执行一次
setup_method(self):在每个测试方法之前执行
test_a方法
teardown_method(self):在每个测试方法之后执行
PASSED
setup_method(self):在每个测试方法之前执行
test_b方法
teardown_method(self):在每个测试方法之后执行
teardown_class(self):每个测试类之后执行一次
"""
(3)函数级
"""
test_03.py
setup_function()和 teardown_function()函数
需要定义在测试类外面,只负责函数的前后置。
对类中定义的方法,不起作用。
"""
import pytest# 函数级,前置函数
def setup_function():print("setup_function: 每个函数开始前都会执行")# 函数级,后置函数
def teardown_function():print("teardown_function: 每个函数结束都会执行\n")# 测试用例a
def test_a():print("类外的test_a函数")assert True# 测试用例b
def test_b():print("类外的test_b函数")assert True# 测试类
class Test_setUp_tearDown:# 测试用例adef test_c(self):print("类内的test_c方法")assert True# 测试用例bdef test_d(self):print("类内的test_d方法")assert Trueif __name__ == '__main__':pytest.main()"""
执行结果:
setup_function: 每个函数开始前都会执行
类外的test_a函数
teardown_function: 每个函数结束都会执行
PASSEDsetup_function: 每个函数开始前都会执行
类外的test_b函数
teardown_function: 每个函数结束都会执行
PASSED类内的test_c方法
PASSED类内的test_d方法
PASSED
"""
(4)模块级
"""
test_04.py
setup_module()和 teardown_module()函数
需要定义在测试类外面,
对函数和类中定义的方法,都不起作用。
"""
import pytest# 模块级,前置函数
def setup_module():print("setup_module():在模块最之前执行\n")# 模块级,后置函数
def teardown_module():print("teardown_module:在模块之后执行")# 函数级,前置函数
def setup_function():print("setup_function: 每个函数开始前都会执行")# 函数级,后置函数
def teardown_function():print("teardown_function: 每个函数结束都会执行\n")# 测试用例a
def test_a():print("test_a函数")assert True# 测试用例b
def test_b():print("test_b函数")assert True# 测试类
class Test_setUp_tearDown:# 测试用例adef test_c(self):print("test_c方法")assert True# 测试用例bdef test_d(self):print("test_d方法")assert Trueif __name__ == '__main__':pytest.main() """
setup_module():在模块最之前执行
setup_function: 每个函数开始前都会执行
test_a函数
teardown_function: 每个函数结束都会执行
PASSEDsetup_function: 每个函数开始前都会执行
test_b函数
teardown_function: 每个函数结束都会执行
PASSEDtest_c方法
PASSEDtest_d方法
teardown_module:在模块之后执行
PASSED
"""
2. Pytest fixture
定义
1、定义fixture跟定义普通函数差不多,唯一区别就是在函数上加个装饰器@pytest.fixture(),fixture命名不要用test_开头,跟用例区分开。用例才是test_开头的命名;
(装饰器本质上是一个 Python 函数或类,它可以让其他函数或类在不需要做任何代码修改的前提下,在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator),装饰器的返回值也是一个函数/类对象。)
2、fixture装饰器里的scope有四个级别的参数:function(不写默认这个)、class、module、session;
3、fixture可以有返回值,如果没有return,默认会是None;用例调用fixture的返回值,就是直接把fixture的函数名称作为参数传入;
4、fixture可以返回一个元组、列表或字典;
5、测试用例可传单个、多个fixture参数;
6、fixture与fixture间可相互调用;
2.1 fixture的用法
2.1.1 作为参数使用
2.1.1.1 将fixture函数作为参数传递给测试用例
1、返回一个参数
# test_05.py
import pytest@pytest.fixture()
def fix_1():a = 'AAAAAA'print("fix_1 返回一个参数")print(a)return adef test1(fix_1):b = fix_1print("test1 ")print("在test中的值"+b)
'''
fix_1 返回一个参数
AAAAAA
PASSED test1
在test中的值AAAAAA
'''
返回两个参数
#test_05.py
import pytest
@pytest.fixture()
def fix_2():a = 'var_a'b = "var_b"print("fix_2 返回两个参数")print("do something before test")yield a,bprint("do something after test")def test2(fix_2):v_a,v_b = fix_2print("test2 ")print("test2 中参数v_a:"+v_a)print("test2 中参数v_b:"+v_b)'''
fix_2 返回两个参数
do something before test
PASSED test2
test2 中参数v_a:var_a
test2 中参数v_b:var_b
do something after test
'''
2、fixture返回一个元组,list或字典,然后从里面取出对应数据
#test_05.py
import pytest@pytest.fixture()
def fix_3():print('函数fix_3')a = 'leo'b = '123456'return (a, b)def test3(fix_3):print("函数test3")u = fix_3[0]p = fix_3[1]assert u == 'leo'assert p == '123456'print('元祖形式正确')
'''
函数fix_3
PASSED 函数test3
元祖形式正确
'''
2.1.1.2 同一个用例中传入多个fixture函数
#test_05.py
import pytest@pytest.fixture()
def fix_4():a = 'leo'print('\n fix_4 传出a')return a@pytest.fixture()
def fix_5():b = '123456'print('fix_5 传出b')return bdef test4(fix_4, fix_5):print('函数test4')u = fix_4p = fix_5assert u == 'leo'assert p == '123456'print('传入多个fixture参数正确')'''
test4 fix_4 传出a
fix_5 传出b
PASSED 函数test4
传入多个fixture参数正确
'''
2.1.1.3 fixture函数之间的相互传递
#test_06.py
import pytest@pytest.fixture()
def pre_01():print("pre_01 begin")# 前置条件:数据准备之类a ="pre_01 values"yield a# 后置条件,用例结束后的处理,清除数据print("pre_01 end")@pytest.fixture()
def pre_02(pre_01):print("pre_02 begin")# 前置条件:数据准备之类yield# 后置条件,用例结束后的处理,清除数据print("pre_02 end")def test_01(pre_01):print("test_01 01 01")def test_02(pre_02):print("test_02 02 02##")def test_03():print("test_03 03 03 ##")if __name__ == '__main__':pytest.main()'''
pre_01 begin
PASSED test_01 01 01
pre_01 endtest_06.py::test_02
pre_01 begin
pre_02 begin
PASSED test_02 02 02##
pre_02 end
pre_01 endtest_06.py::test_03 PASSED test_03 03 03 ##'''
2.1.2 提供灵活的类似setup和teardown功能
Pytest的fixture另一个强大的功能就是在函数执行前后增加操作,类似setup和teardown操作,但是比setup和teardown的操作更加灵活;
具体使用方式是同样定义一个函数,然后用装饰器标记为fixture,然后在此函数中使用一个yield语句,yield语句之前的就会在测试用例之前使用,yield之后的语句就会在测试用例执行完成之后再执行。
#test_07py
@pytest.fixture()
def run_function():print("run before function...")yieldprint("run after function...")def test_run_1(run_function):print("case 1")def test_run_2():print("case 2")def test_run_3(run_function):print("case 3")'''
run before function...
PASSED case 1
run after function...case 2run before function...
PASSED case 3
run after function...'''
常见的应用场景:@pytest.fixture可以用在测试用例执行前后打开、关闭浏览器的操作:
#test_07.py
from playwright.sync_api import sync_playwright
@pytest.fixture(scope="session")
def fixture_driver():p = sync_playwright().start()browser = p.chromium.launch(channel="chrome",headless=False)# context = browser.new_context(viewport={'width': 1920, 'height': 1080})context = browser.new_context()context.clear_cookies()yield context# 实现用例后置context.close()browser.close()p.stop()def test_baidu(fixture_driver):page = fixture_driver.new_page()page.goto("http://www.baidu.com")
2.1.3 利用pytest.mark.usefixtures叠加调用多个fixture
如果一个方法或者一个class用例想要同时调用多个fixture,可以使用@pytest.mark.usefixtures()进行叠加。
注意叠加顺序,① 与直接传入fixture不同的是,@pytest.mark.usefixtures无法获取到被fixture装饰的函数的返回值;
#test_08.py
import pytest
@pytest.fixture
def func_1():print("用例前置操作---1")yieldprint("用例后置操作---1")@pytest.fixture
def func_2():print("用例前置操作---2")yieldprint("用例后置操作---2")@pytest.fixture
def func_3():print("用例前置操作---3")yieldprint("用例后置操作---3")@pytest.mark.usefixtures("func_3") # 最后执行func_3
@pytest.mark.usefixtures("func_2") # 再执行func_2
@pytest.mark.usefixtures("func_1") # 先执行func_1
def test_func():print("这是测试用例")'''
用例前置操作---1
用例前置操作---2
用例前置操作---3
PASSED 这是测试用例
用例后置操作---3
用例后置操作---2
用例后置操作---1'''
2.1.4 fixture自动使用autouse=True
当用例很多的时候,每次都传这个参数,会很麻烦。fixture里面有个参数autouse,默认是False没开启的,可以设置为True开启自动使用fixture功能,这样用例就不用每次都去传参了,autouse设置为True,自动调用fixture功能。所有用例都会生效,包括类中的测试用例和类以外的测试用例。
@pytest.fixture(scope="function", autouse=True)
def fix_func_autouse():print("fix_func_autouse")
#test_09.py
@pytest.fixture(autouse=True, scope="function")
def func_auto():"""autouse为True时,会作用于每一条用例"""print("\n---用例前置操作---")yieldprint("---用例后置操作---")# func_auto函数的autouse=True时,无论是否使用usefixtures引用func_auto,都会执行func_auto
@pytest.mark.usefixtures("func_auto")
def test_01():print("case 1")def test_02():print("case 2")class Test:def test_03(self):print("case 3")'''
test_01
---用例前置操作---
PASSED case 1
---用例后置操作---test_02
---用例前置操作---
PASSED case 2
---用例后置操作---Test::test_03
---用例前置操作---
PASSED case 3
---用例后置操作---
'''
2.2 四种作用域
fixture(scope=‘function’,params=None,autouse=False,ids=None,name=None)
fixture里面有个
function:每一个函数或方法都会调用
class:每一个类调用一次,一个类中可以有多个方法
module:每一个.py文件调用一次,该文件内又有多个function和class
session:多个文件调用一次,可以跨.py文件调用(通常这个级别会结合conftest.py文件使用)
2.2.1 function级别
function默认模式为@pytest.fixture() 函数级别,即scope=“function”,scope可以不写。每一个函数或方法都会调用,每个测试用例执行前都会执行一次function级别的fixture。
# @pytest.fixture(scope="function")等价于@pytest.fixture()
@pytest.fixture(scope="function")
def func_auto():"""用例级别fixture,作用域单个用例"""print("\n---function级别的用例前置操作---")yieldprint("---function级别的用例后置操作---")# test_01会引用func_auto函数,test_02没有用修饰器修饰,故不会引用
def test_func_auto_fixture_1(func_auto):print("func 1 print")def test_func_auto_fixture_2():print("func 2 print")
2.2.2 class级别
fixture的scope值还可以是class,此时则fixture定义的动作就会在测试类class的所有用例之前和之后运行,需注意:测试类中只要有一个测试用例的参数中使用了class级别的fixture,则在整个测试类的所有测试用例都会调用fixture函数
① 用例类中的测试用例调用fixture
执行fixture定义的动作,以及此测试类的所有用例结束后同样要运行fixture指定的动作
import pytest@pytest.fixture(scope="class")
def class_auto():"""类级别fixture,作用域整个类"""print("\n---class级别的用例前置操作---")yieldprint("---class级别的用例后置操作---")class TestClassAutoFixture:# class级别的fixture任意一个用例引用即可def test_class_auto_fixture_1(self, class_auto):print("class 1 print")def test_class_auto_fixture_2(self):print("class 1 print")
测试类中的第1条测试用例引用了fixture修饰的函数,则整个测试类的所有测试用例都会执行fixture函数的前置操作,在所有用例执行完成后,都会执行fixture函数的后置操作。
② 用例类外的测试用例调用fixture
如果在类外的函数中去使用class级别的fixture,则此时在测试类外每个测试用例中,fixture跟function级别的fixture作用是一致的,即
def test_class_auto_fixture(class_auto): print("class 1 print")
测试类外的函数引用了class级别的fixture,则它的作用会等同于function级别的fixture,
2.2.3 module级别
在Python中module即.py文件,当fixture定义为module时,则此fixture将在当前文件中起作用。这里需要特别说明的是,当fixture的scope定义为module时,只要当前文件中有一个测试用例使用了fixture,不管这个用例是在类外,还是在类中,都会在当前文件(模块)的所有测试用例执行之前去执行fixture定义的行为以及当前文件的所有用例结束之后同样去执行fixture定义的对应操作。
@pytest.fixture(scope="module")
def module_auto():"""作用于整个py文件"""print("\n---module级别的用例前置操作---")yieldprint("---module级别的用例后置操作---")# 测试类外和测试类内的函数方法都调用了module级别的fixture,但整个py文件只会生效一次fixture。
def test_module_scope_out_class(module_auto):print("case scope 01")class TestScope1:def test_scope_01(self):print("case scope 01")def test_scope_02(self, module_auto):print("case scope 02")def test_scope_03(self):print("case scope 03")
若类中的方法分别调用了class级别的fixture和module级别的fixture,则会两个fixture都生效:
# 顺序在前面fixture会先执行
def test_scope_01(self, module_auto, class_auto): print("case scope 01")
若类中的方法同时调用了function级别、class级别、module级别的fixture,则3种fixture会同时生效:
# 顺序在前面fixture会先执行
def test_scope_02(self, module_auto, class_auto, func_auto): print("case scope 02")
2.2.4 session级别(使用conftest.py共享fixture)
当fixture的scope定义为session时,是指在当前目录下的所有用例之前和之后执行fixture对应的操作
fixture为session级别是可以跨.py模块调用的,也就是当我们有多个.py文件的用例的时候,如果多个用例只需调用一次fixture,那就可以设置为scope=“session”,并且写到conftest.py文件里
使用方式:
① 定义测试用例文件
② 在指定目录下创建conftest.py(固定命名,不可修改)文件,然后在conftest.py文件中定义fixture方法,将scope指定为session,此时在当前目录下只要有一个用例使用了此fixture,则就会在当前目录下所有用例之前和之后会执行fixture定义的对应的操作。
@pytest.fixture(scope="session", )
def session_auto():"""session级别的fixture,针对该目录下的所有用例都生效"""print("\n---session级别的用例前置操作---")yieldprint("---session级别的用例后置操作---")
定义了session级别的fixture,存放于该用例文件的同一个目录下的conftest.py文件中,该目录下的任一用例文件中的任一测试用例,引用了这个session级别的fixture,则这个session级别的fixture会针对这整个用例文件会生效。若存放在根目录下,则针对整个工程的所有用例都会生效。
class TestSessionAutoFixture:# session级别的fixture任意一个用例引用即可def test_session_auto_fixture_1(self, session_auto):print("session 1 print")def test_session_auto_fixture_2(self):print("session 1 print")def test_session_auto_fixture():print("session 1 print")
3. conftest全局作用
Pytest支持在测试的目录中,创建conftest.py文件,进行全局配置。
conftest.py文件须知:
可以跨.py文件调用,有多个.py文件调用时,可让conftest.py只调用了一次fixture,或调用多次fixture;
conftest.py与运行的用例要在同一个pakage下,并且有__init__.py文件;
不需要import导入conftest.py,pytest用例会自动识别该文件,放到项目的根目录下就可以全局目录调用了,如果放到某个package下,那就在package内有效,可有多个conftest.py;
conftest.py配置脚本名称是固定的,不能改名称;
conftest.py文件不能被其他文件导入;
所有同目录测试文件运行前都会执行conftest.py文件;