WeKnora/docs/swagger_contract_test.go

83 lines
1.8 KiB
Go

package docs_test
import (
"encoding/json"
"os"
"testing"
docs "github.com/Tencent/WeKnora/docs"
"gopkg.in/yaml.v3"
)
func TestKnowledgeSearchRouteContract(t *testing.T) {
tests := []struct {
name string
loadSpec func(t *testing.T) []byte
parse func([]byte, any) error
}{
{
name: "registered document",
loadSpec: func(t *testing.T) []byte {
t.Helper()
return []byte(docs.SwaggerInfo.ReadDoc())
},
parse: json.Unmarshal,
},
{
name: "swagger.json",
loadSpec: func(t *testing.T) []byte {
t.Helper()
return readSwaggerFile(t, "swagger.json")
},
parse: json.Unmarshal,
},
{
name: "swagger.yaml",
loadSpec: func(t *testing.T) []byte {
t.Helper()
return readSwaggerFile(t, "swagger.yaml")
},
parse: yaml.Unmarshal,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
assertKnowledgeSearchRouteContract(t, tt.loadSpec(t), tt.parse)
})
}
}
func readSwaggerFile(t *testing.T, name string) []byte {
t.Helper()
data, err := os.ReadFile(name)
if err != nil {
t.Fatalf("read %s: %v", name, err)
}
return data
}
func assertKnowledgeSearchRouteContract(t *testing.T, data []byte, parse func([]byte, any) error) {
t.Helper()
var spec struct {
Paths map[string]map[string]any `json:"paths" yaml:"paths"`
}
if err := parse(data, &spec); err != nil {
t.Fatalf("parse generated Swagger document: %v", err)
}
knowledgeSearch, ok := spec.Paths["/knowledge-search"]
if !ok {
t.Fatal("generated Swagger document does not expose /knowledge-search")
}
if _, ok := knowledgeSearch["post"]; !ok {
t.Fatal("generated Swagger document does not expose POST /knowledge-search")
}
if staleRoute, ok := spec.Paths["/sessions/search"]; ok {
if _, ok := staleRoute["post"]; ok {
t.Fatal("generated Swagger document still exposes stale POST /sessions/search")
}
}
}