util

Documentation

Index

• func CanReadFile(path string) bool
• func DecryptText(cryptoText string) (string, error)
• func EncryptText(text string) (string, error)
• func EscapeStringForSSHUse(s string) string
• func GenerateSelfSignedCert(certPath, keyPath string, ips []net.IP, alternateDNS []string) error
• func HomeDir() string
• func Pad(str string) string
• func ReadInputFromStdin(fieldlabel string) string
• func ReadPasswordFromStdin(fieldlabel string) string
• func Retry(attempts int, callback func() error) (err error)
• func RetryAfter(attempts int, callback func() error, d time.Duration) (err error)
• func Until(fn func() error, w io.Writer, name string, sleep time.Duration, ...)
• func ValidateProxyURI(uri string) bool
• func VersionOrdinal(version string) string
• type MultiError
  • func (m *MultiError) Collect(err error)
  • func (m MultiError) ToError() error
• type RealRunner
  • func (r RealRunner) Output(command string, args ...string) ([]byte, error)
  • func (r RealRunner) Run(stdOut io.Writer, stdErr io.Writer, commandPath string, args ...string) int
• type Runner

Functions

func CanReadFile

func CanReadFile(path string) bool

If the file represented by path exists and readable, return true otherwise return false.

func DecryptText

func DecryptText(cryptoText string) (string, error)

Decrypt from base64 to decrypted string

func EncryptText

func EncryptText(text string) (string, error)

Encrypt string to base64 crypto using AES

func EscapeStringForSSHUse

func EscapeStringForSSHUse(s string) string

EscapeStringForSSHUse will parse string and replace shell special characters with escape

func GenerateSelfSignedCert

func GenerateSelfSignedCert(certPath, keyPath string, ips []net.IP, alternateDNS []string) error

You may also specify additional subject alt names (either ip or dns names) for the certificate The certificate will be created with file mode 0644. The key will be created with file mode 0600. If the certificate or key files already exist, they will be overwritten. Any parent directories of the certPath or keyPath will be created as needed with file mode 0755.

func HomeDir

func HomeDir() string

HomeDir returns the home directory for the current user

func Pad

func Pad(str string) string

func ReadInputFromStdin

func ReadInputFromStdin(fieldlabel string) string

func ReadPasswordFromStdin

func ReadPasswordFromStdin(fieldlabel string) string

func Retry

func Retry(attempts int, callback func() error) (err error)

func RetryAfter

func RetryAfter(attempts int, callback func() error, d time.Duration) (err error)

func Until

func Until(fn func() error, w io.Writer, name string, sleep time.Duration, done <-chan struct{})

Until endlessly loops the provided function until a message is received on the done channel. The function will wait the duration provided in sleep between function calls. Errors will be sent on provider Writer.

func ValidateProxyURI

func ValidateProxyURI(uri string) bool

func VersionOrdinal

func VersionOrdinal(version string) string

Types

type MultiError

type MultiError struct {
	Errors []error
}

func (*MultiError) Collect

func (m *MultiError) Collect(err error)

func (MultiError) ToError

func (m MultiError) ToError() error

type RealRunner

type RealRunner struct{}

func (RealRunner) Output

func (r RealRunner) Output(command string, args ...string) ([]byte, error)

the real runner for get the output as byte format

func (RealRunner) Run

func (r RealRunner) Run(stdOut io.Writer, stdErr io.Writer, commandPath string, args ...string) int

type Runner

type Runner interface {
	Run(stdOut io.Writer, stdErr io.Writer, commandPath string, args ...string) int
	Output(string, ...string) ([]byte, error)
}