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 保留。
225 lines
7.9 KiB
Go
225 lines
7.9 KiB
Go
package pluginmgr
|
||
|
||
import (
|
||
"archive/zip"
|
||
"bytes"
|
||
"encoding/json"
|
||
"os"
|
||
"path/filepath"
|
||
"sync"
|
||
"testing"
|
||
|
||
"github.com/JianFeeeee/HomeAgent/internal/events"
|
||
"github.com/JianFeeeee/HomeAgent/internal/plugin"
|
||
sdk "github.com/JianFeeeee/HomeAgent/internal/sdk"
|
||
)
|
||
|
||
func TestCmpVersion(t *testing.T) {
|
||
cases := []struct{ a, b string; want int }{
|
||
{"1.0.0", "1.0.0", 0},
|
||
{"1.0.1", "1.0.0", 1},
|
||
{"1.0.0", "1.0.1", -1},
|
||
{"1.0", "1.0.0", 0},
|
||
{"v2.0.0", "1.9.9", 1},
|
||
{"2.0.0", "10.0.0", -1}, // 数字比较而非字典序
|
||
{"1.0.0-alpha", "1.0.0", 0}, // 非数字段按 0
|
||
}
|
||
for _, c := range cases {
|
||
if got := cmpVersion(c.a, c.b); got != c.want {
|
||
t.Errorf("cmpVersion(%q,%q)=%d want %d", c.a, c.b, got, c.want)
|
||
}
|
||
}
|
||
}
|
||
|
||
// ---- 最小 mock SDK ----
|
||
|
||
type pmSettings struct{}
|
||
|
||
func (m *pmSettings) DataDir() string { return "/tmp/mock_data" }
|
||
|
||
func (m *pmSettings) Get(string) (interface{}, error) { return nil, nil }
|
||
func (m *pmSettings) Set(string, interface{}) error { return nil }
|
||
func (m *pmSettings) List(string) ([]string, error) { return nil, nil }
|
||
func (m *pmSettings) GetCore(string) (interface{}, error) { return nil, nil }
|
||
func (m *pmSettings) SetCore(string, interface{}) error { return nil }
|
||
func (m *pmSettings) ListCore(string) ([]string, error) { return nil, nil }
|
||
func (m *pmSettings) GetPlugin(string, string) (interface{}, error) { return nil, nil }
|
||
func (m *pmSettings) SetPlugin(string, string, interface{}) error { return nil }
|
||
func (m *pmSettings) ListPlugin(string, string) ([]string, error) { return nil, nil }
|
||
func (m *pmSettings) RegisterDef(sdk.ConfigDef) {}
|
||
func (m *pmSettings) Defs(string) []*sdk.ConfigDef { return nil }
|
||
func (m *pmSettings) Dump() map[string]interface{} { return nil }
|
||
func (m *pmSettings) Plugins() []string { return nil }
|
||
func (m *pmSettings) DefsCore(string) []*sdk.ConfigDef { return nil }
|
||
func (m *pmSettings) DefsPlugin(string, string) []*sdk.ConfigDef { return nil }
|
||
func (m *pmSettings) Remove(string) error { return nil }
|
||
func (m *pmSettings) RemoveCore(string) error { return nil }
|
||
func (m *pmSettings) RemovePlugin(string, string) error { return nil }
|
||
|
||
// fakePluginMgr 记录调用;StopAndUnload 只记标志,不真正操作。
|
||
type fakePluginMgr struct {
|
||
mu sync.Mutex
|
||
stopAndUnloads []string
|
||
}
|
||
|
||
func (f *fakePluginMgr) ListLoadedPlugins() []string { return nil }
|
||
func (f *fakePluginMgr) ListDisabledPlugins() []sdk.DisabledPluginInfo { return nil }
|
||
func (f *fakePluginMgr) IsPluginDisabled(string) bool { return false }
|
||
func (f *fakePluginMgr) IsBuiltinPlugin(string) bool { return false }
|
||
func (f *fakePluginMgr) DisablePlugin(string, string) error { return nil }
|
||
func (f *fakePluginMgr) EnablePlugin(string) error { return nil }
|
||
func (f *fakePluginMgr) RemovePlugin(string) error { return nil }
|
||
func (f *fakePluginMgr) StopAndUnload(name string) error {
|
||
f.mu.Lock()
|
||
defer f.mu.Unlock()
|
||
f.stopAndUnloads = append(f.stopAndUnloads, name)
|
||
return nil
|
||
}
|
||
func (f *fakePluginMgr) ReloadPlugins() (string, error) { return "", nil }
|
||
func (f *fakePluginMgr) ReloadOne(string) error { return nil }
|
||
func (f *fakePluginMgr) PluginMetas() map[string]sdk.PluginMeta {
|
||
return map[string]sdk.PluginMeta{}
|
||
}
|
||
func (f *fakePluginMgr) PluginDir() string { return "" }
|
||
func (f *fakePluginMgr) PluginRuntime(string) (sdk.PluginRuntimeInfo, bool) {
|
||
return sdk.PluginRuntimeInfo{}, false
|
||
}
|
||
func (f *fakePluginMgr) ListPluginRuntimes() []sdk.PluginRuntimeInfo { return nil }
|
||
|
||
// buildHmap 构造一个最小 .hmap 包。
|
||
func buildHmap(t *testing.T, name, version string) []byte {
|
||
t.Helper()
|
||
var buf bytes.Buffer
|
||
zw := zip.NewWriter(&buf)
|
||
manifest := map[string]interface{}{
|
||
"name": name, "name_zh": name, "name_en": name,
|
||
"version": version, "entry": "plugin.bin",
|
||
}
|
||
mData, _ := json.Marshal(manifest)
|
||
f, _ := zw.Create("plugin.json")
|
||
f.Write(mData)
|
||
bin, _ := zw.Create("plugin.bin")
|
||
bin.Write([]byte("binary-" + name + "-" + version))
|
||
zw.Close()
|
||
return buf.Bytes()
|
||
}
|
||
|
||
func TestInstallThenUpgradeKeepsConfig(t *testing.T) {
|
||
dir := t.TempDir()
|
||
fm := &fakePluginMgr{}
|
||
bus := events.NewBus()
|
||
sdkInst := sdk.New("pluginmgr", sdk.SDKConfig{
|
||
Settings: &pmSettings{},
|
||
EventBus: bus,
|
||
PluginMgr: fm,
|
||
})
|
||
|
||
p := &Plugin{pluginDir: dir, sdk: sdkInst}
|
||
|
||
// 1. 首次安装 v1.0.0
|
||
r1, _ := p.installFromData(buildHmap(t, "demo", "1.0.0"), false)
|
||
m1 := r1.(map[string]interface{})
|
||
if m1["status"] != "installed" {
|
||
t.Fatalf("install failed: %v", m1)
|
||
}
|
||
if _, err := os.Stat(filepath.Join(dir, "demo", "plugin.json")); err != nil {
|
||
t.Fatalf("installed dir missing: %v", err)
|
||
}
|
||
|
||
// 2. 不带 overwrite 重装 → 报 already exists + remove_first hint
|
||
r2, _ := p.installFromData(buildHmap(t, "demo", "1.0.0"), false)
|
||
m2 := r2.(map[string]interface{})
|
||
if m2["error"] != "plugin already exists" || m2["hint"] == "" {
|
||
t.Fatalf("expected already-exists with hint, got %v", m2)
|
||
}
|
||
if m2["current"] != "1.0.0" {
|
||
t.Fatalf("current version not reported: %v", m2)
|
||
}
|
||
|
||
// 3. overwrite 升级 v1.0.0 → v2.0.0
|
||
r3, _ := p.installFromData(buildHmap(t, "demo", "2.0.0"), true)
|
||
m3 := r3.(map[string]interface{})
|
||
if m3["status"] != "installed" || m3["action"] != "upgraded" {
|
||
t.Fatalf("upgrade failed: %v", m3)
|
||
}
|
||
if m3["previous_version"] != "1.0.0" {
|
||
t.Fatalf("previous_version = %v", m3["previous_version"])
|
||
}
|
||
if m3["config_kept"] != true {
|
||
t.Fatalf("config_kept should be true: %v", m3)
|
||
}
|
||
// StopAndUnload 应被调用且不触发 RemovePlugin(不删配置)
|
||
fm.mu.Lock()
|
||
calls := append([]string{}, fm.stopAndUnloads...)
|
||
fm.mu.Unlock()
|
||
if len(calls) != 1 || calls[0] != "demo" {
|
||
t.Fatalf("StopAndUnload not called once with demo: %v", calls)
|
||
}
|
||
// 新二进制写入
|
||
binData, err := os.ReadFile(filepath.Join(dir, "demo", "plugin.bin"))
|
||
if err != nil {
|
||
t.Fatalf("read new bin: %v", err)
|
||
}
|
||
if string(binData) != "binary-demo-2.0.0" {
|
||
t.Fatalf("bin not overwritten: %q", string(binData))
|
||
}
|
||
|
||
// 4. 降级 v2.0.0 → v1.5.0
|
||
r4, _ := p.installFromData(buildHmap(t, "demo", "1.5.0"), true)
|
||
m4 := r4.(map[string]interface{})
|
||
if m4["action"] != "downgraded" {
|
||
t.Fatalf("downgrade action = %v", m4)
|
||
}
|
||
}
|
||
|
||
func TestExtractFailureRollsBack(t *testing.T) {
|
||
dir := t.TempDir()
|
||
fm := &fakePluginMgr{}
|
||
bus := events.NewBus()
|
||
sdkInst := sdk.New("pluginmgr", sdk.SDKConfig{
|
||
Settings: &pmSettings{},
|
||
EventBus: bus,
|
||
PluginMgr: fm,
|
||
})
|
||
p := &Plugin{pluginDir: dir, sdk: sdkInst}
|
||
|
||
// 先装 v1.0.0
|
||
if r, _ := p.installFromData(buildHmap(t, "rollback", "1.0.0"), false); r.(map[string]interface{})["status"] != "installed" {
|
||
t.Fatal("install failed")
|
||
}
|
||
|
||
// 构造损坏包:zip 但缺 plugin.json(extractPackage 会失败)
|
||
var buf bytes.Buffer
|
||
zw := zip.NewWriter(&buf)
|
||
f, _ := zw.Create("plugin.bin")
|
||
f.Write([]byte("corrupt"))
|
||
zw.Close()
|
||
|
||
// 畸形包在 validatePackage 层就拒绝,未达 extract——模拟 extract 失败:
|
||
// 直接注入非法平台文件触发 extractPackage 错误
|
||
bad := buildHmap(t, "rollback", "9.9.9")
|
||
// 篡改使 extract 失败:附加一个越界路径
|
||
var rb bytes.Buffer
|
||
zw2 := zip.NewWriter(&rb)
|
||
f2, _ := zw2.Create("../../evil")
|
||
f2.Write([]byte("x"))
|
||
mf, _ := zw2.Create("plugin.json")
|
||
mData, _ := json.Marshal(map[string]interface{}{"name": "rollback", "version": "9.9.9", "entry": "plugin.bin"})
|
||
mf.Write(mData)
|
||
zw2.Close()
|
||
bad = rb.Bytes()
|
||
|
||
r, _ := p.installFromData(bad, true)
|
||
m := r.(map[string]interface{})
|
||
if m["error"] == nil {
|
||
t.Fatalf("expected error for corrupt package, got %v", m)
|
||
}
|
||
if m["rollback"] != nil {
|
||
t.Fatalf("rollback itself failed: %v", m)
|
||
}
|
||
// 旧版应被恢复
|
||
mfest, err := plugin.ReadManifest(filepath.Join(dir, "rollback"))
|
||
if err != nil || mfest.Version != "1.0.0" {
|
||
t.Fatalf("old version not restored: %v / %v", mfest, err)
|
||
}
|
||
} |