【mock-Responses】

星星向前看

于 2024-09-11 09:57:41 发布

阅读量909

点赞数 7

文章标签： python

本文链接：https://blog.csdn.net/adfksdfhkshdufh/article/details/142130051

版权

Mock --> Responses

    一、Responses 是什么？

    二、基本用法

    三、高级用法

    四、小结

Responses 是什么？

在 Python 的测试世界中，responses 是一把锋利的宝剑。它可以在你需要测试 HTTP 请求时，轻松地拦截这些请求，并返回你预定义的响应数据。这样你就不需要依赖真实的 API 服务器了。

responses 的工作原理很简单：它通过拦截 Python 内部 requests 模块发出的 HTTP 请求来控制你想要的响应数据。这使得你能够在测试时避免与外部网络或 API 服务交互，从而大大提高了测试的稳定性和速度。

为什么选择 Responses？
稳定性：模拟外部请求，避免受限于网络问题和第三方 API 状态。
灵活性：支持多种 HTTP 方法，能够轻松模拟不同场景下的请求和响应。
高效性：让测试速度飞速提升，再也不用等着真实的 API 响应。

Responses 的安装
万丈高楼平地起，首先，我们需要安装 responses。幸运的是，responses 的安装过程简单到你都不需要喝一杯咖啡：

pip install responses

基本用法

拦截 HTTP 请求
让我们从一个简单的例子开始。假设你在一个项目中编写了一个函数，用来向某个 API 请求数据。为了避免在测试时依赖真实的 API，我们可以使用 responses 来模拟这个请求。

首先，看看这个非常简单的函数，它向一个 API 发送 GET 请求并返回响应数据：

import requests

def get_data_from_api(url):
    response = requests.get(url)
    return response.json()

接下来，我们用 responses 模拟这个 GET 请求的响应，来进行单元测试：

mport responses
import unittest

class TestAPI(unittest.TestCase):

    @responses.activate
    def test_get_data_from_api(self):
        # 定义我们期望的响应数据
        api_url = 'https://example.com/api/data'
        expected_data = {'key': 'value'}

        # 使用 responses 模拟 GET 请求的响应
        responses.add(responses.GET, api_url, json=expected_data, status=200)

        # 测试函数是否返回了正确的数据
        result = get_data_from_api(api_url)
        self.assertEqual(result, expected_data)

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

解读：
@responses.activate 是 responses 提供的装饰器，用来开启它的拦截功能。
responses.add() 用来模拟 HTTP 请求，这里我们设置了一个 GET 请求，并返回了一个 JSON 响应。
在测试函数中，我们调用了 get_data_from_api()，并验证它是否返回了期望的数据。

这段代码就如同给程序戴上了“虚拟现实”眼镜，API 不再是真实的，它被我们编织的“虚假”现实所替代。

高级用法

模拟不同的 HTTP 方法
刚刚我们只是模拟了一个 GET 请求，但在实际项目中，我们常常需要使用各种 HTTP 方法，如 POST、PUT、DELETE 等。幸运的是，responses 让我们可以轻松地模拟这些方法。

代码示例：模拟 POST 请求

import requests

def send_data_to_api(url, data):
    response = requests.post(url, json=data)
    return response.status_code

单元测试：

@responses.activate
def test_send_data_to_api():
    api_url = 'https://example.com/api/submit'
    input_data = {'name': 'Alice'}
    
    # 模拟 POST 请求
    responses.add(responses.POST, api_url, status=201)

    # 测试 POST 请求是否返回了正确的状态码
    result = send_data_to_api(api_url, input_data)
    assert result == 201

解读：
这里我们模拟了一个 POST 请求，返回状态码 201，表示创建成功。
responses 允许你对每一种 HTTP 方法都进行类似的模拟，比如 PUT、DELETE 等，这极大地增强了测试的灵活性。

模拟错误响应：让测试更具现实感
但现实生活中总是充满了各种意外，API 并不是每次都会乖乖地返回 200 状态码。为了使我们的测试更健壮，有时我们需要模拟一些错误响应，比如 404 或 500 状态码。

代码示例：模拟 404 错误

@responses.activate
def test_get_data_from_api_404():
    api_url = 'https://example.com/api/data'
    
    # 模拟 404 错误
    responses.add(responses.GET, api_url, status=404)

    try:
        result = get_data_from_api(api_url)
    except requests.exceptions.HTTPError as e:
        print(f"请求失败：{e}")

解读：
这里我们模拟了一个 404 错误，测试当 API 不存在时函数的行为。
responses 能让你轻松模拟各种 HTTP 错误，从而确保你的代码在面对 API 问题时能够正确处理。

自定义响应
有时候，API 返回的数据并不总是简单的 JSON 格式。它可能是 XML、文本，甚至是二进制文件。responses 为你提供了自定义响应的能力，无论是数据格式还是状态码，你都可以随意定义。

代码示例：模拟文本响应

@responses.activate
def test_get_data_from_api_text():
    api_url = 'https://example.com/api/text'
    
    # 模拟文本响应
    responses.add(responses.GET, api_url, body="这是一段文本响应", status=200)

    response = requests.get(api_url)
    assert response.text == "这是一段文本响应"