acctest

type Fixture struct {
	// Root is the directory the declared files live under.
	Root string
	// UniqueName is the per-test token substituted for {{name}}; see the
	// UniqueName function.
	UniqueName string
	// Lock is the lockfile as re-read from disk after the last apply, so a
	// Check sees what a later run would load.
	Lock *core.Lockfile
	// Plan is the current step's plan, not the re-plan that checks
	// convergence. BeforePlan sees the previous step's plan, or nil on the
	// first step.
	Plan *core.Plan
	// Unrecorded is the same client without the recorder, for out-of-band
	// edits that must not show up in ExpectWrites.
	Unrecorded core.Client
	// contains filtered or unexported fields
}

type Step struct {
	// Name is the subtest name. It defaults to "step N", counting from 1.
	Name string

	// Write creates or overwrites files (slash paths, relative to Fixture.Root)
	// before planning. "{{name}}" in content is replaced with
	// Fixture.UniqueName, for fields the server requires to be unique.
	Write map[string]string
	// Remove deletes files or directories before planning.
	Remove []string
	// BeforePlan runs after Remove and Write, before planning: to change
	// server state behind the reconciler's back through Fixture.Unrecorded,
	// or to write files whose content needs IDs an earlier step minted.
	BeforePlan func(t *testing.T, fx *Fixture)

	// Prune and Force set the core.Planner fields of the same names, as
	// --prune and --force do.
	Prune bool
	Force bool

	// ExpectActions maps resource key → the action the plan must choose.
	// Keys are lockfile keys: the path relative to Root with a leading "./",
	// such as "./agents/a.md", or the directory for a skill, "./skills/s".
	// Keys not listed are not checked.
	ExpectActions map[string]core.Action
	// ExpectBlocked maps resource key → a substring of the reason the plan
	// must refuse it. Every blocked change must be listed. A step with
	// blocked changes is not applied.
	ExpectBlocked map[string]string
	// ExpectNoop requires the plan to have no work at all.
	ExpectNoop bool
	// ExpectWrites is the exact, ordered list of writes the apply must make:
	// "create agent", "update skill", "destroy environment". nil skips the
	// check; an empty slice requires that nothing is written.
	ExpectWrites []string
	// ExpectKeys is the exact set of lockfile keys after the step. nil skips
	// the check; an empty slice requires an empty lockfile.
	ExpectKeys []string

	// Check runs after the apply (or after the plan, for a blocked step) for
	// anything the declarative fields cannot say.
	Check func(t *testing.T, fx *Fixture)
}