common

Documentation

Index

• Variables
• func ActionStrings() []string
• func Actions() map[string]interface{}
• func Exit(err error, code int)
• func Fields() (map[string]interface{}, error)
• func FieldsString() ([]string, error)
• func JsonTagName(tag reflect.StructTag) (string, bool)
• func Keys(m map[string]DocEntry) []string
• func ReadFile(path string) ([]byte, error)
• func Schedulers() map[string]interface{}
• type DocEntry
• type DummyScheduler
  • func (dummy DummyScheduler) Execute(context.Context, *logger.Log, time.Duration, []scenario.Action, string, ...) error
  • func (dummy DummyScheduler) PopulateHookData(data map[string]interface{})
  • func (dummy DummyScheduler) RequireScenario() bool
  • func (dummy DummyScheduler) Validate() ([]string, error)
• type GroupsEntry

Variables

var (
	// IgnoreActions list of "helper" actions to be ignored for documentation
	IgnoreActions = []string{"connectws"}
)

Shared global variables for compile and generate documentation

Functions

func ActionStrings

func ActionStrings() []string

ActionStrings all registered actions

func Actions

func Actions() map[string]interface{}

Actions all registered actions with action settings

func Exit

func Exit(err error, code int)

Exit prints errors message and exits program with code

func Fields

func Fields() (map[string]interface{}, error)

Fields config fields sections with objects

func FieldsString

func FieldsString() ([]string, error)

FieldsString config fields sections

func JsonTagName

func JsonTagName(tag reflect.StructTag) (string, bool)

func Keys

func Keys(m map[string]DocEntry) []string

Keys returns a sorted slice of map keys

func ReadFile

func ReadFile(path string) ([]byte, error)

ReadFile into memory

func Schedulers

func Schedulers() map[string]interface{}

Types

type DocEntry

type DocEntry struct {
	// Description Information preceding parameters
	Description string
	// Examples Information subsequent to parameters
	Examples string
}

DocEntry contains strings and examples

type DummyScheduler

type DummyScheduler struct{}

func (DummyScheduler) Execute

func (dummy DummyScheduler) Execute(context.Context, *logger.Log, time.Duration, []scenario.Action, string, users.UserGenerator, *connection.ConnectionSettings, *statistics.ExecutionCounters) error

func (DummyScheduler) PopulateHookData

func (dummy DummyScheduler) PopulateHookData(data map[string]interface{})

func (DummyScheduler) RequireScenario

func (dummy DummyScheduler) RequireScenario() bool

func (DummyScheduler) Validate

func (dummy DummyScheduler) Validate() ([]string, error)

type GroupsEntry

type GroupsEntry struct {
	// Name of the group
	Name string
	// Title of the group (as used in documentation
	Title string
	// Actions contained in the group
	Actions []string
	DocEntry
}

GroupsEntry definition of group of actions