experiment

type ApplyOptions struct {
	Key       string
	Files     []string
	Recursive bool
}

type Document = *output.Document

type DumpOptions struct {
	Directory string
	Type      string
	Teams     []string
}

type GetOptions struct {
	Key, File, Type string
}

type InitOptions struct {
	Template    string
	Team        string
	Environment string
	File        string
}

type RunOptions struct {
	Key           string
	Files         []string
	Recursive     bool
	Yes, Wait     bool
	AllowParallel bool
	Retries       int
	RetryInterval int
	// Parallel is how many runs go at once; 0 or 1 runs them one after another.
	Parallel int
	// BusyRetries tries a run again, BusyRetryInterval apart, when another experiment is
	// running and running in parallel is not allowed, instead of asking or failing.
	BusyRetries       int
	BusyRetryInterval time.Duration
	// ExpectationRetries runs an experiment again, ExpectationRetryInterval apart, when
	// its run did not end as expected.
	ExpectationRetries       int
	ExpectationRetryInterval time.Duration
	WaitOptions
	// Report is a file to write a JUnit (or, for .json, JSON) report of the runs to.
	Report string

	TemplateOptions
}

type RunResult struct {
	ID         int64     `json:"id"`
	Key        string    `json:"key"`
	Name       string    `json:"name"`
	State      string    `json:"state"`
	Reason     string    `json:"reason,omitempty"`
	Started    time.Time `json:"started"`
	Ended      time.Time `json:"ended"`
	UILocation string    `json:"uiLocation,omitempty"`
	// APILocation is where the platform's API serves the run, as run-experiment's
	// executionUrl output names it.
	APILocation string `json:"apiLocation,omitempty"`
	Steps       []Step `json:"steps"`
}

type Step struct {
	Name    string    `json:"name"`
	State   string    `json:"state"`
	Reason  string    `json:"reason,omitempty"`
	Started time.Time `json:"started"`
	Ended   time.Time `json:"ended"`
}

type TemplateOptions struct {
	Template          string
	Team              string
	Environment       string
	ExternalID        string
	Placeholder       *jsyaml.Map
	PlaceholdersFile  string
	Variable          *jsyaml.Map
	ResetProperties   bool
	ExecutionVariable *jsyaml.Map
}

type WaitOptions struct {
	// Timeout cancels the run once it has taken this long; zero waits indefinitely.
	Timeout time.Duration
	// KeepRunningOnInterrupt leaves the run going when the CLI is interrupted, as the
	// TypeScript CLI did. By default it is cancelled: an aborted pipeline should not
	// leave an attack running on its own.
	KeepRunningOnInterrupt bool
	// ShowSteps prints each step's state as it changes.
	ShowSteps bool
	// Prefix starts each line about the run, telling runs apart when several go at once.
	Prefix string
	// ExpectState passes the run once it reaches this state, which need not be an end
	// such as RUNNING, and fails it when it ends in another. A run that ended passes a
	// state it went through without a poll seeing it. Empty expects COMPLETED.
	ExpectState string
	// ExpectReason also requires the run's reason to be exactly this.
	ExpectReason string
	// Steps asks the platform for the steps of the run, which reports need.
	Steps bool
}