docs(update):更新Arabica Sprint3代码单元测试样例说明文档

Signed-off-by: gzkoala <guohao@gitconomy.org>
This commit is contained in:
gzkoala
2026-03-11 10:59:47 +08:00
parent d60587fd88
commit ea3b3e6d8f

View File

@@ -18,20 +18,7 @@ status: Active
-->
# Arabica Sprint 3 代码单元测试样例
## 1. 概述
根据 **Arabica Sprint 3** 的架构设计,本阶段的核心目标是实现外部学术 API 的集成文献查询以及双轨制数据的标准化落盘。为保证该链路的高可用性与健壮性本文档基于《Project Caffeine 项目代码测试规范指南》,为 Sprint 3 的核心组件Service 层与 Controller 层)提供标准的 Jest 测试用例编写范例。
**Sprint 3 测试重点模块**
1. `src/services/literatureService.ts`:外部 API 网络请求(必须 Mock 网络)。
2. `src/services/adapter/metadataMapper.ts`:原始 JSON 映射为标准字典(纯逻辑验证)。
3. `src/services/vaultService.ts`Markdown 与 YAML 写入(必须 Mock 磁盘 I/O
4. `src/controllers/literatureController.ts`:工具调用的 Zod 参数校验与路由分发。
---
## 2. 测试架构概览
## 1. 测试架构概览
在 Sprint 3 中系统彻底从“提示词Prompt驱动”转向了“工具Tool驱动”。我们的测试重点也应该从原来的 Prompts 转移到**核心服务层Services和工具控制层Controllers**。
@@ -43,7 +30,7 @@ status: Active
---
## 3. 核心测试场景设计与示例
## 2. 核心测试场景设计与示例
为了让您的 Jest 测试跑通,以下是针对 Sprint 3 真实文件的测试用例编写指南及代码示例。您可以在 `src/services/__test__/``src/controllers/__test__/` 目录下创建或修改对应的 `.test.ts` 文件。
@@ -284,7 +271,7 @@ describe('Tools Controller - Sprint 3 (意图驱动与容错机制)', () => {
---
## 4. 测试执行说明
## 3. 测试执行说明
在您配置好上述的测试文件后,请在终端使用项目中 `package.json` 原有配置的命令执行测试: