scenarios

Documentation

Index

• Variables
• func ContextValues(ctx context.Context) []context.Context
• func JoinContexts(ctx context.Context, others ...context.Context) context.Context
• func MustRegisterStepHandlers(handlers ...stepHandler)
• func Param[P any](ctx context.Context, name string) (P, bool)
• func RegisterStepHandlers(handlers ...stepHandler) error
• func Run(ctx context.Context, scenarios ...*Scenario) error
• func StepHandler(handler interface{}, matchExpressions ...string) stepHandler
• type AfterScenarioHook
• type AfterStepHook
• type BeforeScenarioHook
• type BeforeStepHook
• type CompoundContext
  • func (join *CompoundContext) Err() error
  • func (join *CompoundContext) Value(key interface{}) interface{}
• type Context
  • func WithParam(ctx context.Context, name string, value interface{}) Context
• type Options
• type Params
• type Scenario
• type ScenarioError
  • func NewScenarioError(err error, result ScenarioResult, cause error) *ScenarioError
  • func (e *ScenarioError) Error() string
  • func (e *ScenarioError) Unwrap() error
• type ScenarioResult
• type Scenarios
  • func (s Scenarios) Run(ctx context.Context, scenarioNames ...string) error
• type SimulationContext
• type SimulationInitializer
• type Step
• type StepResult
  • func NewStepResult(scenarioId string, step *Step) StepResult
• type StepStatus
  • func (st StepStatus) String() string

Variables

var (
	ErrUnmatchedStepArgumentNumber = errors.New("func received more arguments than expected")
	ErrCannotConvert               = errors.New("cannot convert argument")
	ErrUnsupportedArgumentType     = errors.New("unsupported argument type")
)

var ErrUndefined = errors.New("step is undefined")

ErrUndefined is returned in case if step definition was not found

var TimeNowFunc = time.Now

Functions

func ContextValues

func ContextValues(ctx context.Context) []context.Context

func JoinContexts

func JoinContexts(ctx context.Context, others ...context.Context) context.Context

func MustRegisterStepHandlers

func MustRegisterStepHandlers(handlers ...stepHandler)

func Param

func Param[P any](ctx context.Context, name string) (P, bool)

func RegisterStepHandlers

func RegisterStepHandlers(handlers ...stepHandler) error

func Run

func Run(ctx context.Context, scenarios ...*Scenario) error

func StepHandler

func StepHandler(handler interface{}, matchExpressions ...string) stepHandler

Types

type AfterScenarioHook

type AfterScenarioHook func(context.Context, *Scenario, error) (context.Context, error)

type AfterStepHook

type AfterStepHook func(context.Context, *Step, StepStatus, error) (context.Context, error)

type BeforeScenarioHook

type BeforeScenarioHook func(context.Context, *Scenario) (context.Context, error)

type BeforeStepHook

type BeforeStepHook func(context.Context, *Step) (context.Context, error)

type CompoundContext

type CompoundContext struct {
	context.Context
	// contains filtered or unexported fields
}

func (*CompoundContext) Err

func (join *CompoundContext) Err() error

func (*CompoundContext) Value

func (join *CompoundContext) Value(key interface{}) interface{}

type Context

type Context interface {
	devnet.Context
	WithParam(name string, value interface{}) Context
}

func WithParam

func WithParam(ctx context.Context, name string, value interface{}) Context

type Options

type Options struct {
	Concurrency int
}

type Params

type Params map[string]interface{}

type Scenario

type Scenario struct {
	Context     devnet.Context `json:"-"`
	Id          string         `json:"id"`
	Name        string         `json:"name"`
	Description string         `json:"description,omitempty"`
	Steps       []*Step        `json:"steps"`
}

type ScenarioError

type ScenarioError struct {
	Result ScenarioResult
	Cause  error
	// contains filtered or unexported fields
}

func NewScenarioError

func NewScenarioError(err error, result ScenarioResult, cause error) *ScenarioError

func (*ScenarioError) Error

func (e *ScenarioError) Error() string

func (*ScenarioError) Unwrap

func (e *ScenarioError) Unwrap() error

type ScenarioResult

type ScenarioResult struct {
	ScenarioId string
	StartedAt  time.Time

	StepResults []StepResult
}

type Scenarios

type Scenarios map[string]*Scenario

func (Scenarios) Run

func (s Scenarios) Run(ctx context.Context, scenarioNames ...string) error

type SimulationContext

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

type SimulationInitializer

type SimulationInitializer func(*SimulationContext)

type Step

type Step struct {
	Id          string        `json:"id"`
	Args        []interface{} `json:"args,omitempty"`
	Text        string        `json:"text"`
	Description string        `json:"description,omitempty"`
}

type StepResult

type StepResult struct {
	Status     StepStatus
	FinishedAt time.Time
	Err        error
	Returns    []interface{}
	ScenarioId string

	Step *Step
}

func NewStepResult

func NewStepResult(scenarioId string, step *Step) StepResult

type StepStatus

type StepStatus int

const (
	Passed StepStatus = iota
	Failed
	Skipped
	Undefined
	Pending
)

func (StepStatus) String

func (st StepStatus) String() string

String ...