Documentation
¶
Index ¶
Constants ¶
const ( // DefaultDefaultTitle is a default title for terraform commands DefaultDefaultTitle = "## Terraform result" // DefaultFmtTitle is a default title for terraform fmt DefaultFmtTitle = "## Fmt result" // DefaultValidateTitle is a default title for terraform validate DefaultValidateTitle = "## Validate result" // DefaultPlanTitle is a default title for terraform plan DefaultPlanTitle = "## Plan result" // DefaultDestroyWarningTitle is a default title of destroy warning DefaultDestroyWarningTitle = "## WARNING: Resource Deletion will happen" // DefaultApplyTitle is a default title for terraform apply DefaultApplyTitle = "## Apply result" // DefaultDefaultTemplate is a default template for terraform commands DefaultDefaultTemplate = `` /* 189-byte string literal not displayed */ // DefaultFmtTemplate is a default template for terraform fmt DefaultFmtTemplate = `` /* 189-byte string literal not displayed */ // DefaultValidateTemplate is a default template for terraform validate DefaultValidateTemplate = `` /* 189-byte string literal not displayed */ // DefaultPlanTemplate is a default template for terraform plan DefaultPlanTemplate = `` /* 189-byte string literal not displayed */ // DefaultDestroyWarningTemplate is a default template for terraform plan DefaultDestroyWarningTemplate = `` /* 169-byte string literal not displayed */ // DefaultApplyTemplate is a default template for terraform apply DefaultApplyTemplate = `` /* 189-byte string literal not displayed */ )
const ( // ExitPass is status code zero ExitPass int = iota // ExitFail is status code non-zero ExitFail )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplyParser ¶
ApplyParser is a parser for terraform apply
func NewApplyParser ¶
func NewApplyParser() *ApplyParser
NewApplyParser is ApplyParser initialized with its Regexp
func (*ApplyParser) Parse ¶
func (p *ApplyParser) Parse(body string) ParseResult
Parse returns ParseResult related with terraform apply
type ApplyTemplate ¶
type ApplyTemplate struct {
Template string
CommonTemplate
}
ApplyTemplate is a default template for terraform apply
func NewApplyTemplate ¶
func NewApplyTemplate(template string) *ApplyTemplate
NewApplyTemplate is ApplyTemplate initializer
func (*ApplyTemplate) Execute ¶
func (t *ApplyTemplate) Execute() (string, error)
Execute binds the execution result of terraform apply into template
func (*ApplyTemplate) GetValue ¶
func (t *ApplyTemplate) GetValue() CommonTemplate
GetValue gets template entities
func (*ApplyTemplate) SetValue ¶
func (t *ApplyTemplate) SetValue(ct CommonTemplate)
SetValue sets template entities about terraform apply to CommonTemplate
type CommonTemplate ¶
type CommonTemplate struct {
Title string
Message string
Result string
Body string
Link string
UseRawOutput bool
}
CommonTemplate represents template entities
type DefaultParser ¶
type DefaultParser struct {
}
DefaultParser is a parser for terraform commands
func NewDefaultParser ¶
func NewDefaultParser() *DefaultParser
NewDefaultParser is DefaultParser initializer
func (*DefaultParser) Parse ¶
func (p *DefaultParser) Parse(body string) ParseResult
Parse returns ParseResult related with terraform commands
type DefaultTemplate ¶
type DefaultTemplate struct {
Template string
CommonTemplate
}
DefaultTemplate is a default template for terraform commands
func NewDefaultTemplate ¶
func NewDefaultTemplate(template string) *DefaultTemplate
NewDefaultTemplate is DefaultTemplate initializer
func (*DefaultTemplate) Execute ¶
func (t *DefaultTemplate) Execute() (string, error)
Execute binds the execution result of terraform command into template
func (*DefaultTemplate) GetValue ¶
func (t *DefaultTemplate) GetValue() CommonTemplate
GetValue gets template entities
func (*DefaultTemplate) SetValue ¶
func (t *DefaultTemplate) SetValue(ct CommonTemplate)
SetValue sets template entities to CommonTemplate
type DestroyWarningTemplate ¶ added in v0.4.0
type DestroyWarningTemplate struct {
Template string
CommonTemplate
}
DestroyWarningTemplate is a default template for warning of destroy operation in plan
func NewDestroyWarningTemplate ¶ added in v0.4.0
func NewDestroyWarningTemplate(template string) *DestroyWarningTemplate
NewDestroyWarningTemplate is DestroyWarningTemplate initializer
func (*DestroyWarningTemplate) Execute ¶ added in v0.4.0
func (t *DestroyWarningTemplate) Execute() (string, error)
Execute binds the execution result of terraform plan into template
func (*DestroyWarningTemplate) GetValue ¶ added in v0.4.0
func (t *DestroyWarningTemplate) GetValue() CommonTemplate
GetValue gets template entities
func (*DestroyWarningTemplate) SetValue ¶ added in v0.4.0
func (t *DestroyWarningTemplate) SetValue(ct CommonTemplate)
SetValue sets template entities about destroy warning to CommonTemplate
type FmtParser ¶
FmtParser is a parser for terraform fmt
func NewFmtParser ¶
func NewFmtParser() *FmtParser
NewFmtParser is FmtParser initialized with its Regexp
func (*FmtParser) Parse ¶
func (p *FmtParser) Parse(body string) ParseResult
Parse returns ParseResult related with terraform fmt
type FmtTemplate ¶
type FmtTemplate struct {
Template string
CommonTemplate
}
FmtTemplate is a default template for terraform fmt
func NewFmtTemplate ¶
func NewFmtTemplate(template string) *FmtTemplate
NewFmtTemplate is FmtTemplate initializer
func (*FmtTemplate) Execute ¶
func (t *FmtTemplate) Execute() (string, error)
Execute binds the execution result of terraform fmt into template
func (*FmtTemplate) GetValue ¶
func (t *FmtTemplate) GetValue() CommonTemplate
GetValue gets template entities
func (*FmtTemplate) SetValue ¶
func (t *FmtTemplate) SetValue(ct CommonTemplate)
SetValue sets template entities about terraform fmt to CommonTemplate
type ParseResult ¶
type ParseResult struct {
Result string
HasAddOrUpdateOnly bool
HasDestroy bool
HasNoChanges bool
HasPlanError bool
ExitCode int
Error error
}
ParseResult represents the result of parsed terraform execution
type Parser ¶
type Parser interface {
Parse(body string) ParseResult
}
Parser is an interface for parsing terraform execution result
type PlanParser ¶
type PlanParser struct {
Pass *regexp.Regexp
Fail *regexp.Regexp
HasDestroy *regexp.Regexp
HasNoChanges *regexp.Regexp
}
PlanParser is a parser for terraform plan
func NewPlanParser ¶
func NewPlanParser() *PlanParser
NewPlanParser is PlanParser initialized with its Regexp
func (*PlanParser) Parse ¶
func (p *PlanParser) Parse(body string) ParseResult
Parse returns ParseResult related with terraform plan
type PlanTemplate ¶
type PlanTemplate struct {
Template string
CommonTemplate
}
PlanTemplate is a default template for terraform plan
func NewPlanTemplate ¶
func NewPlanTemplate(template string) *PlanTemplate
NewPlanTemplate is PlanTemplate initializer
func (*PlanTemplate) Execute ¶
func (t *PlanTemplate) Execute() (string, error)
Execute binds the execution result of terraform plan into template
func (*PlanTemplate) GetValue ¶
func (t *PlanTemplate) GetValue() CommonTemplate
GetValue gets template entities
func (*PlanTemplate) SetValue ¶
func (t *PlanTemplate) SetValue(ct CommonTemplate)
SetValue sets template entities about terraform plan to CommonTemplate
type Template ¶
type Template interface {
Execute() (resp string, err error)
SetValue(template CommonTemplate)
GetValue() CommonTemplate
}
Template is an template interface for parsed terraform execution result
type ValidateParser ¶ added in v0.8.0
ValidateParser is a parser for terraform Validate
func NewValidateParser ¶ added in v0.8.0
func NewValidateParser() *ValidateParser
NewValidateParser is ValidateParser initialized with its Regexp
func (*ValidateParser) Parse ¶ added in v0.8.0
func (p *ValidateParser) Parse(body string) ParseResult
Parse returns ParseResult related with terraform validate
type ValidateTemplate ¶ added in v0.8.0
type ValidateTemplate struct {
Template string
CommonTemplate
}
ValidateTemplate is a default template for terraform validate
func NewValidateTemplate ¶ added in v0.8.0
func NewValidateTemplate(template string) *ValidateTemplate
NewValidateTemplate is ValidateTemplate initializer
func (*ValidateTemplate) Execute ¶ added in v0.8.0
func (t *ValidateTemplate) Execute() (string, error)
Execute binds the execution result of terraform validate into template
func (*ValidateTemplate) GetValue ¶ added in v0.8.0
func (t *ValidateTemplate) GetValue() CommonTemplate
GetValue gets template entities
func (*ValidateTemplate) SetValue ¶ added in v0.8.0
func (t *ValidateTemplate) SetValue(ct CommonTemplate)
SetValue sets template entities about terraform validate to CommonTemplate
Source Files