engine

Documentation

Index

• func ExecuteCodeBlockAsync(codeBlock parsers.CodeBlock, env map[string]string) tea.Cmd
• func ExecuteCodeBlockSync(codeBlock parsers.CodeBlock, env map[string]string) tea.Msg
• type AzureStatusUpdatedMessage
• type CodeBlockState
• type Engine
  • func NewEngine(configuration EngineConfiguration) (*Engine, error)
  • func (e *Engine) ExecuteAndRenderSteps(steps []Step, env map[string]string) error
  • func (e *Engine) ExecuteScenario(scenario *Scenario) error
  • func (e *Engine) InteractWithScenario(scenario *Scenario) error
  • func (e *Engine) TestScenario(scenario *Scenario) error
  • func (e *Engine) TestSteps(steps []Step, env map[string]string) error
• type EngineConfiguration
• type FailedCommandMessage
• type InteractiveModeCommands
• type InteractiveModeModel
  • func NewInteractiveModeModel(title string, engine *Engine, steps []Step, env map[string]string) (InteractiveModeModel, error)
  • func (model InteractiveModeModel) Init() tea.Cmd
  • func (model InteractiveModeModel) Update(message tea.Msg) (tea.Model, tea.Cmd)
  • func (model InteractiveModeModel) View() string
• type Scenario
  • func CreateScenarioFromMarkdown(path string, languagesToExecute []string, ...) (*Scenario, error)
  • func (s *Scenario) ToShellScript() string
• type Step
• type SuccessfulCommandMessage

Functions

func ExecuteCodeBlockAsync

func ExecuteCodeBlockAsync(codeBlock parsers.CodeBlock, env map[string]string) tea.Cmd

Executes a bash command and returns a tea message with the output. This function will be executed asycnhronously.

func ExecuteCodeBlockSync

func ExecuteCodeBlockSync(codeBlock parsers.CodeBlock, env map[string]string) tea.Msg

Executes a bash command syncrhonously. This function will block until the command finishes executing.

Types

type AzureStatusUpdatedMessage

type AzureStatusUpdatedMessage struct{}

Empty struct used to indicate that the azure status has been updated so that we can respond to it within the Update() function.

type CodeBlockState

type CodeBlockState struct {
	CodeBlock       parsers.CodeBlock
	CodeBlockNumber int
	Error           error
	StdErr          string
	StdOut          string
	StepName        string
	StepNumber      int
	Success         bool
}

State for the codeblock in interactive mode. Used to keep track of the state of each codeblock.

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 []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 *Scenario) error

Executes a deployment scenario.

func (*Engine) InteractWithScenario

func (e *Engine) InteractWithScenario(scenario *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 *Scenario) error

Validates a deployment scenario.

func (*Engine) TestSteps

func (e *Engine) TestSteps(steps []Step, env map[string]string) error

type EngineConfiguration

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

Configuration for the engine.

type FailedCommandMessage

type FailedCommandMessage struct {
	StdOut string
	StdErr string
	Error  error
}

Emitted when a command has failed to execute.

type InteractiveModeCommands

type InteractiveModeCommands struct {
	// contains filtered or unexported fields
}

type InteractiveModeModel

type InteractiveModeModel struct {
	// contains filtered or unexported fields
}

func NewInteractiveModeModel

func NewInteractiveModeModel(
	title string,
	engine *Engine,
	steps []Step,
	env map[string]string,
) (InteractiveModeModel, error)

Create a new interactive mode model.

func (InteractiveModeModel) Init

func (model InteractiveModeModel) Init() tea.Cmd

Initialize the intractive mode model

func (InteractiveModeModel) Update

func (model InteractiveModeModel) Update(message tea.Msg) (tea.Model, tea.Cmd)

Updates the intractive mode model

func (InteractiveModeModel) View

func (model InteractiveModeModel) View() string

Renders the interactive mode model.

type Scenario

type Scenario struct {
	Name        string
	MarkdownAst ast.Node
	Steps       []Step
	Environment map[string]string
}

Scenarios are the top-level object that represents a scenario to be executed.

func CreateScenarioFromMarkdown

func CreateScenarioFromMarkdown(
	path string,
	languagesToExecute []string,
	environmentVariableOverrides map[string]string,
) (*Scenario, error)

Creates a scenario object from a given markdown file. languagesToExecute is used to filter out code blocks that should not be parsed out of the markdown file.

func (*Scenario) ToShellScript

func (s *Scenario) ToShellScript() string

Convert a scenario into a shell script

type Step

type Step struct {
	Name       string
	CodeBlocks []parsers.CodeBlock
}

Individual steps within a scenario.

type SuccessfulCommandMessage

type SuccessfulCommandMessage struct {
	StdOut string
	StdErr string
}

Emitted when a command has been executed successfully.