common

Documentation

Overview

Package common contains common constants and variables.

Index

• Constants
• func GetDefaultScenarios() []scenario.Scenario
• func GetScenarioNames() (names []string)
• func GetScenarios() map[string]scenario.Scenario
• func RegisterScenario(s scenario.Scenario, d bool) error

Constants

const (
	CfgLogFmt             = "log.format"
	CfgLogLevel           = "log.level"
	CfgScenarioRegex      = "scenario"
	CfgScenarioRegexShort = "s"
	CfgScenarioSkipRegex  = "skip"

	// ScenarioParamsMask is the form of parameters passed to specific scenario.
	//
	// [1] parameter is scenario name, [2] parameter is a parameter name. This
	// is used when binding and parsing (recursive) parameters with viper.
	ScenarioParamsMask = "%[1]s.%[2]s"
)

Functions

func GetDefaultScenarios

func GetDefaultScenarios() []scenario.Scenario

GetDefaultScenarios returns all registered default scenarios.

This function *is not* thread-safe.

func GetScenarioNames

func GetScenarioNames() (names []string)

GetScenarioNames returns the names of all scenarios. NOTE: Scenarios are sorted alphabetically.

func GetScenarios

func GetScenarios() map[string]scenario.Scenario

GetScenarios returns all registered scenarios.

This function *is not* thread-safe.

func RegisterScenario

func RegisterScenario(s scenario.Scenario, d bool) error

RegisterScenario adds given scenario to the map of all scenarios and optionally appends it to default scenarios list.

This function *is not* thread-safe.