mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-31 22:37:25 +00:00
feat(commondev): 主管式多仓库开发流水线 + sidecar 后端抽象（pi/zcode） (#3)
* feat(commondev): 主管式多仓库开发流水线 + sidecar 后端抽象（pi/zcode）
## 是什么
agent 统筹开发流程的插件：登记项目 → 开工程线（每条线一个隔离工作目录 +
一个 sidecar 子进程 + 一对通道）→ 投递任务 → 同会话续投 → 评审/合入。
38 个工具：project_*/branch_*/workdir_*/job_*/review_*/test_*/
endpoint_*/agent_*/pi_*/conflict_check。
## sidecar 后端抽象（本轮核心）
传输层（local/ssh）与后端（pi/zcode/自定义）**正交**，四个自由组合：
driver.json 描述一个后端：script / cliPath / env / args / llmConfig
三级查找：插件数据目录 → **随包 rawfile** → 内置 pi 描述
占位符：{workdir} {dataDir} {pluginDir} {rawfile} {sessionId}
★ 内置 pi 回退**与默认后端解耦**（2026-10-17 修）：原实现写
`if cli == defaultAgentCLI { return builtinPiDriver() }`，把"给谁兜底"
和"默认选谁"耦合到同一常量 —— 一旦有人改默认，pi 当场失去兜底，
显式 cli="pi" 开始报「驱动不存在」。现在判断字面 "pi"。
默认后端保持 **pi**（我们本地主用）；交付方用 zcode 走两种局部开关：
· 单线：commondev_branch_open(cli="zcode")
· 按机器：commondev_endpoint_set(host=..., cli="zcode")
## zcode 接入（三条真机判据，全部要求真改工程文件）
· TestZcodeFullPipeline（29-34s）：随包 driver + 真实 ZCode CLI
· TestZcodeOverSSH（39s）：真 ssh + scp，远端 node 跑 zcode
· TestZcodeOverSSHWithPerHostEndpoints（68s）：两个 host 别名配不同
cli_path，走端点表而不是全局 settings
★ 会话库必须隔离到工作区（sidecar.mjs 的 ensureWorkspaceSessionStore）：
实测 ZCode 的会话库路径**硬编码 homedir()**，`ZCODE_DATA_BASE_DIR` 对它
完全无效（26 个会话全落全局库）。但 `<workdir>/.zcode/config.json` 的
`storage.sessionDbPath` **确实生效**。所以启动前写一份工作区配置，
一举解决：多线不共用历史 / 不污染全局 ~/.zcode / 删线不留孤儿会话。
只在不存在时写 —— 用户手工放的要尊重。
## 其他
· rawfile：项目根 rawfile/ 默认全收，解到 <插件目录>/rawfile/，绝对路径拒绝
· 凭证：命名引用 + ${ENV_VAR}，独立 0600 文件，绝不进 config.db(0644)
· secretshell：给不受信 agent 用的安全 shell（ackey + safeshell）
· 冲突检查 / 评审判据 / 镜像 / 每条线独立 workdir（hash 命名，合并后删除）
判据 30+ 条，含 4 条「判据本身的判据」（防止判据假绿）。
* fix(sdk): 协议通道纪律 + hmapdev 模板升级 + 示例插件 stdout 污染
## 核心缺陷：插件往 stdout 打日志 = 污染 JSON-RPC 协议通道
子进程插件与内核用 stdout 传 NDJSON 帧，stderr 才是日志通道。
脚手架模板（及 4 个示例插件）用 `fmt.Printf` 打日志 ⇒ 内核收到非 JSON 文本：
[proc] weather 收到非法 JSON 帧（21 字节）: invalid character 'i'
**生产实测 1038 条**（huawei_smarthome 720 / weather 113 / rss 103 / calendar 102）。
后果不只是日志噪音：那一行日志被**丢弃**，插件看起来"没启动"。
修法：
- hmapdev 模板 `fmt.Printf` → `log.Printf`（9 处）
- 示例插件 4 个 14 处：ai_image(2) calendar(5) rss(4) weather(3)
+ 补 "log" import
- 内核侧（主仓）同步让报错可定位：内容摘要 + 可能原因 + 修法
判别法：`package main` = 子进程（协议通道，禁用 stdout 打日志）；
普通库包 = 进程内插件（编译进内核，写真实终端，**不是**缺陷）——
`internal/plugins/cli` 的 `fmt.Println` 属后者。
## hmapdev
- `cmd_build.go` +136：平台产物精确匹配（`--target` 是**append** 语义，
原脚本 `ls dist/*.hmap | head -1` 会按字典序抓到 amd64，
**导致 arm64 包里装的是 x86-64 二进制**，且退出码 0、校验和通过）
- `cmd_init.go` +46：脚手架 stdio 纪律
- `templates/proc_main.go.tmpl`：补齐 mgrStop/mgrStart/mgrIsRuntimeStopped
三态能力（插件管理器运行态停启）
- `templates/plg.json.tmpl` 删除（合并进 cmd_init）
## 判据
- `scaffold_stdout_test.go`（3 条）：扫模板生成的代码不得写 stdout。
★ 判据自身先假红过一次：**模板的注释里就写了 `fmt.Printf`** ⇒
必须 `stripTemplateComments()` 之后才判
- `example_stdout_test.go`（2 条）：扫全部 20 个子进程示例插件，
报错给**文件:行号**；变异咬住并给出准确行号
- `package_examples_test.go`（2 条）：**执行真实打包脚本**
（第一版测的是 hmapdev 而不是脚本 ⇒ 变异不咬）
- `cmd_build` / `cmd_init` 新判据
## 其他
- sdk/settings.go +15（三态能力透传）
- `docs/versions.md` +§示例插件协议通道纪律（含生产 1038 条实测表格）
- `skills/homeagent-plugin-dev/SKILL.md` +§协议通道纪律（正误代码对比）
* fix(examples): 恢复 go.mod 相对路径 + 移除 plg.json 的 sdk 固定（修 CI 红）
CI 上 `Examples (linux/amd64)` 与 `(darwin/arm64)` 双红，只有两个失败：
✗ commondev 构建失败
✗ editdoc 构建失败
error: 项目声明 sdk=1.4.0，但本地 SDK 存储里没有这个版本
其余 20 个示例全部成功 —— 说明不是通用问题，而是这两个被改坏了。
## 根因（两个叠加）
**① go.mod 被本机绝对路径污染**
我在上一个提交里用 `git add -A`，把本机 `go build` **自动改写**过的
go.mod 一并提交了：
require github.com/JianFeeeee/homeagentsdk v1.4.0
replace github.com/JianFeeeee/homeagentsdk => /root/.homeagent/hmapdev/sdk/v1.4.0
基线（origin/main）是：
require github.com/JianFeeeee/homeagentsdk v0.0.0
replace github.com/JianFeeeee/homeagentsdk => ../../
本机那个目录真的存在 ⇒ 本地全绿；CI 没有 ⇒ 必红。
**② plg.json 声明了 `"sdk": "1.4.0"`**
一声明版本，hmapdev 就去**本地 SDK store** 找它，找不到直接拒绝构建。
全仓 20+ 示例**都不声明**，只有我改过的这两个声明了。
示例的正确依赖表达是 go.mod 的 `v0.0.0` + `replace ../../`。
## 修法
两个文件都恢复到与其余示例一致的写法。
## 判据（3 条，都是新加的）
· `TestExampleGoModHasNoAbsoluteReplace`：任何示例 go.mod 不得含
`/root/`、`/home/`、`/Users/`、`C:\`
· `TestExampleGoModUsesRelativeSDKReplace`：replace 必须是相对路径 `../../`
· `TestExamplePlgJsonDoesNotPinSDKVersion`：plg.json 不得声明 sdk
变异 2/2 咬住（重新引入绝对路径 / 重新声明 sdk，都准确报出文件路径）。
## 本地验证（模拟 CI 干净环境）
用干净 HOME 跑 `package/build-examples.sh`：
· 修复前：成功 18 / 失败 4（commondev, editdoc, browser, rss）
· 修复后：成功 20 / 失败 2（browser, rss —— **本机代理不通**，
`proxy.golang.org` 超时；用本地 modcache 验证这两个可正常构建）
即 22/22 源码都能构建，CI 有网络不受影响。
## 教训
`git add -A` 会把「构建工具自动改写的文件」一起提交。
提交前必须 `git status` 逐个看，尤其 go.mod / go.sum。
---------
Co-authored-by: JianFeeeee <JianFeeeee@users.noreply.gitcode.com>
This commit is contained in:
JianFeeeee
GitHub
178
example/editdoc/plugin_test.go
Normal file
178
example/editdoc/plugin_test.go
Normal file
@ -0,0 +1,178 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/JianFeeeee/homeagentsdk/sdk"
|
||||
)
|
||||
|
||||
// fakeSettings 是 SettingsAPI 的最小实现，只为把 resolveScript 的 DataDir 分支跑通。
|
||||
// 其余方法测试用不到，给个安全默认值即可。
|
||||
type fakeSettings struct {
|
||||
dataDir string
|
||||
defs []*sdk.ConfigDef
|
||||
}
|
||||
|
||||
func (f *fakeSettings) Get(string) (interface{}, error) { return nil, nil }
|
||||
func (f *fakeSettings) Set(string, interface{}) error { return nil }
|
||||
func (f *fakeSettings) SetSecret(string, interface{}) error { return nil }
|
||||
func (f *fakeSettings) GetSecret(string) (string, error) { return "", nil }
|
||||
func (f *fakeSettings) List(string) ([]string, error) { return nil, nil }
|
||||
func (f *fakeSettings) GetCore(string) (interface{}, error) { return nil, nil }
|
||||
func (f *fakeSettings) SetCore(string, interface{}) error { return nil }
|
||||
func (f *fakeSettings) ListCore(string) ([]string, error) { return nil, nil }
|
||||
func (f *fakeSettings) DataDir() string { return f.dataDir }
|
||||
func (f *fakeSettings) GetPlugin(string, string) (interface{}, error) { return nil, nil }
|
||||
func (f *fakeSettings) SetPlugin(string, string, interface{}) error { return nil }
|
||||
func (f *fakeSettings) ListPlugin(string, string) ([]string, error) { return nil, nil }
|
||||
func (f *fakeSettings) RegisterDef(def sdk.ConfigDef) { f.defs = append(f.defs, &def) }
|
||||
func (f *fakeSettings) Defs(string) []*sdk.ConfigDef { return f.defs }
|
||||
func (f *fakeSettings) Dump() map[string]interface{} { return nil }
|
||||
func (f *fakeSettings) Plugins() []string { return nil }
|
||||
|
||||
// newTestPlugin 造一个带可用 DataDir 的 Plugin（sdk 走 sdk.New，只注入 SettingsAPI）。
|
||||
func newTestPlugin(t *testing.T, scriptPath string) *Plugin {
|
||||
t.Helper()
|
||||
sett := &fakeSettings{dataDir: t.TempDir()}
|
||||
s := sdk.New("editdoc", sett, nil, nil, nil, nil)
|
||||
return &Plugin{
|
||||
name: "editdoc",
|
||||
sdk: s,
|
||||
scriptPath: scriptPath,
|
||||
venvPython: "/usr/local/bin/python3",
|
||||
timeoutSec: 60,
|
||||
}
|
||||
}
|
||||
|
||||
// 内嵌脚本必须自带 v2 协议标记，否则防呆会把自己的脚本也挡掉。
|
||||
func TestEmbeddedScriptHasProtocolMarker(t *testing.T) {
|
||||
if !containsMarker(embeddedScript) {
|
||||
t.Fatalf("内嵌脚本缺少协议标记 %q —— 防呆会把内嵌脚本自己判为旧版", scriptProtocolMarker)
|
||||
}
|
||||
// 标记必须与 embed/edit_doc.py 顶部一致（防手改两处不同步）
|
||||
t.Logf("协议标记=%q 内嵌脚本指纹=%s", scriptProtocolMarker, scriptStamp())
|
||||
}
|
||||
|
||||
// 业务脚本只能有**一份**：embed/edit_doc.py。
|
||||
//
|
||||
// 为何钉这一条（2026-10-13 迁入仓库时实测）：原工作目录里同时存在
|
||||
// edit_doc.py 与 embed/edit_doc.py —— 两份逐字节相同的副本，而只有
|
||||
// embed/ 那份被 //go:embed 引用。同名双副本是典型的漂移源：
|
||||
// 改了顶层那份（看着像“主文件”）而真正生效的是 embed/ 里的，
|
||||
// 或反过来；两种都不会报错，只会让行为与源码对不上。
|
||||
func TestOnlyOneBusinessScript(t *testing.T) {
|
||||
if _, err := os.Stat("edit_doc.py"); err == nil {
|
||||
t.Error("存在顶层 edit_doc.py：业务脚本只应有 embed/edit_doc.py 一份（顶部副本未被 embed，改了不生效）")
|
||||
}
|
||||
if _, err := os.Stat(filepath.Join("embed", "edit_doc.py")); err != nil {
|
||||
t.Fatalf("缺少 embed/edit_doc.py: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// script_path 指向 v1 脚本（无标记）→ 必须忽略它、回退内嵌脚本，
|
||||
// 并记录 ignoredScriptPath。这是防呆的核心契约。
|
||||
func TestResolveScriptIgnoresV1Script(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
v1 := filepath.Join(dir, "edit_doc_v1.py")
|
||||
// v1 脚本的真实特征：argv 约定 <file> <op> <json>，且没有 v2 标记
|
||||
if err := os.WriteFile(v1, []byte(
|
||||
"import sys\npath = sys.argv[1]\noperation = sys.argv[2]\n"), 0644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
p := newTestPlugin(t, v1)
|
||||
got, err := p.resolveScript()
|
||||
if err != nil {
|
||||
t.Fatalf("应回退到内嵌脚本，却报错: %v", err)
|
||||
}
|
||||
if got == v1 {
|
||||
t.Fatal("v1 脚本被采用了 —— 防呆失效，6 个工具会被打挂")
|
||||
}
|
||||
if filepath.Base(got) != "edit_doc.py" {
|
||||
t.Fatalf("应回退到 runtime/edit_doc.py，实际: %s", got)
|
||||
}
|
||||
if p.ignoredScriptPath != v1 {
|
||||
t.Fatalf("ignoredScriptPath 未记录，实际: %q", p.ignoredScriptPath)
|
||||
}
|
||||
// 回退出来的脚本必须是内嵌那份（字节一致）
|
||||
released, err := os.ReadFile(got)
|
||||
if err != nil {
|
||||
t.Fatalf("内嵌脚本未落盘: %v", err)
|
||||
}
|
||||
if string(released) != string(embeddedScript) {
|
||||
t.Fatal("落盘的脚本与内嵌脚本字节不一致")
|
||||
}
|
||||
t.Logf("v1 被正确忽略，回退到 %s", got)
|
||||
}
|
||||
|
||||
// script_path 指向含标记的 v2 脚本 → 必须采用它，且不记 ignoredScriptPath。
|
||||
func TestResolveScriptAcceptsV2Script(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
v2 := filepath.Join(dir, "edit_doc_v2.py")
|
||||
if err := os.WriteFile(v2, []byte(
|
||||
"#!/usr/bin/env python3\n"+scriptProtocolMarker+"\n"), 0644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
p := newTestPlugin(t, v2)
|
||||
got, err := p.resolveScript()
|
||||
if err != nil {
|
||||
t.Fatalf("应直接采用 v2 脚本，却报错: %v", err)
|
||||
}
|
||||
if got != v2 {
|
||||
t.Fatalf("v2 脚本未被采用，实际用了: %s", got)
|
||||
}
|
||||
if p.ignoredScriptPath != "" {
|
||||
t.Fatalf("v2 脚本不应被标记忽略: %q", p.ignoredScriptPath)
|
||||
}
|
||||
}
|
||||
|
||||
// script_path 为空 → 走内嵌脚本释放，且指纹命中第二次不再重复写。
|
||||
func TestResolveScriptFallsBackToEmbedded(t *testing.T) {
|
||||
p := newTestPlugin(t, "")
|
||||
got, err := p.resolveScript()
|
||||
if err != nil {
|
||||
t.Fatalf("空 script_path 应回退内嵌脚本: %v", err)
|
||||
}
|
||||
if p.ignoredScriptPath != "" {
|
||||
t.Fatalf("空配置不该有 ignoredScriptPath: %q", p.ignoredScriptPath)
|
||||
}
|
||||
// 第二次调用应复用（指纹 + 文件都在），路径一致
|
||||
got2, err := p.resolveScript()
|
||||
if err != nil || got2 != got {
|
||||
t.Fatalf("第二次解析不稳定: %s vs %s (%v)", got, got2, err)
|
||||
}
|
||||
// .stamp 指纹应有内容
|
||||
stamp, err := os.ReadFile(filepath.Join(filepath.Dir(got), ".stamp"))
|
||||
if err != nil || string(stamp) != scriptStamp() {
|
||||
t.Fatalf("指纹文件异常: %q %v", stamp, err)
|
||||
}
|
||||
}
|
||||
|
||||
// 指向不存在的路径 → 不该报错，应静默回退内嵌脚本。
|
||||
func TestResolveScriptMissingPathFallsBack(t *testing.T) {
|
||||
p := newTestPlugin(t, filepath.Join(t.TempDir(), "not-there.py"))
|
||||
got, err := p.resolveScript()
|
||||
if err != nil {
|
||||
t.Fatalf("路径不存在应回退内嵌脚本: %v", err)
|
||||
}
|
||||
if p.ignoredScriptPath != "" {
|
||||
t.Fatalf("不存在的路径不该记为 ignored: %q", p.ignoredScriptPath)
|
||||
}
|
||||
if filepath.Base(got) != "edit_doc.py" {
|
||||
t.Fatalf("应回退到 runtime/edit_doc.py，实际: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
// containsMarker 与 resolveScript 内部用的是同一判据，供测试复用。
|
||||
func containsMarker(b []byte) bool {
|
||||
m := []byte(scriptProtocolMarker)
|
||||
for i := 0; i+len(m) <= len(b); i++ {
|
||||
if string(b[i:i+len(m)]) == string(m) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
Reference in New Issue
Block a user