Files
knowledge-governance/internal/dingtalkdiscovery/discovery_test.go
T
姚章浩 e00cab2f70 feat(settings): 数据源配置改成「列出来、勾选、变成来源」,并去掉文件格式筛选
用户对 系统设置 → 数据源配置 的四条要求:
① 这里不要做文件格式筛选(格式归目录级标注决定);
② 列出我账号下能看到的知识库;③ 列出钉盘能看到哪些;④ 勾选那些作为来源。

① 来源卡片不再渲染 FilenameFilterEditor(目录级筛选仍在「来源与目录」里,按目录就近覆盖)。
②③ 新端点 GET /api/v1/dingtalk-spaces/available(管理员,只读):用 dws 列举
   - 知识库:wiki +space-list --type orgWikiSpace/myWikiSpace(实测 17 + 1 个)
   - 钉盘:wiki space list --type mySpace/orgSpace(实测 我的文件 + 6 个组织空间)
   实测约束写进命令形态:--limit 上限是 50;翻页必须 --page-all(--max-items 兜底),
   否则超过一页的知识库会被静默截断(被截断时页面显示"可能不全"而不是假装列全)。
   列不出来 ≠ 空列表:dws 未登录/权限不足 → 503 + 原因;某一类失败只丢那一类。
④ 面板勾选后走既有登记路径(/api/v1/dingtalk-spaces),首次目录扫描自动排队;
   已登记的按空间名标「已是来源」并禁用勾选;扫码会话失效时直接弹二维码,扫完自动重试。

基础设施:api 与 worker 共享同一份 dws 状态(bind mount 同一份,refresh token 是轮换制,
不能各留一份)。子进程 HOME 必须指向 DWS_HOME —— 这条是实测踩出来的:漏了会报"未登录",
已有回归测试钉住。dws 子进程沿用白名单环境,库口令等变量不进子进程。

测试:新包 internal/dingtalkdiscovery(fixture 用真实 dws 输出形状):paging 约束、
截断提示、一类失败不连带、全部失败→ErrUnavailable、子进程环境;httpapi 侧 401/501/503/500
与不泄漏内部错误;OpenAPI 契约(400/503 组件)通过。前端 189 条 + tsc 干净。

面板实测:知识库(18)/钉盘(7)都列出来,已有三条钉钉来源自动标「已是来源」;
勾选「视觉文档」→ 加入为来源 → 新来源 sc-8a4be5b8293d1c9a048c3c7e9b194155(dingtalk,enabled)
+ source.catalog.refresh 已完成。
2026-10-10 16:46:39 +08:00

202 lines
8.4 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
package dingtalkdiscovery
import (
"context"
"errors"
"strings"
"testing"
)
// fakeRunner 按命令行返回预设 stdout —— fixture 用的是 dws 真实输出形状(已实跑核对)。
type fakeRunner struct {
responses map[string]string
failures map[string]error
seen []string
}
func (f *fakeRunner) RunDWS(_ context.Context, args ...string) ([]byte, error) {
key := strings.Join(args, " ")
f.seen = append(f.seen, key)
if err, ok := f.failures[key]; ok {
return nil, err
}
if body, ok := f.responses[key]; ok {
return []byte(body), nil
}
return []byte(`{"ok":true,"data":{"spaces":[]}}`), nil
}
func kbKey(spaceType string) string { return strings.Join(SpaceListArgs(spaceType), " ") }
const orgKnowledgeFixture = `{
"ok": true,
"outcome": "success",
"data": {
"autoPageComplete": true,
"count": 3,
"hasMore": false,
"pagesFetched": 1,
"requestedType": "orgWikiSpace",
"spaces": [
{"createTime": 1753837670187, "description": "", "name": "ATOM知识库",
"url": "https://alidocs.dingtalk.com/i/spaces/9JOGOQneRgkneX4Q/overview", "workspaceId": "9JOGOQneRgkneX4Q"},
{"createTime": 1770260286344, "description": "公司级知识库,是公司统一口径、可被 AI 使用、可持续维护的权威知识中心。",
"name": "公司级技术支持知识库", "url": "https://alidocs.dingtalk.com/i/spaces/9JOGO6332vlBnm4Q/overview", "workspaceId": "9JOGO6332vlBnm4Q"},
{"createTime": 1, "description": "", "name": "没有链接的空间", "url": "", "workspaceId": "9JOGO0000000000Q"}
]
}
}`
const myKnowledgeFixture = `{"ok": true, "data": {"autoPageComplete": true, "count": 1, "hasMore": false, "requestedType": "myWikiSpace",
"spaces": [{"description": "", "name": "我的文档", "url": "https://alidocs.dingtalk.com/i/spaces/9JOGOxeo90ybnz4Q/overview", "workspaceId": "9JOGOxeo90ybnz4Q"}]}}`
const mySpaceFixture = `{"success": true, "result": {"items": [
{"createTime": 1768373459000, "modifyTime": 1768374168000, "rootFolderId": "65Y1OQX0akWmxN7DYGwUw8GlDd3mERZq",
"spaceId": "28122692916", "spaceName": "我的文件", "spaceType": "mySpace"}
]}}`
const orgSpaceFixture = `{"success": true, "result": {"items": [
{"createTime": 1453221947000, "modifyTime": 1782304977000, "rootFolderId": "g1YGl6Pm2Db8Dr3OayClVxLq0Ee4p79a",
"spaceId": "102571304", "spaceName": "全员文件夹", "spaceType": "orgSpace"},
{"createTime": 1773248364000, "modifyTime": 1791620354000, "rootFolderId": "DElyQod3RxJKGnaQ61nIAJkb4Mw9r5vq",
"spaceId": "28459418500", "spaceName": "公司级营销资料管理", "spaceType": "orgSpace"}
]}}`
func fullRunner() *fakeRunner {
return &fakeRunner{responses: map[string]string{
kbKey("orgWikiSpace"): orgKnowledgeFixture,
kbKey("myWikiSpace"): myKnowledgeFixture,
"wiki space list --type mySpace": mySpaceFixture,
"wiki space list --type orgSpace": orgSpaceFixture,
}}
}
func TestDiscoverParsesKnowledgeBasesAndDriveSpaces(t *testing.T) {
runner := fullRunner()
result, err := Discover(context.Background(), runner)
if err != nil {
t.Fatalf("discover: %v", err)
}
if len(result.KnowledgeBases) != 4 {
t.Fatalf("knowledge bases = %d, want 4(组织 3 + 我的 1)", len(result.KnowledgeBases))
}
// 缺 url 的空间由空间 id 拼链接,保证勾选后仍能登记。
missingURL := result.KnowledgeBases[2]
if missingURL.URL != "https://alidocs.dingtalk.com/i/spaces/9JOGO0000000000Q/overview" {
t.Fatalf("synthesised url = %q", missingURL.URL)
}
if result.KnowledgeBases[0].SpaceType != "orgWikiSpace" || result.KnowledgeBases[3].SpaceType != "myWikiSpace" {
t.Fatalf("space types = %q / %q", result.KnowledgeBases[0].SpaceType, result.KnowledgeBases[3].SpaceType)
}
if len(result.DriveSpaces) != 3 {
t.Fatalf("drive spaces = %d, want 3 (%+v)", len(result.DriveSpaces), result.DriveSpaces)
}
if result.DriveSpaces[1].SpaceType != "orgSpace" || result.DriveSpaces[1].RootFolderID == "" {
t.Fatalf("org space = %+v", result.DriveSpaces[1])
}
if result.DriveNotice != "" || result.KnowledgeNotice != "" {
t.Fatalf("unexpected notices: %q / %q", result.KnowledgeNotice, result.DriveNotice)
}
// 两条实测约束:--limit 上限是 50,且必须 --page-all,否则知识库会被静默截断。
for _, call := range runner.seen {
if strings.HasPrefix(call, "wiki +space-list") {
if !strings.Contains(call, "--page-all") || !strings.Contains(call, "--limit 50") {
t.Fatalf("knowledge list call misses paging constraints: %q", call)
}
if strings.Contains(call, "--limit 200") {
t.Fatalf("--limit above the CLI cap is rejected at runtime: %q", call)
}
}
}
}
// 钉盘列举被拒(租户权限)时,知识库必须照常返回,只带一条原因 —— 否则页面上什么都看不到。
func TestDiscoverKeepsKnowledgeBasesWhenDriveIsDenied(t *testing.T) {
runner := fullRunner()
runner.failures = map[string]error{
"wiki space list --type mySpace": errors.New("permission denied (operation: drive/list_spaces)"),
"wiki space list --type orgSpace": errors.New("permission denied (operation: drive/list_spaces)"),
}
result, err := Discover(context.Background(), runner)
if err != nil {
t.Fatalf("discover should tolerate drive failure, got %v", err)
}
if len(result.KnowledgeBases) != 4 {
t.Fatalf("knowledge bases = %d, want 4", len(result.KnowledgeBases))
}
if len(result.DriveSpaces) != 0 {
t.Fatalf("drive spaces = %d, want 0", len(result.DriveSpaces))
}
if !strings.Contains(result.DriveNotice, "permission denied") {
t.Fatalf("drive notice = %q", result.DriveNotice)
}
}
// 一类知识库失败(例如个人知识库无权限)不该连带组织知识库一起消失。
func TestDiscoverKeepsOneKnowledgeScopeWhenTheOtherFails(t *testing.T) {
runner := fullRunner()
runner.failures = map[string]error{kbKey("myWikiSpace"): errors.New("[AUTH_PERMISSION_DENIED] Permission denied")}
result, err := Discover(context.Background(), runner)
if err != nil {
t.Fatalf("discover: %v", err)
}
if len(result.KnowledgeBases) != 3 {
t.Fatalf("knowledge bases = %d, want the org scope only", len(result.KnowledgeBases))
}
if !strings.Contains(result.KnowledgeNotice, "myWikiSpace") {
t.Fatalf("notice should name the failed scope: %q", result.KnowledgeNotice)
}
}
// 被 --max-items 截断时必须留下提示,不能假装列出了全部。
func TestDiscoverReportsTruncatedKnowledgeList(t *testing.T) {
runner := fullRunner()
runner.responses[kbKey("orgWikiSpace")] = `{"ok":true,"data":{"autoPageComplete":false,"count":50,"hasMore":true,
"spaces":[{"name":"只列出一部分","url":"","workspaceId":"9JOGO1111111111Q"}]}}`
result, err := Discover(context.Background(), runner)
if err != nil {
t.Fatalf("discover: %v", err)
}
if !strings.Contains(result.KnowledgeNotice, "上限") {
t.Fatalf("expected a truncation notice, got %q", result.KnowledgeNotice)
}
}
// 知识库是主列表:两个范围都列不出来时按「环境不可用」上报,页面显示提示而不是空列表。
func TestDiscoverReportsUnavailableWhenEveryKnowledgeScopeFails(t *testing.T) {
for name, body := range map[string]string{
"not logged in": `{"ok":false,"outcome":"failure","error":{"type":"auth","message":"dws: 未登录,请先执行 dws auth login"}}`,
"permission": `{"ok":false,"outcome":"failure","error":{"type":"permission","message":"[AUTH_PERMISSION_DENIED] Permission denied"}}`,
"garbage output": `not json at all`,
"bad flag": `{"ok":false,"outcome":"failure","error":{"type":"internal","message":"--limit 必须是 1-50 之间的整数"}}`,
} {
t.Run(name, func(t *testing.T) {
runner := &fakeRunner{responses: map[string]string{kbKey("orgWikiSpace"): body, kbKey("myWikiSpace"): body}}
_, err := Discover(context.Background(), runner)
if err == nil {
t.Fatal("expected an error")
}
if !errors.Is(err, ErrUnavailable) {
t.Fatalf("err = %v, want ErrUnavailable", err)
}
})
}
}
func TestDiscoverReportsUnavailableWhenDWSMissing(t *testing.T) {
runner := &fakeRunner{failures: map[string]error{
kbKey("orgWikiSpace"): errors.New("dws binary not found"),
kbKey("myWikiSpace"): errors.New("dws binary not found"),
}}
_, err := Discover(context.Background(), runner)
if !errors.Is(err, ErrUnavailable) {
t.Fatalf("err = %v, want ErrUnavailable", err)
}
}
func TestSpaceURL(t *testing.T) {
if got := SpaceURL("ABC123"); got != "https://alidocs.dingtalk.com/i/spaces/ABC123/overview" {
t.Fatalf("space url = %q", got)
}
}