experiment

Documentation

Index

• func RegisterScenario(s Scenario)
• type Scenario
  • func GetAllScenarios() []Scenario
  • func GetScenario(s string) Scenario

Functions

func RegisterScenario

func RegisterScenario(s Scenario)

RegisterScenario registers a new scenario in the registry.

Types

type Scenario

type Scenario interface {
	// Name returns the name of the scenario.
	Name() string
	// Description returns the description of the scenario.
	Description() string
	// LongDescription returns the description of the scenario.
	LongDescription() string
	// Done is closed once the scenario is finished.
	Done() <-chan struct{}
	// AddToManager adds all runnables of the scenario to the manager.
	AddToManager(manager.Manager) error
}

Scenario is an evaluation scenario that can be executed by experiment.

func GetAllScenarios

func GetAllScenarios() []Scenario

GetAllScenarios returns all registered scenarios.

func GetScenario

func GetScenario(s string) Scenario

GetScenario gets a single registered scenario by name.