utils

Documentation

Index

• Variables
• func CreateFile(contents []byte, filename string, location string) error
• func DownloadFile(filepath string, url string) error
• func ErrGetBool(key string, err error) error
• func ErrGettingLatestReleaseTag(err error) error
• func ErrMarshal(err error) error
• func ErrReadingLocalFile(err error) error
• func ErrReadingRemoteFile(err error) error
• func ErrRemoteFileNotFound(url string) error
• func ErrUnmarshal(err error) error
• func ErrUnmarshalInvalid(err error, typ reflect.Type) error
• func ErrUnmarshalSyntax(err error, offset int64) error
• func ErrUnmarshalType(err error, value string) error
• func ErrUnmarshalUnsupportedType(err error, typ reflect.Type) error
• func ErrUnmarshalUnsupportedValue(err error, value reflect.Value) error
• func Filepath() string
• func GetBool(key string) (bool, error)
• func GetHome() string
• func GetLatestReleaseTag(org string, repo string) (string, error)
• func Git() (version, commitHead string)
• func Marshal(obj interface{}) (string, error)
• func MergeToTemplate(tpl []byte, data interface{}) ([]byte, error)
• func NewUUID() (string, error)
• func ReadFileSource(uri string) (string, error)
• func ReadLocalFile(location string) (string, error)
• func ReadRemoteFile(url string) (string, error)
• func StrConcat(s ...string) string
• func TcpCheck(hp *HostPort, mock *MockOptions) bool
• func Unmarshal(obj string, result interface{}) error
• type Endpoint
• type HostPort
• type MockOptions

Variables

var (
	ErrUnmarshalCode                 = "11043"
	ErrUnmarshalInvalidCode          = "11044"
	ErrUnmarshalSyntaxCode           = "11045"
	ErrUnmarshalTypeCode             = "11046"
	ErrUnmarshalUnsupportedTypeCode  = "11047"
	ErrUnmarshalUnsupportedValueCode = "11048"
	ErrMarshalCode                   = "11049"
	ErrGetBoolCode                   = "11050"
	ErrInvalidProtocolCode           = "11051"
	ErrRemoteFileNotFoundCode        = "11052"
	ErrReadingRemoteFileCode         = "11053"
	ErrReadingLocalFileCode          = "11054"
	ErrGettingLatestReleaseTagCode   = "11055"
	ErrInvalidProtocol               = errors.New(ErrInvalidProtocolCode, errors.Alert, []string{"invalid protocol: only http, https and file are valid protocols"}, []string{}, []string{"Network protocol is incorrect"}, []string{"Make sure to specify the right network protocol"})
)

Functions

func CreateFile

func CreateFile(contents []byte, filename string, location string) error

CreateFile creates a file with the given content on the given location with the given filename

func DownloadFile

func DownloadFile(filepath string, url string) error

func ErrGetBool

func ErrGetBool(key string, err error) error

func ErrGettingLatestReleaseTag

func ErrGettingLatestReleaseTag(err error) error

func ErrMarshal

func ErrMarshal(err error) error

func ErrReadingLocalFile

func ErrReadingLocalFile(err error) error

func ErrReadingRemoteFile

func ErrReadingRemoteFile(err error) error

func ErrRemoteFileNotFound

func ErrRemoteFileNotFound(url string) error

func ErrUnmarshal

func ErrUnmarshal(err error) error

func ErrUnmarshalInvalid

func ErrUnmarshalInvalid(err error, typ reflect.Type) error

func ErrUnmarshalSyntax

func ErrUnmarshalSyntax(err error, offset int64) error

func ErrUnmarshalType

func ErrUnmarshalType(err error, value string) error

func ErrUnmarshalUnsupportedType

func ErrUnmarshalUnsupportedType(err error, typ reflect.Type) error

func ErrUnmarshalUnsupportedValue

func ErrUnmarshalUnsupportedValue(err error, value reflect.Value) error

func Filepath

func Filepath() string

func GetBool

func GetBool(key string) (bool, error)

getBool function returns the boolean config data

func GetHome

func GetHome() string

GetHome returns the home path

func GetLatestReleaseTag

func GetLatestReleaseTag(org string, repo string) (string, error)

Gets the latest stable release tag from github for a given org name and repo name(in that org)

func Git

func Git() (version, commitHead string)

git method which allows fetch the git HEAD tag version and commit number

func Marshal

func Marshal(obj interface{}) (string, error)

func MergeToTemplate

func MergeToTemplate(tpl []byte, data interface{}) ([]byte, error)

MergeToTemplate merges data into the template tpl and returns the result.

func NewUUID

func NewUUID() (string, error)

func ReadFileSource

func ReadFileSource(uri string) (string, error)

ReadFileSource supports "http", "https" and "file" protocols. it takes in the location as a uri and returns the contents of file as a string.

func ReadLocalFile

func ReadLocalFile(location string) (string, error)

ReadLocalFile takes in the location of a local file in the format `file://location/of/file` and returns the content of the file if the path is valid and no error occurs

func ReadRemoteFile

func ReadRemoteFile(url string) (string, error)

ReadRemoteFile takes in the location of a remote file in the format 'http://location/of/file' or 'https://location/file' and returns the content of the file if the location is valid and no error occurs

func StrConcat

func StrConcat(s ...string) string

func TcpCheck

func TcpCheck(hp *HostPort, mock *MockOptions) bool

func Unmarshal

func Unmarshal(obj string, result interface{}) error

unmarshal returns parses the JSON config data and stores the value in the reference to result

Types

type Endpoint

type Endpoint struct {
	Name     string
	Internal *HostPort
	External *HostPort
}

Endpoint represents the structure for an endpoint

type HostPort

type HostPort struct {
	Address string
	Port    int32
}

type MockOptions

type MockOptions struct {
	DesiredEndpoint string
}