report

type BaselineRun struct {
	RunID     string    `json:"run_id,omitempty"`
	StartedAt time.Time `json:"started_at"`
}

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

type Contract struct {
	Spec      string `json:"spec"`               // The contract, such as the path of an OpenAPI document
	Operation string `json:"operation"`          // Such as GET /users/{id}
	Response  string `json:"response,omitempty"` // Such as 200, 2XX or default; empty when none is declared
}

type Count struct {
	Total    int `json:"total"`
	Passed   int `json:"passed"`
	Failed   int `json:"failed"`
	Skipped  int `json:"skipped"`
	Untested int `json:"untested,omitempty"`
}

type Failure struct {
	Kind     string         `json:"kind"`
	Message  string         `json:"message"`
	Request  map[string]any `json:"request,omitempty"`
	Response map[string]any `json:"response,omitempty"`
	// Violations are what broke the contract, when Kind is a contract's.
	Violations []Violation `json:"violations,omitempty"`
}

type Format string

type Job struct {
	ID         string    `json:"id"`
	Name       string    `json:"name"`
	Status     string    `json:"status"`
	StartedAt  time.Time `json:"started_at"`
	DurationMs int64     `json:"duration_ms"`
	Steps      []Step    `json:"steps"`
	// RepeatTest is the outcome of the test of a repeated job over its
	// runs, which decides whether the job passed; nil when it has none.
	RepeatTest *RepeatTest `json:"repeat_test,omitempty"`
	// BaselineTest is the outcome of the test of a repeated job against the
	// run compared to, which the job passes only when it holds or is not
	// checked; nil when the job has none.
	BaselineTest *RepeatTest `json:"baseline_test,omitempty"`
}

type Latency struct {
	Count int     `json:"count"`
	MinMs float64 `json:"min_ms"`
	// MeanMs is the arithmetic mean.
	MeanMs float64 `json:"mean_ms"`
	P50Ms  float64 `json:"p50_ms"`
	P90Ms  float64 `json:"p90_ms"`
	P95Ms  float64 `json:"p95_ms"`
	P99Ms  float64 `json:"p99_ms"`
	MaxMs  float64 `json:"max_ms"`
}

type Repeat struct {
	Total   int `json:"total"`
	Success int `json:"success"`
	Failure int `json:"failure"`
	// Skipped is the iterations in which the step was not run: after a
	// step that failed in a job with fail_fast, or for an iteration that
	// came to no entry.
	Skipped int `json:"skipped,omitempty"`
	// Warmup is the runs before those counted here, which are counted in
	// nothing.
	Warmup int `json:"warmup,omitempty"`
	// Latency is the distribution of the times the step's action took, nil
	// when it returned none, as an action that failed to run does.
	Latency *Latency `json:"latency,omitempty"`
	// Baseline is the outcome of the step in the run compared to; nil when
	// none was compared, or the run had no step of the id.
	Baseline *RepeatBaseline `json:"baseline,omitempty"`
}

type RepeatBaseline struct {
	Total   int      `json:"total"`
	Success int      `json:"success"`
	Latency *Latency `json:"latency,omitempty"`
}

type RepeatTest struct {
	Test    string   `json:"test"`
	Status  string   `json:"status"` // Passed, Failed or Skipped
	Failure *Failure `json:"failure,omitempty"`
	// Reason is why the test was skipped, which a test against the run
	// compared to is when there is nothing to compare to.
	Reason string `json:"reason,omitempty"`
}

type Report struct {
	Name string `json:"name"`
	// RunID names the run, as actions are told it, such as in the trace
	// header of the http action.
	RunID       string    `json:"run_id,omitempty"`
	Description string    `json:"description,omitempty"`
	Status      string    `json:"status"`
	StartedAt   time.Time `json:"started_at"`
	FinishedAt  time.Time `json:"finished_at"`
	DurationMs  int64     `json:"duration_ms"`
	Summary     Summary   `json:"summary"`
	Jobs        []Job     `json:"jobs"`
	// Baseline is the run the response times were compared to; nil when
	// they were compared to none. See Compare.
	Baseline *BaselineRun `json:"baseline,omitempty"`
}

type Retry struct {
	Attempts int `json:"attempts"`
	Max      int `json:"max"`
}

type Step struct {
	Index int `json:"index"`
	// ID is the id of the step, or step_ and where it is written in the job
	// when it has none, by which a later run's report finds it.
	ID         string   `json:"id,omitempty"`
	Name       string   `json:"name"`
	Status     string   `json:"status"`
	Test       string   `json:"test,omitempty"`
	DurationMs int64    `json:"duration_ms"`
	Retry      *Retry   `json:"retry,omitempty"`
	Repeat     *Repeat  `json:"repeat,omitempty"`
	Echo       string   `json:"echo,omitempty"`
	Failure    *Failure `json:"failure,omitempty"`
	// Contract is what the action matched the response to in the contract
	// it checked it against, such as an operation of an OpenAPI document.
	Contract *Contract `json:"contract,omitempty"`
}

type Summary struct {
	Jobs  Count `json:"jobs"`
	Steps Count `json:"steps"`
}

type Target struct {
	Format Format
	Path   string
}

type Violation struct {
	In      string `json:"in"`              // Where it was found: request or response
	Field   string `json:"field,omitempty"` // The field, such as /items/0/id
	Reason  string `json:"reason,omitempty"`
	Message string `json:"message"`
}