前言
- 与unittest不同,pytest使用的是python自带的assert关键字来进行断言
- assert关键字后面可以接一个表达式,只要表达式的最终结果为True,那么断言通过,用例执行成功,否则用例执行失败
Pytest的断言方式及应用场景
-
使用assert语句
-
断言预期的异常
-
断言预期的告警
-
利用上下文信息进行断言
-
自定义断言方式
使用assert语句进行断言
-
pytest允许使用python的标准assert语句进行断言处理
-
采用assert断言时,可添加备注信息,当断言失败时,备注信息会以assertionerror抛出,并在控制台输出
import requests class TestAssert(): def test_assert(self): r = requests.get('http://www.baidu.com') assert r.status_code == 100, "返回200说明访问成功"
示例2:在抛出异常之后输出一些提示信息,执行之后就方便查看是什么原因了
# 异常信息 def f(): return 3 def test_function(): a = f() assert a % 2 == 0, "判断 a 为偶数,当前 a 的值为:%s" % a
常用断言
断言预期的异常
-
在测试过程中,对某些方法进行测试时,预测输入某些特定数据,会抛出特定异常,若出现特定异常,则用例执行通过。
-
对这类特定异常的断言,可以采用pytest中的pytest.raises()进行处理。
以下示例对一个判断是否为闰年的方法进行测试:
# -*- coding: utf-8 -*- """ __title__ = pytest study __Time__ = 2021-04-12 08:47 __Author__ = sary """ import pytest def is_leap_year(year): # 先判断year是不是整型 if isinstance(year, int) is not True: raise TypeError("传入的参数不是整数") elif year == 0: raise ValueError("公元元年是从公元一年开始!!") elif abs(year) != year: raise ValueError("传入的参数不是正整数") elif (year % 4 ==0 and year % 100 != 0) or year % 400 == 0: print("%d年是闰年" % year) return True else: print("%d年不是闰年" % year) return False class TestAssert(): # 对一个判断是否是闰年的方法进行测试 def test_exception_typeerror(self): with pytest.raises(TypeError): is_leap_year('ss') def test_true(self): assert is_leap_year(2021) == True
2、将异常信息存储到一个变量中,变量的类型则为异常类,包含异常的type、value和traceback等信息
# -*- coding: utf-8 -*- """ __title__ = pytest study __Time__ = 2021-04-12 08:47 __Author__ = sary """ import pytest def is_leap_year(year): # 先判断year是不是整型 if isinstance(year, int) is not True: raise TypeError("传入的参数不是整数") elif year == 0: raise ValueError("公元元年是从公元一年开始!!") elif abs(year) != year: raise ValueError("传入的参数不是正整数") elif (year % 4 ==0 and year % 100 != 0) or year % 400 == 0: print("%d年是闰年" % year) return True else: print("%d年不是闰年" % year) return False class TestAssert(): def test_exception_value(self): with pytest.raises(ValueError) as excinfo: is_leap_year(0) assert "从公元一年开始" in str(excinfo.value) assert excinfo.type == ValueError
3、可以在用例中定义抛出的异常信息是否与预期的异常信息匹配,若不匹配则用例执行失败
# -*- coding: utf-8 -*- """ __title__ = pytest study __Time__ = 2021-04-12 08:47 __Author__ = sary """ import pytest def is_leap_year(year): # 先判断year是不是整型 if isinstance(year, int) is not True: raise TypeError("传入的参数不是整数") elif year == 0: raise ValueError("公元元年是从公元一年开始!!") elif abs(year) != year: raise ValueError("传入的参数不是正整数") elif (year % 4 ==0 and year % 100 != 0) or year % 400 == 0: print("%d年是闰年" % year) return True else: print("%d年不是闰年" % year) return False class TestAssert(): def test_exception_match(self): with pytest.raises(ValueError, match=r'公元33元年是从公元一年开始') as excinfo: is_leap_year(0) assert excinfo.type == ValueError
将match中的Pattern该为能够匹配的信息,则该用例能够执行成功。
4、使用标记函数检查异常
pytest.mark.xfail(raises=xx)
异常断言
可以使用 pytest.raises 作为上下文管理器,当抛出异常时可以获取到对应的异常实例
# 断言异常 def test_zero_division(): with pytest.raises(ZeroDivisionError): 1 / 0
异常断言示例:
断言场景:断言它抛的异常是不是预期想要的
代码执行:1/0
预期结果:抛的异常是ZeroDivisionError: division by zero
如何断言:通常是断言异常的 type 和 value 值了
具体方式:这里 1/0 的异常类型是 ZeroDivisionError,异常的 value 值是 divisionby zero
# 详细断言异常 def test_zero_division_long(): with pytest.raises(ZeroDivisionError) as excinfo: 1 / 0 # 断言异常类型 type assert excinfo.type == ZeroDivisionError # 断言异常 value 值 assert "division by zero" in str(excinfo.value)
excinfo :是一个异常信息实例
主要属性: .type 、 .value 、 .traceback
注意:断言 type 的时候,异常类型是不需要加引号的,断言 value值的时候需转 str
拓展一:match
可以将 match 关键字参数传递给上下文管理器,以测试正则表达式与异常的字符串表示形式是否匹配
注意:这种方法只能断言value,不能断言type
# 自定义消息 def test_zero_division_long(): with pytest.raises(ZeroDivisionError, match=".*zero.*") as excinfo: 1 / 0
该 match 方法的regexp参数与 re.search 函数匹配,因此在上面的示例中 match='zero' 也可以使用
拓展二:检查断言装饰器
# 断言装饰器 @pytest.mark.xfail(raises=ZeroDivisionError) def test_f(): 1 / 0
知识点
- 代码抛出异常,但是和raises指定的异常类相匹配,所以不会断言失败
- 它相当于一个检查异常装饰器,功能:检查是否有异常,不确定是否有异常
- with pytest.raise(ZeroDivisionError) 对于故意测试异常代码的情况,使用可能会更好
而@pytest.mark.xfail(raises=ZeroDivisionError)
对于检查未修复的错误(即,可能会发生异常),使用检查断言可能会更好
总结
pytest的断言方式非常简洁明确。本节主要介绍了对异常信息的断言,包括4种情况:
-
直接断言,不添加assert语句
-
将异常信息存储在变量中,再读取异常信息进行断言判断
-
对异常的输出信息进行断言,异常类型、异常输出信息同时匹配成功,用例才能执行成功
-
采用标记函数进行异常断言