mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-20 00:48:12 +00:00
fix(hmapdev): 工具链能报出版本(此前 -ldflags -X meta.Version 静默无效)
两个缺口叠加:既没有 `version` 子命令,构建时的 `-ldflags "-X gitcode.com/JianFeeeee/homeagent-sdk/meta.Version=…"` 也因为 **meta 包根本没被工具链引用**而完全不生效(链接器不会保留未被引用的符号, rodata 里连那个字符串都没有)——于是「手里是哪一版 hmapdev」无从判断, 而插件产物与内核是协议绑定的,这恰恰是最需要判断的一件事(v0.8.0 SDK 陈旧目录 导致模板编译失败那次就是靠猜)。 - main.go 引用 meta 包并新增 `version`(以及 `-v/--version`)子命令, 输出工具链版本 / SDK 模块 / 构建提交 / 构建时间 / 构建用 Go / 可执行文件路径; - 未注入(源码默认值)时也照常报,unknown 字段不打印(避免噪声); - usage 里补上 `hmapdev version`; - 加测试钉住两件事:注入值必须出现在输出里(-X 一旦失效立刻变红)、 未注入时也要能报出源码默认版本。 验证:`go build` 默认输出 1.3.0(主干默认值);`-X …meta.Version=1.2.1 -X …meta.Commit=abc1234` 后输出 1.2.1 + 提交号,且二进制内精确匹配到该串 (说明注入真的进了镜像);`go test -run PrintVersion` 2/2 PASS。
This commit is contained in:
@ -2,7 +2,11 @@ package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"runtime"
|
||||
|
||||
"gitcode.com/JianFeeeee/homeagent-sdk/meta"
|
||||
)
|
||||
|
||||
func main() {
|
||||
@ -21,15 +25,42 @@ func main() {
|
||||
cmdDebug(os.Args[2:])
|
||||
case "sdk":
|
||||
cmdSDK(os.Args[2:])
|
||||
case "version", "-v", "--version":
|
||||
printVersion()
|
||||
default:
|
||||
help()
|
||||
}
|
||||
}
|
||||
|
||||
// printVersion 输出工具链自身的版本身份。
|
||||
//
|
||||
// 为何必须有:此前工具链不报版本,而插件产物与内核是**协议绑定**的——
|
||||
// 手里是哪一版工具链、能不能配当前内核,只能靠翻文件名或猜。
|
||||
// 版本号来自 meta.Version(与 SDK 发布同源,由 -ldflags -X 注入);
|
||||
// lnflags 未注入时它是源码里的默认值,此时提示它可能是开发构建。
|
||||
func printVersion() {
|
||||
printVersionTo(os.Stdout)
|
||||
}
|
||||
|
||||
// printVersionTo 把版本身份写到 w(抽出来是为了能被测试钉住)。
|
||||
func printVersionTo(w io.Writer) {
|
||||
fmt.Fprintf(w, "hmapdev %s\n", meta.Version)
|
||||
fmt.Fprintf(w, " SDK 模块: %s\n", "gitcode.com/JianFeeeee/homeagent-sdk")
|
||||
if meta.Commit != "" && meta.Commit != "unknown" {
|
||||
fmt.Fprintf(w, " 构建提交: %s\n", meta.Commit)
|
||||
}
|
||||
if meta.BuildTime != "" && meta.BuildTime != "unknown" {
|
||||
fmt.Fprintf(w, " 构建时间: %s\n", meta.BuildTime)
|
||||
}
|
||||
fmt.Fprintf(w, " 构建用 Go: %s\n", runtime.Version())
|
||||
fmt.Fprintf(w, " 可执行文件: %s\n", os.Args[0])
|
||||
}
|
||||
|
||||
func help() {
|
||||
fmt.Print(`HomeAgent Plugin Dev Tool
|
||||
|
||||
Usage:
|
||||
hmapdev version Print toolchain version
|
||||
hmapdev init <name> Scaffold a new plugin project
|
||||
hmapdev init <name> --lua Create Lua plugin
|
||||
hmapdev init <name> --type remotedevice
|
||||
|
||||
57
tools/hmapdev/main_version_test.go
Normal file
57
tools/hmapdev/main_version_test.go
Normal file
@ -0,0 +1,57 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"gitcode.com/JianFeeeee/homeagent-sdk/meta"
|
||||
)
|
||||
|
||||
// 工具链必须能报出自己的版本。
|
||||
//
|
||||
// 为什么值得钉住:插件产物与内核是协议绑定的,「手里是哪一版工具链」直接决定
|
||||
// 产物能不能建链;此前既没有 version 子命令,`-ldflags -X meta.Version` 也因为
|
||||
// meta 包没被链接而**静默无效**(表现为报不出任何版本)。
|
||||
func TestPrintVersionReportsInjectedVersion(t *testing.T) {
|
||||
origVersion, origCommit := meta.Version, meta.Commit
|
||||
defer func() { meta.Version, meta.Commit = origVersion, origCommit }()
|
||||
|
||||
// 模拟 -ldflags 注入后的取值
|
||||
meta.Version = "9.9.9"
|
||||
meta.Commit = "deadbee"
|
||||
|
||||
var buf bytes.Buffer
|
||||
printVersionTo(&buf)
|
||||
out := buf.String()
|
||||
|
||||
if !strings.Contains(out, "9.9.9") {
|
||||
t.Fatalf("版本号未出现在输出里(-X 注入会失效):\n%s", out)
|
||||
}
|
||||
if !strings.Contains(out, "hmapdev") {
|
||||
t.Fatalf("输出里没有工具名:\n%s", out)
|
||||
}
|
||||
if !strings.Contains(out, "deadbee") {
|
||||
t.Fatalf("提交号未出现在输出里:\n%s", out)
|
||||
}
|
||||
if !strings.Contains(out, "HomeAgent") && !strings.Contains(out, "homeagent-sdk") {
|
||||
t.Fatalf("输出里没有 SDK 模块标识:\n%s", out)
|
||||
}
|
||||
}
|
||||
|
||||
// 未注入时(源码默认值)也必须能报——否则开发构建和发版构建长得一样。
|
||||
func TestPrintVersionWorksWithoutInjection(t *testing.T) {
|
||||
origCommit, origBuildTime := meta.Commit, meta.BuildTime
|
||||
defer func() { meta.Commit, meta.BuildTime = origCommit, origBuildTime }()
|
||||
meta.Commit, meta.BuildTime = "unknown", "unknown"
|
||||
|
||||
var buf bytes.Buffer
|
||||
printVersionTo(&buf)
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, meta.Version) {
|
||||
t.Fatalf("未注入时应报出源码默认版本 %q:\n%s", meta.Version, out)
|
||||
}
|
||||
if strings.Contains(out, "unknown") {
|
||||
t.Fatalf("unknown 字段不应出现在输出里(噪声):\n%s", out)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user