util

package
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2018 License: Apache-2.0 Imports: 19 Imported by: 41

Documentation

Index

Constants

This section is empty.

Variables

View Source
var OSEnviron = os.Environ
View Source
var SkipWrapperCheck = false

Functions

func AbsFile added in v0.16.0

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 BoolPtr

func BoolPtr(b bool) *bool

BoolPtr returns a pointer to a bool

func CreateTar added in v0.4.0

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

func CreateTarGz

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

func ExecuteEnvTemplate added in v0.7.0

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 added in v0.15.0

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 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 HasMeta added in v0.16.0

func HasMeta(path string) bool

HasMeta reports whether path contains any of the magic characters recognized by filepath.Match. This is a copy of filepath/match.go's hasMeta

func IsSupportedKubernetesFormat

func IsSupportedKubernetesFormat(n string) bool

IsSupportedKubernetesFormat is for determining if a file under a glob pattern is deployable file format. It makes no attempt to check whether or not the file is actually deployable or has the correct contents.

func ParseEnvTemplate added in v0.7.0

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

ParseEnvTemplate is a simple wrapper to parse an env template

func RandomID

func RandomID() string

func ReadConfiguration added in v0.4.0

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

func RemoveFromSlice added in v0.14.0

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

RemoveFromSlice removes a string from a slice of strings

func RunCmd added in v0.6.0

func RunCmd(cmd *exec.Cmd) error

func RunCmdOut added in v0.6.0

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

func StrSliceContains

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

func StringPtr added in v0.11.0

func StringPtr(s string) *string

StringPtr returns a pointer to a string

func VerifyOrCreateFile added in v0.13.0

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 added in v0.16.0

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 added in v0.16.0

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 added in v0.6.0

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

RunCmd runs an exec.Command.

func (*Commander) RunCmdOut added in v0.6.0

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL