scenarios

Documentation

Index

• type ScenarioRegistration
• type ScenarioRegistry
  • func NewScenarioRegistry() ScenarioRegistry
• type TerraformInputVarsHook
• type ValidateHook

Types

type ScenarioRegistration

type ScenarioRegistration struct {
	// The name of the scenario. This name should match the value
	// of TEST_SCENARIO environment variable which the test uses
	// to determine the scenario to run.
	Name string

	// The name of the example's folder under the `examples/` directory
	FolderName string

	// List of TF variables that needs to be supplied to the
	// example's terraform config.
	TerraformInputVars TerraformInputVarsHook

	// Validate is the hook called when validations need to be performed on the deployment. This
	// hook will only be called after a successful terraform apply.
	Validate ValidateHook
}

ScenarioRegistration is the struct we expect each individual scenario to use and register themselves by providing valid lifecycle hooks

type ScenarioRegistry

type ScenarioRegistry interface {
	// Register registers a scenario into the registry
	Register(ScenarioRegistration)

	// Retrieve retrieves a scenario from the registry
	Retrieve(name string) (ScenarioRegistration, error)
}

ScenarioRegistry helps us interact with the actual registry that holds details about the scenarios.

func NewScenarioRegistry

func NewScenarioRegistry() ScenarioRegistry

type TerraformInputVarsHook

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

type ValidateHook

type ValidateHook func(*testing.T, []byte)