report

Documentation

Index

• type Result
• type Summary
  • func NewSummary(w io.Writer) *Summary
  • func (s *Summary) AddFailedApp(org, space, app string, err error)
  • func (s *Summary) AddSuccessfulApp(org, space, app string)
  • func (s *Summary) AppFailureCount() int
  • func (s *Summary) AppSuccessCount() int
  • func (s *Summary) Display()
  • func (s *Summary) Duration() time.Duration
  • func (s *Summary) Results() []Result
  • func (s *Summary) SetDuration(duration time.Duration)

Types

type Result

type Result struct {
	OrgName   string
	SpaceName string
	AppName   string
	Message   string
}

Result is a specific app migration result: success or failure

type Summary

type Summary struct {
	TableWriter io.Writer
	// contains filtered or unexported fields
}

Summary is a thread safe sink of execution results for app migrations

func NewSummary

func NewSummary(w io.Writer) *Summary

NewSummary creates a new initialized summary instance

func (*Summary) AddFailedApp

func (s *Summary) AddFailedApp(org, space, app string, err error)

AddFailedApp adds a failed app along with its error to the summary result

func (*Summary) AddSuccessfulApp

func (s *Summary) AddSuccessfulApp(org, space, app string)

AddSuccessfulApp adds a successful app and increments the count of successful apps

func (*Summary) AppFailureCount

func (s *Summary) AppFailureCount() int

AppFailureCount is the number of total app failures that have occurred

func (*Summary) AppSuccessCount

func (s *Summary) AppSuccessCount() int

AppSuccessCount is the number of total app successes that have occurred

func (*Summary) Display

func (s *Summary) Display()

func (*Summary) Duration

func (s *Summary) Duration() time.Duration

func (*Summary) Results

func (s *Summary) Results() []Result

Results returns a copy of all the app migrations that have occurred

func (*Summary) SetDuration

func (s *Summary) SetDuration(duration time.Duration)