beads/cmd/bd/close_gate_test.go
Julian Knutsen 6d27a4f96e
fix(issueops): enforce the close guards on every close leg (#7425)
* fix(issueops): enforce the close guards on every close leg

The template read-only guard, the pin guard and the assignee authority
fence (be-035) lived only in cmd/bd (validateIssueClosable), so a close
through bd serve, issues:batchClose, a batch:apply close item or a library
caller of Lifecycle.Close / BatchCloser / BatchApplier closed what bd close
refused.

They now run inside the close's own transaction in CloseIssueCheckedInTx
(enforceCloseGuardsInTx), the body every checked close shares (dolt,
embedded, uow, and the server behind httpapi), for a target that is not
already closed:
- a template refuses with *issueops.TemplateReadOnlyError (no bypass);
- unless Force (CloseRequest, CloseBatchRequest, CloseItem) is set, a pinned
  issue refuses with *issueops.PinnedError and another actor's bead with
  *issueops.CloseNotAssigneeError (matches ErrNotOwner).

Wire: 409 template_read_only, issue_pinned and not_assignee (holder in
`assignee`, also on a batch-close outcome); the client rebuilds the typed
errors. The decision is one exported pure rule over the pre-image,
issueops.CheckClosable (internal/storage/issueops), which the in-tx guard
calls; bd close's direct and proxied preflights call it too, ahead of gate
satisfaction under the same already-closed skip, so bd close output, refusal
order and exit codes are unchanged (validateIssueClosable is gone). bd close
--if-revision now applies the guards too.

Conformance: RunLifecycleCloseEnforcesTheCloseGuards,
RunBatchCloserItemsAnswerToTheCloseGuards and
RunBatchApplyCloseItemsAnswerToTheCloseGuards on dolt, embedded, uow and
http, plus handler mapping tests, a CheckClosable table test, and a cmd/bd
test pinning that the guards outrank gate satisfaction.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(httpclient): send force on the raw close; scope the close guards

Review fixes for #7425 (adopt-pr bd-0h0ao4, iterations 1 and 2).

The raw close keeps parity over http. httpclient.Store.CloseIssue maps the
off-role raw close onto the role's closeIssue op and sent force=false.
With the guards in the role, a pinned or claimed target then refused (409
issue_pinned / not_assignee) on http only: dolt, embedded and proxied run
the raw close as issueops.CloseIssueInTx, which applies neither the guards
nor close policy. The molecule auto-close, `bd gate resolve`,
`bd todo done` and `bd human dismiss` all make that call, and its
signature carries no force a caller could pass. It now sends force. Over
http that also stops applying close policy to the raw close, which it did
at base and no other backend does; parity is the point, so that goes too.
The template guard has no bypass on the wire, so a template still refuses
the raw close over http where the other backends close it; no raw caller
is known to close one. TestServedRawCloseKeepsParityWithTheOtherBackends
closes both pin spellings, a held bead and a parent with an open child
through Store.CloseIssue and requires the template refusal; with force
back to false it fails on 409 issue_pinned.

The close guards stay on the close verbs. A status update that crosses
into the done category (`bd update -s closed`, PATCH, a batchApply update
item) still answers to close policy only, so it closes a pinned issue or
another actor's bead on every backend, as it did before this PR. Guarding
it changes what the update legs admit and needs its own refusal mapping on
PATCH and batchApply, so it is left for a follow-up; the update.go and
domain/db comments now say the exclusion is deliberate.

CHANGELOG: the entry moves from Fixed to Changed as BREAKING, is scoped to
the close operations, names the two paths the guards do not cover, and
adds a Migration line (send force or reclaim; templates are never
closable). Docs: the OpBatchCloseIssues item codes, the CloseIssueChecked
and CloseIssueOptions.Force docs (storage, dolt, embeddeddolt), the
oracle-a scenario strings that named the retired validateIssueClosable,
and the TestCloseCheckOne_CloseGuardsOutrankGateSatisfaction doc, which
claimed a proxied route it does not drive.

Iteration 2: the wire contract says what force waives. The OpenAPI
`force` members of CloseIssueRequest, BatchCloseRequest and ApplyCloseItem
said force bypasses close policy "and nothing else"; it also waives the
pin and the assignee guard, and never the template guard. The batchClose
"only two answers" paragraph now says the same, and types.gen.go is
regenerated (`make api-gen`). "Close guards" names the close operations
instead of "every route to a close" and adds that a status update into
the done category is not one, and the PATCH done-crossing paragraph says
a patch is never refused `issue_pinned` or `not_assignee`. The conformance
comments that quoted the old Force sentence (batch_apply_contract.go,
batch_closer_contract.go, lifecycle_close_reopen_contract.go) quote the
current docs, and the batch_apply failure message no longer says Force
does nothing else. CHANGELOG: a `close` line of `bd batch` is named among
the raw closes, and "a template is never closable" becomes "the close
operations never close a template, forced or not". The storage interface
CloseIssue gains a doc that states its HTTP exception.

TestCloseGuardRefusalsPrintTheGuardSentenceOnEveryRoute pins the sentence
`bd close` prints for each guard (template, pin, assignee) through each
printer (closeDirectRefusal, closeDirectTypedRefusal, closeProxiedRefusal,
closeProxiedTypedRefusal), with the refusal bare, wrapped by the use case
and the SQL repository, or inside a served problem envelope. One pinned
refusal also goes through closeProxiedOutcomes and closeProxiedFailures,
where the stderr line and the `--json` error field must both be the
sentence. Six overlay mutants fail it: closeGuardRefusal recognizing no
guard, or not the pin, and each of the four printers skipping its call to
closeGuardRefusal.

Not done here: a CLI test that `--if-revision` exits 1 on a guard refusal,
not ExitGuardMismatch. External PR #7372 carries per-id fence tests for
that route (6 of 7 pass at this head); they are better absorbed with
credit than rewritten.

Agent-Signature: claude-code-claude-opus-5-5-max on behalf of Gas City Adopt-PR
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-09 18:30:42 +00:00

432 lines
13 KiB
Go

package main
import (
"context"
"encoding/json"
"errors"
"strings"
"testing"
"time"
"github.com/steveyegge/beads/internal/storage"
"github.com/steveyegge/beads/internal/types"
)
func TestIsMachineCheckableGate(t *testing.T) {
tests := []struct {
name string
issue *types.Issue
want bool
}{
{
name: "nil issue",
issue: nil,
want: false,
},
{
name: "non-gate issue",
issue: &types.Issue{
IssueType: "task",
},
want: false,
},
{
name: "gate with human await type",
issue: &types.Issue{
IssueType: "gate",
AwaitType: "human",
},
want: false,
},
{
name: "gate with gh:pr await type",
issue: &types.Issue{
IssueType: "gate",
AwaitType: "gh:pr",
},
want: true,
},
{
name: "gate with gh:run await type",
issue: &types.Issue{
IssueType: "gate",
AwaitType: "gh:run",
},
want: true,
},
{
name: "gate with timer await type",
issue: &types.Issue{
IssueType: "gate",
AwaitType: "timer",
},
want: true,
},
{
name: "gate with bead await type",
issue: &types.Issue{
IssueType: "gate",
AwaitType: "bead",
},
want: true,
},
{
name: "gate with empty await type",
issue: &types.Issue{
IssueType: "gate",
AwaitType: "",
},
want: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := isMachineCheckableGate(tt.issue)
if got != tt.want {
t.Errorf("isMachineCheckableGate() = %v, want %v", got, tt.want)
}
})
}
}
func TestCheckGateSatisfaction_NonGateIssues(t *testing.T) {
// Non-gate issues should always pass (return nil)
tests := []struct {
name string
issue *types.Issue
}{
{
name: "nil issue",
issue: nil,
},
{
name: "task issue",
issue: &types.Issue{
IssueType: "task",
Title: "Regular task",
},
},
{
name: "bug issue",
issue: &types.Issue{
IssueType: "bug",
Title: "A bug",
},
},
{
name: "gate with human await (not machine-checkable)",
issue: &types.Issue{
IssueType: "gate",
AwaitType: "human",
Title: "Human gate",
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := checkGateSatisfaction(tt.issue, nil)
if err != nil {
t.Errorf("checkGateSatisfaction() returned error for non-machine-checkable issue: %v", err)
}
})
}
}
func TestCheckGateSatisfaction_GHPRWithoutAwaitID(t *testing.T) {
// gh:pr gate without an await_id is unsatisfied (no PR to check)
issue := &types.Issue{
IssueType: "gate",
AwaitType: "gh:pr",
AwaitID: "",
Title: "PR gate without ID",
}
err := checkGateSatisfaction(issue, nil)
if err == nil {
t.Error("checkGateSatisfaction() should return error for gh:pr gate without await_id")
}
if err != nil && !strings.Contains(err.Error(), "no PR number") {
t.Errorf("error should mention 'no PR number', got: %v", err)
}
}
func TestCheckGateSatisfaction_GHRunWithoutAwaitID(t *testing.T) {
// gh:run gate without an await_id is unsatisfied (no run to check)
issue := &types.Issue{
IssueType: "gate",
AwaitType: "gh:run",
AwaitID: "",
Title: "Run gate without ID",
}
err := checkGateSatisfaction(issue, nil)
if err == nil {
t.Error("checkGateSatisfaction() should return error for gh:run gate without await_id")
}
if err != nil && !strings.Contains(err.Error(), "no run ID") {
t.Errorf("error should mention 'no run ID', got: %v", err)
}
}
func TestCheckGateSatisfaction_BeadGateInvalidFormat(t *testing.T) {
// bead gate with invalid await_id should return an error
issue := &types.Issue{
IssueType: "gate",
AwaitType: "bead",
AwaitID: "invalid-no-colon",
Title: "Bead gate with bad format",
}
err := checkGateSatisfaction(issue, nil)
if err == nil {
t.Error("checkGateSatisfaction() should return error for bead gate with invalid await_id format")
}
}
func TestCheckGateSatisfaction_ErrorMessageFormat(t *testing.T) {
// Verify error messages contain the force override hint
issue := &types.Issue{
IssueType: "gate",
AwaitType: "bead",
AwaitID: "invalid-no-colon",
Title: "Test gate",
}
err := checkGateSatisfaction(issue, nil)
if err == nil {
t.Fatal("expected error")
}
errMsg := err.Error()
if !strings.Contains(errMsg, "--force") {
t.Errorf("error message should mention --force, got: %s", errMsg)
}
if !strings.Contains(errMsg, "gate condition not satisfied") {
t.Errorf("error message should mention 'gate condition not satisfied', got: %s", errMsg)
}
}
// unreadableGateStore is a DoltStorage stand-in whose GetIssue always fails
// with err. It embeds a nil DoltStorage and overrides only the read the bead
// arm of checkGateSatisfaction makes.
type unreadableGateStore struct {
storage.DoltStorage
err error
}
func (s *unreadableGateStore) GetIssue(context.Context, string) (*types.Issue, error) {
return nil, s.err
}
func TestCheckGateSatisfaction_BeadGateUnreadableStoreRefuses(t *testing.T) {
// A bead gate whose store read fails (anything but not-found) must refuse
// the close with the read error, not fall through to the fail-open
// warning the gh:* and timer arms use.
issue := &types.Issue{
IssueType: "gate",
AwaitType: "bead",
AwaitID: "bd-abc",
Title: "Bead gate on an unreadable store",
}
err := checkGateSatisfaction(issue, &unreadableGateStore{err: errors.New("dolt exploded")})
if err == nil {
t.Fatal("checkGateSatisfaction() let a bead gate close although its store could not be read")
}
for _, want := range []string{"could not check bead gate", "dolt exploded", "--force"} {
if !strings.Contains(err.Error(), want) {
t.Errorf("error should mention %q, got: %v", want, err)
}
}
}
func TestCheckGateSatisfaction_BeadGateNeedsASighting(t *testing.T) {
// The close pre-check applies bd gate check's rule: an awaited bead the
// gate's store does not have satisfies the gate only if an earlier check
// saw it there, so a gate on a typo'd await_id cannot be closed past. Nor
// can a gate that a rename moved on after bd close read it.
withBeadGateTown(t)
gateStore := &beadGateLocalStore{issues: map[string]*types.Issue{}}
for _, awaitID := range []string{"bd-typo123", "other:ot-typo123"} {
gate := &types.Issue{ID: "bd-gate", IssueType: "gate", AwaitType: "bead", AwaitID: awaitID}
gateStore.issues[gate.ID] = gate
err := checkGateSatisfaction(gate, gateStore)
if err == nil {
t.Fatalf("%s: checkGateSatisfaction() let a gate close on a bead no check ever saw", awaitID)
}
for _, want := range []string{"no earlier gate check saw it", "--force"} {
if !strings.Contains(err.Error(), want) {
t.Errorf("%s: error should mention %q, got: %v", awaitID, want, err)
}
}
gate.Metadata = json.RawMessage(`{"await_seen":"` + awaitID + `"}`)
if err := checkGateSatisfaction(gate, gateStore); err != nil {
t.Errorf("%s: a seen bead that is gone should satisfy the gate, got: %v", awaitID, err)
}
moved := *gate
moved.AwaitID = awaitID + "-renamed"
gateStore.issues[gate.ID] = &moved
err = checkGateSatisfaction(gate, gateStore)
if err == nil || !strings.Contains(err.Error(), "the gate changed") {
t.Errorf("%s: a gate moved on since it was read should not be closed past, got: %v", awaitID, err)
}
}
}
func TestCloseDirectPreflight_BeadGateReadsTheGatesOwnStore(t *testing.T) {
// A gate reached through a route is checked against the store that owns
// it, as bd gate check in its rig would. The launcher's store does not
// have the awaited bead: checking there would read the open bead as
// deleted and, the gate's sighting being recorded, let the close through.
saveAndRestoreGlobals(t)
withBeadGateTown(t)
store = &beadGateLocalStore{issues: map[string]*types.Issue{}}
for _, tt := range []struct {
name string
target types.Status
wantRefusal string
}{
{name: "awaited bead open in the gate's rig", target: types.StatusOpen, wantRefusal: "bead rg-target is open"},
{name: "awaited bead closed in the gate's rig", target: types.StatusClosed},
} {
t.Run(tt.name, func(t *testing.T) {
gate := &types.Issue{
ID: "rg-gate",
Status: types.StatusOpen,
IssueType: "gate",
AwaitType: "bead",
AwaitID: "rg-target",
Metadata: json.RawMessage(`{"await_seen":"rg-target"}`),
}
gateStore := &beadGateLocalStore{issues: map[string]*types.Issue{
"rg-target": {ID: "rg-target", Status: tt.target},
}}
results := []*RoutedResult{{Issue: gate, Store: gateStore, Routed: true, ResolvedID: gate.ID}}
plan := closeDirectPreflight(results, []string{gate.ID}, []string{"done"}, false)
if tt.wantRefusal == "" {
if plan.refusals[0] != "" || len(plan.items) != 1 {
t.Fatalf("close refused (%q), want it to go to the batch", plan.refusals[0])
}
if plan.items[0].store != gateStore {
t.Error("the close does not go to the gate's own store")
}
return
}
if len(plan.items) != 0 {
t.Fatalf("the gate went to the batch, want a refusal mentioning %q", tt.wantRefusal)
}
if !strings.Contains(plan.refusals[0], tt.wantRefusal) {
t.Errorf("refusal %q does not mention %q", plan.refusals[0], tt.wantRefusal)
}
})
}
}
// The close pre-check reads a bead gate's target through the route that can
// serve it: the proxied route has no local store, so it must not build a
// store-backed getter there (#5861), and the direct route reads from the
// store that owns the gate.
func TestCloseBeadGateGetter_RouteSelection(t *testing.T) {
oldMode := proxiedServerMode
t.Cleanup(func() { proxiedServerMode = oldMode })
gateStore := &beadGateLocalStore{}
proxiedServerMode = true
if _, ok := closeBeadGateGetter(gateStore).(proxiedFreshReadGetter); !ok {
t.Errorf("proxied-server mode: got %T, want proxiedFreshReadGetter", closeBeadGateGetter(gateStore))
}
proxiedServerMode = false
getter, ok := closeBeadGateGetter(gateStore).(routedBeadGateGetter)
if !ok {
t.Fatalf("direct mode: got %T, want routedBeadGateGetter", closeBeadGateGetter(gateStore))
}
if getter.localStore != gateStore {
t.Error("direct mode: the getter does not read the gate's own store")
}
}
// TestCloseCheckOne_CloseGuardsOutrankGateSatisfaction pins `bd close`'s
// refusal order on the direct preflight route (closeDirectCheckOne): the close
// guards (storeissueops.CheckClosable, the role's own rule) answer before gate
// satisfaction, so a pinned, held or template gate whose condition is unmet
// prints the guard's sentence, as it always has. Force waives the pin and the
// holder (and the gate check with them) but never the template, and a row
// already closed skips the guards (ga-ktn9pe.4.8). closeProxiedCheckOne makes
// the same call in the same order; it resolves the row through a unit of work,
// so this test does not drive it.
func TestCloseCheckOne_CloseGuardsOutrankGateSatisfaction(t *testing.T) {
actorMu.Lock()
savedActor, savedPending := actor, actorGitFallbackPending
actor, actorGitFallbackPending = "alice", false
actorMu.Unlock()
t.Cleanup(func() {
actorMu.Lock()
actor, actorGitFallbackPending = savedActor, savedPending
actorMu.Unlock()
})
// An unexpired timer gate: checkGateSatisfaction refuses it unforced.
gate := func(mut func(*types.Issue)) *types.Issue {
issue := &types.Issue{
ID: "bd-g1",
IssueType: "gate",
AwaitType: "timer",
Status: types.StatusOpen,
CreatedAt: time.Now(),
Timeout: time.Hour,
}
mut(issue)
return issue
}
const gateRefusal = "cannot close bd-g1: gate condition not satisfied"
cases := []struct {
name string
issue *types.Issue
force bool
want string
}{
{"pinned", gate(func(i *types.Issue) { i.Pinned = true }), false,
"cannot modify pinned issue bd-g1 (use --force to override)"},
{"pinned status", gate(func(i *types.Issue) { i.Status = types.StatusPinned }), false,
"cannot modify pinned issue bd-g1 (use --force to override)"},
{"template", gate(func(i *types.Issue) { i.IsTemplate = true }), false,
"cannot modify template bd-g1: templates are read-only; use 'bd mol pour' to create a work item"},
{"forced template", gate(func(i *types.Issue) { i.IsTemplate = true }), true,
"cannot modify template bd-g1: templates are read-only; use 'bd mol pour' to create a work item"},
{"held", gate(func(i *types.Issue) { i.Assignee = "bob" }), false,
`cannot close bd-g1: assignee is "bob", actor is "alice"; reclaim or use --force to override`},
{"unguarded gate", gate(func(*types.Issue) {}), false, gateRefusal},
{"forced pin", gate(func(i *types.Issue) { i.Pinned = true; i.Assignee = "bob" }), true, ""},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
check := func(route, got string) {
t.Helper()
if tc.want == gateRefusal {
if !strings.HasPrefix(got, gateRefusal) {
t.Fatalf("%s refusal = %q, want the gate refusal", route, got)
}
return
}
if got != tc.want {
t.Fatalf("%s refusal = %q, want %q", route, got, tc.want)
}
}
check("direct", closeDirectCheckOne("bd-g1", tc.issue, nil, tc.force))
})
}
// The already-closed skip: a forced close leaves pinned=true behind, and
// the plain re-close must reach the engine as the idempotent no-op.
residue := &types.Issue{ID: "bd-c1", Status: types.StatusClosed, Pinned: true, Assignee: "bob"}
if got := closeDirectCheckOne("bd-c1", residue, nil, false); got != "" {
t.Fatalf("closed residue refusal = %q, want none", got)
}
}