mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-10-15 12:15:16 +00:00
## 背景 仓库早已迁移到 GitHub(`github.com/JianFeeeee/HomeAgent`,CI/CD 都在那边跑), gitcode 保留为**国内只读镜像**(`ci.yml` 的 sync-gitcode-main 快进推送)。 但 go.mod 的 module 路径一直是 `gitcode.com/JianFeeeee/...` —— 既与权威源 不符,`meta.SourceURL`(AGPL §13 的源码提供入口)也指向镜像而非实际运行的代码。 ## 关键区分(这是本次改动安全的前提) 两个 module 是**不同**的,影响面差一个数量级: | module | 谁依赖 | 改它的后果 | |---|---|---| | `.../HomeAgent`(主仓) | **只有主仓自己** | 内部重构,零外部影响 | | `.../homeagent-sdk`(SDK 仓) | 主仓 49 文件 + 所有外部插件 | 需重编插件 | ★ 实测确认:**插件不 import 主仓 module**(`strings qq/plugin.bin | grep HomeAgent` = 0), 只依赖 SDK 仓。而插件与内核的边界是 **RPC 方法名字符串** (`plugin.init` / `tool.invoke`…,见 proc/protocol.go),**与 Go module 名无关**。 ⇒ module 改名**不改变任何 wire 协议**,现网已装的插件照常运行。 SDK 的 GitHub 仓名是 `homeagentsdk`(无连字符),module 路径必须与之精确匹配, 否则 `go get` 会因路径不符失败,故取 `github.com/JianFeeeee/homeagentsdk`。 ## 改动 - `go.mod` / `go.sum`:两个 module 路径 + require/replace - 277 个 Go 文件 + Makefile + 打包脚本的 import 与 ldflags 路径 - SDK 仓 `meta.CoreModule`、`tools/hmapdev` 的 module 声明与工程模板 - 对外文档/链接的仓库地址(README、PLUGIN_DEV、OVERVIEW 等) ## 明确**保留** gitcode 的地方(镜像机制,不能动) - `GITCODE_TOKEN`、`GC_URL="…@gitcode.com"`(CI 同步 job) - `gitcode.com/api/v5/...`(release 附件上传) - git remote `gitcode`(镜像拉取/推送) - `docs/zh/ci-cd-runbook.md`(整篇讲镜像运维) ## 验证 - `go build ./...` / `go vet ./...` 绿 - `go test ./... -count=1` → 48 包 ok / 0 FAIL - hmapdev 工具链编译通过(`third_party/homeagent-sdk/tools/hmapdev`) - 全仓残留检查:module 形态的 `gitcode.com/JianFeeeee` = 0 - 镜像机制抽验:GC_URL / @gitcode / api/v5 / remote 均完好 ## 顺带修正 `hmapdev/templates.go` 的注释此前写「gitcode 的模块不在 proxy.golang.org 上」—— module 已迁 GitHub,该论断不再成立。改为如实说明**为何仍默认 replace 到本机 SDK**: 离线可构建、避免版本漂移、内网可用。理由与托管地无关,故 replace 保留。
231 lines
8.9 KiB
Go
231 lines
8.9 KiB
Go
//go:build linux || darwin
|
||
|
||
package plugins
|
||
|
||
import (
|
||
"fmt"
|
||
"net/http"
|
||
"path/filepath"
|
||
"strings"
|
||
"testing"
|
||
"time"
|
||
|
||
internalConfig "github.com/JianFeeeee/HomeAgent/internal/config"
|
||
)
|
||
|
||
// forbidStoppingSharedBackend 给测试实例关上「退出时停后端」这道闸。
|
||
//
|
||
// 本机 127.0.0.1:8888 的 SearXNG 是**线上服务在用的**。插件侧已保证「只关自己拉起的实例」,
|
||
// 这里再加一道:即便这个测试实例真的把它拉起来了,退出时也不关 —— 否则跑一次测试就断一次
|
||
// 线上搜索(实测被这条坑过:E2E 临时目录里的插件实例在 teardown 时 `docker compose stop`,
|
||
// 表现为「搜索后端起不来」)。
|
||
func forbidStoppingSharedBackend(t *testing.T, env *testPluginEnv) {
|
||
t.Helper()
|
||
if env.cfgReg == nil {
|
||
t.Fatal("测试环境没有配置注册表,无法关闭后端托管")
|
||
}
|
||
ps := env.cfgReg.PluginConfig("deepsearch")
|
||
// 配置表只在 RegisterDef 时创建(内核有意为之:读写不隐式建表)。
|
||
// 插件启动时才会注册自己的 def,而我们要在那之前写入,所以这里先注册这个键。
|
||
ps.RegisterDef(internalConfig.ConfigDef{Key: "stop_searxng_on_exit", Type: "bool", Default: "true"})
|
||
if err := ps.Set("stop_searxng_on_exit", "false"); err != nil {
|
||
t.Fatalf("写 stop_searxng_on_exit=false 失败: %v", err)
|
||
}
|
||
}
|
||
|
||
// deepsearch 插件的真实调用往返:内核 ExecuteTool → RPC → 插件子进程 → 本地 SearXNG → 结果回传。
|
||
//
|
||
// 与 TestRealPlugin_ToolInvokeRoundTrip 的区别:那条只断言「链路通(拿到结果或拿到插件侧的错误)」,
|
||
// 这条断言**内容形状**——返回里必须有「摘要」与「引擎覆盖度」。这正是旧实现(抓 Bing HTML)
|
||
// 拿不到的东西,也是「搜索能力不行」的根因,所以它必须成为回归判据。
|
||
//
|
||
// 前置:本机 127.0.0.1:8888 上跑着 SearXNG(部署见 /root/searxng-agent)。
|
||
// 未启动时 fail 并给出可操作提示,而不是 skip —— 否则这条判据会在环境退化时静默失效。
|
||
func TestRealPlugin_DeepSearchInvoke(t *testing.T) {
|
||
env := setupIntegration(t)
|
||
defer env.cleanup()
|
||
|
||
plgDir := filepath.Join(env.tmpDir, "plugins")
|
||
installRealPlugin(t, plgDir, "deepsearch")
|
||
forbidStoppingSharedBackend(t, env)
|
||
|
||
if err := env.pluginReg.Load(plgDir); err != nil {
|
||
t.Fatalf("加载插件: %v", err)
|
||
}
|
||
if env.pluginReg.Get("deepsearch") == nil {
|
||
t.Fatal("deepsearch 未经 proc 通道加载")
|
||
}
|
||
|
||
var toolName string
|
||
for _, def := range env.stageHost.GetToolDefs() {
|
||
if strings.HasPrefix(def.Name, "deepsearch") && strings.HasSuffix(def.Name, "_search") {
|
||
toolName = def.Name
|
||
break
|
||
}
|
||
}
|
||
if toolName == "" {
|
||
t.Fatal("deepsearch 未注册检索工具")
|
||
}
|
||
t.Logf("调用工具 %s", toolName)
|
||
|
||
// 用当初失败的那条查询做判据
|
||
res, err := env.stageHost.ExecuteTool(toolName, map[string]interface{}{
|
||
"query": "深度科技 deepin 开发者 被开除",
|
||
"count": float64(3),
|
||
})
|
||
if err != nil {
|
||
if strings.Contains(err.Error(), "not found in any plugin") {
|
||
t.Fatalf("工具未注册到 stageHost: %v", err)
|
||
}
|
||
t.Fatalf("工具调用失败(检查本机 SearXNG 是否在 127.0.0.1:8888 运行): %v", err)
|
||
}
|
||
if res == nil {
|
||
t.Fatal("工具返回 nil 且无错误")
|
||
}
|
||
|
||
text := fmt.Sprintf("%v", res)
|
||
t.Logf("工具返回前 500 字:\n%s", truncRunes(text, 500))
|
||
|
||
// 上游限流/CAPTCHA 时跳过内容形状断言(外部条件,非功能回归)。
|
||
skipIfUpstreamUnavailable(t, text)
|
||
|
||
if !strings.Contains(text, "摘要:") {
|
||
t.Errorf("返回内容缺少摘要——这正是旧实现拿不到的部分:\n%s", truncRunes(text, 800))
|
||
}
|
||
if !strings.Contains(text, "覆盖:") {
|
||
t.Errorf("返回内容缺少引擎覆盖度(模型据此判断可信度):\n%s", truncRunes(text, 800))
|
||
}
|
||
if !strings.Contains(text, "http") {
|
||
t.Errorf("返回内容缺少结果链接:\n%s", truncRunes(text, 800))
|
||
}
|
||
}
|
||
|
||
// deepsearch_status 也走一遍真实调用:它把「后端是否可用、哪些引擎在出结果」暴露成工具,
|
||
// 出问题时 agent 可以先自检,而不是盲目换词重搜。
|
||
func TestRealPlugin_DeepSearchStatusInvoke(t *testing.T) {
|
||
env := setupIntegration(t)
|
||
defer env.cleanup()
|
||
|
||
plgDir := filepath.Join(env.tmpDir, "plugins")
|
||
installRealPlugin(t, plgDir, "deepsearch")
|
||
forbidStoppingSharedBackend(t, env)
|
||
if err := env.pluginReg.Load(plgDir); err != nil {
|
||
t.Fatalf("加载插件: %v", err)
|
||
}
|
||
|
||
var toolName string
|
||
for _, def := range env.stageHost.GetToolDefs() {
|
||
if strings.HasPrefix(def.Name, "deepsearch") && strings.HasSuffix(def.Name, "_status") {
|
||
toolName = def.Name
|
||
break
|
||
}
|
||
}
|
||
if toolName == "" {
|
||
t.Fatal("deepsearch 未注册自检工具")
|
||
}
|
||
|
||
res, err := env.stageHost.ExecuteTool(toolName, map[string]interface{}{"probe": "test"})
|
||
if err != nil {
|
||
t.Fatalf("自检调用失败(检查本机 SearXNG 是否运行): %v", err)
|
||
}
|
||
text := fmt.Sprintf("%v", res)
|
||
t.Logf("自检返回:%s", truncRunes(text, 400))
|
||
|
||
for _, want := range []string{"healthz", "search_ok", "engines_returning_results"} {
|
||
if !strings.Contains(text, want) {
|
||
t.Errorf("自检结果缺少字段 %q:%s", want, truncRunes(text, 500))
|
||
}
|
||
}
|
||
}
|
||
|
||
// upstreamUnavailable 判定本次检索失败是否**源于上游不可用**(限流/CAPTCHA),
|
||
// 而不是插件功能回归。
|
||
//
|
||
// 为什么必须区分:插件在「所有引擎都没给出结果」时返回的是**正常结果**
|
||
// (err == nil,content 里带 "未返回结果" 与无响应引擎列表)——这是上游限流、
|
||
// CAPTCHA 等**外部条件**,与代码是否正确无关。
|
||
//
|
||
// 此前这条测试把它们一视同仁地判红:实测失败信息是
|
||
// brave(Suspended: too many requests), duckduckgo(CAPTCHA), google cse(Suspended: ...)
|
||
// 于是「上游限流」被当成「搜索能力坏了」。更糟的是它**不可控地随机红**:
|
||
// 用 A/B 对照实测(同一时段连跑 20 轮)干净树也复现 2 次失败,
|
||
// 与任何代码改动无关 —— 这种判据会让真正的回归淹没在噪声里。
|
||
//
|
||
// 现在的语义:
|
||
// 上游限流/CAPTCHA ⇒ t.Skip(带明确理由,不静默通过)
|
||
// 其他异常 ⇒ t.Fatalf/Fail(真回归)
|
||
func upstreamUnavailable(text string) bool {
|
||
// 插件只有在「无任何结果」时才输出这句;有结果时不会出现。
|
||
return strings.Contains(text, "未返回结果")
|
||
}
|
||
|
||
// skipIfUpstreamUnavailable 在判定为上游不可用时以**明确理由**跳过。
|
||
// 注意是 Skip 而不是静默 return:后者会让这条判据在环境退化时无声失效
|
||
// (本文件原本的注释正是担心这一点,只是用错了应对方式——把噪声判成红)。
|
||
func skipIfUpstreamUnavailable(t *testing.T, text string) {
|
||
t.Helper()
|
||
if upstreamUnavailable(text) {
|
||
t.Skipf("上游搜索后端不可用(限流/CAPTCHA),跳过内容形状断言。"+
|
||
"这不是功能回归;要验证内容形状请在引擎可用时重跑。返回:%s",
|
||
truncRunes(text, 300))
|
||
}
|
||
}
|
||
|
||
func truncRunes(s string, n int) string {
|
||
r := []rune(s)
|
||
if len(r) <= n {
|
||
return s
|
||
}
|
||
return string(r[:n]) + "…"
|
||
}
|
||
|
||
// 插件的停止**不得带走共享后端**:这是「搜索后端起不来」的直接回归判据。
|
||
// 判据落在网络层(healthz 仍然 200),而不是「有没有执行 docker 命令」。
|
||
func TestRealPlugin_DeepSearchKeepsSharedBackendOnStop(t *testing.T) {
|
||
env := setupIntegration(t)
|
||
defer env.cleanup()
|
||
|
||
// 前置:后端必须可达(本测试判据是「停止后 healthz 仍 200」,
|
||
// 后端本来就不可用时该判据无从谈起 —— 用 skip 而非 fail,
|
||
// 因为那是环境问题,不是「插件把后端带走了」)。
|
||
if !searxngHealthy() {
|
||
t.Skip("本机 127.0.0.1:8888 的 SearXNG 不可用,无法验证「停止不带走后端」;" +
|
||
"先 `cd /root/searxng-agent && docker compose up -d` 再跑")
|
||
}
|
||
|
||
plgDir := filepath.Join(env.tmpDir, "plugins")
|
||
installRealPlugin(t, plgDir, "deepsearch")
|
||
forbidStoppingSharedBackend(t, env)
|
||
if err := env.pluginReg.Load(plgDir); err != nil {
|
||
t.Fatalf("加载插件: %v", err)
|
||
}
|
||
if env.pluginReg.Get("deepsearch") == nil {
|
||
t.Fatal("deepsearch 未加载")
|
||
}
|
||
|
||
// 停掉这个插件实例(相当于测试 teardown / 另一个 daemon 退出)
|
||
if err := env.pluginReg.StopAndUnload("deepsearch"); err != nil {
|
||
t.Fatalf("停止插件失败: %v", err)
|
||
}
|
||
|
||
// 给「如果它真去关了」留出执行窗口:stop -t 2 最多 2 秒
|
||
deadline := time.Now().Add(6 * time.Second)
|
||
for time.Now().Before(deadline) {
|
||
if !searxngHealthy() {
|
||
t.Fatalf("插件停止把共享后端带走了(healthz 不再是 200)—— 线上搜索会因此不可用")
|
||
}
|
||
time.Sleep(500 * time.Millisecond)
|
||
}
|
||
t.Log("插件已停止,共享后端仍在服务")
|
||
}
|
||
|
||
func searxngHealthy() bool {
|
||
cl := &http.Client{Timeout: 3 * time.Second}
|
||
resp, err := cl.Get("http://127.0.0.1:8888/healthz")
|
||
if err != nil {
|
||
return false
|
||
}
|
||
defer resp.Body.Close()
|
||
return resp.StatusCode == http.StatusOK
|
||
}
|