Files
coder/scripts/releaser/version_test.go
T
Garrett Delfosse a8222e02e5 fix(scripts/releaser): fix tag sorting and changelog blurb for older branches (#24798)
Fixes two bugs in the release tool.

## 1. RC tags chosen over release tags on release branches

`allSemverTags()` and `mergedSemverTags()` rely on `git tag
--sort=-v:refname` for ordering. Git's version sort treats pre-release
suffixes (e.g. `-rc.0`) as *greater* than the base release version,
which is the opposite of semver where `v2.32.0 > v2.32.0-rc.0`.

When the release branch code iterates the tag list looking for the first
matching `major.minor`, it finds the RC tag first, leading to incorrect
version suggestions (e.g. suggesting `v2.32.0` again instead of
`v2.32.1`).

**Fix:** Re-sort parsed tags using the existing `GreaterThan` method via
a new `sortVersionsDesc` helper.

## 2. Misleading mainline changelog blurb on ESR/older branch patches

When releasing a patch on an older branch (e.g. `release/2.29` for ESR),
the version is neither mainline nor stable. Declining the stable prompt
would always produce the mainline changelog note ("This is a mainline
Coder release..."), which is incorrect.

**Fix:** Only emit the mainline note when the version's minor matches
the current mainline series. For older branches the changelog omits the
note entirely.

> Generated by Coder Agents
2026-05-01 14:41:09 -04:00

241 lines
5.5 KiB
Go

package main
import (
"testing"
)
func TestParseVersion(t *testing.T) {
t.Parallel()
tests := []struct {
input string
ok bool
want version
}{
{"v2.32.0", true, version{2, 32, 0, ""}},
{"v1.0.0", true, version{1, 0, 0, ""}},
{"v2.32.0-rc.0", true, version{2, 32, 0, "rc.0"}},
{"v2.32.0-rc.1", true, version{2, 32, 0, "rc.1"}},
{"v2.32.1-beta.3", true, version{2, 32, 1, "beta.3"}},
{"2.32.0", false, version{}},
{"v2.32", false, version{}},
{"vx.y.z", false, version{}},
{"", false, version{}},
}
for _, tt := range tests {
t.Run(tt.input, func(t *testing.T) {
t.Parallel()
got, ok := parseVersion(tt.input)
if ok != tt.ok {
t.Fatalf("parseVersion(%q) ok = %v, want %v", tt.input, ok, tt.ok)
}
if ok && got != tt.want {
t.Fatalf("parseVersion(%q) = %+v, want %+v", tt.input, got, tt.want)
}
})
}
}
func TestVersionString(t *testing.T) {
t.Parallel()
tests := []struct {
v version
want string
}{
{version{2, 32, 0, ""}, "v2.32.0"},
{version{2, 32, 0, "rc.0"}, "v2.32.0-rc.0"},
{version{1, 0, 0, "beta.1"}, "v1.0.0-beta.1"},
}
for _, tt := range tests {
t.Run(tt.want, func(t *testing.T) {
t.Parallel()
if got := tt.v.String(); got != tt.want {
t.Fatalf("String() = %q, want %q", got, tt.want)
}
})
}
}
func TestVersionIsRC(t *testing.T) {
t.Parallel()
tests := []struct {
v version
want bool
}{
{version{2, 32, 0, "rc.0"}, true},
{version{2, 32, 0, "rc.1"}, true},
{version{2, 32, 0, ""}, false},
{version{2, 32, 0, "beta.1"}, false},
}
for _, tt := range tests {
t.Run(tt.v.String(), func(t *testing.T) {
t.Parallel()
if got := tt.v.IsRC(); got != tt.want {
t.Fatalf("IsRC() = %v, want %v", got, tt.want)
}
})
}
}
func TestVersionRCNumber(t *testing.T) {
t.Parallel()
tests := []struct {
v version
want int
}{
{version{2, 32, 0, "rc.0"}, 0},
{version{2, 32, 0, "rc.5"}, 5},
{version{2, 32, 0, ""}, -1},
{version{2, 32, 0, "beta.1"}, -1},
}
for _, tt := range tests {
t.Run(tt.v.String(), func(t *testing.T) {
t.Parallel()
if got := tt.v.rcNumber(); got != tt.want {
t.Fatalf("rcNumber() = %d, want %d", got, tt.want)
}
})
}
}
func TestVersionGreaterThan(t *testing.T) {
t.Parallel()
tests := []struct {
a, b version
want bool
}{
// Standard comparisons.
{version{2, 32, 1, ""}, version{2, 32, 0, ""}, true},
{version{2, 32, 0, ""}, version{2, 32, 1, ""}, false},
{version{2, 33, 0, ""}, version{2, 32, 0, ""}, true},
{version{3, 0, 0, ""}, version{2, 99, 99, ""}, true},
// Release > RC with same base version.
{version{2, 32, 0, ""}, version{2, 32, 0, "rc.0"}, true},
{version{2, 32, 0, "rc.0"}, version{2, 32, 0, ""}, false},
// RC ordering.
{version{2, 32, 0, "rc.1"}, version{2, 32, 0, "rc.0"}, true},
{version{2, 32, 0, "rc.0"}, version{2, 32, 0, "rc.1"}, false},
{version{2, 32, 0, "rc.10"}, version{2, 32, 0, "rc.9"}, true},
{version{2, 32, 0, "rc.9"}, version{2, 32, 0, "rc.10"}, false},
// Equal.
{version{2, 32, 0, ""}, version{2, 32, 0, ""}, false},
{version{2, 32, 0, "rc.0"}, version{2, 32, 0, "rc.0"}, false},
}
for _, tt := range tests {
t.Run(tt.a.String()+"_gt_"+tt.b.String(), func(t *testing.T) {
t.Parallel()
if got := tt.a.GreaterThan(tt.b); got != tt.want {
t.Fatalf("%s.GreaterThan(%s) = %v, want %v", tt.a, tt.b, got, tt.want)
}
})
}
}
func TestVersionEqual(t *testing.T) {
t.Parallel()
tests := []struct {
a, b version
want bool
}{
{version{2, 32, 0, ""}, version{2, 32, 0, ""}, true},
{version{2, 32, 0, "rc.0"}, version{2, 32, 0, "rc.0"}, true},
{version{2, 32, 0, ""}, version{2, 32, 0, "rc.0"}, false},
{version{2, 32, 0, "rc.0"}, version{2, 32, 0, "rc.1"}, false},
}
for _, tt := range tests {
t.Run(tt.a.String()+"_eq_"+tt.b.String(), func(t *testing.T) {
t.Parallel()
if got := tt.a.Equal(tt.b); got != tt.want {
t.Fatalf("%s.Equal(%s) = %v, want %v", tt.a, tt.b, got, tt.want)
}
})
}
}
func TestSortVersionsDesc(t *testing.T) {
t.Parallel()
tests := []struct {
name string
input []version
want []version
}{
{
// This is the exact scenario that triggered the bug:
// git's --sort=-v:refname places v2.32.0-rc.0 before
// v2.32.0, but semver says v2.32.0 > v2.32.0-rc.0.
name: "release_sorts_before_rc",
input: []version{
{2, 32, 0, "rc.0"},
{2, 32, 0, ""},
{2, 31, 2, ""},
},
want: []version{
{2, 32, 0, ""},
{2, 32, 0, "rc.0"},
{2, 31, 2, ""},
},
},
{
name: "multiple_rcs_and_releases",
input: []version{
{2, 33, 0, "rc.1"},
{2, 33, 0, "rc.0"},
{2, 32, 0, "rc.0"},
{2, 32, 0, ""},
{2, 32, 1, ""},
{2, 31, 0, ""},
},
want: []version{
{2, 33, 0, "rc.1"},
{2, 33, 0, "rc.0"},
{2, 32, 1, ""},
{2, 32, 0, ""},
{2, 32, 0, "rc.0"},
{2, 31, 0, ""},
},
},
{
name: "already_sorted",
input: []version{{3, 0, 0, ""}, {2, 0, 0, ""}, {1, 0, 0, ""}},
want: []version{{3, 0, 0, ""}, {2, 0, 0, ""}, {1, 0, 0, ""}},
},
{
name: "empty",
input: []version{},
want: []version{},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
got := make([]version, len(tt.input))
copy(got, tt.input)
sortVersionsDesc(got)
if len(got) != len(tt.want) {
t.Fatalf("sortVersionsDesc() returned %d elements, want %d", len(got), len(tt.want))
}
for i := range got {
if !got[i].Equal(tt.want[i]) {
t.Fatalf("sortVersionsDesc()[%d] = %s, want %s\n full result: %v", i, got[i], tt.want[i], got)
}
}
})
}
}