run

Documentation

Index

• func Cmd(s *scenarios.Scenarios, builders []api.Builder, settings envsettings.Settings, ...) *cobra.Command
• func LogFilePathOrDefault(customPath, runName string) string
• type Result
  • func NewResult(runOptions options.RunOptions, views *views.Views, ...) *Result
  • func (r *Result) AddError(err error) *Result
  • func (r *Result) Error() error
  • func (r *Result) Failed() bool
  • func (r *Result) GetTotals()
  • func (r *Result) HasDroppedIterations() bool
  • func (r *Result) Interrupted() *views.ViewContext[views.InterruptData]
  • func (r *Result) MaxDurationElapsed() *views.ViewContext[views.TimeoutData]
  • func (r *Result) MaxIterationsReached() *views.ViewContext[views.MaxIterationsReachedData]
  • func (r *Result) Progress() *views.ViewContext[views.ProgressData]
  • func (r *Result) RecordStarted()
  • func (r *Result) RecordTestFinished()
  • func (r *Result) Setup() *views.ViewContext[views.SetupData]
  • func (r *Result) Snapshot() progress.Snapshot
  • func (r *Result) SnapshotProgress(period time.Duration)
  • func (r *Result) Summary() *views.ViewContext[views.ResultData]
  • func (r *Result) Teardown() *views.ViewContext[views.TeardownData]
• type Run
  • func NewRun(options options.RunOptions, scenarios *scenarios.Scenarios, ...) (*Run, error)
  • func (r *Run) Do(ctx context.Context) (*Result, error)
• type ScenarioLogger
  • func NewScenarioLogger(output *ui.Output) *ScenarioLogger
  • func (s *ScenarioLogger) Close() error
  • func (s *ScenarioLogger) Open(logFilePath string, logConfig *log.Config, runName string, logToFile bool) string

Functions

func Cmd

func Cmd(
	s *scenarios.Scenarios,
	builders []api.Builder,
	settings envsettings.Settings,
	metricsInstance *metrics.Metrics,
	output *ui.Output,
) *cobra.Command

func LogFilePathOrDefault

func LogFilePathOrDefault(customPath, runName string) string

Types

type Result

type Result struct {
	LogFilePath string

	TestDuration time.Duration
	// contains filtered or unexported fields
}

func NewResult

func NewResult(
	runOptions options.RunOptions,
	views *views.Views,
	progressStats *progress.Stats,
) *Result

func (*Result) AddError

func (r *Result) AddError(err error) *Result

func (*Result) Error

func (r *Result) Error() error

func (*Result) Failed

func (r *Result) Failed() bool

func (*Result) GetTotals

func (r *Result) GetTotals()

func (*Result) HasDroppedIterations

func (r *Result) HasDroppedIterations() bool

func (*Result) Interrupted

func (r *Result) Interrupted() *views.ViewContext[views.InterruptData]

func (*Result) MaxDurationElapsed

func (r *Result) MaxDurationElapsed() *views.ViewContext[views.TimeoutData]

func (*Result) MaxIterationsReached

func (r *Result) MaxIterationsReached() *views.ViewContext[views.MaxIterationsReachedData]

func (*Result) Progress

func (r *Result) Progress() *views.ViewContext[views.ProgressData]

func (*Result) RecordStarted

func (r *Result) RecordStarted()

func (*Result) RecordTestFinished

func (r *Result) RecordTestFinished()

func (*Result) Setup

func (r *Result) Setup() *views.ViewContext[views.SetupData]

func (*Result) Snapshot

func (r *Result) Snapshot() progress.Snapshot

func (*Result) SnapshotProgress

func (r *Result) SnapshotProgress(period time.Duration)

func (*Result) Summary

func (r *Result) Summary() *views.ViewContext[views.ResultData]

func (*Result) Teardown

func (r *Result) Teardown() *views.ViewContext[views.TeardownData]

type Run

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

func NewRun

func NewRun(
	options options.RunOptions,
	scenarios *scenarios.Scenarios,
	trigger *api.Trigger,
	waitForCompletionTimeout time.Duration,
	settings envsettings.Settings,
	metricsInstance *metrics.Metrics,
	parentOutput *ui.Output,
) (*Run, error)

func (*Run) Do

func (r *Run) Do(ctx context.Context) (*Result, error)

type ScenarioLogger

type ScenarioLogger struct {
	Logger *slog.Logger
	// contains filtered or unexported fields
}

func NewScenarioLogger

func NewScenarioLogger(output *ui.Output) *ScenarioLogger

func (*ScenarioLogger) Close

func (s *ScenarioLogger) Close() error

func (*ScenarioLogger) Open

func (s *ScenarioLogger) Open(logFilePath string, logConfig *log.Config, runName string, logToFile bool) string