util

Documentation

Index

• Constants
• Variables
• func AbsFile(workspace string, filename string) (string, error)
• func AbsolutePaths(workspace string, paths []string) []string
• func BoolPtr(b bool) *bool
• func CloneThroughJSON(old interface{}, new interface{})
• func CloneThroughYAML(old interface{}, new interface{})
• func CreateMappedTar(w io.Writer, root string, pathMap map[string][]string) error
• func CreateTar(w io.Writer, root string, paths []string) error
• func CreateTarGz(w io.Writer, root string, paths []string) error
• func CreateTarWithParents(w io.Writer, root string, paths []string, uid, gid int, modTime time.Time) error
• func Download(url string) ([]byte, error)
• func ExecuteEnvTemplate(envTemplate *template.Template, customMap map[string]string) (string, error)
• func Expand(text, key, value string) string
• func ExpandEnvTemplate(s string, envMap map[string]string) (string, error)
• func ExpandPathsGlob(workingDir string, paths []string) ([]string, error)
• func GetAvailablePort(address string, port int, usedPorts *PortSet) int
• func IsDir(path string) bool
• func IsFile(path string) bool
• func IsHiddenDir(filename string) bool
• func IsHiddenFile(filename string) bool
• func IsPortFree(address string, p int) bool
• func IsTerminal(w io.Writer) (uintptr, bool)
• func IsURL(s string) bool
• func NonEmptyLines(input []byte) []string
• func ParseEnvTemplate(t string) (*template.Template, error)
• func RandomID() string
• func ReadConfiguration(filename string) ([]byte, error)
• func RegexEqual(expected, actual string) bool
• func RemoveFromSlice(s []string, target string) []string
• func RunCmd(cmd *exec.Cmd) error
• func RunCmdOut(cmd *exec.Cmd) ([]byte, error)
• func StrSliceContains(sl []string, s string) bool
• func StrSliceIndex(sl []string, s string) int
• func StrSliceInsert(sl []string, index int, insert []string) []string
• func StringPtr(s string) *string
• func VerifyOrCreateFile(path string) error
• type Command
• type CommandWrapper
  • func (cw CommandWrapper) CreateCommand(ctx context.Context, workingDir string, args []string) exec.Cmd
• type Commander
  • func (*Commander) RunCmd(cmd *exec.Cmd) error
  • func (*Commander) RunCmdOut(cmd *exec.Cmd) ([]byte, error)
• type Gsutil
  • func (g *Gsutil) Copy(ctx context.Context, src, dst string, recursive bool) error
• type PortSet
  • func (f *PortSet) Delete(port int)
  • func (f *PortSet) Length() int
  • func (f *PortSet) List() []int
  • func (f *PortSet) LoadOrSet(port int) bool
  • func (f *PortSet) Set(port int)

Constants

const GsutilExec = "gsutil"

const Loopback = "127.0.0.1"

Loopback network address. Skaffold should not bind to 0.0.0.0 unless we really want to expose something to the network.

Variables

var (
	OSEnviron = os.Environ
)

For testing

var SkipWrapperCheck = false

Functions

func AbsFile

func AbsFile(workspace string, filename string) (string, error)

AbsFile resolves the absolute path of the file named filename in directory workspace, erroring if it is not a file

func AbsolutePaths

func AbsolutePaths(workspace string, paths []string) []string

AbsolutePaths prepends each path in paths with workspace if the path isn't absolute

func BoolPtr

func BoolPtr(b bool) *bool

BoolPtr returns a pointer to a bool

func CloneThroughJSON

func CloneThroughJSON(old interface{}, new interface{})

CloneThroughJSON clones an `old` object into a `new` one using json marshalling and unmarshalling. Since the object can be marshalled, it's almost sure it can be unmarshalled. So we prefer to panic instead of returning an error that would create an untestable branch on the call site.

func CloneThroughYAML

func CloneThroughYAML(old interface{}, new interface{})

CloneThroughYAML clones an `old` object into a `new` one using yaml marshalling and unmarshalling. Since the object can be marshalled, it's almost sure it can be unmarshalled. So we prefer to panic instead of returning an error that would create an untestable branch on the call site.

func CreateMappedTar

func CreateMappedTar(w io.Writer, root string, pathMap map[string][]string) error

func CreateTar

func CreateTar(w io.Writer, root string, paths []string) error

func CreateTarGz

func CreateTarGz(w io.Writer, root string, paths []string) error

func CreateTarWithParents

func CreateTarWithParents(w io.Writer, root string, paths []string, uid, gid int, modTime time.Time) error

func Download

func Download(url string) ([]byte, error)

func ExecuteEnvTemplate

func ExecuteEnvTemplate(envTemplate *template.Template, customMap map[string]string) (string, error)

ExecuteEnvTemplate executes an envTemplate based on OS environment variables and a custom map

func Expand

func Expand(text, key, value string) string

Expand replaces placeholders for a given key with a given value. It supports the ${key} and the $key syntax.

func ExpandEnvTemplate

func ExpandEnvTemplate(s string, envMap map[string]string) (string, error)

ExpandEnvTemplate parses and executes template s with an optional environment map

func ExpandPathsGlob

func ExpandPathsGlob(workingDir string, paths []string) ([]string, error)

ExpandPathsGlob expands paths according to filepath.Glob patterns Returns a list of unique files that match the glob patterns passed in.

func GetAvailablePort

func GetAvailablePort(address string, port int, usedPorts *PortSet) int

See https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt,

func IsDir

func IsDir(path string) bool

func IsFile

func IsFile(path string) bool

func IsHiddenDir

func IsHiddenDir(filename string) bool

IsHiddenDir returns if a directory is hidden.

func IsHiddenFile

func IsHiddenFile(filename string) bool

IsHiddenFile returns if a file is hidden. File is hidden if it starts with prefix "."

func IsPortFree

func IsPortFree(address string, p int) bool

func IsTerminal

func IsTerminal(w io.Writer) (uintptr, bool)

func IsURL

func IsURL(s string) bool

func NonEmptyLines

func NonEmptyLines(input []byte) []string

NonEmptyLines scans the provided input and returns the non-empty strings found as an array

func ParseEnvTemplate

func ParseEnvTemplate(t string) (*template.Template, error)

ParseEnvTemplate is a simple wrapper to parse an env template

func RandomID

func RandomID() string

func ReadConfiguration

func ReadConfiguration(filename string) ([]byte, error)

ReadConfiguration reads a `skaffold.yaml` configuration and returns its content.

func RegexEqual

func RegexEqual(expected, actual string) bool

RegexEqual matches the string 'actual' against a regex compiled from 'expected' If 'expected' is not a valid regex, string comparison is used as fallback

func RemoveFromSlice

func RemoveFromSlice(s []string, target string) []string

RemoveFromSlice removes a string from a slice of strings

func RunCmd

func RunCmd(cmd *exec.Cmd) error

func RunCmdOut

func RunCmdOut(cmd *exec.Cmd) ([]byte, error)

func StrSliceContains

func StrSliceContains(sl []string, s string) bool

func StrSliceIndex

func StrSliceIndex(sl []string, s string) int

func StrSliceInsert

func StrSliceInsert(sl []string, index int, insert []string) []string

func StringPtr

func StringPtr(s string) *string

StringPtr returns a pointer to a string

func VerifyOrCreateFile

func VerifyOrCreateFile(path string) error

VerifyOrCreateFile checks if a file exists at the given path, and if not, creates all parent directories and creates the file.

Types

type Command

type Command interface {
	RunCmdOut(cmd *exec.Cmd) ([]byte, error)
	RunCmd(cmd *exec.Cmd) error
}

Command is an interface used to run commands. All packages should use this interface instead of calling exec.Cmd directly.

var DefaultExecCommand Command = &Commander{}

DefaultExecCommand runs commands using exec.Cmd

type CommandWrapper

type CommandWrapper struct {
	// Executable is the base name of the command, like `gradle`
	Executable string

	// Wrapper is the optional base name of a command wrapper, like `gradlew`
	Wrapper string
}

CommandWrapper defines an association between an executable command (like `gradle`) and possible command wrappers (like `gradlew`). `CreateCommand` uses this definition to create a `Cmd` object. Maven and Gradle projects often provide a wrapper script to ensure a particular version of their builder is used.

func (CommandWrapper) CreateCommand

func (cw CommandWrapper) CreateCommand(ctx context.Context, workingDir string, args []string) exec.Cmd

CreateCommand creates an `exec.Cmd` that is configured to call the executable (possibly using a wrapper in `workingDir`, when found) with the given arguments, with working directory set to `workingDir`.

type Commander

type Commander struct{}

Commander is the exec.Cmd implementation of the Command interface

func (*Commander) RunCmd

func (*Commander) RunCmd(cmd *exec.Cmd) error

RunCmd runs an exec.Command.

func (*Commander) RunCmdOut

func (*Commander) RunCmdOut(cmd *exec.Cmd) ([]byte, error)

RunCmdOut runs an exec.Command and returns the stdout and error.

type Gsutil

type Gsutil struct{}

func (*Gsutil) Copy

func (g *Gsutil) Copy(ctx context.Context, src, dst string, recursive bool) error

Copy calls `gsutil cp [-r] <source_url> <destination_url>

type PortSet

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

func (*PortSet) Delete

func (f *PortSet) Delete(port int)

func (*PortSet) Length

func (f *PortSet) Length() int

func (*PortSet) List

func (f *PortSet) List() []int

func (*PortSet) LoadOrSet

func (f *PortSet) LoadOrSet(port int) bool

func (*PortSet) Set

func (f *PortSet) Set(port int)