runner

Documentation

Index

• Constants
• Variables
• type Config
• type MetricsAggregate
• type MetricsField
• type MetricsTimeStats
• type MetricsValue
• type RecorderConfig
• type RecordingProgress
• type RecordingStatus
• type Report
• type ReportMetadata
• type RequestBody
• type RequestConfig
• type Runner
  • func New(onRecordingProgress func(RecordingProgress)) *Runner
  • func (r *Runner) Progress() RecordingProgress
  • func (r *Runner) Run(ctx context.Context, cfg config.Global) (*Report, error)
• type TestCase
• type TestCaseResult
• type TestPredicate
• type TestSuiteResults

Constants

const (
	StatusRunning  = recorder.StatusRunning
	StatusCanceled = recorder.StatusCanceled
	StatusTimeout  = recorder.StatusTimeout
	StatusDone     = recorder.StatusDone

	ConfigFieldMethod         = config.FieldMethod
	ConfigFieldURL            = config.FieldURL
	ConfigFieldHeader         = config.FieldHeader
	ConfigFieldBody           = config.FieldBody
	ConfigFieldRequests       = config.FieldRequests
	ConfigFieldConcurrency    = config.FieldConcurrency
	ConfigFieldInterval       = config.FieldInterval
	ConfigFieldRequestTimeout = config.FieldRequestTimeout
	ConfigFieldGlobalTimeout  = config.FieldGlobalTimeout
	ConfigFieldTests          = config.FieldTests
)

Variables

var (
	DefaultConfig     = config.Default
	ConfigFieldsUsage = config.FieldsUsage
	NewRequestBody    = config.NewRequestBody
	IsConfigField     = config.IsField
)

Types

type Config

type Config = config.Global

type MetricsAggregate

type MetricsAggregate = metrics.Aggregate

type MetricsField

type MetricsField = metrics.Field

type MetricsTimeStats

type MetricsTimeStats = metrics.TimeStats

type MetricsValue

type MetricsValue = metrics.Value

type RecorderConfig

type RecorderConfig = config.Runner

type RecordingProgress

type RecordingProgress = recorder.Progress

type RecordingStatus

type RecordingStatus = recorder.Status

type Report

type Report = report.Report

type ReportMetadata

type ReportMetadata = report.Metadata

type RequestBody

type RequestBody = config.RequestBody

type RequestConfig

type RequestConfig = config.Request

type Runner

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

func New

func New(onRecordingProgress func(RecordingProgress)) *Runner

func (*Runner) Progress

func (r *Runner) Progress() RecordingProgress

Progress returns the current progress of the recording. r.Run must have been called before, otherwise it returns a zero RecorderProgress.

func (*Runner) Run

func (r *Runner) Run(ctx context.Context, cfg config.Global) (*Report, error)

type TestCase

type TestCase = tests.Case

type TestCaseResult

type TestCaseResult = tests.CaseResult

type TestPredicate

type TestPredicate = tests.Predicate

type TestSuiteResults

type TestSuiteResults = tests.SuiteResult