Files
coder/scripts/releaser/v2/cmdexec_test.go
T
Garrett Delfosse bfbacd64f4 refactor: consolidate release tooling into a single releaser command (#27034)
## What

Consolidates the two separate release programs into a single command at
`scripts/releaser`:

- `scripts/releaser/v1/` — the former interactive releaser (package
`v1`).
- `scripts/releaser/v2/` — the former `scripts/release-action` CI tool
(package `v2`).
- `scripts/releaser/main.go` — new entrypoint. Runs the **v2** tooling
by
  default and the **v1** interactive wizard with `--legacy`.

## CLI shape

Three documented subcommands, each backed by v2 `prepare-release` with
the
release type baked in:

- `releaser rc` — tag a release candidate
- `releaser branch` — cut a new release branch and tag its first RC
- `releaser release` — tag a stable release or patch

The former release-action verbs (`calculate-version`, `prepare-release`,
`generate-notes`, `publish`) are retained as **hidden** top-level
commands with
identical flags and stdout, so `tag-and-release.yaml` migrates with a
path-only
change (`scripts/release-action` -> `scripts/releaser`). `--legacy` runs
the v1
wizard and is mutually exclusive with the subcommands.
`scripts/release.sh` now
launches `releaser --legacy`.

All file moves are rename-detected by git, so the per-file diff is just
the
package declaration.

## Testing

- `go build ./scripts/...`, `go vet ./scripts/releaser/...`, `go test
./scripts/releaser/...`
- `golangci-lint run ./scripts/releaser/...`, `make lint/emdash`,
`shellcheck`, `actionlint`
- Smoke: `releaser --help` shows only rc/branch/release; hidden verbs
still run;
`releaser rc --ref main --dry-run` emits the same JSON contract;
`--legacy rc`
  errors cleanly.

<details>
<summary>Implementation plan</summary>

# Plan: Consolidate release tooling into a single `scripts/releaser`
command

## Goal

Merge the two separate release programs into one binary at
`scripts/releaser`:

- `scripts/releaser/v1/` — the current interactive releaser (package
`v1`).
- `scripts/releaser/v2/` — the current CI `scripts/release-action`
(package `v2`).
- `scripts/releaser/main.go` — new entrypoint (package `main`).
  - Uses v2 by default, v1 with `--legacy`.
- Exposes 3 subcommands: `rc`, `branch` (cut release branch), `release`.

## Design decision (Option A, chosen)

The workflow needs `prepare-release`, `generate-notes`, and `publish`
invokable
separately (a build happens between prepare and publish). The latter two
are
version-driven and type-agnostic, so they do not map cleanly onto
`rc`/`branch`/`release`.

- Visible subcommands `rc`, `branch`, `release` run v2 `prepare-release`
with the
  type baked in and print the same JSON.
- Hidden verbs `calculate-version`, `prepare-release`, `generate-notes`,
  `publish` keep byte-identical flags/stdout, so the workflow change is
  path-only. Lowest risk; honors "3 subcommands" from a UX perspective.

## `--legacy` semantics

- `releaser --legacy` runs the v1 interactive wizard (preserves today's
  behavior; the wizard auto-detects RC vs release from the branch).
- `--legacy` is mutually exclusive with the subcommands (clear error if
  combined), because v1 auto-detects type and cannot cut a branch.

## Work items

1. Create `v1` and `v2` packages via `git mv`, renaming `package main`.
Move the `owner`/`repo` consts into each package. Add `v1.Run(inv,
dryRun)`
   (old wizard `main()` body) and v2 command builders (`CICommands`,
   `TypeCommand`) so internals stay unexported.
2. New `scripts/releaser/main.go`: top-level `releaser` with `--legacy`,
the 3
subcommands, and the hidden compat verbs; delegates to `v1.Run` for
legacy.
3. Update references: `tag-and-release.yaml` (3 command paths + header
comment)
   and `scripts/release.sh` (`--legacy`).
4. Verify: build, vet, test, `go run` smoke tests, fmt, lint.
5. Open a single PR from a feature branch.

## Risks / notes

- stdout contract for rc/branch/release and the hidden verbs must stay
identical
  (workflow parses stdout); logs go to stderr.
- Patch releases from pre-existing `release/X.Y` branches run those
branches'
own (old) workflow + `scripts/release-action`, so they stay
self-consistent.
New releases cut from branches containing this change get the new
workflow +
`scripts/releaser`. No forwarding stub needed since code and workflow
ship
  together.

</details>

---

This PR was created by Coder Agents on behalf of @f0ssel.
2026-07-07 11:13:50 -04:00

135 lines
3.6 KiB
Go

package v2 //nolint:testpackage // Tests unexported release helpers.
import (
"bytes"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestRealExecutor_RunOutput(t *testing.T) {
t.Parallel()
exec := realExecutor{}
out, err := exec.RunOutput("echo", "hello")
require.NoError(t, err)
assert.Equal(t, "hello", out)
}
func TestRealExecutor_Run(t *testing.T) {
t.Parallel()
exec := realExecutor{}
err := exec.Run("true")
require.NoError(t, err)
err = exec.Run("false")
require.Error(t, err)
}
func TestRealExecutor_RunMutation(t *testing.T) {
t.Parallel()
exec := realExecutor{}
err := exec.RunMutation("true")
require.NoError(t, err)
err = exec.RunMutation("false")
require.Error(t, err)
}
func TestRealExecutor_RunMutationSurfacesStderr(t *testing.T) {
t.Parallel()
exec := realExecutor{}
err := exec.RunMutation("sh", "-c", "echo 'fatal: boom' 1>&2; exit 1")
require.Error(t, err)
assert.Contains(t, err.Error(), "fatal: boom")
}
func TestRealExecutor_RunMutationStdout(t *testing.T) {
t.Parallel()
exec := realExecutor{}
var stdout, stderr bytes.Buffer
err := exec.RunMutationStdout(&stdout, &stderr, "echo", "output")
require.NoError(t, err)
assert.Equal(t, "output\n", stdout.String())
}
func TestDryRunExecutor_RunOutputDelegates(t *testing.T) {
t.Parallel()
var buf bytes.Buffer
exec := newDryRunExecutor(&buf)
// RunOutput should still execute (read-only commands).
out, err := exec.RunOutput("echo", "real-output")
require.NoError(t, err)
assert.Equal(t, "real-output", out)
assert.Empty(t, buf.String(), "RunOutput should not produce dry-run output")
}
func TestDryRunExecutor_RunDelegates(t *testing.T) {
t.Parallel()
var buf bytes.Buffer
exec := newDryRunExecutor(&buf)
err := exec.Run("true")
require.NoError(t, err)
assert.Empty(t, buf.String(), "Run should not produce dry-run output")
}
func TestDryRunExecutor_RunMutationPrints(t *testing.T) {
t.Parallel()
var buf bytes.Buffer
exec := newDryRunExecutor(&buf)
err := exec.RunMutation("git", "push", "origin", "refs/tags/v2.21.0:refs/tags/v2.21.0")
require.NoError(t, err)
assert.Contains(t, buf.String(), "[dry-run] would run: git push origin refs/tags/v2.21.0:refs/tags/v2.21.0")
}
func TestDryRunExecutor_RunMutationStdoutPrints(t *testing.T) {
t.Parallel()
var buf bytes.Buffer
exec := newDryRunExecutor(&buf)
var stdout, stderr bytes.Buffer
err := exec.RunMutationStdout(&stdout, &stderr, "gh", "release", "create", "--repo", "coder/coder", "--title", "v2.21.0")
require.NoError(t, err)
assert.Empty(t, stdout.String(), "RunMutationStdout should not produce real output in dry-run")
assert.Contains(t, buf.String(), "[dry-run] would run: gh release create --repo coder/coder --title v2.21.0")
}
func TestDryRunExecutor_RunMutationStdoutQuotesArgs(t *testing.T) {
t.Parallel()
var buf bytes.Buffer
exec := newDryRunExecutor(&buf)
var stdout, stderr bytes.Buffer
err := exec.RunMutationStdout(&stdout, &stderr, "gh", "release", "create", "--title", "has space")
require.NoError(t, err)
assert.Contains(t, buf.String(), "'has space'")
}
func TestShelljoin(t *testing.T) {
t.Parallel()
tests := []struct {
name string
args []string
want string
}{
{"simple", []string{"a", "b"}, "a b"},
{"space", []string{"a", "has space"}, "a 'has space'"},
// shelljoin uses POSIX single-quote escaping, so an embedded
// single quote becomes '"'"'.
{"quote", []string{"it's"}, `'it'"'"'s'`},
{"empty", []string{}, ""},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
got := shelljoin(tt.args)
assert.Equal(t, tt.want, got)
})
}
}