common

Documentation

Overview

Package common collection of small utils

Index

• Variables
• func CanRead(filename string) bool
• func ChdirToFile(file string) error
• func CheckSkip(line string) (skip bool)
• func CheckType(t any, expected string) (ok bool, haveType string)
• func CmdFlagChanged(cmd *cobra.Command, name string) (changed bool)
• func CmdRun(cmd *cobra.Command, args []string) (out string, err error)
• func CommandExists(command string) bool
• func DestroyDockerContainer(container *dockertest.Resource)
• func ExecDockerCmd(container *dockertest.Resource, cmd []string) (out string, code int, err error)
• func ExecuteOsCommand(cmdArgs []string, stdIn io.Reader) (stdOut string, stdErr string, err error)
• func FileExists(filename string) bool
• func FindCommand(name string) string
• func FindFileInPath(filename string, dirs []string) string
• func FormatUnixtsString(ts string, layout string) string
• func GetBoolEnv(key string, fallback bool) bool
• func GetBoolVal(value string) (bool, error)
• func GetContainerHostAndPort(container *dockertest.Resource, portID string) (server string, port int)
• func GetDockerAPIVersion(client *docker.Client) (v string)
• func GetDockerHost(pool *dockertest.Pool) string
• func GetDockerPool() (*dockertest.Pool, error)
• func GetEnv(key, fallback string) string
• func GetFloatEnv(key string, fallback float64) float64
• func GetFloatVal(value string) (float64, error)
• func GetGitRootDir(start string) (rootDir string, err error)
• func GetGitlabJobURL() string
• func GetGitlabPipelineURL() string
• func GetHexInt64Val(value string) (int64, error)
• func GetHostPort(input string) (host string, port int, err error)
• func GetHostname() string
• func GetInt64Val(value string) (int64, error)
• func GetIntEnv(key string, fallback int) int
• func GetIntVal(value string) (int, error)
• func GetLastCommit(gitDir string, filename string) (c *object.Commit, err error)
• func GetStringEnv(key string, fallback string) string
• func GetVersionedDockerPool(version string) (pool *dockertest.Pool, err error)
• func HTTPGet(url string, timeout int) (resp string, err error)
• func InArray(needle interface{}, haystack interface{}) (exists bool, index int)
• func IsDir(name string) bool
• func IsFile(name string) bool
• func IsGitFile(filename string) (rootDir string, gitFileName string, err error)
• func IsNil(i interface{}) bool
• func IsNumeric(s string) bool
• func MergeMaps(m1, m2 interface{}) (interface{}, error)
• func PromptPassword(label string) (pw string, err error)
• func RandString(n int) string
• func ReadFileByLine(filename string) ([]string, error)
• func ReadFileToString(filename string) (string, error)
• func ReadFileToStruct(filename string, data any) (err error)
• func ReadStdinByLine() ([]string, error)
• func ReadStdinToString() (string, error)
• func RemoveSpace(s string) string
• func ReverseMap[M ~map[K]V, K comparable, V comparable](m M) map[V]K
• func SetHostPort(host string, port int) string
• func StructToJSON(m interface{}) (string, error)
• func StructToMap(obj interface{}) (map[string]interface{}, error)
• func StructToString(o interface{}, prefix string) (s string)
• func WriteStringToFile(filename string, content string) error

Variables

var (
	// DefaultPorts is a map of default ports for common services
	DefaultPorts = map[string]int{
		"http":           80,
		"https":          443,
		"ftp":            21,
		"ftps":           990,
		"ssh":            22,
		"ldap":           389,
		"ldaps":          636,
		"imap":           143,
		"imaps":          993,
		"smtp":           25,
		"smtps":          465,
		"pop3":           110,
		"pop3s":          995,
		"mysql":          3306,
		"postgresql":     5432,
		"oracle":         1521,
		"mssql":          1433,
		"mongodb":        27017,
		"redis":          6379,
		"memcached":      11211,
		"couchdb":        5984,
		"couchbase":      8091,
		"cassandra":      9042,
		"elasticsearch":  9200,
		"kibana":         5601,
		"grafana":        3000,
		"prometheus":     9090,
		"alertmanager":   9093,
		"consul":         8500,
		"vault":          8200,
		"nomad":          4646,
		"etcd":           2379,
		"zookeeper":      2181,
		"kafka":          9092,
		"rabbitmq":       5672,
		"nats":           4222,
		"nats-streaming": 4223,
		"mqtt":           1883,
		"coap":           5683,
		"dns":            53,
		"dhcp":           67,
		"tftp":           69,
		"ntp":            123,
		"snmp":           161,
		"syslog":         514,
		"radius":         1812,
		"radius-acct":    1813,
	}
)

var InputReader = os.Stdin

Functions

func CanRead

func CanRead(filename string) bool

CanRead checks if a file can be read(opened

func ChdirToFile

func ChdirToFile(file string) error

ChdirToFile change working directory to the filename

func CheckSkip

func CheckSkip(line string) (skip bool)

CheckSkip checks if a line can be skipped

func CheckType

func CheckType(t any, expected string) (ok bool, haveType string)

CheckType checks if an interface is of a certain type and returns if it matches expected or is Nil

func CmdFlagChanged

func CmdFlagChanged(cmd *cobra.Command, name string) (changed bool)

CmdFlagChanged checks if the named commandline flag has been supplied and changed

func CmdRun

func CmdRun(cmd *cobra.Command, args []string) (out string, err error)

CmdRun starts a command and returns captured output

func CommandExists

func CommandExists(command string) bool

CommandExists checks if a command exists in PATH

func DestroyDockerContainer

func DestroyDockerContainer(container *dockertest.Resource)

DestroyDockerContainer destroys a docker container

func ExecDockerCmd

func ExecDockerCmd(container *dockertest.Resource, cmd []string) (out string, code int, err error)

ExecDockerCmd executes an OS cmd within container and print output

func ExecuteOsCommand

func ExecuteOsCommand(cmdArgs []string, stdIn io.Reader) (stdOut string, stdErr string, err error)

ExecuteOsCommand runs an OS command and returns output

func FileExists

func FileExists(filename string) bool

FileExists checks if a file or directory exists

func FindCommand

func FindCommand(name string) string

FindCommand searches for a command in the PATH environment variable

func FindFileInPath

func FindFileInPath(filename string, dirs []string) string

FindFileInPath searches for a file with the given name in the provided directories. It returns the absolute path of the found file, or an empty string if not found.

func FormatUnixtsString

func FormatUnixtsString(ts string, layout string) string

FormatUnixtsString converts a unix timestamp string to a human readable

func GetBoolEnv

func GetBoolEnv(key string, fallback bool) bool

GetBoolEnv read an OS Env variable and convert to bool

func GetBoolVal

func GetBoolVal(value string) (bool, error)

GetBoolVal convert String to bool

func GetContainerHostAndPort

func GetContainerHostAndPort(container *dockertest.Resource, portID string) (server string, port int)

GetContainerHostAndPort returns the mapped host and port of a docker container for a given portID

func GetDockerAPIVersion

func GetDockerAPIVersion(client *docker.Client) (v string)

GetDockerAPIVersion returns the running supported docker API version

func GetDockerHost

func GetDockerHost(pool *dockertest.Pool) string

GetDockerHost returns the docker host from a pool

func GetDockerPool

func GetDockerPool() (*dockertest.Pool, error)

GetDockerPool initializes a docker pool

func GetEnv

func GetEnv(key, fallback string) string

GetEnv read an OS Env variable

func GetFloatEnv

func GetFloatEnv(key string, fallback float64) float64

GetFloatEnv read an OS Env variable and convert to float64

func GetFloatVal

func GetFloatVal(value string) (float64, error)

GetFloatVal convert String to float64

func GetGitRootDir

func GetGitRootDir(start string) (rootDir string, err error)

GetGitRootDir returns the root directory of a git repository

func GetGitlabJobURL

func GetGitlabJobURL() string

func GetGitlabPipelineURL

func GetGitlabPipelineURL() string

func GetHexInt64Val

func GetHexInt64Val(value string) (int64, error)

func GetHostPort

func GetHostPort(input string) (host string, port int, err error)

GetHostPort returns host and port from a string

func GetHostname

func GetHostname() string

GetHostname returns the hostname as full qualified domain name

func GetInt64Val

func GetInt64Val(value string) (int64, error)

GetInt64Val convert String to int64

func GetIntEnv

func GetIntEnv(key string, fallback int) int

GetIntEnv read an OS Env variable and convert to int

func GetIntVal

func GetIntVal(value string) (int, error)

GetIntVal convert String to int

func GetLastCommit

func GetLastCommit(gitDir string, filename string) (c *object.Commit, err error)

GetLastCommit returns a string with last commit details for given file

func GetStringEnv

func GetStringEnv(key string, fallback string) string

GetStringEnv read an OS Env variable

func GetVersionedDockerPool

func GetVersionedDockerPool(version string) (pool *dockertest.Pool, err error)

GetVersionedDockerPool returns a docker pool with a specific docker version, use running version if empty

func HTTPGet

func HTTPGet(url string, timeout int) (resp string, err error)

HTTPGet returns the body of a GET request

func InArray

func InArray(needle interface{}, haystack interface{}) (exists bool, index int)

InArray will search element inside array with any type. Will return boolean and index for matched element. True and index more than 0 if element is exist. needle is element to search, haystack is slice of value to be search. Taken from https://github.com/SimonWaldherr/golang-examples/blob/master/advanced/in_array.go

func IsDir

func IsDir(name string) bool

IsDir checks if a filename is a directory

func IsFile

func IsFile(name string) bool

IsFile checks if a filename is a file

func IsGitFile

func IsGitFile(filename string) (rootDir string, gitFileName string, err error)

IsGitFile returns nil if given file is part of a git repo or a meaningful message

func IsNil

func IsNil(i interface{}) bool

IsNil checks if an interface is nil

func IsNumeric

func IsNumeric(s string) bool

IsNumeric checks if a trimmed string is numeric using regexp

func MergeMaps

func MergeMaps(m1, m2 interface{}) (interface{}, error)

MergeMapsAny merges two maps of any types, inserting all key-value pairs from the second map into the first map, and returns the updated map. Note: Both input maps must be of the same type.

func PromptPassword

func PromptPassword(label string) (pw string, err error)

func RandString

func RandString(n int) string

RandString generates a pseudo random string with letters and digits with desired length

func ReadFileByLine

func ReadFileByLine(filename string) ([]string, error)

ReadFileByLine read a file and return array of lines

func ReadFileToString

func ReadFileToString(filename string) (string, error)

ReadFileToString read a file and return a string

func ReadFileToStruct

func ReadFileToStruct(filename string, data any) (err error)

ReadFileToStruct reads a file or from stdin and fills a given struct

func ReadStdinByLine

func ReadStdinByLine() ([]string, error)

ReadStdinByLine reads stdin and returns array of lines

func ReadStdinToString

func ReadStdinToString() (string, error)

ReadStdinToString reads stdin and returns a string

func RemoveSpace

func RemoveSpace(s string) string

RemoveSpace deletes all spaces and newlines from string

func ReverseMap

func ReverseMap[M ~map[K]V, K comparable, V comparable](m M) map[V]K

ReverseMap will reverse a map

func SetHostPort

func SetHostPort(host string, port int) string

SetHostPort returns host:port from a string host and port int

func StructToJSON

func StructToJSON(m interface{}) (string, error)

func StructToMap

func StructToMap(obj interface{}) (map[string]interface{}, error)

StructToMap converts a struct to a map

func StructToString

func StructToString(o interface{}, prefix string) (s string)

StructToString converts a struct to sorted key string

func WriteStringToFile

func WriteStringToFile(filename string, content string) error

WriteStringToFile saves a string to filename and assign rights 0600