record

type File struct {
	Path   string
	Record *Record
}

type FileWriter struct {
	Dir string
}

type Node struct {
	ID         string                     `json:"id"`
	Kind       string                     `json:"kind"`
	StartedAt  time.Time                  `json:"started_at"`
	FinishedAt time.Time                  `json:"finished_at"`
	Status     string                     `json:"status"`
	Outputs    map[string]json.RawMessage `json:"outputs,omitempty"`
	Error      string                     `json:"error,omitempty"`
	// Undo is how the node's provider says to reverse it (a typed
	// insert: delete the row by its primary key). `orchard teardown`
	// runs it when the action has no explicit teardown block. Records
	// from before undo existed simply don't have it.
	Undo *Undo `json:"undo,omitempty"`
	// TornDown marks a node whose teardown succeeded, so re-running a
	// partly failed teardown skips it.
	TornDown bool `json:"torn_down,omitempty"`
}

type Options struct {
	Inner     engine.Reporter
	Writer    Writer
	Scenario  Scenario
	Variables map[string]cty.Value // resolved scenario variables
	Seed      uint64               // the run's random seed
	// ProviderConfigs are the evaluated provider configs, recorded as
	// hashes (see HashConfig).
	ProviderConfigs map[string]map[string]cty.Value
	// Sensitive names the scenario variables recorded as a hash
	// rather than a value (ParsedScenario.Sensitive).
	Sensitive map[string]bool
	LogOutput io.Writer // where write failures surface; defaults to os.Stderr
}

type Record struct {
	Format     string                     `json:"format"`
	ID         string                     `json:"id"`
	Scenario   Scenario                   `json:"scenario"`
	StartedAt  time.Time                  `json:"started_at"`
	FinishedAt time.Time                  `json:"finished_at"`
	Status     string                     `json:"status"`
	Error      string                     `json:"error,omitempty"`
	Variables  map[string]json.RawMessage `json:"variables,omitempty"`
	// Seed is the run's random seed; `orchard run --seed` with it
	// draws the same random values again. Absent in older records.
	Seed *uint64 `json:"seed,omitempty"`
	// ComponentVariables are each component's resolved inputs (its
	// var.* namespace), keyed by component key ("merchant.acme",
	// "merchant.acme[0]"), for its actions' teardown bodies. Absent
	// in older records.
	ComponentVariables map[string]map[string]json.RawMessage `json:"component_variables,omitempty"`
	Nodes              []Node                                `json:"nodes"`
	Outputs            map[string]json.RawMessage            `json:"outputs,omitempty"`
	// TornDownAt is set once `orchard teardown` has finished every
	// node's teardown; such a record is refused by a later teardown.
	TornDownAt *time.Time `json:"torn_down_at,omitempty"`
	// ConfigHashes fingerprints each provider config attribute the run
	// used (provider -> attribute -> HashConfig), so teardown can
	// refuse a config that now points somewhere else without the
	// record holding DSNs or keys. Absent in older records.
	ConfigHashes map[string]map[string]string `json:"config_hashes,omitempty"`
	// SensitiveVariables holds, for each scenario variable declared
	// `sensitive = true`, a hash of its value (see HashValue) in place
	// of the value, which Variables leaves out. Teardown needs the
	// value passed again and checks it against the hash.
	SensitiveVariables map[string]string `json:"sensitive_variables,omitempty"`
	// SensitiveComponentVariables names, per component key, the
	// component variables ComponentVariables leaves out because they
	// hold a sensitive value. Teardown evaluates them again.
	SensitiveComponentVariables map[string][]string `json:"sensitive_component_variables,omitempty"`
}

type Reporter struct {

	// WriteErr is set if the record could not be persisted.
	WriteErr error
	// contains filtered or unexported fields
}

type Scenario struct {
	Name string `json:"name"`
	Path string `json:"path"`
}

type Undo struct {
	Action string                     `json:"action"`
	Attrs  map[string]json.RawMessage `json:"attrs"`
}

type Writer interface {
	Write(r *Record) error
}