utils

Documentation

Index

• func CopyDir(srcPath, dstPath string) error
• func GenerateUUID(name string) uuid.UUID
• func SameContent(src, dst string) (bool, error)
• func WalkPath(root string, skip []string) ([]string, error)
• type ConcurrentMap
  • func NewConcurrentMap() *ConcurrentMap
  • func (cm *ConcurrentMap) Get(key string) (interface{}, bool)
  • func (cm *ConcurrentMap) Iter() <-chan ConcurrentMapItem
  • func (cm *ConcurrentMap) Set(key string, value interface{})
• type ConcurrentMapItem
• type ConcurrentSlice
  • func NewConcurrentSlice() *ConcurrentSlice
  • func (cs *ConcurrentSlice) Append(item interface{})
  • func (cs *ConcurrentSlice) Iter() <-chan ConcurrentSliceItem
• type ConcurrentSliceItem
• type FileOwner
• type FileUtil
  • func NewFileUtil(path string) *FileUtil
  • func (fu *FileUtil) Abs() (string, error)
  • func (fu *FileUtil) Chmod(perm os.FileMode) error
  • func (fu *FileUtil) CopyFrom(srcPath string, overwrite bool) error
  • func (fu *FileUtil) Exists() bool
  • func (fu *FileUtil) Md5() (string, error)
  • func (fu *FileUtil) Mode() (os.FileMode, error)
  • func (fu *FileUtil) Owner() (*FileOwner, error)
  • func (fu *FileUtil) Remove() error
  • func (fu *FileUtil) SameContentWith(dst string) (bool, error)
  • func (fu *FileUtil) SetOwner(owner, group string) error
  • func (fu *FileUtil) Sha1() (string, error)
  • func (fu *FileUtil) Sha256() (string, error)
• type GitRepo
  • func NewGitRepo(path, upstream string) (*GitRepo, error)
  • func (gr *GitRepo) Checkout(branch string) ([]byte, error)
  • func (gr *GitRepo) CheckoutDetached(branch string) ([]byte, error)
  • func (gr *GitRepo) Clone() ([]byte, error)
  • func (gr *GitRepo) Fetch(remote string) ([]byte, error)
  • func (gr *GitRepo) Head() (string, error)
  • func (gr *GitRepo) IsGitRepo() bool
  • func (gr *GitRepo) Pull(remote, branch string) ([]byte, error)
• type List
  • func NewList(s ...string) List
  • func (l List) Contains(x string) bool
• type String
  • func NewString(s string) String
  • func (s String) IsInList(l List) bool
  • func (s String) String() string

Functions

func CopyDir

func CopyDir(srcPath, dstPath string) error

CopyDir recursively copies files from one directory to another

func GenerateUUID

func GenerateUUID(name string) uuid.UUID

GenerateUUID generates a new uuid for a minion

func SameContent

func SameContent(src, dst string) (bool, error)

SameContent returns a boolean indicating whether two files have the same content

func WalkPath

func WalkPath(root string, skip []string) ([]string, error)

WalkPath walks a path and returns a slice of file names that were found during path traversing

Types

type ConcurrentMap

type ConcurrentMap struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

ConcurrentMap is a map type that can be safely shared between goroutines that require read/write access to a map

func NewConcurrentMap

func NewConcurrentMap() *ConcurrentMap

NewConcurrentMap creates a new concurrent map

func (*ConcurrentMap) Get

func (cm *ConcurrentMap) Get(key string) (interface{}, bool)

Get retrieves the value for a concurrent map item

func (*ConcurrentMap) Iter

func (cm *ConcurrentMap) Iter() <-chan ConcurrentMapItem

Iter iterates over the items in a concurrent map Each item is sent over a channel, so that we can iterate over the map using the builtin range keyword

func (*ConcurrentMap) Set

func (cm *ConcurrentMap) Set(key string, value interface{})

Set adds an item to a concurrent map

type ConcurrentMapItem

type ConcurrentMapItem struct {
	Key   string
	Value interface{}
}

ConcurrentMapItem contains a key/value pair item of a concurrent map

type ConcurrentSlice

type ConcurrentSlice struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

ConcurrentSlice type that can be safely shared between goroutines

func NewConcurrentSlice

func NewConcurrentSlice() *ConcurrentSlice

NewConcurrentSlice creates a new concurrent slice

func (*ConcurrentSlice) Append

func (cs *ConcurrentSlice) Append(item interface{})

Append adds an item to the concurrent slice

func (*ConcurrentSlice) Iter

func (cs *ConcurrentSlice) Iter() <-chan ConcurrentSliceItem

Iter iterates over the items in the concurrent slice Each item is sent over a channel, so that we can iterate over the slice using the builin range keyword

type ConcurrentSliceItem

type ConcurrentSliceItem struct {
	Index int
	Value interface{}
}

ConcurrentSliceItem contains the index/value pair of an item in a concurrent slice

type FileOwner

type FileOwner struct {
	*user.User
	*user.Group
}

FileOwner type provides details about the user and group that owns a file

type FileUtil

type FileUtil struct {
	// Path to the file we manage
	Path string
}

FileUtil type

func NewFileUtil

func NewFileUtil(path string) *FileUtil

NewFileUtil creates a file utility from the given path

func (*FileUtil) Abs

func (fu *FileUtil) Abs() (string, error)

Abs returns the absolute path for the file

func (*FileUtil) Chmod

func (fu *FileUtil) Chmod(perm os.FileMode) error

Chmod changes the permissions of the file

func (*FileUtil) CopyFrom

func (fu *FileUtil) CopyFrom(srcPath string, overwrite bool) error

CopyFrom copies contents from another source to the current file

func (*FileUtil) Exists

func (fu *FileUtil) Exists() bool

Exists returns a boolean indicating whether the file exists or not

func (*FileUtil) Md5

func (fu *FileUtil) Md5() (string, error)

Md5 returns the md5 checksum of the file's contents

func (*FileUtil) Mode

func (fu *FileUtil) Mode() (os.FileMode, error)

Mode returns the file permission bits

func (*FileUtil) Owner

func (fu *FileUtil) Owner() (*FileOwner, error)

Owner retrieves the owner and group for the file

func (*FileUtil) Remove

func (fu *FileUtil) Remove() error

Remove removes the file

func (*FileUtil) SameContentWith

func (fu *FileUtil) SameContentWith(dst string) (bool, error)

SameContentWith returns a boolean indicating whether the content of the current file is the same as the destination

func (*FileUtil) SetOwner

func (fu *FileUtil) SetOwner(owner, group string) error

SetOwner sets the ownership for the file

func (*FileUtil) Sha1

func (fu *FileUtil) Sha1() (string, error)

Sha1 returns the sha1 checksum of the file's contents

func (*FileUtil) Sha256

func (fu *FileUtil) Sha256() (string, error)

Sha256 returns the sha256 checksum of the file's contents

type GitRepo

type GitRepo struct {
	// Local path to the repository
	Path string

	// Upstream URL of the Git repository
	Upstream string
	// contains filtered or unexported fields
}

GitRepo type manages a VCS repository with Git

func NewGitRepo

func NewGitRepo(path, upstream string) (*GitRepo, error)

NewGitRepo creates a new Git repository

func (*GitRepo) Checkout

func (gr *GitRepo) Checkout(branch string) ([]byte, error)

Checkout checks out a given local branch

func (*GitRepo) CheckoutDetached

func (gr *GitRepo) CheckoutDetached(branch string) ([]byte, error)

CheckoutDetached checks out a given local branch in detached mode

func (*GitRepo) Clone

func (gr *GitRepo) Clone() ([]byte, error)

Clone clones the upstream repository

func (*GitRepo) Fetch

func (gr *GitRepo) Fetch(remote string) ([]byte, error)

Fetch fetches from the given remote

func (*GitRepo) Head

func (gr *GitRepo) Head() (string, error)

Head returns the SHA1 commit id at HEAD

func (*GitRepo) IsGitRepo

func (gr *GitRepo) IsGitRepo() bool

IsGitRepo checks if the repository is a valid Git repository

func (*GitRepo) Pull

func (gr *GitRepo) Pull(remote, branch string) ([]byte, error)

Pull pulls from the given remote and merges changes into the local branch

type List

type List []string

List type represents a slice of strings

func NewList

func NewList(s ...string) List

NewList creates a new list with the given items

func (List) Contains

func (l List) Contains(x string) bool

Contains returns a boolean indicating whether the list contains the given string.

type String

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

String type represents a string

func NewString

func NewString(s string) String

NewString creates a new string

func (String) IsInList

func (s String) IsInList(l List) bool

IsInList returns a boolean indicating whether the string is contained within a given list

func (String) String

func (s String) String() string

String implements the fmt.Stringer interface