API Mock 测试深度指南：基础入门到高阶技巧全覆盖

API测试是一种检查API功能、性能和安全性的方法。有时候，我们可能需要在测试过程中模拟API的返回，而不是真实的调用它，这就是Mock测试的应用场景。本文将从基础到高阶，全方位介绍Python的API Mock测试，并带有实例。

Python Mock 测试基础

Python的unittest.mock库提供了创建Mock对象的工具。在API测试的场景中，我们通常会模拟requests库的get或post等方法。

基础示例：

from unittest.mock import Mock

import requests


# 创建一个 Mock 对象

mock_get = Mock()


# 设置 Mock 对象的返回值

mock_get.return_value.status_code = 200

mock_get.return_value.json.return_value = {"key": "value"}


# 将 requests.get 替换为 Mock 对象

requests.get = mock_get


# 使用 requests.get

response = requests.get('http://myapi.com')

print(response.status_code) # 输出：200

print(response.json()) # 输出：{'key': 'value'}

在这个例子中，我们创建了一个Mock对象，并设置了它的返回值，然后替换了requests.get方法。

高级用法：Patch

unittest.mock库提供了patch函数，让我们可以在测试的上下文中替换掉整个模块或类的方法。这样，我们就不用担心影响到其他的测试或代码。

Patch 示例：

from unittest.mock import patch

import requests


def test_myapi():

with patch.object(requests, 'get') as mock_get:

mock_get.return_value.status_code = 200

mock_get.return_value.json.return_value = {"key": "value"}


# 在这个上下文中，requests.get 被替换为 Mock 对象

response = requests.get('http://myapi.com')

print(response.status_code) # 输出：200

print(response.json()) # 输出：{'key': 'value'}


# 在这个上下文外，requests.get 是原来的方法

response = requests.get('http://myapi.com')

在这个例子中，我们使用了patch函数在测试的上下文中替换了requests.get方法。这样，我们就不用担心影响到其他的测试或代码。

更高级的用法：Mock 对象的属性和方法

你可以像操作普通Python对象一样操作Mock对象。你可以获取和设置它的属性，你可以调用它的方法。

属性和方法示例：

# 设置 Mock 对象的属性

mock_get.return_value.status_code = 200


# 设置 Mock 对象的方法

mock_get.return_value.json.return_value = {"key": "value"}

在这个例子中，我们设置了Mock对象的一个属性和一个方法。注意，方法本身也是一个Mock对象，所以我们也可以设置它的返回值。

高阶用法：断言

你可以使用Mock对象提供的断言方法，检查它是否

被正确地调用。比如，你可以检查一个方法是否被调用，它被调用了多少次，或者它被调用时的参数是什么。

断言示例：

from unittest.mock import patch

import requests


def test_myapi():

with patch.object(requests, 'get') as mock_get:

mock_get.return_value.status_code = 200

mock_get.return_value.json.return_value = {"key": "value"}


# 在这个上下文中，requests.get 被替换为 Mock 对象

response = requests.get('http://myapi.com')


# 检查它是否被调用

mock_get.assert_called()


# 检查它被调用的参数

mock_get.assert_called_with('http://myapi.com')


# 在这个上下文外，requests.get 是原来的方法

response = requests.get('http://myapi.com')

在这个例子中，我们调用了Mock对象，并使用断言方法检查它的调用情况。

更高级的用法：模拟请求错误

在进行API测试时，我们不仅需要模拟正常的响应，还需要模拟可能出现的错误，如网络错误或HTTP错误。我们可以使用Mock对象的side_effect属性来模拟这些错误。

模拟请求错误示例：

from unittest.mock import patch

import requests

from requests.exceptions import Timeout


def test_myapi():

with patch.object(requests, 'get') as mock_get:

# 模拟一个 Timeout 错误

mock_get.side_effect = Timeout


try:

response = requests.get('http://myapi.com')

except Timeout:

print('Timeout occurred as expected') # 输出：Timeout occurred as expected

在这个例子中，我们设置了Mock对象的side_effect属性，让它在被调用时抛出一个Timeout错误。这样，我们就可以测试我们的代码是否能正确处理这种错误。

更高级的用法：动态返回值

有时，我们希望Mock对象根据输入参数返回不同的结果。我们可以使用一个函数作为Mock对象的side_effect属性来实现这个需求。

动态返回值示例：

from unittest.mock import patch

import requests


def dynamic_response(*args, **kwargs):

if args[0] == 'http://myapi.com/success':

return {"key": "value"}

else:

return {"error": "not found"}


def test_myapi():

with patch.object(requests, 'get') as mock_get:

mock_get.return_value.json.side_effect = dynamic_response


response = requests.get('http://myapi.com/success')

print(response.json()) # 输出：{'key': 'value'}


response = requests.get('http://myapi.com/failure')

print(response.json()) # 输出：{'error': 'not found'}

在这个例子中，我们创建了一个函数作为Mock对象的side_effect属性。当这个Mock对象被调用时，它会调用这个函数，并传递所有的参数。

这种方法可以让我们更灵活地模拟API的行为，但需要注意的是，这个函数需要能处理所有可能的输入参数。

在总结之前，这篇文章已经详细地介绍了Python的API Mock测试的各个层面，包括创建Mock对象、使用patch函数、设置Mock对象的属性和方法、使用断言方法、模拟请求错误，以及动态返回值。希望这篇文章能帮助你在进行API测试时更好地使用Python的unittest.mock库。

最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：【文末小卡片领取】

​

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！