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 保留。
209 lines
6.1 KiB
Go
209 lines
6.1 KiB
Go
package webui
|
||
|
||
import (
|
||
"net/http"
|
||
"net/http/httptest"
|
||
"testing"
|
||
|
||
sdk "github.com/JianFeeeee/HomeAgent/internal/sdk"
|
||
)
|
||
|
||
// mockPluginMgr 是 sdk.PluginManager 的最小实现,用于 handler 路由层测试。
|
||
type mockPluginMgr struct {
|
||
builtins map[string]bool
|
||
disabled []sdk.DisabledPluginInfo
|
||
isDisabled map[string]bool
|
||
runtimes map[string]sdk.PluginRuntimeInfo
|
||
|
||
removed []string
|
||
reloadN int
|
||
removeErr error
|
||
}
|
||
|
||
func (m *mockPluginMgr) ListLoadedPlugins() []string { return nil }
|
||
func (m *mockPluginMgr) ListDisabledPlugins() []sdk.DisabledPluginInfo {
|
||
return m.disabled
|
||
}
|
||
func (m *mockPluginMgr) IsPluginDisabled(name string) bool {
|
||
return m.isDisabled[name]
|
||
}
|
||
func (m *mockPluginMgr) IsBuiltinPlugin(name string) bool {
|
||
return m.builtins[name]
|
||
}
|
||
func (m *mockPluginMgr) DisablePlugin(name, by string) error {
|
||
if m.isDisabled == nil {
|
||
m.isDisabled = map[string]bool{}
|
||
}
|
||
m.isDisabled[name] = true
|
||
return nil
|
||
}
|
||
func (m *mockPluginMgr) EnablePlugin(name string) error {
|
||
delete(m.isDisabled, name)
|
||
return nil
|
||
}
|
||
func (m *mockPluginMgr) RemovePlugin(name string) error {
|
||
if m.removeErr != nil {
|
||
return m.removeErr
|
||
}
|
||
m.removed = append(m.removed, name)
|
||
return nil
|
||
}
|
||
func (m *mockPluginMgr) ReloadPlugins() (string, error) {
|
||
m.reloadN++
|
||
return "reloaded", nil
|
||
}
|
||
func (m *mockPluginMgr) ReloadOne(name string) error { return nil }
|
||
func (m *mockPluginMgr) StopAndUnload(name string) error { return nil }
|
||
func (m *mockPluginMgr) PluginMetas() map[string]sdk.PluginMeta {
|
||
return nil
|
||
}
|
||
func (m *mockPluginMgr) PluginDir() string { return "" }
|
||
func (m *mockPluginMgr) PluginRuntime(name string) (sdk.PluginRuntimeInfo, bool) {
|
||
info, ok := m.runtimes[name]
|
||
return info, ok
|
||
}
|
||
func (m *mockPluginMgr) ListPluginRuntimes() []sdk.PluginRuntimeInfo {
|
||
out := make([]sdk.PluginRuntimeInfo, 0, len(m.runtimes))
|
||
for _, v := range m.runtimes {
|
||
out = append(out, v)
|
||
}
|
||
return out
|
||
}
|
||
|
||
// newHandlerWithMock 构造带 mock PluginManager 的 Handler(绕过 SDK 组装)。
|
||
func newHandlerWithMock(m *mockPluginMgr) *Handler {
|
||
h := NewHandler(nil)
|
||
h.pluginMgr = m
|
||
return h
|
||
}
|
||
|
||
func TestHandlePluginByID_DisabledList(t *testing.T) {
|
||
m := &mockPluginMgr{
|
||
disabled: []sdk.DisabledPluginInfo{{Name: "foo"}},
|
||
}
|
||
h := newHandlerWithMock(m)
|
||
|
||
req := httptest.NewRequest(http.MethodGet, "/api/v1/plugins/disabled", nil)
|
||
w := httptest.NewRecorder()
|
||
h.handlePluginByID(w, req)
|
||
|
||
if w.Code != http.StatusOK {
|
||
t.Fatalf("expected 200, got %d", w.Code)
|
||
}
|
||
if body := w.Body.String(); len(body) == 0 || !contains(body, "foo") {
|
||
t.Fatalf("expected disabled list with foo, got %s", body)
|
||
}
|
||
}
|
||
|
||
func contains(s, sub string) bool {
|
||
return len(s) >= len(sub) && (func() bool {
|
||
for i := 0; i+len(sub) <= len(s); i++ {
|
||
if s[i:i+len(sub)] == sub {
|
||
return true
|
||
}
|
||
}
|
||
return false
|
||
})()
|
||
}
|
||
|
||
func TestHandlePluginByID_ReloadPost(t *testing.T) {
|
||
m := &mockPluginMgr{}
|
||
h := newHandlerWithMock(m)
|
||
|
||
req := httptest.NewRequest(http.MethodPost, "/api/v1/plugins/reload", nil)
|
||
w := httptest.NewRecorder()
|
||
h.handlePluginByID(w, req)
|
||
|
||
if w.Code != http.StatusOK {
|
||
t.Fatalf("expected 200, got %d: %s", w.Code, w.Body.String())
|
||
}
|
||
if m.reloadN != 1 {
|
||
t.Fatalf("expected ReloadPlugins called once, got %d", m.reloadN)
|
||
}
|
||
}
|
||
|
||
func TestHandlePluginByID_ReloadDeleteRejected(t *testing.T) {
|
||
// DELETE /plugins/reload 不允许把保留字当插件名反代成卸载
|
||
m := &mockPluginMgr{}
|
||
h := newHandlerWithMock(m)
|
||
|
||
req := httptest.NewRequest(http.MethodDelete, "/api/v1/plugins/reload", nil)
|
||
w := httptest.NewRecorder()
|
||
h.handlePluginByID(w, req)
|
||
|
||
if w.Code != http.StatusMethodNotAllowed {
|
||
t.Fatalf("expected 405, got %d", w.Code)
|
||
}
|
||
if len(m.removed) != 0 {
|
||
t.Fatalf("expected no plugin removed, got %v", m.removed)
|
||
}
|
||
}
|
||
|
||
func TestHandlePluginByID_PathTraversalRejected(t *testing.T) {
|
||
cases := []string{"../evil", "a/b", "a..b-ok-but-dots-only-check", "..%2Fetc"}
|
||
for _, name := range cases {
|
||
req := httptest.NewRequest(http.MethodDelete, "/api/v1/plugins/"+name, nil)
|
||
w := httptest.NewRecorder()
|
||
h := newHandlerWithMock(&mockPluginMgr{})
|
||
h.handlePluginByID(w, req)
|
||
// 含路径分隔符或以 .. 开头的名称必须被拒绝(400/405),绝不能反代到 pluginmgr
|
||
if w.Code != http.StatusBadRequest && w.Code != http.StatusMethodNotAllowed && w.Code != http.StatusNotFound {
|
||
t.Errorf("name %q: expected 4xx rejection, got %d", name, w.Code)
|
||
}
|
||
}
|
||
}
|
||
|
||
func TestHandlePluginByID_InvalidNamesRejected(t *testing.T) {
|
||
cases := []string{"has%20space", "has%3Acolon", "back%5Cslash"}
|
||
for _, name := range cases {
|
||
req := httptest.NewRequest(http.MethodGet, "/api/v1/plugins/"+name, nil)
|
||
w := httptest.NewRecorder()
|
||
h := newHandlerWithMock(&mockPluginMgr{})
|
||
h.handlePluginByID(w, req)
|
||
if w.Code != http.StatusBadRequest {
|
||
t.Errorf("name %q: expected 400, got %d", name, w.Code)
|
||
}
|
||
}
|
||
}
|
||
|
||
func TestHandlePluginByID_ValidNamePassesValidation(t *testing.T) {
|
||
// 合法插件名(含点/横线/下划线)不应被名称校验拦截;
|
||
// 这里 pluginmgr 未运行会得到 502 Bad Gateway,但绝不应该是 400。
|
||
m := &mockPluginMgr{}
|
||
h := newHandlerWithMock(m)
|
||
|
||
for _, name := range []string{"my-plugin", "plugin_v2", "weather.so"} {
|
||
req := httptest.NewRequest(http.MethodGet, "/api/v1/plugins/"+name, nil)
|
||
w := httptest.NewRecorder()
|
||
h.handlePluginByID(w, req)
|
||
if w.Code == http.StatusBadRequest {
|
||
t.Errorf("valid name %q should pass validation, got 400", name)
|
||
}
|
||
}
|
||
}
|
||
|
||
func TestHandlePluginByID_DisableEnable(t *testing.T) {
|
||
m := &mockPluginMgr{builtins: map[string]bool{"webui": true}}
|
||
h := newHandlerWithMock(m)
|
||
|
||
req := httptest.NewRequest(http.MethodPost, "/api/v1/plugins/webui/disable", nil)
|
||
w := httptest.NewRecorder()
|
||
h.handlePluginByID(w, req)
|
||
if w.Code != http.StatusOK {
|
||
t.Fatalf("disable: expected 200, got %d: %s", w.Code, w.Body.String())
|
||
}
|
||
if !m.isDisabled["webui"] {
|
||
t.Fatal("webui should be disabled in mock")
|
||
}
|
||
|
||
req = httptest.NewRequest(http.MethodPost, "/api/v1/plugins/webui/enable", nil)
|
||
w = httptest.NewRecorder()
|
||
h.handlePluginByID(w, req)
|
||
if w.Code != http.StatusOK {
|
||
t.Fatalf("enable: expected 200, got %d: %s", w.Code, w.Body.String())
|
||
}
|
||
if m.isDisabled["webui"] {
|
||
t.Fatal("webui should be re-enabled")
|
||
}
|
||
}
|