api

type BenchmarkSpec struct {
	Scenarios  []*ScenarioSpec `json:"scenarios" yaml:"scenarios" validate:"required,min=1,dive"`
	Executions int             `validate:"required,gte=1"`
	Alternate  bool            `json:"alternate,omitempty" yaml:"alternate,omitempty"`
}

type CommandExecutor interface {
	Execute(cmd *CommandSpec, defaultWorkingDir string, env map[string]string) error
}

type CommandSpec struct {
	WorkingDirectory string   `json:"workingDir,omitempty" yaml:"workingDir,omitempty"`
	Cmd              []string `json:"cmd" yaml:"cmd" validate:"required"`
}

type End = func(error)

type ExecutionContext struct {
	Executor CommandExecutor
	Tracer   Tracer
}

type ID = string

type Identifiable interface {
	ID() ID
}

type ReportContext struct {
	Labels         []string
	IncludeHeaders bool
}

type ReportHandler interface {
	Subscribe(TraceStream)
	Finalize() error
}

type ScenarioSpec struct {
	Name             string            `json:"name" yaml:"name" validate:"required"`
	WorkingDirectory string            `json:"workingDir,omitempty" yaml:"workingDir,omitempty"`
	Env              map[string]string `json:"env,omitempty" yaml:"env,omitempty"`
	BeforeAll        *CommandSpec      `json:"beforeAll,omitempty" yaml:"beforeAll,omitempty"`
	AfterAll         *CommandSpec      `json:"afterAll,omitempty" yaml:"afterAll,omitempty"`
	BeforeEach       *CommandSpec      `json:"beforeEach,omitempty" yaml:"beforeEach,omitempty"`
	AfterEach        *CommandSpec      `json:"afterEach,omitempty" yaml:"afterEach,omitempty"`
	Command          *CommandSpec      `validate:"required,dive"`
}

type Stats interface {
	Min() (float64, error)
	Max() (float64, error)
	Mean() (float64, error)
	Median() (float64, error)
	Percentile(percent float64) (float64, error)
	StdDev() (float64, error)
	ErrorRate() float64
	Count() int
}

type Summary interface {
	Get(ID) Stats
	All() map[ID]Stats
	Time() time.Time
}

type Trace interface {
	ID() string
	Elapsed() time.Duration
	Error() error
}

type TraceStream = chan Trace

type Tracer interface {
	Start(i Identifiable) End
	Stream() TraceStream
}

type WriteSummaryReportFn = func(Summary, *BenchmarkSpec, *ReportContext) error