runner

Documentation

Index

• type Opt
  • func WithDiagnostics(ds ...diagnostics.Diagnostic) Opt
  • func WithMatchingTags(tagFilters []diagnostics.TagFilter) Opt
  • func WithSkipCleanupPhase(skip bool) Opt
  • func WithSkipGeneratePhase(skip bool) Opt
  • func WithSkipVerifyPhase(skip bool) Opt
  • func WithTestContext(tstContext diagnostics.TestContext) Opt
• type Reporter
  • func NewDefaultReporter() Reporter
• type Runner
  • func New(opts ...Opt) *Runner
  • func (r *Runner) Run() error

Types

type Opt

type Opt func(*Runner)

Opt are functional optionals for Runner

func WithDiagnostics

func WithDiagnostics(ds ...diagnostics.Diagnostic) Opt

WithDiagnostics sets the diagnostics the runner will use. If not set, it will use all registered ones

func WithMatchingTags

func WithMatchingTags(tagFilters []diagnostics.TagFilter) Opt

func WithSkipCleanupPhase

func WithSkipCleanupPhase(skip bool) Opt

WithSkipCleanupPhase will skip the cleanup phase if set to true. Defaults to false

func WithSkipGeneratePhase

func WithSkipGeneratePhase(skip bool) Opt

WithSkipGeneratePhase will skip the generate phase if set to true. Defaults to false

func WithSkipVerifyPhase

func WithSkipVerifyPhase(skip bool) Opt

WithSkipVerifyPhase will skip the verify phase if set to true. Defaults to false

func WithTestContext

func WithTestContext(tstContext diagnostics.TestContext) Opt

WithTestContext sets the test context to use. The default one will not be able to talk to deployment service

type Reporter

type Reporter interface {
	ReportGenerateSkip(componentName, msg string)
	ReportGenerateSkipErrored(componentName, msg string)
	ReportGenerateStart(componentName string)
	ReportGenerateSuccess(componentName string)
	ReportGenerateErrored(componentName, msg string)

	ReportVerifySkip(componentName, msg string)
	ReportVerifySkipErrored(componentName, msg string)
	ReportVerifyStart(componentName string)
	ReportVerifyFinish(componentName string)
	ReportVerifyFailure(componentName, msg string)

	ReportCleanupSkip(componentName, msg string)
	ReportCleanupSkipErrored(componentName, msg string)
	ReportCleanupStart(componentName string)
	ReportCleanupSuccess(componentName string)
	ReportCleanupErrored(componentName, msg string)

	SummarizeFailures()
}

A Reporter is used to report runner lifecycle events

func NewDefaultReporter

func NewDefaultReporter() Reporter

NewDefaultReporter creates a reporter that pretty prints messages and does all the fancy progress spinner stuff

type Runner

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

Runner is responsible for running diagnostics

func New

func New(opts ...Opt) *Runner

New returns a new Runner

func (*Runner) Run

func (r *Runner) Run() error

Run runs the diagnostics