utils

Documentation

Index

• Variables
• func CheckErr(err error)
• func DirWritable(path string) bool
• func FilesExisting(files ...string) []string
• func FindFilesInDir(dir string, name string) ([]string, error)
• func FormatProjectName(projectName string) string
• func GetInterfaceIpv4Addr(interfaceName string) (string, error)
• func GetNextListener(opts ...getNextListenerOption) (net.Listener, error)
• func GlobInDir(dir, pattern string) ([]string, error)
• func GoPath() (string, error)
• func JoinCamelCase(ss []string) string
• func MaxPort(maxPort int) getNextListenerOption
• func MinPort(minPort int) getNextListenerOption
• func NewIncompatibleWorkerError() error
• func NewNitricLogFile(stackPath string) (string, error)
• func NitricConfigDir() string
• func NitricHistoryFile(stackPath string, historyType string) (string, error)
• func NitricHomeDir() string
• func NitricLocalPassphrasePath() string
• func NitricLogDir(stackPath string) string
• func NitricPreferencesPath() string
• func NitricProviderDir() string
• func NitricRunDir() string
• func NitricStacksDir() (string, error)
• func NitricTemplatesDir() string
• func SplitPath(p string) []string
• func StringTrunc(s string, max int) string
• func Take(n int) ([]int, error)
• type GetterClient
  • func NewGetter(c *getter.Client) GetterClient

Variables

var (
	// Raw is the string representation of the version. This will be replaced
	// with the calculated version at build time.
	// set in the Makefile.
	Version = "was not built with version info"

	// Commit is the commit hash from which the software was built.
	// Set via LDFLAGS in Makefile.
	Commit = "unknown"

	// BuildTime is the string representation of build time.
	// Set via LDFLAGS in Makefile.
	BuildTime = "unknown"
)

Functions

func CheckErr

func CheckErr(err error)

func DirWritable

func DirWritable(path string) bool

func FilesExisting

func FilesExisting(files ...string) []string

func FindFilesInDir

func FindFilesInDir(dir string, name string) ([]string, error)

func FormatProjectName

func FormatProjectName(projectName string) string

func GetInterfaceIpv4Addr

func GetInterfaceIpv4Addr(interfaceName string) (string, error)

func GetNextListener

func GetNextListener(opts ...getNextListenerOption) (net.Listener, error)

GetNextListener - Gets the next available free port starting from a predefined minimum port Up to a pre-defined maximum port

func GlobInDir

func GlobInDir(dir, pattern string) ([]string, error)

func GoPath

func GoPath() (string, error)

func JoinCamelCase

func JoinCamelCase(ss []string) string

func MaxPort

func MaxPort(maxPort int) getNextListenerOption

func MinPort

func MinPort(minPort int) getNextListenerOption

func NewIncompatibleWorkerError

func NewIncompatibleWorkerError() error

func NewNitricLogFile

func NewNitricLogFile(stackPath string) (string, error)

NewNitricLogFile returns a path to a unique log file that does not exist.

func NitricConfigDir

func NitricConfigDir() string

NitricConfigDir returns the directory to find configuration.

func NitricHistoryFile

func NitricHistoryFile(stackPath string, historyType string) (string, error)

NitricHistoryFile returns a path to a request history file, making one if it doesn't exist

func NitricHomeDir

func NitricHomeDir() string

NitricHomeDir gets the nitric home directory

func NitricLocalPassphrasePath

func NitricLocalPassphrasePath() string

func NitricLogDir

func NitricLogDir(stackPath string) string

NitricLogDir returns the directory to find log files.

func NitricPreferencesPath

func NitricPreferencesPath() string

func NitricProviderDir

func NitricProviderDir() string

NitricProviderDir returns the directory to place provider deployment binaries.

func NitricRunDir

func NitricRunDir() string

NitricRunDir returns the directory to place runtime data.

func NitricStacksDir

func NitricStacksDir() (string, error)

func NitricTemplatesDir

func NitricTemplatesDir() string

NitricTemplatesDir returns the directory to place template related data.

func SplitPath

func SplitPath(p string) []string

SplitPath - splits a path into its component parts, ignoring leading or trailing slashes. e.g - SplitPath("/one/two/three/") == SplitPath("/one/two/three") == SplitPath("one/two/three") == ["one" "two" "three"]

func StringTrunc

func StringTrunc(s string, max int) string

func Take

func Take(n int) ([]int, error)

Take is just a wrapper around freeport.Take() that changes the stderr output to pterm.Debug

Types

type GetterClient

type GetterClient interface {
	Get() error
}

GetterClient exists because go-getter does not have an interface to mock.

func NewGetter

func NewGetter(c *getter.Client) GetterClient