io

Documentation

Index

• Variables
• func AsyncMultiWriter(limit int, writers ...io.Writer) io.Writer
• func CleanOldDirs() error
• func Close(closer io.Closer, err *error)
• func CopyDir(fromPath, toPath string, includeDirs bool, excludeNames []string) error
• func CopyFile(dst, src string) (err error)
• func CreateDirIfNotExist(path string) error
• func CreateFilePath(localPath, fileName string) (string, error)
• func CreateRandomLenFile(maxLen int, filesDir string, prefix string) string
• func CreateTempDir() (string, error)
• func DoubleWinPathSeparator(filePath string) string
• func DownloadFile(downloadTo string, fromUrl string) (err error)
• func FindFileInDirAndParents(dirPath, fileName string) (string, error)
• func GetFileAndDirFromPath(path string) (fileName, dir string)
• func GetFileContentAndInfo(filePath string) (fileContent []byte, fileInfo os.FileInfo, err error)
• func GetFileInfo(path string, followSymlink bool) (fileInfo os.FileInfo, err error)
• func GetFileSeparator() string
• func IsDirExists(path string, followSymlink bool) (bool, error)
• func IsFileExists(path string, followSymlink bool) (bool, error)
• func IsFileSymlink(file os.FileInfo) bool
• func IsPathExists(path string) bool
• func IsPathSymlink(path string) bool
• func ListFiles(path string, includeDirs bool) ([]string, error)
• func ListFilesByFilterFunc(path string, filterFunc func(filePath string) (bool, error)) ([]string, error)
• func MoveDir(fromPath, toPath string) error
• func MoveFile(sourcePath, destPath string) (err error)
• func ReadNLines(path string, total int) (lines []string, err error)
• func RemoveTempDir(dirPath string) error
• func RunCmd(config CmdConfig) error
• func RunCmdOutput(config CmdConfig) (string, error)
• func RunCmdWithOutputParser(config CmdConfig, prompt bool, regExpStruct ...*CmdOutputPattern) (stdOut string, errorOut string, exitOk bool, err error)
• func Unmarshal(filePath string, loadTarget interface{}) (err error)
• func Walk(root string, walkFn WalkFunc, walkIntoDirSymlink bool) error
• type CmdConfig
• type CmdOutputPattern
• type Command
  • func NewCommand(executable, cmdName string, cmdArgs []string) *Command
  • func (config *Command) GetCmd() (cmd *exec.Cmd)
  • func (config *Command) GetEnv() map[string]string
  • func (config *Command) GetErrWriter() io.WriteCloser
  • func (config *Command) GetStdWriter() io.WriteCloser
  • func (config *Command) RunWithOutput() (data []byte, err error)
• type RandFile
  • func CreateRandFile(path string, len int) (file *RandFile, err error)
• type Stat
• type WalkFunc

Variables

var ErrShortWrite = errors.New("the number of bytes written is less than the length of the input")

var ErrSkipDir = errors.New("skip this directory")

Functions

func AsyncMultiWriter

func AsyncMultiWriter(limit int, writers ...io.Writer) io.Writer

AsyncMultiWriter creates a writer that duplicates its writes to all the provided writers asynchronous

func CleanOldDirs

func CleanOldDirs() error

Old runs/tests may leave junk at temp dir. Each temp file/Dir is named with prefix+timestamp, search for all temp files/dirs that match the common prefix and validate their timestamp.

func Close

func Close(closer io.Closer, err *error)

Close the reader/writer and append the error to the given error.

func CopyDir

func CopyDir(fromPath, toPath string, includeDirs bool, excludeNames []string) error

Copy directory content from one path to another. includeDirs means to copy also the dirs if presented in the src folder. excludeNames - Skip files/dirs in the src folder that match names in provided slice. ONLY excludes first layer (only in src folder).

func CopyFile

func CopyFile(dst, src string) (err error)

func CreateDirIfNotExist

func CreateDirIfNotExist(path string) error

func CreateFilePath

func CreateFilePath(localPath, fileName string) (string, error)

func CreateRandomLenFile

func CreateRandomLenFile(maxLen int, filesDir string, prefix string) string

Create a temp file with the requested prefix at the provided dir. File length and contents are random, up to the requested max length.

func CreateTempDir

func CreateTempDir() (string, error)

CreateTempDir creates a temporary directory and returns its path.

func DoubleWinPathSeparator

func DoubleWinPathSeparator(filePath string) string

func DownloadFile

func DownloadFile(downloadTo string, fromUrl string) (err error)

func FindFileInDirAndParents

func FindFileInDirAndParents(dirPath, fileName string) (string, error)

FindFileInDirAndParents looks for a file named fileName in dirPath and its parents, and returns the path of the directory where it was found. dirPath must be a full path.

func GetFileAndDirFromPath

func GetFileAndDirFromPath(path string) (fileName, dir string)

Return the file's name and dir of a given path by finding the index of the last separator in the path. Support separators : "/" , "\\" and "\\\\"

func GetFileContentAndInfo

func GetFileContentAndInfo(filePath string) (fileContent []byte, fileInfo os.FileInfo, err error)

func GetFileInfo

func GetFileInfo(path string, followSymlink bool) (fileInfo os.FileInfo, err error)

Get the file info of the file in path. If path points at a symlink and `followSymlink == false`, return the file info of the symlink instead

func GetFileSeparator

func GetFileSeparator() string

func IsDirExists

func IsDirExists(path string, followSymlink bool) (bool, error)

Check if path points at a directory. If path points at a symlink and `followSymlink == false`, function will return `false` regardless of the symlink target

func IsFileExists

func IsFileExists(path string, followSymlink bool) (bool, error)

Checxk if path points at a file. If path points at a symlink and `followSymlink == false`, function will return `true` regardless of the symlink target

func IsFileSymlink

func IsFileSymlink(file os.FileInfo) bool

func IsPathExists

func IsPathExists(path string) bool

IsPathExists checks if a path exists.

func IsPathSymlink

func IsPathSymlink(path string) bool

func ListFiles

func ListFiles(path string, includeDirs bool) ([]string, error)

Return the list of files and directories in the specified path

func ListFilesByFilterFunc

func ListFilesByFilterFunc(path string, filterFunc func(filePath string) (bool, error)) ([]string, error)

Return all files in the specified path who satisfy the filter func. Not recursive.

func MoveDir

func MoveDir(fromPath, toPath string) error

Move directory content from one path to another.

func MoveFile

func MoveFile(sourcePath, destPath string) (err error)

GoLang: os.Rename() give error "invalid cross-device link" for Docker container with Volumes. MoveFile(source, destination) will work moving file between folders Therefore, we are using our own implementation (MoveFile) in order to rename files.

func ReadNLines

func ReadNLines(path string, total int) (lines []string, err error)

strip '\n' or read until EOF, return error if read error readNLines reads up to 'total' number of lines separated by \n.

func RemoveTempDir

func RemoveTempDir(dirPath string) error

func RunCmd

func RunCmd(config CmdConfig) error

Runs an external process and prints its output to stdout / stderr.

func RunCmdOutput

func RunCmdOutput(config CmdConfig) (string, error)

Executes an external process and returns its output. If the returned output is not needed, use the RunCmd function instead , for better performance.

func RunCmdWithOutputParser

func RunCmdWithOutputParser(config CmdConfig, prompt bool, regExpStruct ...*CmdOutputPattern) (stdOut string, errorOut string, exitOk bool, err error)

Executes the command and captures the output. Analyze each line to match the provided regex. Returns the complete stdout output of the command.

func Unmarshal

func Unmarshal(filePath string, loadTarget interface{}) (err error)

Parses the JSON-encoded data and stores the result in the value pointed to by 'loadTarget'. filePath - Path to json file. loadTarget - Pointer to a struct

func Walk

func Walk(root string, walkFn WalkFunc, walkIntoDirSymlink bool) error

The same as filepath.Walk the only difference is that we can walk into symlink. Avoiding infinite loops by saving the real paths we already visited.

Types

type CmdConfig

type CmdConfig interface {
	GetCmd() *exec.Cmd
	GetEnv() map[string]string
	GetStdWriter() io.WriteCloser
	GetErrWriter() io.WriteCloser
}

type CmdOutputPattern

type CmdOutputPattern struct {
	RegExp         *regexp.Regexp
	MatchedResults []string
	Line           string
	ExecFunc       func(pattern *CmdOutputPattern) (string, error)
}

RegExp - The regexp that the line will be searched upon. MatchedResults - The slice result that was found by the regexp Line - The output line from the external process ExecFunc - The function to execute

type Command

type Command struct {
	Executable string
	CmdName    string
	CmdArgs    []string
	Dir        string
	StrWriter  io.WriteCloser
	ErrWriter  io.WriteCloser
}

func NewCommand

func NewCommand(executable, cmdName string, cmdArgs []string) *Command

func (*Command) GetCmd

func (config *Command) GetCmd() (cmd *exec.Cmd)

func (*Command) GetEnv

func (config *Command) GetEnv() map[string]string

func (*Command) GetErrWriter

func (config *Command) GetErrWriter() io.WriteCloser

func (*Command) GetStdWriter

func (config *Command) GetStdWriter() io.WriteCloser

func (*Command) RunWithOutput

func (config *Command) RunWithOutput() (data []byte, err error)

type RandFile

type RandFile struct {
	*os.File
	Info os.FileInfo
}

func CreateRandFile

func CreateRandFile(path string, len int) (file *RandFile, err error)

Create a file at the provided path with a request number of random bytes.

type Stat

type Stat func(path string) (info os.FileInfo, err error)

type WalkFunc

type WalkFunc func(path string, info os.FileInfo, err error) error