[接口测试_B] 06 Pytest的setup和teardown

pytest实际上是python自带测试框架unittest的扩展,那么pytest是如何实现unittest中的setup和teardown的呢?

pytest初始化的类别和作用域

  • 模块级别(Module level setup/teardown):作用于一个模块内的所有class和def,对于所有class和def,setup和teardown只执行一次
def setup_module(module):
""" setup any state specific to the execution of the given module."""
def teardown_module(module):
""" teardown any state that was previously setup with a setup_module
method.
"""
  • 类级别(Class level setup/teardown):作用于一个class内中的所有test,所有用例只执行一次setup,当所有用例执行完成后,才会执行teardown
@classmethod
def setup_class(cls):
""" setup any state specific to the execution of the given class (which
usually contains tests).
"""
@classmethod
def teardown_class(cls):
 """ teardown any state that was previously setup with a call to
setup_class.
"""
  • 方法和函数级别(Method and function level setup/teardown):作用于单个测试用例,若用例没有执行(如被skip了)或失败了,则不会执行teardown
def setup_method(self, method):
""" setup any state tied to the execution of the given method in a
class. setup_method is invoked for every test method of a class.
"""
def teardown_method(self, method):
""" teardown any state that was previously setup with a setup_method
call.
"""

若用例直接写在模块中,而不是在类中,则用:

def setup_function(function):
""" setup any state tied to the execution of the given function.
Invoked for every test function in the module.
"""
def teardown_function(function):
""" teardown any state that was previously setup with a setup_function
call.
"""
  • pytest.fixture()装饰函数,结合yield实现初始化和teardown
    举个例子(pytest)文档中的:
import smtplib
import pytest
@pytest.fixture(scope="module")
def smtp():
    smtp = smtplib.SMTP("smtp.gmail.com", 587, timeout=5)
    yield smtp # provide the fixture value
    print("teardown smtp")
    smtp.close()

运行结果:

$ pytest -s -q --tb=no
FFteardown smtp
2 failed in 0.12 seconds

pytest用例初始化操作的示例

为了体现初始化和环境恢复,本节演示采用邮件发送的脚本,可查看邮件发送的脚本:python发送邮件脚本或者参考文章:SMTP发送邮件

1、setup_method(self, method)

  • 在test_method.py中构建了3个测试用例,每个用例在执行前后都会执行setup_method/teardown_method连接smtp和断开smtp。
import smtplib
from email.mime.text import MIMEText
from email.header import Header
from email.mime.multipart import MIMEMultipart

import pytest

class TestSmtp():
    # 发件人和收件人,换成你自己的发件人、收件人qq号
    sender = "sender@qq.com"
    receivers = "rece@qq.com"

    # 邮箱服务器
    smtpserver = "smtp.qq.com"
    smtpport = 465

    # 连接邮箱服务器,qq邮箱和密码,换成自己的
    username = "sendr@qq.com"
    password = "qq mail's password"
    smtp = smtplib.SMTP_SSL()

    def setup_method(self, method):
        self.smtp.connect(self.smtpserver, self.smtpport)
        self.smtp.login(self.username, self.password)
        print("成功登录")

    def teardown_method(self, method):
        self.smtp.quit()
        print("断开连接")

    def test_send_text(self):
        # 邮件发送、接收人员,邮件标题、正文
        msg = MIMEText("微信公众号号:开源优测", "plain", "utf-8")
        msg["From"] = self.sender
        msg["To"] = self.receivers
        msg["Subject"] = Header("开源优测_DeepTest_from_chenlele_text", "utf-8")

        # 发送邮件
        self.smtp.sendmail(self.sender, self.receivers, msg.as_string())

    def test_send_html(self):
        msg = MIMEText("<p>微信公众号号:开源优测</p><a href='http://www.testingunion.com'>开源优测社区</a>>", 
        "html", 
        "utf-8")
        msg["From"] = self.sender
        msg["To"] = self.receivers
        msg["Subject"] = Header("开源优测_DeepTest_from_chenlele_html", "utf-8")

        # 发送邮件
        self.smtp.sendmail(self.sender, self.receivers, msg.as_string())

    def test_send_attchment(self):
        # 邮件格式说明、发送、接收人员信息、邮件标题
        msg = MIMEMultipart()
        msg["From"] = self.sender
        msg["To"] = self.receivers
        msg["Subject"] = Header("开源优测_DeepTest_from_chenlele", "utf-8")

        # 构建带附件的邮件正文
        msg.attach(MIMEText("微信公众号:开源优测", "plain", "utf-8")) 
    
        # 构造附件,多个附件同理
        attach1 = MIMEText(open("judge_leap.json", 'rb').read(), "base64", "utf-8")
        attach1["Content-Type"] = "application/octet-stream"

        # 这里filename随意写,将会在邮件中显示
        attach1["Content-Disposition"] = "attrachment;filename=code.py"
    
        # 关联附件到正文
        msg.attach(attach1)
        # 发送邮件
        self.smtp.sendmail(self.sender, self.receivers, msg.as_string())


  • 查看结果,采用pytest -s -q 运行,-s 可以查看打印信息,-q减少输出信息:


    test_method结果.png

2、setup_class(cls)

  • 作用于class的setup_class/teardown_class,类中所有的用例只会执行一次,如图所示;
  • ps:用例与test_method.py的一致,参考上一串代码。
test_class.png

3、setup_module(module)

  • setup_module/teardown_module在一个模块内,只会执行一次,作用于模块内的所有用例
  • 示例中构建了2个class和1个def,共4个用例,可以看到,4个用例只执行了一次module
test_module结果.png
test_module.py
import smtplib
from email.mime.text import MIMEText
from email.header import Header
from email.mime.multipart import MIMEMultipart

import pytest

info = {"sender": "your@qq.com", 
        "receivers": "yourother@qq.com",
        "smtpserver": "smtp.qq.com",
        "smtpport": 465,
        "username":"your@qq.com",
        "password": "yourpassword",
        "smtp": smtplib.SMTP_SSL()}


def setup_module(module):
    info["smtp"].connect(info["smtpserver"], info["smtpport"])
    info["smtp"].login(info["username"], info["password"])
    print("成功登录")

def teardown_module(module):
    info["smtp"].quit()
    print("断开连接")

class TestSendText():
     def test_send_text(self):
        # 邮件发送、接收人员,邮件标题、正文
        msg = MIMEText("微信公众号号:开源优测", "plain", "utf-8")
        msg["From"] =info["sender"]
        msg["To"] = info["receivers"]
        msg["Subject"] = Header("开源优测_DeepTest_from_chenlele_text", "utf-8")

        # 发送邮件
        info["smtp"].sendmail(info["sender"], info["receivers"], msg.as_string())
    
     def test_send_html(self):
        msg = MIMEText("<p>微信公众号号:开源优测</p><a href='http://www.testingunion.com'>开源优测社区</a>>", 
        "html", 
        "utf-8")
        msg["From"] = info["sender"]
        msg["To"] = info["receivers"]
        msg["Subject"] = Header("开源优测_DeepTest_from_chenlele_html", "utf-8")

        # 发送邮件
        info["smtp"].sendmail(info["sender"], info["receivers"], msg.as_string())

class TestSendAttach():
    def test_send_attchment(self):
        # 邮件格式说明、发送、接收人员信息、邮件标题
        msg = MIMEMultipart()
        msg["From"] = info["sender"]
        msg["To"] = info["receivers"]
        msg["Subject"] = Header("开源优测_DeepTest_from_chenlele", "utf-8")

        # 构建带附件的邮件正文
        msg.attach(MIMEText("微信公众号:开源优测", "plain", "utf-8")) 
    
        # 构造附件,多个附件同理
        attach1 = MIMEText(open("judge_leap.json", 'rb').read(), "base64", "utf-8")
        attach1["Content-Type"] = "application/octet-stream"

        # 这里filename随意写,将会在邮件中显示
        attach1["Content-Disposition"] = "attrachment;filename=code.py"
    
        # 关联附件到正文
        msg.attach(attach1)

        # 发送邮件
        info["smtp"].sendmail(info["sender"], info["receivers"], msg.as_string())

def test_send_text_out():
    # 邮件发送、接收人员,邮件标题、正文
    msg = MIMEText("微信公众号号:开源优测", "plain", "utf-8")
    msg["From"] =info["sender"]
    msg["To"] = info["receivers"]
    msg["Subject"] = Header("class外的用例执行", "utf-8")

    # 发送邮件
    info["smtp"].sendmail(info["sender"], info["receivers"], msg.as_string())

4、pytest.fixture()

  • pytest.fixture采用yield实现setup和teardown操作,yield提供的参数为函数名称
  • 与setup_module类似,pytest.fixture可作用于一个模块内的所有def和class。区别在于,必须将pytest.fixture()装饰的函数作为参数传递给用例。
  • pytest.fixture()装饰的函数必须作为参数传递给用例吗?
    1)、将class中的smtp_ini都删除,class中的用例执行失败,def用例执行成功;
    2)、将class中test_send_text的smtp_ini保留,其余2个删除,class中的用例都执行成功?这是为什么呢?只有1个用力传入了参数,但所有用例都执行成功了。
    3)、将class和def中的smtp_ini都删除,用例全部执行失败。
  • ps:用例内容与test_module.py的一致,就不粘代码了。
image.png

总结

4种方式的作用域:

  • setup_method:仅作用于class用例集中的用例,置于class内,每个用例都会调用一次
  • setup_function:作用于独立的def用例,不可作用于class内的用例
  • setup_class:作用于class用例集中的用例,置于class内,只在class用例执行的开始执行setup_class,结束时执行teardown_class
  • setup_module:作用于模块内的所有用例,置于class外,只在所以用例的开始执行setup_module,结束时执行teardown_module
  • pytest.fixture():作用于模块内的所有用例,但需要传递装饰函数为参数,可置于class内或class外
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容

  • 在pytest中加入fixture的目的是提供一个固定的基准,使测试能够可靠、重复地执行,pytest的fixtu...
    何小有阅读 13,537评论 1 17
  • Python 面向对象Python从设计之初就已经是一门面向对象的语言,正因为如此,在Python中创建一个类和对...
    顺毛阅读 4,210评论 4 16
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • Startup 单元测试的核心价值在于两点: 更加精确地定义某段代码的作用,从而使代码的耦合性更低 避免程序员写出...
    wuwenxiang阅读 10,083评论 1 27
  • 一个类的定义放在另一个类的内部,这个类就叫做内部类 10.1创建内部类 public class First {p...
    zlb阅读 378评论 0 0