utils

Documentation

Index

• Constants
• func AddEscapingParentheses(pattern, target string) string
• func AddTrailingSlashIfNeeded(url string) string
• func Bool2Int(b bool) int
• func BuildTargetPath(pattern, path, target string, ignoreRepo bool) (string, error)
• func CheckErrorWithMessage(err error, message string) error
• func ConvertSliceToMap(slice []string) map[string]bool
• func CopyMap(src map[string]string) (dst map[string]string)
• func GetBoolEnvValue(flagName string, defValue bool) (bool, error)
• func GetLogMsgPrefix(threadId int, dryRun bool) string
• func GetRegExp(regex string) (*regexp.Regexp, error)
• func GetRootPath(path string, useRegExp bool) string
• func GetUserAgent() string
• func GetUserHomeDir() string
• func IndentJson(jsonStr []byte) string
• func IsWindows() bool
• func MaskCredentials(completeUrl, credentialsPart string) string
• func MergeMaps(src map[string]string, dst map[string]string)
• func PrepareLocalPathForUpload(localPath string, useRegExp bool) string
• func RemovePlaceholderParentheses(pattern, target string) string
• func ReplaceTildeWithUserHome(path string) string
• func SetUserAgent(newUserAgent string)
• func SplitWithEscape(str string, separator rune) []string
• func StringToBool(boolVal string, defaultValue bool) (bool, error)
• func TrimPath(path string) string
• type Artifact
• type ExecutionHandlerFunc
• type Parentheses
• type ParenthesesSlice
  • func (p *ParenthesesSlice) IsPresent(index int) bool
• type RetryExecutor
  • func (runner *RetryExecutor) Execute() error

Constants

const CredentialsInUrlRegexp = `((http|https):\/\/[%|\w]+:[%|\w]+@)`

const (
	Development = "development"
)

Functions

func AddEscapingParentheses

func AddEscapingParentheses(pattern, target string) string

Escapoing Parentheses with no corresponding placeholder

func AddTrailingSlashIfNeeded

func AddTrailingSlashIfNeeded(url string) string

func Bool2Int

func Bool2Int(b bool) int

func BuildTargetPath

func BuildTargetPath(pattern, path, target string, ignoreRepo bool) (string, error)

Replaces matched regular expression from path to corresponding {i} at target. Example 1:

pattern = "repoA/1(.*)234" ; path = "repoA/1hello234" ; target = "{1}" ; ignoreRepo = false
returns "hello"

Example 2:

pattern = "repoA/1(.*)234" ; path = "repoB/1hello234" ; target = "{1}" ; ignoreRepo = true
returns "hello"

func CheckErrorWithMessage

func CheckErrorWithMessage(err error, message string) error

func ConvertSliceToMap

func ConvertSliceToMap(slice []string) map[string]bool

func CopyMap

func CopyMap(src map[string]string) (dst map[string]string)

func GetBoolEnvValue

func GetBoolEnvValue(flagName string, defValue bool) (bool, error)

func GetLogMsgPrefix

func GetLogMsgPrefix(threadId int, dryRun bool) string

func GetRegExp

func GetRegExp(regex string) (*regexp.Regexp, error)

func GetRootPath

func GetRootPath(path string, useRegExp bool) string

Get the local root path, from which to start collecting artifacts to be used for: 1. Uploaded to Artifactory, 2. Adding to the local build-info, to be later published to Artifactory.

func GetUserAgent

func GetUserAgent() string

func GetUserHomeDir

func GetUserHomeDir() string

func IndentJson

func IndentJson(jsonStr []byte) string

func IsWindows

func IsWindows() bool

func MaskCredentials

func MaskCredentials(completeUrl, credentialsPart string) string

Mask the credentials information from the completeUrl, contained in credentialsPart. The credentials are built as user:password For example: completeUrl = http://user:password@127.0.0.1:8081/artifactory/path/to/repo credentialsPart = http://user:password@ Returned value: http://***:***@127.0.0.1:8081/artifactory/path/to/repo

func MergeMaps

func MergeMaps(src map[string]string, dst map[string]string)

func PrepareLocalPathForUpload

func PrepareLocalPathForUpload(localPath string, useRegExp bool) string

func RemovePlaceholderParentheses

func RemovePlaceholderParentheses(pattern, target string) string

func ReplaceTildeWithUserHome

func ReplaceTildeWithUserHome(path string) string

func SetUserAgent

func SetUserAgent(newUserAgent string)

func SplitWithEscape

func SplitWithEscape(str string, separator rune) []string

Split str by the provided separator, escaping the separator if it is prefixed by a back-slash.

func StringToBool

func StringToBool(boolVal string, defaultValue bool) (bool, error)

func TrimPath

func TrimPath(path string) string

Types

type Artifact

type Artifact struct {
	LocalPath  string
	TargetPath string
	Symlink    string
}

type ExecutionHandlerFunc

type ExecutionHandlerFunc func() (bool, error)

type Parentheses

type Parentheses struct {
	OpenIndex  int
	CloseIndex int
}

This struct represents the parentheses used for defining Placeholders (Placeholders is a feature supported by File Specs).

type ParenthesesSlice

type ParenthesesSlice struct {
	Parentheses []Parentheses
}

func (*ParenthesesSlice) IsPresent

func (p *ParenthesesSlice) IsPresent(index int) bool

type RetryExecutor

type RetryExecutor struct {
	// The amount of retries to perform.
	MaxRetries int

	// Number of seconds to sleep between retries.
	RetriesInterval int

	// Message to display when retrying.
	ErrorMessage string

	// Prefix to print at the beginning of each log.
	LogMsgPrefix string

	// ExecutionHandler is the operation to run with retries.
	ExecutionHandler ExecutionHandlerFunc
}

func (*RetryExecutor) Execute

func (runner *RetryExecutor) Execute() error