mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-31 14:27:30 +00:00
* 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>
339 lines
12 KiB
Go
339 lines
12 KiB
Go
package main
|
||
|
||
// 对齐审计:**逐个调用**已注册工具,检查它们真的能工作。
|
||
//
|
||
// 为何要这个:注册了名字 ≠ 能用。上一轮补了工具,但「能注册」只证明
|
||
// 编译通过。本文件对每个工具做一次最小真实调用,把「写了但没接上」
|
||
// (空返回、nil handler、路径写死错、参数名不匹配)暴露出来。
|
||
//
|
||
// 判定原则:
|
||
// - 返回 error ≠ 失败(很多工具对缺参数就是返回 error,那是正确的响亮行为)
|
||
// - 真正的失败是:panic、handler 为 nil、或**参数齐全却依然拒绝**
|
||
// - 这里的目标是发现"连正确调用都走不通"的工具
|
||
|
||
import (
|
||
"os"
|
||
"path/filepath"
|
||
"strings"
|
||
"testing"
|
||
)
|
||
|
||
// listRegisteredTools 从 plugin.go 里抽出注册的工具名。
|
||
// 用源码而非运行期 sdk,因为 SDK 的 mock 不暴露注册表。
|
||
func listRegisteredTools(t *testing.T) []string {
|
||
t.Helper()
|
||
b, err := os.ReadFile("plugin.go")
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
var out []string
|
||
for _, line := range strings.Split(string(b), "\n") {
|
||
line = strings.TrimSpace(line)
|
||
const p = `p.sdk.RegisterTool("`
|
||
if i := strings.Index(line, p); i >= 0 {
|
||
rest := line[i+len(p):]
|
||
if j := strings.Index(rest, `"`); j > 0 {
|
||
out = append(out, rest[:j])
|
||
}
|
||
}
|
||
}
|
||
return out
|
||
}
|
||
|
||
// handlerFor 通过名字映射到实际 handler 函数。
|
||
//
|
||
// ★ 这里刻意**手写映射**而不是反射:如果新增了工具却忘了在这里登记,
|
||
// 下面的覆盖率判据会报出来 —— 这正好是"新工具没接 handler"的探测。
|
||
func handlerFor(p *Plugin, name string) func(map[string]interface{}) (interface{}, error) {
|
||
switch name {
|
||
case "commondev_project_add", "commondev_project_open":
|
||
return p.handleProjectAdd
|
||
case "commondev_project_list":
|
||
return p.handleProjectList
|
||
case "commondev_branch_open":
|
||
return p.handleBranchOpen
|
||
case "commondev_branch_status":
|
||
return p.handleBranchStatus
|
||
case "commondev_branch_close":
|
||
return p.handleBranchClose
|
||
case "commondev_job_status":
|
||
return p.handleJobStatus
|
||
case "commondev_agent_up":
|
||
return p.handleAgentUp
|
||
case "commondev_agent_state":
|
||
return p.handleAgentState
|
||
case "commondev_agent_down":
|
||
return p.handleAgentDown
|
||
case "commondev_workdir_prepare":
|
||
return p.handleWorkdirPrepare
|
||
case "commondev_workdir_clean":
|
||
return p.handleWorkdirClean
|
||
case "commondev_test_define":
|
||
return p.handleTestDefine
|
||
case "commondev_test_list":
|
||
return p.handleTestList
|
||
case "commondev_test_run":
|
||
return p.handleTestRun
|
||
case "commondev_test_mutate":
|
||
return p.handleTestMutate
|
||
case "commondev_review_submit":
|
||
return p.handleReviewSubmit
|
||
case "commondev_review_result":
|
||
return p.handleReviewResult
|
||
case "commondev_conflict_check":
|
||
return p.handleConflictCheck
|
||
case "commondev_parallel_status":
|
||
return p.handleParallelStatus
|
||
case "commondev_pi_config_get":
|
||
return p.handlePiConfigGet
|
||
case "commondev_pi_config_set":
|
||
return p.handlePiConfigSet
|
||
case "commondev_pi_source_add":
|
||
return p.handlePiSourceAdd
|
||
case "commondev_pi_source_list":
|
||
return p.handlePiSourceList
|
||
case "commondev_pi_source_remove":
|
||
return p.handlePiSourceRemove
|
||
case "commondev_pi_source_default":
|
||
return p.handlePiSourceDefault
|
||
case "commondev_pi_source_import":
|
||
return p.handlePiSourceImport
|
||
case "commondev_pi_package_install", "commondev_pi_plugin_install":
|
||
return p.handlePiPackageInstall
|
||
case "commondev_pi_plugin_list":
|
||
return p.handlePiPluginList
|
||
case "commondev_pi_plugin_remove":
|
||
return p.handlePiPluginRemove
|
||
case "commondev_pi_plugin_update":
|
||
return p.handlePiPluginUpdate
|
||
case "commondev_pi_mcp_list":
|
||
return p.handlePiMCPList
|
||
case "commondev_pi_mcp_add":
|
||
return p.handlePiMCPAdd
|
||
case "commondev_pi_mcp_remove":
|
||
return p.handlePiMCPRemove
|
||
case "enc_store":
|
||
return p.handleEncStore
|
||
case "enc_list":
|
||
return p.handleEncList
|
||
case "enc_show":
|
||
return p.handleEncShow
|
||
case "enc_rm":
|
||
return p.handleEncRm
|
||
case "enc_shell":
|
||
return p.handleEncryptedShell
|
||
case "commondev_endpoint_set":
|
||
return p.handleEndpointSet
|
||
case "commondev_endpoint_list":
|
||
return p.handleEndpointList
|
||
case "commondev_endpoint_remove":
|
||
return p.handleEndpointRemove
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// ★★ 判据:**每个注册的工具都必须有对应 handler**。
|
||
//
|
||
// 这条能抓出「加了 RegisterTool 却指向不存在的 handler」或
|
||
// 「加了工具但这里没同步登记」(后者是需要人补映射,属于审计信号)。
|
||
func TestEveryRegisteredToolHasHandler(t *testing.T) {
|
||
p := newAuditPlugin(t)
|
||
tools := listRegisteredTools(t)
|
||
if len(tools) < 40 {
|
||
t.Fatalf("注册工具数异常偏少(%d),插件文件可能没被正确解析", len(tools))
|
||
}
|
||
var missing []string
|
||
for _, name := range tools {
|
||
if handlerFor(p, name) == nil {
|
||
missing = append(missing, name)
|
||
}
|
||
}
|
||
if len(missing) > 0 {
|
||
t.Fatalf("★ 这些工具没有可用 handler(注册了但没接上): %v", missing)
|
||
}
|
||
t.Logf("已注册 %d 个工具,全部有 handler", len(tools))
|
||
}
|
||
|
||
// ★★ 判据:**无参数调用不得 panic**。
|
||
//
|
||
// 工具会遇到模型乱传参数(缺字段、类型错)。正确行为是返回 error,
|
||
// 不是崩掉整个插件进程。
|
||
func TestNoToolPanicsOnEmptyArgs(t *testing.T) {
|
||
p := newAuditPlugin(t)
|
||
for _, name := range listRegisteredTools(t) {
|
||
h := handlerFor(p, name)
|
||
if h == nil {
|
||
continue
|
||
}
|
||
func() {
|
||
defer func() {
|
||
if r := recover(); r != nil {
|
||
t.Errorf("★ %s 空参数 panic: %v", name, r)
|
||
}
|
||
}()
|
||
// 空 map + nil map 都要试:模型可能传 null
|
||
h(map[string]interface{}{})
|
||
h(nil)
|
||
}()
|
||
}
|
||
}
|
||
|
||
// ★★★ 判据:**本轮补的工具必须真的能完成一次正常调用**。
|
||
//
|
||
// 与前两条不同:这里给足参数,检查业务是否真走通。
|
||
// 「注册 + 不 panic」还不够 —— 一条写死的错误路径也能满足那两条。
|
||
func TestNewlyAddedToolsActuallyWork(t *testing.T) {
|
||
p := newAuditPlugin(t)
|
||
p.ledger.Projects["proj"] = &Project{
|
||
Name: "proj", RemoteURL: "https://example.invalid/o/r.git", DefaultBranch: "main"}
|
||
dir := t.TempDir()
|
||
p.ledger.Branches["br-1"] = &Branch{
|
||
ID: "br-1", ProjectID: "proj", Name: "feat/x", Workdir: dir, Status: "open"}
|
||
|
||
// ① agent_state 应报出真实状态(此前完全不存在)
|
||
res, err := p.handleAgentState(map[string]interface{}{"branch_id": "br-1"})
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
m := res.(map[string]interface{})
|
||
if m["branch_id"] != "br-1" || m["agent_alive"] != false {
|
||
t.Errorf("agent_state 返回不对: %v", m)
|
||
}
|
||
|
||
// ② agent_down 应成功停掉(无进程时也幂等成功)
|
||
res2, err := p.handleAgentDown(map[string]interface{}{"branch_id": "br-1"})
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
if res2.(map[string]interface{})["status"] != "ok" {
|
||
t.Errorf("agent_down 未成功: %v", res2)
|
||
}
|
||
|
||
// ③ workdir_clean 默认 dry_run,且能识别孤儿
|
||
root := p.programRoot()
|
||
os.MkdirAll(filepath.Join(root, "deadbeef-feat_x"), 0o755)
|
||
res3, err := p.handleWorkdirClean(map[string]interface{}{})
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
m3 := res3.(map[string]interface{})
|
||
if m3["status"] != "dry_run" {
|
||
t.Errorf("workdir_clean 默认应为 dry_run: %v", m3)
|
||
}
|
||
if n, _ := m3["count"].(int); n != 1 {
|
||
t.Errorf("应识别 1 个孤儿目录,实际 %v", m3["orphans"])
|
||
}
|
||
|
||
// ④ pi_config_get 必须能读到结构(即使没有任何 provider)
|
||
res4, err := p.handlePiConfigGet(map[string]interface{}{})
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
if _, ok := res4.(map[string]interface{})["providers"]; !ok {
|
||
t.Errorf("pi_config_get 缺少 providers 字段: %v", res4)
|
||
}
|
||
}
|
||
|
||
// ★★ 判据:**设计文档点名的工具必须真的存在**。
|
||
//
|
||
// 这条把「文档说做了」与「代码里有」绑起来 —— 上一轮就是靠它
|
||
// 发现 pr_open / agent_state 等工具根本不存在。
|
||
//
|
||
// ⚠ 2026-10-15 起:**git 托管平台专有的工具已不在清单里**
|
||
// (account_* / repo_search / pr_* / protect_branch)—— 那些能力进 skill,
|
||
// 由 agent 用 safeshell + curl 完成。
|
||
func TestDesignNamedToolsExist(t *testing.T) {
|
||
tools := listRegisteredTools(t)
|
||
have := map[string]bool{}
|
||
for _, n := range tools {
|
||
have[n] = true
|
||
}
|
||
want := []string{
|
||
"commondev_project_add", "commondev_project_list",
|
||
"commondev_branch_open", "commondev_branch_status", "commondev_branch_close",
|
||
"commondev_workdir_prepare", "commondev_workdir_clean",
|
||
"commondev_agent_up", "commondev_agent_state", "commondev_agent_down",
|
||
"commondev_pi_plugin_install", "commondev_pi_plugin_remove", "commondev_pi_plugin_list",
|
||
"commondev_pi_source_import", "commondev_pi_source_add", "commondev_pi_source_list",
|
||
"commondev_pi_source_default", "commondev_pi_config_get",
|
||
"commondev_test_define", "commondev_test_run", "commondev_test_mutate",
|
||
"commondev_review_submit",
|
||
}
|
||
var missing []string
|
||
for _, w := range want {
|
||
if !have[w] {
|
||
missing = append(missing, w)
|
||
}
|
||
}
|
||
if len(missing) > 0 {
|
||
t.Fatalf("设计点名的工具缺失: %v", missing)
|
||
}
|
||
}
|
||
|
||
// ★ 判据:**git 平台专有的工具已全部移出插件**。
|
||
//
|
||
// 这条钉住 2026-10-15 的架构决定:平台知识进 skill。若有人又把
|
||
// account_* / pr_* / protect_branch 加回插件,这里会报红。
|
||
func TestPlatformToolsAreNotInPlugin(t *testing.T) {
|
||
tools := listRegisteredTools(t)
|
||
have := map[string]bool{}
|
||
for _, n := range tools {
|
||
have[n] = true
|
||
}
|
||
for _, forbidden := range []string{
|
||
"commondev_account_add", "commondev_account_list", "commondev_account_test",
|
||
"commondev_account_remove", "commondev_repo_search",
|
||
"commondev_pr_open", "commondev_pr_status", "commondev_pr_approve",
|
||
"commondev_pr_merge", "commondev_protect_branch",
|
||
} {
|
||
if have[forbidden] {
|
||
t.Errorf("★ %s 属 git 平台专有能力,不应再注册在插件里(应进 skill + safeshell)", forbidden)
|
||
}
|
||
}
|
||
}
|
||
|
||
// ★★ 判据:**平台专有代码不得回到插件里**。
|
||
//
|
||
// 钉住 2026-10-15 的架构决定(用户拍板):git 托管平台的知识进 skill,
|
||
// 插件只保留与平台无关的机制。若有人把 platformSpec / 按平台构造认证头
|
||
// 又加回来,这里会报红。
|
||
//
|
||
// 为什么要用判据而不只是文档:文档说了还会有人(包括将来的我)图省事加回去,
|
||
// 而那种回退在**功能上看起来完全正常** —— 只是把可移植性换成了硬编码。
|
||
func TestNoPlatformSpecificCodeInPlugin(t *testing.T) {
|
||
// 逐文件扫源码(排除测试与注释性提及由人工判断)
|
||
files := []string{"plugin.go", "credentials.go", "pi_tools.go", "criteria.go",
|
||
"encstore.go", "encshell.go", "conflict.go", "workdir.go", "workdir_security.go",
|
||
"util.go", "llmsource.go", "sidecar.go"}
|
||
forbidden := map[string]string{
|
||
"platformSpec(": "按平台构造请求(认证头/端点差异)应进 skill",
|
||
"plaftformSpec": "平台适配结构体",
|
||
"DefaultAPI": "硬编码平台 API 前缀",
|
||
"AuthHeader:": "硬编码平台认证头",
|
||
"RoleExecutor": "平台角色语义",
|
||
"handleAccountAdd": "平台凭据工具",
|
||
"handleRepoSearch": "平台搜索工具",
|
||
"handlePROpen": "平台 PR 工具",
|
||
"handleProtectBranch": "平台分支保护工具",
|
||
}
|
||
for _, f := range files {
|
||
b, err := os.ReadFile(f)
|
||
if err != nil {
|
||
continue
|
||
}
|
||
src := string(b)
|
||
for sym, why := range forbidden {
|
||
// 只认代码出现,不认注释里的解释性提及
|
||
for i, line := range strings.Split(src, "\n") {
|
||
trimmed := strings.TrimSpace(line)
|
||
if strings.HasPrefix(trimmed, "//") {
|
||
continue // 注释里说明"已移出"是允许的
|
||
}
|
||
if strings.Contains(line, sym) {
|
||
t.Errorf("★ %s:%d 含平台专有代码 %q(%s)", f, i+1, sym, why)
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|