util

Documentation

Index

• Constants
• func AskForConfirmation(message string) bool
• func CommandExecutesSuccessfully(cmd string, args ...string) bool
• func DecryptText(cryptoText string) (string, error)
• func EncryptText(text string) (string, error)
• func FriendlyDuration(d time.Duration) time.Duration
• func GenerateSelfSignedCert(certPath, keyPath string, ips []net.IP, alternateDNS []string) error
• func GetPasswordKeyring(username string) (string, error)
• func IsAdministrativeUser() bool
• func IsDirectoryWritable(path string) bool
• func IsTtySupported() bool
• 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 SetPasswordKeyring(username, password string) error
• func TimeElapsed(start time.Time, friendly bool) string
• func TimeTrack(start time.Time, w io.Writer, friendly bool)
• func Until(fn func() error, w io.Writer, name string, sleep time.Duration, ...)
• func ValidateProxyURL(proxyUrl string, defaultScheme string) error
• type MultiError
  • func (m *MultiError) Collect(err error)
  • func (m MultiError) ToError() error
• type ProxyConfig
  • func NewProxyConfig(httpProxy string, httpsProxy string, noProxy string) (*ProxyConfig, error)
  • func (p *ProxyConfig) AddNoProxy(host string)
  • func (p *ProxyConfig) ApplyToEnvironment()
  • func (p *ProxyConfig) HttpProxy() string
  • func (p *ProxyConfig) HttpsProxy() string
  • func (p *ProxyConfig) IsEnabled() bool
  • func (p *ProxyConfig) NoProxy() string
  • func (p *ProxyConfig) OverrideHttpProxy(proxy string)
  • func (p *ProxyConfig) OverrideHttpsProxy(proxy string)
  • func (p *ProxyConfig) ProxyConfig() []string
• type RealRunner
  • func (r RealRunner) Output(command string, args ...string) ([]byte, error)
  • func (r RealRunner) Run(stdOut io.Writer, stdErr io.Writer, command string, args ...string) int
• type RetriableError
  • func (r RetriableError) Error() string
• type Runner

Constants

const OpenShiftRegistryIp = "172.30.1.1"

Functions

func AskForConfirmation

func AskForConfirmation(message string) bool

func CommandExecutesSuccessfully

func CommandExecutesSuccessfully(cmd string, args ...string) bool

CommandExecutesSuccessfully returns true if the command executed based on the exit code

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 FriendlyDuration

func FriendlyDuration(d time.Duration) time.Duration

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 GetPasswordKeyring

func GetPasswordKeyring(username string) (string, error)

Retrive password from OS native credential provider/keychain

func IsAdministrativeUser

func IsAdministrativeUser() bool

IsAdministrativeUser returns true when user is either root or Administrator

func IsDirectoryWritable

func IsDirectoryWritable(path string) bool

IsDirectoryWritable checks if the directory is writable or not by trying creating a temporary file Return true if directory is writable else false

func IsTtySupported

func IsTtySupported() bool

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 SetPasswordKeyring

func SetPasswordKeyring(username, password string) error

Store the registration password in OS native keychain

func TimeElapsed

func TimeElapsed(start time.Time, friendly bool) string

TimeElapsed is used to time the execution of a method.

func TimeTrack

func TimeTrack(start time.Time, w io.Writer, friendly bool)

TimeTrack is used to time the execution of a method. It is passed the start time as well as a output writer for the timing. The usage of TimeTrack is in combination with defer like so:

defer TimeTrack(time.Now(), os.Stdout)

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 ValidateProxyURL

func ValidateProxyURL(proxyUrl string, defaultScheme string) error

ValidateProxyURL validates that the specified proxyURL is valid

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 ProxyConfig

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

ProxyConfig keeps the proxy configuration for the current environment

func NewProxyConfig

func NewProxyConfig(httpProxy string, httpsProxy string, noProxy string) (*ProxyConfig, error)

NewProxyConfig creates a proxy configuration with the specified parameters. If a empty string is passed the corresponding environment variable is checked.

func (*ProxyConfig) AddNoProxy

func (p *ProxyConfig) AddNoProxy(host string)

AddNoProxy appends the specified host to the list of no proxied hosts.

func (*ProxyConfig) ApplyToEnvironment

func (p *ProxyConfig) ApplyToEnvironment()

Sets the current config as environment variables in the current process.

func (*ProxyConfig) HttpProxy

func (p *ProxyConfig) HttpProxy() string

HttpProxy returns the configured value for the HTTP proxy. The empty string is returned in case HTTP proxy is not set.

func (*ProxyConfig) HttpsProxy

func (p *ProxyConfig) HttpsProxy() string

HttpsProxy returns the configured value for the HTTPS proxy. The empty string is returned in case HTTPS proxy is not set.

func (*ProxyConfig) IsEnabled

func (p *ProxyConfig) IsEnabled() bool

Enabled returns true if at least one proxy (HTTP or HTTPS) is configured. Returns false otherwise.

func (*ProxyConfig) NoProxy

func (p *ProxyConfig) NoProxy() string

NoProxy returns a comma separated list of hosts for which proxies should not be applied.

func (*ProxyConfig) OverrideHttpProxy

func (p *ProxyConfig) OverrideHttpProxy(proxy string)

Override proxy for local/intermediate proxy

func (*ProxyConfig) OverrideHttpsProxy

func (p *ProxyConfig) OverrideHttpsProxy(proxy string)

Override proxy for local/intermediate proxy

func (*ProxyConfig) ProxyConfig

func (p *ProxyConfig) ProxyConfig() []string

ProxyConfig returns a the proxy configuration as a slice, one element for each of the potential settings HTTP_PROXY, HTTPS_PROXY and NO_PROXY. If proxies are not enabled an empty slice is returned.

type RealRunner

type RealRunner struct {
	Env []string
}

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, command string, args ...string) int

type RetriableError

type RetriableError struct {
	Err error
}

func (RetriableError) Error

func (r RetriableError) Error() string

type Runner

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