engine

Documentation

Index

• type Engine
  • func NewEngine(configuration EngineConfiguration) (*Engine, error)
  • func (e *Engine) ExecuteAndRenderSteps(steps []common.Step, env map[string]string) error
  • func (e *Engine) ExecuteScenario(scenario *common.Scenario) error
  • func (e *Engine) InteractWithScenario(scenario *common.Scenario) error
  • func (e *Engine) TestScenario(scenario *common.Scenario) error
• type EngineConfiguration

Types

type Engine

type Engine struct {
	Configuration EngineConfiguration
}

func NewEngine

func NewEngine(configuration EngineConfiguration) (*Engine, error)

/ Create a new engine instance.

func (*Engine) ExecuteAndRenderSteps

func (e *Engine) ExecuteAndRenderSteps(steps []common.Step, env map[string]string) error

Executes the steps from a scenario and renders the output to the terminal.

func (*Engine) ExecuteScenario

func (e *Engine) ExecuteScenario(scenario *common.Scenario) error

Executes a markdown scenario.

func (*Engine) InteractWithScenario

func (e *Engine) InteractWithScenario(scenario *common.Scenario) error

Executes a Scenario in interactive mode. This mode goes over each codeblock step by step and allows the user to interact with the codeblock.

func (*Engine) TestScenario

func (e *Engine) TestScenario(scenario *common.Scenario) error

Executes a scenario in testing moe. This mode goes over each code block and executes it without user interaction.

type EngineConfiguration

type EngineConfiguration struct {
	Verbose          bool
	DoNotDelete      bool
	CorrelationId    string
	Subscription     string
	Environment      string
	WorkingDirectory string
	RenderValues     bool
	ReportFile       string
}

Configuration for the engine.