ds2api/TESTING.md

DS2API 测试指南

语言 / Language: 中文 + English

概述 | Overview

DS2API 提供两个层级的测试：

层级	命令	说明
单元测试	go test ./...	不需要真实账号
端到端测试	./scripts/testsuite/run-live.sh	使用真实账号执行全链路测试

端到端测试集会录制完整的请求/响应日志，用于故障排查。

---

快速开始 | Quick Start

单元测试 | Unit Tests

go test ./...

node --test api/helpers/stream-tool-sieve.test.js api/chat-stream.test.js

端到端测试 | End-to-End Tests

./scripts/testsuite/run-live.sh

默认行为：

1. Preflight 检查：

   • go test ./... -count=1（单元测试）
   • node --check api/chat-stream.js（语法检查）
   • node --check api/helpers/stream-tool-sieve.js（语法检查）
   • node --test api/helpers/stream-tool-sieve.test.js api/chat-stream.test.js（Node 流式拦截单测）
   • npm run build --prefix webui（WebUI 构建检查）

2. 隔离启动：复制 config.json 到临时目录，启动独立服务进程

3. 场景测试：

   • ✅ OpenAI 非流式 / 流式
   • ✅ Claude 非流式 / 流式
   • ✅ Admin API（登录 / 配置 / 账号管理）
   • ✅ Tool Calling
   • ✅ 并发压力测试
   • ✅ Search 模型

4. 结果收集：继续执行所有用例（不中断），写入最终汇总

---

CLI 参数 | CLI Flags

go run ./cmd/ds2api-tests \
  --config config.json \
  --admin-key admin \
  --out artifacts/testsuite \
  --port 0 \
  --timeout 120 \
  --retries 2 \
  --no-preflight=false \
  --keep 5

参数	说明	默认值
--config	配置文件路径	config.json
--admin-key	Admin 密钥	DS2API_ADMIN_KEY 环境变量，回退 admin
--out	产物输出根目录	artifacts/testsuite
--port	测试服务端口（0 = 自动分配空闲端口）	0
--timeout	单个请求超时秒数	120
--retries	网络/5xx 请求重试次数	2
--no-preflight	跳过 preflight 检查	false
--keep	保留最近几次测试结果（0 = 全部保留）	5

---

自动清理 | Auto Cleanup

每次测试运行完成后，程序会自动扫描输出目录（--out），按时间排序保留最近 --keep 次运行的结果，超出部分自动删除。

• 默认保留 5 次
• 设置 --keep 0 可关闭自动清理
• 被删除的旧运行目录会打印日志提示

---

产物结构 | Artifact Layout

每次运行会创建一个以运行 ID 命名的目录：

artifacts/testsuite/<run_id>/
├── summary.json          # 机器可读报告
├── summary.md            # 人类可读报告
├── server.log            # 测试期间服务端日志
├── preflight.log         # Preflight 命令输出
└── cases/
    └── <case_id>/
        ├── request.json      # 请求体
        ├── response.headers  # 响应头
        ├── response.body     # 响应体
        ├── stream.raw        # 原始 SSE 数据（流式用例）
        ├── assertions.json   # 断言结果
        └── meta.json         # 元信息（耗时、状态码等）

---

Trace 关联 | Trace Binding

每个测试请求自动注入 trace 信息，便于快速定位问题：

位置	格式
请求头	X-Ds2-Test-Trace: <trace_id>
查询参数	__trace_id=<trace_id>

当用例失败时，summary.md 中会包含 trace ID。你可以快速搜索对应的服务端日志：

rg "<trace_id>" artifacts/testsuite/<run_id>/server.log

---

退出码 | Exit Code

退出码	含义
0	所有用例通过 ✅
1	有用例失败 ❌

可将测试集作为本地发布门禁使用（CI/CD 集成）。

---

安全提醒 | Sensitive Data Warning

⚠️ 测试集会存储完整的原始请求/响应载荷用于调试。

• 不要将 artifacts 目录上传到公开仓库
• 不要在 Issue tracker 中分享未脱敏的 artifact 文件
• 如需分享日志，请先手动清除敏感信息（token、密码等）

---

常见用法 | Common Usage

仅跑单元测试

go test ./...

跑端到端测试（跳过 preflight）

go run ./cmd/ds2api-tests --no-preflight

指定输出目录和超时

go run ./cmd/ds2api-tests \
  --out /tmp/ds2api-test \
  --timeout 60

在 CI 中使用

# 确保 config.json 存在且包含有效测试账号
./scripts/testsuite/run-live.sh
exit_code=$?
if [ $exit_code -ne 0 ]; then
  echo "Tests failed! Check artifacts for details."
  exit 1
fi