Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Engine ¶
type Engine struct {
Configuration EngineConfiguration
}
func NewEngine ¶
func NewEngine(configuration EngineConfiguration) (*Engine, error)
/ Create a new engine instance.
func (*Engine) ExecuteAndRenderSteps ¶
Executes the steps from a scenario and renders the output to the terminal.
func (*Engine) ExecuteScenario ¶
Executes a deployment scenario.
func (*Engine) TestScenario ¶
Validates a deployment scenario.
type EngineConfiguration ¶
type EngineConfiguration struct {
Verbose bool
DoNotDelete bool
CorrelationId string
Subscription string
Environment string
WorkingDirectory string
RenderValues bool
}
Configuration for the engine.
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) OverwriteEnvironmentVariables ¶
func (*Scenario) ToShellScript ¶
Convert a scenario into a shell script
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.