utility

Documentation

Overview

Package utility provides utility functionality that is used throughout the Civo CLI.

Index

• func AskForConfirm(message string) error
• func BoolToYesNo(d bool) string
• func ColorStatus(status string) interface{}
• func Error(msg string, args ...interface{})
• func GetStringMap(s string) map[string]string
• func Green(value string) string
• func ObtainKubeConfig(KubeconfigFilename string, civoConfig string, merge bool) error
• func RandomName() string
• func Red(value string) string
• func RedConfirm(msg string, args ...interface{})
• func StartTime() time.Time
• func TrackTime(startTime time.Time) string
• func UserConfirmedDeletion(resourceType string, ignoringConfirmed bool) bool
• func UserConfirmedOverwrite(resourceType string, ignoringConfirmed bool) bool
• func YellowConfirm(msg string, args ...interface{})
• type OutputWriter
  • func NewOutputWriter() *OutputWriter
  • func NewOutputWriterWithMap(data map[string]string) *OutputWriter
  • func (ow *OutputWriter) AppendData(key, value string)
  • func (ow *OutputWriter) AppendDataWithLabel(key, value, label string)
  • func (ow *OutputWriter) StartLine()
  • func (ow *OutputWriter) WriteCustomOutput(fields string)
  • func (ow *OutputWriter) WriteHeader(label string)
  • func (ow *OutputWriter) WriteKeyValues()
  • func (ow *OutputWriter) WriteMultipleObjectsJSON()
  • func (ow *OutputWriter) WriteSingleObjectJSON()
  • func (ow *OutputWriter) WriteSubheader(label string)
  • func (ow *OutputWriter) WriteTable()

Functions

func AskForConfirm

func AskForConfirm(message string) error

AskForConfirm parses and verifies user input for confirmation.

func BoolToYesNo

func BoolToYesNo(d bool) string

BoolToYesNo returns Yes or No depending on the value of a boolean This wouldn't be as necessary if Go had a ternary operator

func ColorStatus

func ColorStatus(status string) interface{}

ColorStatus is to print the status of the Instance or k8s Cluster

func Error

func Error(msg string, args ...interface{})

Error is the function to handler all error in the Cli

func GetStringMap

func GetStringMap(s string) map[string]string

GetStringMap getStringMap convert string in the format a:1,b:2,c:3 in map[string]string, this is util for the flags StringArrayVarP

func Green

func Green(value string) string

Green is the function to convert str to green in console

func ObtainKubeConfig

func ObtainKubeConfig(KubeconfigFilename string, civoConfig string, merge bool) error

ObtainKubeConfig is the function to get the kubeconfig from the cluster and save to the file or merge with the existing one

func RandomName

func RandomName() string

RandomName generates a Heroku-style random name for instances/clusters/etc

func Red

func Red(value string) string

Red is the function to convert str to red in console

func RedConfirm

func RedConfirm(msg string, args ...interface{})

RedConfirm is the function to handler the new version of the Cli

func StartTime

func StartTime() time.Time

StartTime function to start the time

func TrackTime

func TrackTime(startTime time.Time) string

TrackTime function to get the start time and see the time between start time and the end time

func UserConfirmedDeletion

func UserConfirmedDeletion(resourceType string, ignoringConfirmed bool) bool

UserConfirmedDeletion builds a message to ask the user to confirm delete a resource and then sends it through to AskForConfirm to parses and verifies user input.

func UserConfirmedOverwrite

func UserConfirmedOverwrite(resourceType string, ignoringConfirmed bool) bool

UserConfirmedOverwrite builds a message to ask the user to confirm overwrite config and then sends it through to AskForConfirm to parses and verifies user input.

func YellowConfirm

func YellowConfirm(msg string, args ...interface{})

YellowConfirm is the function to handler all delete confirm

Types

type OutputWriter

type OutputWriter struct {
	Keys       []string
	Labels     []string
	Values     [][]string
	TempValues []string
}

OutputWriter is for printing structured data in various tabular formats

ow := utility.NewOutputWriter()
ow.StartLine()
ow.AppendData("ID", instance.ID)

# Then one of:
ow.WriteSingleObjectJSON()
ow.WriteMultipleObjectsJSON()
ow.WriteCustomOutput(outputFields)
ow.WriteKeyValues()
ow.WriteTable()

func NewOutputWriter

func NewOutputWriter() *OutputWriter

NewOutputWriter builds a new OutputWriter

func NewOutputWriterWithMap

func NewOutputWriterWithMap(data map[string]string) *OutputWriter

NewOutputWriterWithMap builds a new OutputWriter and automatically inserts the supplied map as a single line

func (*OutputWriter) AppendData

func (ow *OutputWriter) AppendData(key, value string)

AppendData adds a line of data to the output writer

func (*OutputWriter) AppendDataWithLabel

func (ow *OutputWriter) AppendDataWithLabel(key, value, label string)

AppendDataWithLabel adds a line of data to the output writer

func (*OutputWriter) StartLine

func (ow *OutputWriter) StartLine()

StartLine starts a new line of output

func (*OutputWriter) WriteCustomOutput

func (ow *OutputWriter) WriteCustomOutput(fields string)

WriteCustomOutput prints one or multiple objects using custom formatting

func (*OutputWriter) WriteHeader

func (ow *OutputWriter) WriteHeader(label string)

WriteHeader WriteSubheader writes a centred heading line in to output

func (*OutputWriter) WriteKeyValues

func (ow *OutputWriter) WriteKeyValues()

WriteKeyValues prints a single object stored in the OutputWriter in key: value format

func (*OutputWriter) WriteMultipleObjectsJSON

func (ow *OutputWriter) WriteMultipleObjectsJSON()

WriteMultipleObjectsJSON writes the JSON for multiple objects to STDOUT

func (*OutputWriter) WriteSingleObjectJSON

func (ow *OutputWriter) WriteSingleObjectJSON()

WriteSingleObjectJSON writes the JSON for a single object to STDOUT

func (*OutputWriter) WriteSubheader

func (ow *OutputWriter) WriteSubheader(label string)

WriteSubheader writes a centred heading line in to output

func (*OutputWriter) WriteTable

func (ow *OutputWriter) WriteTable()

WriteTable prints multiple objects stored in the OutputWriter in tabular format