05144309c3
解决"开发构建沿用已发布版本号,分不清开发版与正式版": - 新增 `scripts/version.py --identity`:release_version(无基线即空)/ build_kind / commit_sha(完整 40 位)/ display_version / built_at。显示规则:发布 `X.Y.Z`、 开发 `X.Y.Z-dev+g<短SHA>`、无基线 `dev+g<短SHA>`、什么都拿不到 `dev`。 - `build_kind=release` 只认**显式发布上下文**(`BUILD_KIND=release` / `--release`); 声明发布构建却没有已发布版本 ⇒ 拒绝(rc=2)。普通 main 构建永远是 development, **不许只显示上一正式版本号、不许自称正式版**。 - Go 侧 `internal/version` 加 ReleaseVersion/BuildKind/DisplayVersion()/IsRelease()/Info(), 原 Number/CommitSHA/BuildTime 语义不变(向后兼容);契约测试改成:发布构建必须等于 CHANGELOG 顶部、开发构建必须是 dev 形状;`make verify` 的 contracts 项新增 **负例**「自称正式版 ⇒ 必须红」(只有正例的契约会被静默掏空)。 - 构建接线:Makefile/Dockerfile/ci_checks `--internal-build` 统一走 identity; Makefile 的 `make version` 打印身份 JSON;Dockerfile 新增 RELEASE_VERSION/BUILD_KIND。 - `tests-go` 的"按设计跳过"声明补上 `TestDevBuildDoesNotClaimRelease`(它的强制点在 contracts)。 验证:go test 三态实测(未注入 SKIP、开发身份 PASS、自称正式版 FAIL); --internal-build 产出并打印 dev+g<sha>;--internal-identity 契约项 rc=0; make verify 15/15 success;反向夹具 80/0。
101 lines
4.2 KiB
Go
101 lines
4.2 KiB
Go
package version
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"regexp"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
// changelogTopVersion 返回仓库根 CHANGELOG.md 顶部的已发布版本号;还没有正式版本时返回 ""。
|
|
func changelogTopVersion(t *testing.T) string {
|
|
t.Helper()
|
|
path := filepath.Join("..", "..", "CHANGELOG.md")
|
|
raw, err := os.ReadFile(path)
|
|
if err != nil {
|
|
t.Fatalf("读不到 %s:%v(版本号的唯一来源就在这里)", path, err)
|
|
}
|
|
m := regexp.MustCompile(`(?m)^##\s*\[(\d+\.\d+\.\d+)\]`).FindSubmatch(raw)
|
|
if m == nil {
|
|
return ""
|
|
}
|
|
return string(m[1])
|
|
}
|
|
|
|
// 版本契约:注入进二进制的**正式版本基线**,必须等于仓库根 CHANGELOG.md 顶部的已发布版本。
|
|
//
|
|
// 为什么要有这条断言:CHANGELOG.md 是版本号的**唯一来源**,而注入是构建期动作。
|
|
// 两者只要没人对账,就会出现"改了 CHANGELOG 没重新构建"(产物报旧号)或
|
|
// "构建时手填了一个号"(产物报的号 CHANGELOG 里根本没有)—— 两种都让
|
|
// "线上跑的是哪个提交/版本"这个问题失去答案,而症状是静默的。
|
|
//
|
|
// ⚠️ "还没有正式版本"不等于出错:那时 ReleaseVersion 必须是空,**不许**编一个基线出来。
|
|
//
|
|
// 未注入时(普通 `go test ./...`)本用例 Skip:本地跑全量测试不必先构建。
|
|
// 但 CI 必须带 -ldflags 跑它,**并断言没有 SKIP**(被跳过的断言等于没有断言)。
|
|
func TestNumberMatchesChangelog(t *testing.T) {
|
|
if !HasInjection() {
|
|
t.Skip("构建身份未注入(没有 -ldflags);CI 会注入后跑这条断言,并断言它没有 Skip")
|
|
}
|
|
want := changelogTopVersion(t)
|
|
if want == "" {
|
|
if ReleaseVersion != "" {
|
|
t.Fatalf("CHANGELOG.md 里还没有已发布版本,ReleaseVersion 却是 %q —— 不许编一个版本基线出来", ReleaseVersion)
|
|
}
|
|
} else if ReleaseVersion != want {
|
|
t.Fatalf("注入的 ReleaseVersion %q != CHANGELOG 顶部 %q。"+
|
|
"常见原因:改了 CHANGELOG 却没重新构建(产物还报旧号),"+
|
|
"或者构建时手填了一个 CHANGELOG 里没有的号", ReleaseVersion, want)
|
|
}
|
|
if Number != ReleaseVersion && Number != "dev" {
|
|
t.Fatalf("Number %q 既不是 ReleaseVersion %q 也不是 dev —— 注入口径不一致", Number, ReleaseVersion)
|
|
}
|
|
}
|
|
|
|
// 开发构建不许自称正式版:这是"用正式版号代表开发版"那个问题的守门断言。
|
|
//
|
|
// - `BuildKind=release` 只允许出现在**确实有正式版本基线**的构建上,且显示就是那个版本;
|
|
// - 开发构建的 DisplayVersion 必须带 `dev` 形状,**不允许**退化成只显示上一正式版本号。
|
|
func TestDevBuildDoesNotClaimRelease(t *testing.T) {
|
|
if !HasInjection() {
|
|
t.Skip("构建身份未注入(没有 -ldflags);CI 会带 -ldflags 跑它,并断言它没有 Skip")
|
|
}
|
|
want := changelogTopVersion(t)
|
|
disp := DisplayVersion()
|
|
|
|
if BuildKind == "release" {
|
|
if want == "" {
|
|
t.Fatalf("标成了发布构建(BuildKind=release),但 CHANGELOG.md 里没有任何已发布版本条目 —— "+
|
|
"发布构建必须基于正式版本记录(现在显示 %q)", disp)
|
|
}
|
|
if ReleaseVersion != want || !semver.MatchString(ReleaseVersion) {
|
|
t.Fatalf("发布构建的 ReleaseVersion %q 不是 CHANGELOG 顶部的正式版本 %q", ReleaseVersion, want)
|
|
}
|
|
if disp != ReleaseVersion {
|
|
t.Fatalf("发布构建 DisplayVersion %q 应等于 ReleaseVersion %q", disp, ReleaseVersion)
|
|
}
|
|
return
|
|
}
|
|
|
|
if BuildKind != "development" {
|
|
t.Fatalf("BuildKind %q 既不是 development 也不是 release", BuildKind)
|
|
}
|
|
if !strings.Contains(disp, "dev") {
|
|
t.Fatalf("开发构建的 DisplayVersion %q 没有 dev 标识 —— 开发构建不能只显示正式版本号", disp)
|
|
}
|
|
if strings.Contains(disp, "+g") && ShortSHA() == "" {
|
|
t.Fatalf("DisplayVersion %q 带了 +g 但 CommitSHA %q 不是有效 SHA", disp, CommitSHA)
|
|
}
|
|
switch {
|
|
case want != "" && ShortSHA() != "":
|
|
if want := want + "-dev+g" + ShortSHA(); disp != want {
|
|
t.Fatalf("开发构建 DisplayVersion %q,期望 %q", disp, want)
|
|
}
|
|
case want == "" && ShortSHA() != "":
|
|
if want := "dev+g" + ShortSHA(); disp != want {
|
|
t.Fatalf("无正式基线的开发构建 DisplayVersion %q,期望 %q", disp, want)
|
|
}
|
|
}
|
|
}
|