// 本文件记录研究 API 的回归契约;测试注释描述实际断言,不代表本次已运行测试。 package research import ( "context" "database/sql" "encoding/json" "errors" "net/http" "net/http/httptest" "net/url" "strings" "testing" "time" ) // fixtureRepository 捕获调用参数和次数,并可模拟依赖失败或等到 context 被取消。 type fixtureRepository struct { filters Filters id int64 err error wait bool calls int } // List 只返回结构化空列表,wait 分支专门验证请求期限与槽位回收。 func (f *fixtureRepository) List(ctx context.Context, filters Filters) (Page, error) { f.calls++ f.filters = filters if f.wait { <-ctx.Done() return Page{}, ctx.Err() } return Page{Items: []Paper{}, Topics: []string{}, PageSize: filters.PageSize}, f.err } // Get 保存请求 ID 并给出固定论文,不访问数据库。 func (f *fixtureRepository) Get(ctx context.Context, id int64) (Paper, error) { f.calls++ f.id = id return Paper{ID: "42", Title: "Original title", Authors: []string{}, Topics: []string{}, Sources: []Source{}}, f.err } // request 使用内存 recorder 执行路由,不启动监听端口。 func request(handler http.Handler, method, path string) *httptest.ResponseRecorder { w := httptest.NewRecorder() handler.ServeHTTP(w, httptest.NewRequest(method, path, nil)) return w } // TestAnonymousReadRoutes 通过假仓库验证匿名列表/详情、参数传递、JSON 空值与响应头,并拒绝写方法及未知项目。 func TestAnonymousReadRoutes(t *testing.T) { f := &fixtureRepository{} mux := http.NewServeMux() Register(mux, f, map[string]string{"thesisly": "http://localhost:17322/auth/callback"}) w := request(mux, "GET", "/projects/thesisly/research/papers?q=graph&searchIn=author&sort=title&topic=cs.LG&pageSize=10") if w.Code != 200 || f.filters != (Filters{Query: "graph", SearchIn: "author", Topic: "cs.LG", Sort: "title", PageSize: 10}) { t.Fatalf("list: %d %+v", w.Code, f.filters) } var page Page if err := json.Unmarshal(w.Body.Bytes(), &page); err != nil || page.Items == nil || page.Topics == nil { t.Fatalf("invalid page: %s", w.Body.String()) } if w.Header().Get("Cache-Control") != "no-store" || w.Header().Get("Content-Type") != "application/json" { t.Fatal("missing response headers") } w = request(mux, "GET", "/projects/thesisly/research/papers/42") if w.Code != 200 || f.id != 42 || !strings.Contains(w.Body.String(), `"abstract":null`) { t.Fatalf("detail: %d %s", w.Code, w.Body.String()) } if got := request(mux, "POST", "/projects/thesisly/research/papers").Code; got != 405 { t.Fatalf("mutation status %d", got) } if got := request(mux, "GET", "/projects/other/research/papers").Code; got != 404 { t.Fatalf("unknown project status %d", got) } } // TestInvalidQueriesNeverReachRepository 逐项注入重复、未知、超限及非法 Unicode/ID 参数,要求 400 且仓库调用次数保持零。 func TestInvalidQueriesNeverReachRepository(t *testing.T) { queries := []string{"unknown=1", "q=x&q=y", "q=%ff", "q=%00", "q=%zz", "page=0", "page=1001", "page=-1", "page=1.5", "page=01", "pageSize=51", "pageSize=0", "pageSize=9999999999999999999999", "searchIn=sql", "sort=published", "topic=arxiv:cs.LG", "q=" + url.QueryEscape(strings.Repeat("字", 201)), "q=" + url.QueryEscape(strings.Repeat("word ", 21))} for _, query := range queries { t.Run(query, func(t *testing.T) { f := &fixtureRepository{} mux := http.NewServeMux() Register(mux, f, map[string]string{"thesisly": "unused"}) w := request(mux, "GET", "/projects/thesisly/research/papers?"+query) if w.Code != 400 || f.calls != 0 { t.Fatalf("status %d, calls %d", w.Code, f.calls) } }) } for _, path := range []string{"0", "-1", "1x", "9223372036854775808", "1?extra=1"} { mux := http.NewServeMux() f := &fixtureRepository{} Register(mux, f, map[string]string{"thesisly": "unused"}) if w := request(mux, "GET", "/projects/thesisly/research/papers/"+path); w.Code != 400 || f.calls != 0 { t.Fatalf("invalid id %q: %d", path, w.Code) } } } // TestQueryDefaultsAndUnicode 验证多语言查询只裁剪两端空白,并采用文本搜索、最近排序和八条页大小。 func TestQueryDefaultsAndUnicode(t *testing.T) { f, err := parseFilters("q=" + url.QueryEscape(" 论文 Graph ")) if err != nil || f.Query != "论文 Graph" || f.PageSize != 8 || f.SearchIn != "text" || f.Sort != "recent" { t.Fatalf("%+v %v", f, err) } } // databaseFailure 让测试模拟驱动 SQLState,同时让 Error 带私密文本以验证脱敏。 type databaseFailure string // Error 故意返回私密说明,供响应脱敏断言检查。 func (failure databaseFailure) Error() string { return "private database error" } // SQLState 模拟 PostgreSQL 驱动错误分类,不暴露其实际内部消息。 func (failure databaseFailure) SQLState() string { return string(failure) } // TestStorageErrorsAreRedacted 注入缺行、取消和权限错误,检查状态码映射,同时确保私密数据库内容不会进入响应。 func TestStorageErrorsAreRedacted(t *testing.T) { for _, test := range []struct { err error status int code string }{ {sql.ErrNoRows, 404, "not_found"}, {context.DeadlineExceeded, 504, "research_timeout"}, {errors.Join(databaseFailure("57014"), errors.New("private statement")), 504, "research_timeout"}, {databaseFailure("42501"), 503, "research_unavailable"}, {errors.New("postgres://private-user:private-password@db/corpus"), 503, "research_unavailable"}, } { mux := http.NewServeMux() Register(mux, &fixtureRepository{err: test.err}, map[string]string{"thesisly": "unused"}) w := request(mux, "GET", "/projects/thesisly/research/papers/42") if w.Code != test.status || !strings.Contains(w.Body.String(), test.code) || strings.Contains(w.Body.String(), "private") { t.Fatalf("%d %s", w.Code, w.Body.String()) } } } // TestConcurrencyAndTimeoutReleaseSlots 手动占满两个槽验证立即 429,再让假仓库等到超时,验证 504 后槽位被释放。 func TestConcurrencyAndTimeoutReleaseSlots(t *testing.T) { s := &service{repository: &fixtureRepository{wait: true}, projects: map[string]string{"thesisly": "unused"}, slots: make(chan struct{}, 2), timeout: time.Millisecond} mux := http.NewServeMux() mux.HandleFunc("GET /projects/{project}/research/papers", s.serve) s.slots <- struct{}{} s.slots <- struct{}{} w := request(mux, "GET", "/projects/thesisly/research/papers") if w.Code != 429 || w.Header().Get("Retry-After") != "1" { t.Fatalf("busy %d", w.Code) } <-s.slots <-s.slots w = request(mux, "GET", "/projects/thesisly/research/papers") if w.Code != 504 || len(s.slots) != 0 { t.Fatalf("timeout %d, slots %d", w.Code, len(s.slots)) } } // TestInvalidCursorsNeverReachRepository 验证坏编码、过长、筛选不符及重复游标在 HTTP 层拦截,不触发仓库查询。 func TestInvalidCursorsNeverReachRepository(t *testing.T) { f := Filters{Query: "graph", Sort: "recent", SearchIn: "text", PageSize: 8} valid := encodeCursor(f, position{ID: 42}, false) for _, query := range []string{"cursor=!", "cursor=" + strings.Repeat("a", 32769), "q=different&cursor=" + valid, "cursor=" + valid + "&cursor=" + valid, "page=1"} { repository := &fixtureRepository{} mux := http.NewServeMux() Register(mux, repository, map[string]string{"thesisly": "unused"}) w := request(mux, "GET", "/projects/thesisly/research/papers?"+query) if w.Code != 400 || repository.calls != 0 { t.Fatalf("invalid cursor reached storage: status=%d calls=%d", w.Code, repository.calls) } } }