testrun

type AssertionResult struct {
	Source   string `json:"source"`
	Target   string `json:"target,omitempty"`
	Key      string `json:"key,omitempty"`
	Path     string `json:"path,omitempty"`
	Op       string `json:"op,omitempty"`
	Expected any    `json:"expected,omitempty"`
	Actual   any    `json:"actual,omitempty"`
	Passed   bool   `json:"passed"`
	// Message says why it failed.
	Message string `json:"message,omitempty"`
}

type BundleOptions struct {
	// Env is exported with the cases when set.
	Env *domain.Environment
	// IncludeSecrets exports secret values in plain text. Off, they are
	// left out and named in SecretsLeftOut.
	IncludeSecrets bool
}

type CaptureResult struct {
	Var   string `json:"var"`
	Value string `json:"value,omitempty"`
	Error string `json:"error,omitempty"`
}

type Config struct {
	// NewSender returns the sender for one run, see NewSender.
	NewSender func() Sender
	Requests  RequestSource
	// SaveEnv writes an environment back for cases with persistEnv; nil
	// ignores persistEnv.
	SaveEnv func(env *domain.Environment) error
	// Getenv reads OS environment variables; nil means os.Getenv.
	Getenv func(key string) string
}

type Event struct {
	Kind EventKind
	Step *StepResult
	Run  *Run
}

type EventKind int

type Options struct {
	// Env is the environment to run with, with secrets already resolved.
	// It is copied and never changed; nil runs without one.
	Env *domain.Environment
	// Only runs just these steps (by id) of the steps section; setup and
	// teardown still run. Empty runs all.
	Only []string
	// OnEvent reports progress. It is called on the run's goroutine.
	OnEvent func(Event)
}

type Problem struct {
	Where   string
	Message string
}

type RequestFinder func(ref domain.TestRequestRef) error

type RequestSource interface {
	RequestByID(id string) *domain.Request
	// AllRequests returns standalone requests and those in collections,
	// with CollectionName set on the latter.
	AllRequests() []*domain.Request
}

type RequestSummary struct {
	ID       string `json:"id"`
	Name     string `json:"name"`
	Protocol string `json:"protocol"`
	Method   string `json:"method,omitempty"`
	URL      string `json:"url,omitempty"`
}

type ResponseSummary struct {
	Status  int               `json:"status"`
	Size    int               `json:"size"`
	Time    time.Duration     `json:"time"`
	Headers map[string]string `json:"headers,omitempty"`
	Body    string            `json:"body,omitempty"`
	// Truncated is set when Body holds only the first maxBody bytes.
	Truncated bool `json:"truncated,omitempty"`
}

type Run struct {
	ID       string        `json:"id"`
	CaseID   string        `json:"caseId"`
	CaseName string        `json:"caseName"`
	EnvName  string        `json:"envName,omitempty"`
	Status   Status        `json:"status"`
	Started  time.Time     `json:"started"`
	Duration time.Duration `json:"duration"`
	Steps    []StepResult  `json:"steps"`
	// Message is a run-level problem, such as failing to save the env.
	Message string `json:"message,omitempty"`
}

type Runner struct {
	// contains filtered or unexported fields
}

type Sender interface {
	Send(req *domain.Request, env *domain.Environment) (*egress.Response, error)
}

type Status string

type StepResult struct {
	Section  string           `json:"section"`
	StepID   string           `json:"stepId"`
	Name     string           `json:"name"`
	Status   Status           `json:"status"`
	Attempts int              `json:"attempts,omitempty"`
	Duration time.Duration    `json:"duration,omitempty"`
	Request  *RequestSummary  `json:"request,omitempty"`
	Response *ResponseSummary `json:"response,omitempty"`

	Assertions []AssertionResult `json:"assertions,omitempty"`
	Captures   []CaptureResult   `json:"captures,omitempty"`
	// Message says why the step failed, errored or was skipped.
	Message string `json:"message,omitempty"`
}