notion-sdk-py测试指南：使用pytest和VCR录制测试

notion-sdk-py测试指南：使用pytest和VCR录制测试

【免费下载链接】notion-sdk-pyNotion API client SDK, rewritten in Python! (sync + async)项目地址: https://gitcode.com/gh_mirrors/no/notion-sdk-py

notion-sdk-py是一个用Python重写的Notion API客户端SDK，支持同步和异步操作。本文将详细介绍如何使用pytest和VCR录制测试，帮助开发者快速掌握测试技巧，确保SDK的稳定性和可靠性。

测试环境准备

要开始使用notion-sdk-py的测试功能，首先需要准备好测试环境。项目的测试文件主要集中在tests/目录下，包括测试客户端、端点、错误处理和辅助函数等。

安装测试依赖

项目的测试依赖在requirements/tests.txt中定义，你可以通过以下命令安装：

pip install -r requirements/tests.txt

配置测试环境变量

测试过程中需要一些环境变量来配置Notion API的访问，主要包括：

• NOTION_TOKEN：Notion API的访问令牌
• NOTION_TEST_PAGE_ID：测试用的Notion页面ID

你可以在系统环境中设置这些变量，或者创建一个.env文件来管理它们。

pytest基础使用

notion-sdk-py使用pytest作为测试框架，提供了丰富的测试功能和灵活的测试配置。

测试文件结构

项目的测试文件结构如下：

• tests/test_client.py：测试客户端功能
• tests/test_endpoints.py：测试API端点
• tests/test_errors.py：测试错误处理
• tests/test_helpers.py：测试辅助函数

基本测试用例

下面是一个简单的测试用例示例，来自tests/test_client.py：

import pytest from notion_client import Client from notion_client.errors import APIResponseError @pytest.mark.vcr() def test_client_request_error(client): with pytest.raises(APIResponseError): client.databases.retrieve(database_id="invalid_id")

这个测试用例使用@pytest.mark.vcr()装饰器来启用VCR录制功能，后面会详细介绍。测试用例中使用pytest.raises来断言API调用会抛出APIResponseError异常。

VCR录制测试详解

VCR是一个用于录制和回放HTTP请求的库，可以帮助我们创建可靠的测试，而不需要每次都实际调用Notion API。

VCR配置

notion-sdk-py在tests/conftest.py中提供了VCR的配置：

@pytest.fixture(scope="session") def vcr_config() -> Dict[str, Any]: def remove_headers(response: Dict[str, Any]) -> Dict[str, Any]: headers_to_keep: Dict[str, Any] = {} if response.get("headers"): for key, value in response["headers"].items(): key_lower = key.lower() if key_lower in ["content-type", "content-encoding", "content-length"]: headers_to_keep[key] = value response["headers"] = headers_to_keep return response return { "filter_headers": [ ("authorization", "ntn_..."), ("user-agent", None), ("cookie", None), ], "before_record_response": remove_headers, "match_on": ["method", "remove_page_id_for_matches"], "decode_compressed_response": True, }

这个配置做了几件重要的事情：

1. 过滤敏感头信息，如授权令牌
2. 只保留必要的响应头
3. 使用自定义的匹配器来忽略URL中的页面ID
4. 启用压缩响应的解码

录制和回放测试

使用VCR非常简单，只需要在测试函数上添加@pytest.mark.vcr()装饰器即可。当第一次运行测试时，VCR会录制API请求和响应，并保存在tests/cassettes/目录下的YAML文件中。后续运行测试时，VCR会直接使用录制的响应，而不会实际调用API。

例如，在tests/test_endpoints.py中：

import pytest @pytest.mark.vcr() def test_pages_create(client, parent_page_id): response = client.pages.create( parent={"page_id": parent_page_id}, properties={"title": [{"text": {"content": "Test Page"}}]}, ) assert response["object"] == "page"

第一次运行这个测试时，会创建一个新的Notion页面，并将API请求和响应录制到tests/cassettes/test_pages_create.yaml中。后续运行时，会直接使用这个录制的响应，测试速度更快，也更可靠。

自定义VCR使用

除了使用装饰器，还可以手动使用VCR的use_cassette上下文管理器，在tests/conftest.py中可以看到这样的例子：

try: with vcr.use_cassette("test_pages_create.yaml") as cass: response = cass._serializer.deserialize(cass.data[0][1]["body"]["string"]) return response["parent"]["page_id"] except Exception: pytest.exit( "Missing base page id. Restore test_pages_create.yaml or add " "NOTION_TEST_PAGE_ID to your environment.", )

这种方式允许更精细地控制VCR的行为，例如从录制的响应中提取特定信息。

高级测试技巧

参数化测试

pytest支持参数化测试，可以用不同的参数多次运行同一个测试函数。在notion-sdk-py的测试中，你可以看到很多这样的例子，例如在tests/test_helpers.py中：

import pytest @pytest.mark.parametrize("input, expected", [ ("page_id", "page_id"), ("database_id", "database_id"), ("invalid_type", ValueError), ]) def test_get_id_type(input, expected): if expected is ValueError: with pytest.raises(ValueError): helpers.get_id_type(input) else: assert helpers.get_id_type(input) == expected

测试 fixtures

notion-sdk-py使用pytest fixtures来管理测试依赖，在tests/conftest.py中定义了很多有用的fixtures，例如：

• client：创建一个同步客户端
• async_client：创建一个异步客户端
• page_id：创建一个临时页面并返回其ID
• database_id：创建一个临时数据库并返回其ID

这些fixtures可以在测试函数中直接使用，例如：

def test_database_query(client, database_id): response = client.databases.query(database_id=database_id) assert "results" in response

异步测试

notion-sdk-py支持异步操作，测试异步代码需要使用@pytest.mark.asyncio装饰器，例如在tests/test_errors.py中：

import pytest import asyncio @pytest.mark.asyncio async def test_async_request_timeout(async_client): with pytest.raises(RequestTimeoutError): await async_client.pages.retrieve(page_id="invalid_id", timeout=0.1)

测试用例管理

录制文件管理

所有的VCR录制文件都保存在tests/cassettes/目录下，每个测试用例对应一个YAML文件。这些文件记录了API请求和响应的详细信息，可以帮助你调试测试问题。

更新录制文件

当API发生变化或者你需要更新测试数据时，可以删除对应的录制文件，然后重新运行测试来生成新的录制文件。你也可以使用--vcr-record命令行选项来控制VCR的录制行为：

pytest --vcr-record=all # 重新录制所有测试 pytest --vcr-record=none # 不录制，只使用已有的录制文件 pytest --vcr-record=once # 只录制新的测试，已有的录制文件不变

测试最佳实践

保持测试独立

每个测试应该是独立的，不依赖于其他测试的结果。notion-sdk-py的测试使用fixtures来创建和清理测试资源，确保测试之间不会相互干扰。

测试覆盖关键功能

确保测试覆盖了SDK的关键功能，包括各种API端点、错误处理、数据转换等。你可以使用pytest-cov来生成测试覆盖率报告：

pytest --cov=notion_client tests/

定期运行测试

在开发过程中定期运行测试，确保你的更改没有破坏现有功能。你也可以设置CI/CD流程，在每次提交时自动运行测试。

总结

notion-sdk-py提供了完善的测试体系，使用pytest和VCR可以轻松创建可靠的测试。通过本文的介绍，你应该已经掌握了notion-sdk-py测试的基本方法和高级技巧。开始编写你自己的测试，确保SDK的质量和稳定性吧！

希望这篇测试指南对你有所帮助，如果你有任何问题或建议，欢迎在项目中提出issue或PR。

【免费下载链接】notion-sdk-pyNotion API client SDK, rewritten in Python! (sync + async)项目地址: https://gitcode.com/gh_mirrors/no/notion-sdk-py