Python接口自动化之mock模块简单使用

mock简介

        mock原是python的第三方库，python 2可以直接安装mock模块，但在python 3.3以后mock模块已经整合到了unittest测试框架中，不需要再单独安装。

        Mock这个词在英语中有模拟的这个意思，因此我们可以猜测出这个库的主要功能是模拟一些东西。准确的说，Mock是Python中一个用于支持单元测试的库，它的主要功能是使用mock对象替代掉指定的Python对象，以达到模拟对象的行为。简单的说，mock库用于如下的场景：

假设你开发的一个api在工作的时候需要调用发送请求给特定的服务器来得到一个JSON返回值，然后根据这个返回值来做处理。如果要为该API写一个单元测试，该如何做？

一个简单的办法是搭建一个测试的服务器，在单元测试的时候，让该API和这个测试服务器交互。但是这种做法有两个问题：

1、测试服务器可能很不好搭建，或者搭建效率很低。

2、你搭建的测试服务器可能无法返回所有可能的值，或者需要大量的工作才能达到这个目的。

那么如何在没有测试服务器的情况下进行上面这种情况的单元测试呢？Mock模块就是答案。因为mock模块可以替换Python对象，返回值能够由我们的mock对象来决定，而不需要服务器的参与。



mock作用：

1. 解决依赖问题：当我们测试一个接口或者功能模块的时候，如果这个接口或者功能模块依赖其他接口或其他模块，那么如果所依赖的接口或功能模块未开发完毕，那么我们就可以使用mock模拟被依赖接口，完成目标接口的测试

2. 单元测试：如果某个功能未开发完成，我们又要进行测试用例的代码编写，我们也可以先模拟这个功能进行测试

3. 模拟复杂业务的接口：实际工作中如果我们在测试一个接口功能时，如果这个接口依赖一个非常复杂的接口业务，那么我们完全可以使用mock来模拟这个复杂的业务接口，其实这个和解决接口依赖是一样的原理

4.前后端联调：如果你是一个前端页面开发，现在需要开发一个功能：根据后台返回的状态展示不同的页面，那么你就需要调用后台的接口，但是后台接口还未开发完成，是不是你就停止这部分工作呢？答案是否定的，你完全可以借助mock来模拟后台这个接口返回你想要的数据

Mock的安装和导入

1、在Python 3.3以前的版本中，需要另外安装mock模块，可以使用pip命令来安装：

pip install mock

然后在代码中就可以直接import进来：

import mock


2、从Python 3.3开始，mock模块已经被合并到标准库中，被命名为unittest.mock，可以直接import进来使用：

from unittest import mock


Mock对象

    Mock对象是mock模块中最重要的概念。Mock对象就是mock模块中的一个类的实例，这个类的实例可以用来替换其他的Python对象，来达到模拟的效果。Mock类的定义如下：

classMock(spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, **kwargs)

Mock对象的一般用法是这样的：

1、找到你要替换的对象，这个对象可以是一个类，或者是一个函数，或者是一个类实例。

2、然后实例化Mock类得到一个mock对象，并且设置这个mock对象的行为，比如被调用的时候返回什么值，被访问成员的时候返回什么值等。

3、使用这个mock对象替换掉我们想替换的对象，也就是步骤1中确定的对象。

4、之后就可以开始写测试代码，这个时候我们可以保证我们替换掉的对象在测试用例执行的过程中行为和我们预设的一样。

mock实例及基本用法

    一个未开发完成的功能如何测试？假如们现在有一个实现两个数相加的功能需要编写测试用例，但是由于开发进度缓慢，只搭两个简单的框架，并没有内部实现。

import unittest

from unittest import mock

class SubClass(object):

    def add(self, a, b):

        """两个数相加"""

        pass

class TestSub(unittest.TestCase):

　　"""测试两个数相加用例"""

    def test_sub(self):

        sub = SubClass()  # 初始化被测函数类实例

        sub.add = mock.Mock(return_value=10)  # mock add方法 返回10

        result = sub.add(5, 5)  # 调用被测函数

        self.assertEqual(result, 10)  # 断言实际结果和预期结果

if __name__ == '__main__':

    unittest.main()

测试结果：

----------------------------------------------------------------------

Ran 1 test in 0.000s

OK

Process finished with exit code 

测试结果显示，测试用例执行通过了。

实际上mock模拟add方法的原理是 使用相同的对象方法接收mock的对象(使用sub.add接收)，那么当mock对象被调用时(sub.add())就会返回return_value参数对应的数据



稍微高级的用法

1、class Mock的参数

上面讲的是mock对象最基本的用法。下面来看看mock对象的稍微高级点的用法

先来看看Mock这个类的参数，在上面看到的类定义中，我们知道它有好几个参数，这里介绍最主要的几个：

name: 这个是用来命名一个mock对象，只是起到标识作用，当你print一个mock对象的时候，可以看到它的name。

return_value: 这个我们刚才使用过了，这个字段可以指定一个值（或者对象），当mock对象被调用时，如果side_effect函数返回的是DEFAULT，则对mock对象的调用会返回return_value指定的值。

side_effect: 这个参数指向一个可调用对象，一般就是函数。当mock对象被调用时，如果该函数返回值不是DEFAULT时，那么以该函数的返回值作为mock对象调用的返回值。

上面的例子，我们把用例的代码修改一句如下：

class TestSub(unittest.TestCase):

    """测试两个数相加"""

    def test_sub(self):

        sub = SubClass()  # 初始化被测函数类实例

        sub.add = mock.Mock(return_value=10, side_effect=sub.add)  # 传递side_effect关键字参数, 会覆盖return_value参数值, 使用真实的add方法测试

        result = sub.add(5, 11)  # 真正的调用被测函数

        self.assertEqual(result, 16)  # 断言实际结果和预期结果

        代码中我们给Mock方法添加了另一个关键字参数side_effect = sub.add， 这个参数和return_value 正好相反，当传递这个参数的时候return_value 参数就会失效

　　而side_effect生效，这里我给的参数值是sub.add 相当于add方法的地址，那么当调用add方法时就会真实的使用add方法，也就达到了我们测试实际的add 方法。

　　你也可以理解为当传递了side_effect参数且值为被测方法地址时，mock就不会起作用

　　side_effect接收的是一个可迭代序列，当传递多个值时，那么每次调用mock时会返回不同的值

mock_obj = mock.Mock(side_effect= [1,2,3])

print(mock_obj())

print(mock_obj())

print(mock_obj())

print(mock_obj())

输出

Traceback (most recent call last):

1

  File "D:/MyThreading/mymock.py", line 37, in <module>

2

    print(mock_obj())

3

  File "C:\Python36\lib\unittest\mock.py", line 939, in __call__

    return _mock_self._mock_call(*args, **kwargs)

  File "C:\Python36\lib\unittest\mock.py", line 998, in _mock_call

    result = next(effect)

StopIteration

Process finished with exit code 1

当所有值被取完后就会报错(这个地方有点类似生成器的原理)


2、mock对象的自动创建

当访问一个mock对象中不存在的属性时，mock会自动建立一个子mock对象，并且把正在访问的属性指向它，这个功能对于实现多级属性的mock很方便。

client= mock.Mock()client.v2_client.get.return_value ='200'

这个时候，你就得到了一个mock过的client实例，调用该实例的v2_client.get()方法会得到的返回值是"200"。

从上面的例子中还可以看到，指定mock对象的return_value还可以使用属性赋值的方法。



存在依赖关系的功能如何测试？

       假设有这样一个场景：我们要测试一个支付接口但是这个支付接口又依赖一个第三方支付接口，那么第三方支付接口我们暂时没有权限使用，那么我们该如何测试我们自己这个接口呢？

　　看下面的实例，假设第三方接口和我们自己的支付接口如下：

import requests

class PayApi(object):

    @staticmethod

    def auth(card, amount):

        """

        第三方支付接口

        :param card: 卡号

        :param amount: 支付金额

        :return:

        """

        pay_url = "http://www.zhifubao.com"  # 第三方支付接口地址

        data = {"card": card, "amount": amount}

        response = requests.post(pay_url, data=data)  # 请求第三方支付接口

        return response  # 返回状态码

    def pay(self, user_id, card, amount):

        """

        我们自己的支付接口

        :param user_id: 用户id

        :param card: 卡号

        :param amount: 支付金额

        :return:

        """

　　　　 # 调用第三方支付接口

        response = self.auth(card, amount)

        try:

            if response['status_code'] == '200':

                print('用户{}支付金额{}成功'.format(user_id, amount))

                return '支付成功'

            elif response['status_code'] == '500':

                print('用户{}支付失败, 金额不变'.format(user_id))

                return '支付失败'

            else:

                return '未知错误'

        except Exception:

            return "Error, 服务器异常!"

if __name__ == '__main__':

    pass

很明显第三方支付接口是无法访问的，因为接口的地址是我DIY的，为了模拟实际中我们无法使用的第三方支付接口。编写测试用例如下：

import unittest

from unittest import mock

from payment.PayMent import PayApi

class TestPayApi(unittest.TestCase):

    def test_success(self):

        pay = PayApi()

        pay.auth = mock.Mock(return_value={'status_code':'200'})

        status = pay.pay('1000', '12345', '10000')

        self.assertEqual(status, '支付成功')

    def test_fail(self):

        pay = PayApi()

        pay.auth = mock.Mock(return_value={'status_code':'500'})

        status = pay.pay('1000', '12345', '10000')

        self.assertEqual(status, '支付失败')

    def test_error(self):

        pay = PayApi()

        pay.auth = mock.Mock(return_value={'status_code':'300'})

        status = pay.pay('1000', '12345', '10000')

        self.assertEqual(status, '未知错误')

    def test_exception(self):

        pay = PayApi()

        pay.auth = mock.Mock(return_value='200')

        status = pay.pay('1000', '12345', '10000')

        self.assertEqual(status, 'Error, 服务器异常!')

if __name__ == '__main__':

    unittest.main()

测试输出结果：

....用户1000支付失败, 金额不变

用户1000支付金额10000成功

----------------------------------------------------------------------

Ran 4 tests in 0.001s

OK

Process finished with exit code 0

    从执行结果可以看出，即使第三方支付接口无法使用，但是我们自己的支付接口仍然测试通过了。也许有人会问，第三方支付都不能用，我们的测试结果是否是有效的呢？通常我们在测试一个模块的时候，我们是可以认为其他模块的功能是正常的，只针对目标模块进行测试是没有任何问题的，所以说测试结果也是正确的。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,029评论 6赞 492
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,395评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,570评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,535评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,650评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,850评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,006评论 3赞 408
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,747评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,207评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,342评论 4赞 330
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,964评论 3赞 315
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2赞 349