python unittest 之mock

Posted Golover

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了python unittest 之mock相关的知识,希望对你有一定的参考价值。


1.什么是mock
unittest.mock是一个用于在Python中进行单元测试的库,Mock翻译过来就是模拟的意思,顾名思义这个库的主要功能是模拟一些东西。
它的主要功能是使用mock对象替代掉指定的Python对象,以达到模拟对象的行为。
学过python自动化的对unittest并不陌生,unittest其实是单元测试框架,
但对于单元测试,估计很多小伙伴都不懂,单元测试才是自动化测试的至高境界,其中mock是单元测试的脊髓所在
2.mock能做什么:
    1.前后端联调,如果你是一个前端页面开发,现在需要开发一个功能:    下一个订单,支付页面的接口,根据支付结果,支付成功,展示支付成功页,支付失败,展示支付失败页。    要完成此功能,你需要调用后端的接口,根据返回给你的结果,来展示不同的页面。此时后端接口还没开发好,
    作为一个前端开发总不能等别人开发好了,你再开发,那你只有加班的命了。    为了同步开发完成任务,此时,你可以根据接口文档的规定,把接口的地址和入参传过去,然后自己mock接口的不同返回界面,来完成前端的开发任务    2.单元测试,单元测试的目的是测试某个小小单元的功能,但现实中开发的函数或方法都是有依赖关系的,比如b函数的参数,需要调用a函数的返回结果,但是我前面已经测试a函数了    这种情况下,就不需要再测一次a函数了,此时就可以用mock模块来模拟调用这部分内容,并给出返回结果    3.第三方接口依赖,在做接口自动化的时候,有时候需要调用第三方的接口,但是别人公司的接口服务不受你的控制,有可能别人提供的测试环境今天服务给你开着,别人就关掉了,
    给自动化接口测试带来很多的麻烦,此时就可以自己写一个mock-server来模拟接口的返回数据
3.mock环境准备
1.python2.x的版本,mock是一个独立的模块,需要用pip安装
    pip install -U mock
3.从Python 3.3以后的版本mock已经合并到unittest模块中了,是unittest单元测试的一部分,直接导入过来就行
    from unittest import mock
依赖关系
1.如下场景:支付是一个独立的接口,由其它开发提供,根据支付的接口返回状态去显示失败,还是成功,这个是你需要实现的功能
也就是说你写一个b功能,你的同事写一个a功能,你的b功能需要根据a功能的结果去判断,然后实现对应的功能。这就是存在依赖关系,你同事开发的进度你是无法控制的
你要是等他开发完了,你再开发,那你就坐等加班吧.
2.以下是自己写的 zhifu_statues()函数功能,大概设计如下,保存为temple.py文件
# 保存为temple.py
# coding:utf-8

def zhifu():
    ‘‘‘假设这里是一个支付的功能,未开发完
    支付成功返回:{"result": "success", "reason":"null"}
    支付失败返回:{"result": "fail", "reason":"余额不足"}
    reason返回失败原因
    ‘‘‘
    pass

def zhifu_statues():
    ‘‘‘根据支付的结果success or fail,判断跳转到对应页面‘‘‘
    result = zhifu()
    print(result)
    try:
        if result["result"] == "success":
            return "支付成功"
        elif result["result"] == "fail":
            print("失败原因:%s" % result["reason"])
            return "支付失败"
        else:
            return "未知错误异常"
    except:
        return "Error, 服务端返回异常!"

3.单元测试用例设计
# coding:utf-8
from unittest import mock
import unittest
import temple

class Test_zhifu_statues(unittest.TestCase):
    ‘‘‘单元测试用例‘‘‘
    def test_01(self):
        ‘‘‘测试支付成功场景‘‘‘
        # mock一个支付成功的数据
        temple.zhifu = mock.Mock(return_value={"result": "success", "reason":"null"})
        # 根据支付结果测试页面跳转
        statues = temple.zhifu_statues()
        print(statues)
        self.assertEqual(statues, "支付成功")

    def test_02(self):
        ‘‘‘测试支付失败场景‘‘‘
        # mock一个支付成功的数据
        temple.zhifu = mock.Mock(return_value={"result": "fail", "reason": "余额不足"})
        # 根据支付结果测试页面跳转
        statues = temple.zhifu_statues()
        self.assertEqual(statues, "支付失败")

if __name__ == "__main__":
    unittest.main()

二、
mock里面另一种实现方式,patch装饰器的使用,patch() 作为函数装饰器,为您创建模拟并将其传递到装饰函数
官方文档地址
patch简介

1.unittest.mock.patch(target,new = DEFAULT,spec = None,create = False,spec_set = None,autospec = None,new_callable = None,** kwargs )
    target参数必须是一个str,格式为‘package.module.ClassName‘,    注意这里的格式一定要写对,如果你的函数或类写在pakege名称为a下,b.py脚本里,有个c的函数(或类),那这个参数就写“a.b.c”
    new参数如果没写,默认指定的是MagicMock
    spec=True或spec_set=True,这会导致patch传递给被模拟为spec / spec_set的对象    new_callable允许您指定将被调用以创建新对象的不同类或可调用对象。默认情况下MagicMock使用。

函数案例讲解

1.接着,新建一个temple.py,写入以下代码
# 保存为temple.py
# coding:utf-8

def zhifu():
    ‘‘‘假设这里是一个支付的功能,未开发完
    支付成功返回:{"result": "success", "reason":"null"}
    支付失败返回:{"result": "fail", "reason":"余额不足"}
    reason返回失败原因
    ‘‘‘
    pass

def zhifu_statues():
    ‘‘‘根据支付的结果success or fail,判断跳转到对应页面‘‘‘
    result = zhifu()
    print(result)
    try:
        if result["result"] == "success":
            return "支付成功"
        elif result["result"] == "fail":
            print("失败原因:%s" % result["reason"])
            return "支付失败"
        else:
            return "未知错误异常"
    except:
        return "Error, 服务端返回异常!"

2.用mock.patch实现如下:
# coding:utf-8
from unittest import mock
import unittest
import temple

class Test_zhifu_statues(unittest.TestCase):
    ‘‘‘单元测试用例‘‘‘

    @mock.patch("temple.zhifu")
    def test_01(self, mock_zhifu):
        ‘‘‘测试支付成功场景‘‘‘
        # 方法一:mock一个支付成功的数据
        # temple.zhifu = mock.Mock(return_value={"result": "success", "reason":"null"})

        # 方法二:mock.path装饰器模拟返回结果
        mock_zhifu.return_value = {"result": "success", "reason":"null"}
        # 根据支付结果测试页面跳转
        statues = temple.zhifu_statues()
        print(statues)
        self.assertEqual(statues, "支付成功")

    @mock.patch("temple.zhifu")
    def test_02(self, mock_zhifu):
        ‘‘‘测试支付失败场景‘‘‘
        # mock一个支付成功的数据

        mock_zhifu.return_value = {"result": "fail", "reason": "余额不足"}
        # 根据支付结果测试页面跳转
        statues = temple.zhifu_statues()
        self.assertEqual(statues, "支付失败")

if __name__ == "__main__":
    unittest.main()

类和方法案例
1.如果前面的temple.py里面不是函数,是写的类和方法,如何去使用mock?
# 保存为temple.py
# coding:utf-8
class Zhifu():
    def zhifu(self):
        ‘‘‘假设这里是一个支付的功能,未开发完
        支付成功返回:{"result": "success", "reason":"null"}
        支付失败返回:{"result": "fail", "reason":"余额不足"}
        reason返回失败原因
        ‘‘‘
        pass
class Statues():
    def zhifu_statues(self):
        ‘‘‘根据支付的结果success or fail,判断跳转到对应页面‘‘‘
        result = Zhifu().zhifu()
        print(result)
        try:
            if result["result"] == "success":
                return "支付成功"
            elif result["result"] == "fail":
                print("失败原因:%s" % result["reason"])
                return "支付失败"
            else:
                return "未知错误异常"
        except:
            return "Error, 服务端返回异常!"

2.用例设计如下

# coding:utf-8
from unittest import mock
import unittest
from temple_class import Zhifu,Statues

class Test_zhifu_statues(unittest.TestCase):
    ‘‘‘单元测试用例‘‘‘

    @mock.patch("temple_class.Zhifu")
    def test_01(self, mock_Zhifu):
        ‘‘‘测试支付成功场景‘‘‘
        a = mock_Zhifu.return_value  # 先返回实例,对类名称替换
        # 通过实例调用方法,再对方法的返回值替换
        a.zhifu.return_value = {"result": "success", "reason":"null"}
        # 根据支付结果测试页面跳转
        statues = Statues().zhifu_statues()
        print(statues)
        self.assertEqual(statues, "支付成功")

    @mock.patch("temple_class.Zhifu")
    def test_02(self, mock_Zhifu):
        ‘‘‘测试支付失败场景‘‘‘
        b = mock_Zhifu.return_value  # 先返回实例,对类名称替换
        # 通过实例调用方法,再对方法的返回值替换
        b.zhifu.return_value = {"result": "fail", "reason": "余额不足"}
        # 根据支付结果测试页面跳转
        statues = Statues().zhifu_statues()
        print(statues)
        self.assertEqual(statues, "支付失败")

if __name__ == "__main__":
    unittest.main()

3.相当于函数来说,这里主要多一步,要先对类的名称进行mock一次"a = mock_Zhifu.return_value",再通过实例去调用方法。


以上是关于python unittest 之mock的主要内容,如果未能解决你的问题,请参考以下文章

python unittest 之mock

python之unittest单元测试

Python单元测试框架unittest之深入学习

python之测试模块unittest

python之单元测试框架—unittest(补充)

python单元测试之unittest框架