util

Documentation

Index

• Variables
• func Close(c Closer)
• func DeleteFile(path string)
• func FirstNonEmpty(args ...string) string
• func MakeSignature(size int) ([]byte, error)
• func RetryUntilSucceed(action func() error, desc string, ctx context.Context, timeout time.Duration)
• func RunAllAsync(count int, action func(i int) error) (err error)
• func Wait(timeout uint, f func(chan<- bool)) bool
• type Closer
  • func NewCloser(close func() error) Closer
• type KeyLock
  • func NewKeyLock() *KeyLock
  • func (keyLock *KeyLock) Lock(key string)
  • func (keyLock *KeyLock) Unlock(key string)

Variables

var (
	// location to use for generating temporary files, such as the kubeconfig needed by kubectl
	TempDir   string
	NopCloser = NewCloser(func() error {
		return nil
	})
)

Functions

func Close

func Close(c Closer)

Close is a convenience function to close a object that has a Close() method, ignoring any errors Used to satisfy errcheck lint

func DeleteFile

func DeleteFile(path string)

DeleteFile is best effort deletion of a file

func FirstNonEmpty

func FirstNonEmpty(args ...string) string

func MakeSignature

func MakeSignature(size int) ([]byte, error)

MakeSignature generates a cryptographically-secure pseudo-random token, based on a given number of random bytes, for signing purposes.

func RetryUntilSucceed

func RetryUntilSucceed(action func() error, desc string, ctx context.Context, timeout time.Duration)

RetryUntilSucceed keep retrying given action with specified timeout until action succeed or specified context is done.

func RunAllAsync

func RunAllAsync(count int, action func(i int) error) (err error)

func Wait

func Wait(timeout uint, f func(chan<- bool)) bool

Wait takes a check interval and timeout and waits for a function to return `true`. Wait will return `true` on success and `false` on timeout. The passed function, in turn, should pass `true` (or anything, really) to the channel when it's done. Pass `0` as the timeout to run infinitely until completion.

Types

type Closer

type Closer interface {
	Close() error
}

func NewCloser

func NewCloser(close func() error) Closer

type KeyLock

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

Allows to lock by string key

func NewKeyLock

func NewKeyLock() *KeyLock

NewKeyLock creates new instance of KeyLock

func (*KeyLock) Lock

func (keyLock *KeyLock) Lock(key string)

Lock blocks goroutine using key specific mutex

func (*KeyLock) Unlock

func (keyLock *KeyLock) Unlock(key string)

Unlock releases key specific mutex