Pytest框架之fixture详解(一)

我们在编写测试用例,都会涉及到用例执行之前的环境准备工作,和用例执行之后的环境清理工作。

代码版的测试用例也不例外。在自动化测试框架当中,我们也需要编写:

用例执行之前的环境准备工作代码(前置工作代码)

用例执行之后的环境清理工作(后置工作代码)

通常,在自动化测试框架当中,都叫做fixture。

pytest作为python语言的测试框架,它的fixture有2种实现方式。

  • 一种是xunit-style,跟unittest框架的机制非常相似,即setup/teardown系列
  • 一种是它自己的fixture机制,以@pytest.fixture装饰器来申明。

pytest的fixture实现方式一:xunit-style

pytest的xunit-style有三个级别的fixture:测试模块、测试类、测试函数。

1、测试函数/方法级别:每一个测试函数都会执行的前置和后置。

测试类内部的测试方法:

  • 前置函数名称:setup_method
  • 后置函数名称:teardown_method

模块下的测试函数:

  • 前置函数名称:setup_function
  • 后置函数名称:teardown_function

2、测试类级别:一个测试类只执行一次前置和后置。

  • 前置函数名称:setup_class
  • 后置函数名称:teardown_class

注意:用@classmethod装饰

3、测试模块级别:一个测试模块只执行一次前置和后置。

  • 前置函数名称:setup_module
  • 后置函数名称:teardown_module
from selenium import webdriver
from time import sleep
from random import randint
​
​
def setup_module():
    print("====  模块级的 setup 操作  ====")
​
​
def teardown_module():
    print("====  模块级的 teardown 操作  ====")
​
​
def test_random():
    assert randint(1, 5) == 3
​
​
class TestWeb:
​
    @classmethod
    def setup_class(cls):
        print("====  测试类级的 setup 操作  ====")
​
    @classmethod
    def teardown_class(cls):
        print("====  测试类级的 teardown 操作  ====")
​
    def setup_method(self):
        print("====  测试用例级的 setup 操作  ====")
        self.driver = webdriver.Chrome()
​
    def teardown_method(self):
        print("====  测试用例级的 teardown 操作  ====")
        self.driver.quit()
​
    def test_search(self):
        self.driver.get("https://www.baidu.com/")
        self.driver.find_element_by_id("kw").send_keys("柠檬班")
        self.driver.find_element_by_id("su").click()
        sleep(1)

pytest也支持运行unittest的测试用例。支持unittest以下特性:

  • @unittest.skip
  • setUp/tearDown;
  • setUpClass/tearDownClass;
  • setUpModule/tearDownModule;

pytest的fixture实现方式二:fixture机制

通过@pytest.fixture装饰器来定义fixture。一个函数被@pytest.fixture装饰,那么这个函数就是fixture。

使用fixture时,分为二个部分:fixture定义、fixture调用。

除此之外,还有fixture的共享机制,嵌套调用机制。

1、定义fixture。

1)fixture通过函数实现。

2)使用@pytest.fixture进行装饰

import pytest
​
@pytest.fixture
def init():
    pass

3)前置准备工作代码和后置清理工作代码,都写在一个函数里面。

4)通过yeild关键字,区分前置代码和后置代码 。yeild之前的代码为前置代码,yeild之后的代码为后置代码

在实际应用场景当中,可以只有前置准备工作代码,也可以只有后置清理工作代码。

import pytest
​
​
@pytest.fixture
def init():
    print("用例执行之前,执行的代码")  # 前置代码
    yield
    print("用例执行之后,执行的代码")  # 后置代码

​
@pytest.fixture
def init2():
    print("用例执行之前,执行的代码")  # 只有用例执行之前的前置准备代码

​
@pytest.fixture
def init3():
    yield
    print("用例执行之后,执行的代码")  # 只有用例执行之后的后置清理代码

5)fixture有4个作用域:测试会话(session)、测试模块(module)、测试类(class)、测试用例(function)

测试会话:pytest执行测试用例的整个过程,称为会话。

比如pytest收集到了100条用例并执行完成,这个过程称为测试会话。

设置fixture的作用域:通过@pytest.fixture(scope=作用域)来设置。默认情况下,scope=function

import pytest
​
​
# 没有设置scope,默认为测试函数级别。即调用此fixture的测试类/模块/函数下,每个测试函数都会执行一次这个fixture
@pytest.fixture
def init():
    print("用例执行之前,执行的代码")  # 前置代码
    yield
    print("用例执行之后,执行的代码")  # 后置代码
​
​
# 设置scope为class。调用此fixture的测试类下,只执行一次这个fixture.
@pytest.fixture(scope="class")
def init2():
    print("用例执行之前,执行的代码")  # 只有用例执行之前的前置准备代码
​
​
# 设置scope为session。autouse表示自动使用。
# 那么在pytest收集用例后,开始执行用例之前会自动化执行这个fixture当中的前置代码,
# 当所有用例执行完成之后,自动化执行这个fixture的后置代码。
@pytest.fixture(scope="session",autouse=True)
def init3():
    yield
    print("用例执行之后,执行的代码")  # 只有用例执行之后的后置清理代

6)fixture的返回值设置:yeild 返回值

当测试用例当中,要使用fixture里生成的数据时,则需要fixture返回数据。

若有数据返回则:yeild 返回值

import pytest
from selenium import webdriver
from time import sleep
​
​
# 设置scope为class。调用此fixture的测试类下,只执行一次这个fixture.
@pytest.fixture(scope="class")
def init2():
    print("==== 测试类下,执行所有用例之前,执行的代码 ====")
    driver = webdriver.Chrome()
    yield driver   # 返回driver对象
    print("==== 测试类下,执行所有用例之后,执行的代码 ====")
    driver.quit()

2、调用fixture

在fixture定义好之后,可以明确:

  • 1)fixture处理了哪些前置准备工作、哪些后置清理工作
  • 2)fixture作用在哪个范围(是测试函数?还是测试类?还是测试会话?还是测试模块?)

在以上2点都定下来了之后,接下来就是,在测试用例当中,根据需要调用不同的fixture。

调用方法有2种:

  • 1、在测试用例/测试类上面加上:@pytest.mark.usefixture("fixture的函数名字")
  • 2、将fixture函数名,作为测试用例函数的参数。

第2种用法,主要是用参数来接收fixture的返回值,以便在测试用例中使用。

第一种方式案例如下:

第二种方式案例如下:

3、conftest.py共享机制

在某些大的业务场景下,很多用例当中,会使用相同的前置准备工作,和后置清理工作。

如果在每个测试模块下,都把前置准备工作,和后置清理工作写一遍,在维护上和优化上讲不够好。

pytest框架提供了一个fixture共享的机制 ,可以让不同的用例模块,使用同一个fixture。这就是conftest.py文件。

3.1 conftest.py共享实现

1)在项目根目录下,创建一个conftest.py文件。

2)文件名必须是conftest.py,大小写敏感,不可改名字。

3)conftest.py当中,可以编写多个fixture

4)在测试用例文件当中,不需要引入conftest.py文件。直接调用fixture的函数名,会自动去conftest.py当中查找的。

3.2 conftest.py层级作用域

conftest.py在项目根目录下,则项目下的所有测试用例,均可使用conftest.py中定义的fixture。即项目根目录下的conftest.py,作用域是整个项目。

那,如果,conftest.py当中的fixture,只想在某个python包内可用呢?

conftest.py实现了层级作用域。

简单来说就是:conftest.py 在哪个目录下,此目录下(包含子目录)的所有用例可使用其中的fixture。

如下图:

  • 根目录下的conftest.py里的fixture,无论项目下的哪个用例,都可以使用。
  • 子目录moduleA下的conftest.py里的fixture,只有moduleA下的用例可以使用。
  • 子目录moduleB下的conftest.py里的fixture,只有moduleB下的用例可以使用。

moduleB下的用例文件test_module_b.py中的用例,即可以使用根目录下的conftest.py中的fixuture,又可以使用自己目录下的conftest.py的fixture:

那么有个问题,如果出现了同名fixture怎么办呢?

这里涉及到了,测试用例在执行时,调用fixture的顺序。一般来讲,按就近原则调用。

测试用例文件中的fixture > 当前目录中的fixture > 上级目录中的fixture > 根目录中的fixture

4、fixture嵌套

fixture不但支持共享 ,还支持嵌套使用。

嵌套使用即:一个fixture,可以做另外一个fixture的参数。

如下图所示:名为init2的fixture,可以作为init的参数。

并且,init当中,将init2的返回值,同样返回。

当在用例当中,调用init时,init会自动去调用init2。

下图案例中,init2为class级作用域,init为function级作用域。

fixture的执行顺序如下:

  • init2的后置代码
  • init的后置代码
  • init的前置代码
  • init2的前置代码

到此这篇关于Pytest框架之fixture的文章就介绍到这了。希望对大家的学习有所帮助,也希望大家多多支持我们。

(0)

相关推荐

  • python pytest进阶之fixture详解

    前言 学pytest就不得不说fixture,fixture是pytest的精髓所在,就像unittest中的setup和teardown一样,如果不学fixture那么使用pytest和使用unittest是没什么区别的(个人理解). fixture用途 1.做测试前后的初始化设置,如测试数据准备,链接数据库,打开浏览器等这些操作都可以使用fixture来实现 2.测试用例的前置条件可以使用fixture实现 3.支持经典的xunit fixture ,像unittest使用的setup和te

  • pytest官方文档解读fixture的调用方式

    目录 pytest官方文档fixtures调用 一.测试函数声明传参请求fixture 二.fixture中的返回值传递给测试函数 pytest官方文档fixtures调用 既然fixtures是给执行测试做准备工作的,那么pytest如何知道哪些测试函数 或者 fixtures要用到哪一个fixtures呢?说白了,就是fixtures的调用. 一.测试函数声明传参请求fixture 测试函数通过将fixture声明为参数来请求fixture. def test_my_fruit_in_bas

  • pytest官方文档解读fixtures

    目录 一.测试的构成 二.回到fixtures本身 在深入了解fixture之前,让我们先看看什么是测试. 一.测试的构成 其实说白了,测试就是在特定的环境.特定的场景下.执行特定的行为,然后确认结果与期望的是否一致. 就拿最常见的登录来说,完成一次正常的登录场景,需要可用的测试环境,可以正常登录的账号和密码.然后,用这个账号密码进行登录操作,结果登录成功,符合这次正常登录场景的预期结果,测试完成. 这样看来,通常就可以把测试分为4个步骤: Arrange Act Assert Cleanup

  • pytest解读fixture有效性及跨文件共享fixtures

    目录 fixture有效性及跨文件共享fixtures 一.fixture有效性 二.跨文件共享fixtures fixture有效性及跨文件共享fixtures 一.fixture有效性 fixture有效性,说白了就是fixture函数只有在它定义的使用范围内,才可以被请求到.比如,在类里面定义了一个fixture,那么就只能是这个类中的测试函数才可以请求.但是,如果一个fixture定义的范围是整个模块,那么这个模块下的每个测试函数都可以去请求. 这里还有另一个影响fixture有效性的参

  • pytest框架之fixture详细使用详解

    本人之前写了一套基于unnitest框架的UI自动化框架,但是发现了pytest框架之后觉得unnitest太low,现在重头开始学pytest框架,一边学习一边记录,和大家分享,话不多说,那就先从pytest框架的精髓fixture说起吧! 简介: fixture区别于unnitest的传统单元测试(setup/teardown)有显著改进: 1.有独立的命名,并通过声明它们从测试函数.模块.类或整个项目中的使用来激活. 2.按模块化的方式实现,每个fixture都可以互相调用. 3.fixt

  • pytest fixtures函数及测试函数的参数化解读

    目录 pytest fixtures测试函数参数化 一.@pytest.mark.parametrize:参数化测试函数 1. 常规用法 2. 在参数化中标记单个测试实例 3. 多个参数化组合,笛卡尔积 二.用钩子函数pytest_generate_tests example拓展 总结 pytest fixtures测试函数参数化 Pytest会在以下几个级别启用测试参数化: pytest.fixture(),可以对fixture函数进行参数化. @pytest.mark.parametrize

  • 分享Pytest fixture参数传递的几种方式

    目录 1.背景 2.fixture中参数传递的几种方式 1)fixture中的函数返回 2)与@pytest.mark.parametrize的结合 3)fixture中的方法嵌套传递 4)测试方法中产生数据后,直接调用teardown 1.背景 最近使用Pytest中的fixture和conftest时,遇到需要在conftest中的setup和teardown方法里传递参数.这里记录下几种实现的方式. 2.fixture中参数传递的几种方式 1)fixture中的函数返回 conftest.

  • python pytest进阶之xunit fixture详解

    前言 今天我们再说一下pytest框架和unittest框架相同的fixture的使用, 了解unittest的同学应该知道我们在初始化环境和销毁工作时,unittest使用的是setUp,tearDown方法,那么在pytest框架中同样存在类似的方法,今天我们就来具体说明. 先附上官方文档的一段说明 1.每个级别的setup/teardown都可以多次复用 2.如果相应的初始化函数执行失败或者被跳过则不会执行teardown方法 3.在pytest4.2之前,xunit fixture 不遵

  • pytest进阶教程之fixture函数详解

    fixture函数存在意义 与python自带的unitest测试框架中的setup.teardown类似,pytest提供了fixture函数用以在测试执行前和执行后进行必要的准备和清理工作.但是相对来说又比setup.teardown好用. firture相对于setup和teardown的优势 命名方式灵活,不局限于setup和teardown这几个命名 conftest.py 配置里可以实现数据共享,不需要import就能自动找到一些配置 scope="module" 可以实现

  • pytest自动化测试中的fixture的声明和调用

    目录 1. fixture的声明 2. fixture的调用 2.1 fixture的调用方式 2.1.1 使用fixturename 2.1.2 使用@pytest.mark.usefixtures("fixturename") 2.1.3 autouse--自动应用 2.2 fixture使用的灵活性 2.2.1 一个fixture函数可以调用其他的fixture 2.2.2 fixture函数可被反复重用 2.2.3 测试函数/fixture函数可以一次调用多个fixture 2

  • Pytest框架之fixture的详细使用教程

    前言 前面一篇讲了setup.teardown可以实现在执行用例前或结束后加入一些操作,但这种都是针对整个脚本全局生效的 如果有以下场景:用例 1 需要先登录,用例 2 不需要登录,用例 3 需要先登录.很显然无法用 setup 和 teardown 来实现了fixture可以让我们自定义测试用例的前置条件 fixture优势 命名方式灵活,不局限于 setup 和teardown 这几个命名 conftest.py 配置里可以实现数据共享,不需要 import 就能自动找到fixture sc

随机推荐