scriptsave

type Caller struct {
	Email   string
	Admin   bool
	Persona string
	Roles   []string
}

type Gate struct {
	// Recordings is where recordings are read from; nil reads none.
	Recordings scriptrec.Store
	// Destinations is the deployment's bucket destinations, which an export
	// a test or a replay reaches resolves against.
	Destinations []script.Destination
	// MaxMemoryBytes is the memory one test or replay may hold.
	MaxMemoryBytes int64
	// Contracts is what an answer a test declares is held to (#1953); nil
	// checks none.
	Contracts scripttest.Contracts
	// Libraries is where the libraries a source loads are read from
	// (#1941); nil refuses a source that loads any.
	Libraries scriptlib.Source
	// Resources reads the managed-resource files a source loads as text,
	// which a save pins (#2113); nil refuses a source that loads any.
	Resources *scriptsrc.Reader
	// CannotServe reports whether a saved script's run cannot call a
	// connection, which the source is warned of for each one it names
	// (#2086); nil warns of none.
	CannotServe func(connection string) bool
}

type PassthroughConnections struct {
	Kits interface{ All() []registry.Toolkit }
}

type Request struct {
	// Existing is the script saved into, nil for a new one.
	Existing *script.Script
	// Name labels the script in tracebacks.
	Name   string
	Source string
	Caller Caller
	// ChangeSummary is what the new version does differently, in plain
	// language, and Agreed the confirmation that the person the automation
	// runs for agreed to it.
	ChangeSummary string
	Agreed        bool
}

type Result struct {
	// Lint is the formatter's and the lint's result; Lint.Source is what a
	// save stores.
	Lint scriptlint.Result `json:"-"`
	// Tests is the tests' report, nil when the save was refused before they
	// ran.
	Tests *scripttest.Report `json:"tests,omitempty"`
	// Differences is what the new version does differently. Replayed is the
	// recorded runs both versions replayed, and NotCompared the ones the
	// saved version itself could not replay.
	Differences []scriptbehavior.Difference `json:"differences"`
	Replayed    []string                    `json:"replayed"`
	NotCompared []string                    `json:"not_compared,omitempty"`
	// Refusal is why the save is refused, empty when it goes through.
	Refusal string `json:"refusal,omitempty"`
	// ChangeNeeded is true when the refusal is only that a behavior change
	// needs a summary and the person's agreement.
	ChangeNeeded bool `json:"change_needed,omitempty"`
	// ChangeSummary and ChangeAgreedBy are what the saved version carries,
	// empty when there is nothing.
	ChangeSummary  string `json:"-"`
	ChangeAgreedBy string `json:"-"`
	// ResourcePins is the version of each file the source loads (#2113).
	ResourcePins map[string]script.ResourcePin `json:"-"`
}