Documentation
¶
Index ¶
- Variables
- func IsUsageError(err error) bool
- type Compare
- type EnvSet
- type ErrUsage
- type GRPC
- type GRPCOpt
- type HTTP
- type HTTPOpt
- type HistBin
- type Kind
- type Latency
- type Opt
- type Percentile
- type Profile
- type ProfileFail
- type Report
- type Result
- type Select
- type Status
- type Step
- type Stream
- type Test
- type Trace
- type TraceBreach
- type TraceBudget
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrNilWriter = errors.New("headless: nil writer")
Functions ¶
func IsUsageError ¶
Types ¶
type ErrUsage ¶
type ErrUsage struct {
// contains filtered or unexported fields
}
ErrUsage reports invalid input or options passed to the headless API.
type Opt ¶
type Opt struct {
Version string `json:"version,omitempty"`
FilePath string `json:"filePath,omitempty"`
FileContent []byte `json:"-"`
Workspace string `json:"workspace,omitempty"`
Recursive bool `json:"recursive,omitempty"`
ArtifactDir string `json:"artifactDir,omitempty"`
StateDir string `json:"stateDir,omitempty"`
PersistGlobals bool `json:"persistGlobals,omitempty"`
PersistAuth bool `json:"persistAuth,omitempty"`
History bool `json:"history,omitempty"`
Envs EnvSet `json:"envs,omitempty"`
EnvName string `json:"envName,omitempty"`
EnvFile string `json:"envFile,omitempty"`
CompareTargets []string `json:"compareTargets,omitempty"`
CompareBase string `json:"compareBase,omitempty"`
Profile bool `json:"profile,omitempty"`
HTTP HTTPOpt `json:"http,omitempty"`
GRPC GRPCOpt `json:"grpc,omitempty"`
Select Select `json:"select,omitempty"`
}
type Percentile ¶
type Profile ¶
type Profile struct {
Count int `json:"count,omitempty"`
Warmup int `json:"warmup,omitempty"`
Delay time.Duration `json:"delay,omitempty"`
TotalRuns int `json:"totalRuns,omitempty"`
WarmupRuns int `json:"warmupRuns,omitempty"`
SuccessfulRuns int `json:"successfulRuns,omitempty"`
FailedRuns int `json:"failedRuns,omitempty"`
Latency *Latency `json:"latency,omitempty"`
Percentiles []Percentile `json:"percentiles,omitempty"`
Histogram []HistBin `json:"histogram,omitempty"`
Failures []ProfileFail `json:"failures,omitempty"`
}
type ProfileFail ¶
type Report ¶
type Report struct {
Version string `json:"version,omitempty"`
FilePath string `json:"filePath"`
EnvName string `json:"envName,omitempty"`
StartedAt time.Time `json:"startedAt"`
EndedAt time.Time `json:"endedAt"`
Duration time.Duration `json:"duration,omitempty"`
Results []Result `json:"results,omitempty"`
Total int `json:"total"`
Passed int `json:"passed"`
Failed int `json:"failed"`
Skipped int `json:"skipped"`
}
func (*Report) HasFailures ¶
HasFailures reports whether the report contains any failed results.
func (*Report) WriteJSON ¶
WriteJSON writes r as indented JSON. If r is nil, WriteJSON is a no-op. If w is nil, WriteJSON returns ErrNilWriter.
func (*Report) WriteJUnit ¶
WriteJUnit writes r as JUnit XML. If r is nil, WriteJUnit is a no-op. If w is nil, WriteJUnit returns ErrNilWriter.
type Result ¶
type Result struct {
Kind Kind `json:"kind,omitempty"`
Name string `json:"name,omitempty"`
Method string `json:"method,omitempty"`
Target string `json:"target,omitempty"`
Environment string `json:"environment,omitempty"`
Status Status `json:"status"`
Summary string `json:"summary,omitempty"`
Duration time.Duration `json:"duration,omitempty"`
Canceled bool `json:"canceled,omitempty"`
SkipReason string `json:"skipReason,omitempty"`
Error string `json:"error,omitempty"`
ScriptError string `json:"scriptError,omitempty"`
HTTP *HTTP `json:"http,omitempty"`
GRPC *GRPC `json:"grpc,omitempty"`
Stream *Stream `json:"stream,omitempty"`
Trace *Trace `json:"trace,omitempty"`
Tests []Test `json:"tests,omitempty"`
Compare *Compare `json:"compare,omitempty"`
Profile *Profile `json:"profile,omitempty"`
Steps []Step `json:"steps,omitempty"`
}
type Step ¶
type Step struct {
Name string `json:"name,omitempty"`
Method string `json:"method,omitempty"`
Target string `json:"target,omitempty"`
Environment string `json:"environment,omitempty"`
Branch string `json:"branch,omitempty"`
Iteration int `json:"iteration,omitempty"`
Total int `json:"total,omitempty"`
Status Status `json:"status"`
Summary string `json:"summary,omitempty"`
Duration time.Duration `json:"duration,omitempty"`
Canceled bool `json:"canceled,omitempty"`
SkipReason string `json:"skipReason,omitempty"`
Error string `json:"error,omitempty"`
ScriptError string `json:"scriptError,omitempty"`
HTTP *HTTP `json:"http,omitempty"`
GRPC *GRPC `json:"grpc,omitempty"`
Stream *Stream `json:"stream,omitempty"`
Trace *Trace `json:"trace,omitempty"`
Tests []Test `json:"tests,omitempty"`
}
type Trace ¶
type Trace struct {
Duration time.Duration `json:"duration,omitempty"`
Error string `json:"error,omitempty"`
Budget *TraceBudget `json:"budget,omitempty"`
Breaches []TraceBreach `json:"breaches,omitempty"`
ArtifactPath string `json:"artifactPath,omitempty"`
}
type TraceBreach ¶
Click to show internal directories.
Click to hide internal directories.