utils

Documentation

Index

• func DockerUtils() (du *dockerUtils)
• func HashUtils() *hashUtils
• func JsonUtils() *jsonUtils
• func PrintBanner(banner string)
• func RecoverAll(cb func(v any))
• func RecoverAny(errors []error, cb func(v any))
• func RecoverOne(e error, cb func(v any))
• func SetSecret(secret, vector []byte) error
• func StringUtils() *stringUtils
• func TimeUtils(ts Timestamp) *timeUtils
• type DockerContainer
  • func (c *DockerContainer) AutoRemove(value bool) *DockerContainer
  • func (c *DockerContainer) EntryPoint(args ...string) *DockerContainer
  • func (c *DockerContainer) Exists() bool
  • func (c *DockerContainer) IsRunning() bool
  • func (c *DockerContainer) Label(label, value string) *DockerContainer
  • func (c *DockerContainer) Labels(label map[string]string) *DockerContainer
  • func (c *DockerContainer) Name(value string) *DockerContainer
  • func (c *DockerContainer) Port(external, internal string) *DockerContainer
  • func (c *DockerContainer) Ports(ports map[string]string) *DockerContainer
  • func (c *DockerContainer) Run() error
  • func (c *DockerContainer) Stop() error
  • func (c *DockerContainer) Var(key, value string) *DockerContainer
  • func (c *DockerContainer) Vars(vars map[string]string) *DockerContainer
• type HttpUtilsStruct
  • func HttpUtils() *HttpUtilsStruct
  • func (u *HttpUtilsStruct) New(method, url string) *HttpUtilsStruct
  • func (u *HttpUtilsStruct) Send() (*http.Response, error)
  • func (u *HttpUtilsStruct) WithBody(body string) *HttpUtilsStruct
  • func (u *HttpUtilsStruct) WithHeader(key, value string) *HttpUtilsStruct
  • func (u *HttpUtilsStruct) WithHeaders(headers map[string]string) *HttpUtilsStruct
  • func (u *HttpUtilsStruct) WithTimeout(timeout int) *HttpUtilsStruct
• type TokenUtilsStruct
  • func TokenUtils() *TokenUtilsStruct
  • func (t *TokenUtilsStruct) CreateApiKey(appName string) (string, error)
  • func (t *TokenUtilsStruct) CreateToken(claims *jwt.RegisteredClaims) (string, error)
  • func (t *TokenUtilsStruct) ParseApiKey(apiKey string) (string, error)
  • func (t *TokenUtilsStruct) ParseToken(tokenString string) (*jwt.RegisteredClaims, error)

Functions

func DockerUtils

func DockerUtils() (du *dockerUtils)

DockerUtils is a simple utility to execute docker commands using shell This utility does not us the docker client library (due to compatability issues) but instead utilizes the shell command executor (from os/exec package). The pre-requisite

func HashUtils

func HashUtils() *hashUtils

HashUtils is a factory method that acts as a static member

func JsonUtils

func JsonUtils() *jsonUtils

JsonUtils factory method

func PrintBanner

func PrintBanner(banner string)

PrintBanner displays the application's banner and lists all configuration variables along with their values in alphabetical order. This function is designed to provide a clear overview of the application's current configuration state at startup or when needed, facilitating easier debugging and configuration verification. It ensures that the configuration variables are presented in a sorted manner for quick reference and readability.

func RecoverAll

func RecoverAll(cb func(v any))

RecoverAll performs recover for all panics.

Sample usage:

defer RecoverAll(func(err any) {
	fmt.Printf("got error: %s", err)
})

func RecoverAny

func RecoverAny(errors []error, cb func(v any))

RecoverAny calls the callback function: cb with recovered value in case when recovered value exists in slice errors.

Sample usage:

		defer recover.Any([]error{ErrorUsernameBlank, ErrorUsernameAlreadyTaken}, func(err any) {
 		fmt.Printf("got error: %s", err)
		})

func RecoverOne

func RecoverOne(e error, cb func(v any))

RecoverOne calls the callback function: cb with recovered value in case when recovered value equals to e otherwise panic won't be recovered and will be propagated.

Sample usage:

defer recover.One(ErrorUsernameBlank, func(err any) {
	fmt.Printf("got error: %s", err)
})

func SetSecret

func SetSecret(secret, vector []byte) error

SetSecret set the secret key and initializing vector to encode/decode API keys

func StringUtils

func StringUtils() *stringUtils

StringUtils factory method

func TimeUtils

func TimeUtils(ts Timestamp) *timeUtils

TimeUtils is a factory method

Types

type DockerContainer

type DockerContainer struct {
	// contains filtered or unexported fields
}

DockerContainer is used to construct docker container spec for the docker engine.

func (*DockerContainer) AutoRemove

func (c *DockerContainer) AutoRemove(value bool) *DockerContainer

AutoRemove determines whether to automatically remove the container when it has stopped

func (*DockerContainer) EntryPoint

func (c *DockerContainer) EntryPoint(args ...string) *DockerContainer

EntryPoint sets the entrypoint arguments of the container.

func (*DockerContainer) Exists

func (c *DockerContainer) Exists() bool

Exists return true if the container exists

func (*DockerContainer) IsRunning

func (c *DockerContainer) IsRunning() bool

IsRunning return true if the container exists and running

func (*DockerContainer) Label

func (c *DockerContainer) Label(label, value string) *DockerContainer

Label adds custom label

func (*DockerContainer) Labels

func (c *DockerContainer) Labels(label map[string]string) *DockerContainer

Labels adds multiple labels

func (*DockerContainer) Name

func (c *DockerContainer) Name(value string) *DockerContainer

Name sets the container name.

func (*DockerContainer) Port

func (c *DockerContainer) Port(external, internal string) *DockerContainer

Port adds a port mapping

func (*DockerContainer) Ports

func (c *DockerContainer) Ports(ports map[string]string) *DockerContainer

Ports adds multiple port mappings

func (*DockerContainer) Run

func (c *DockerContainer) Run() error

Run builds and run command

func (*DockerContainer) Stop

func (c *DockerContainer) Stop() error

Stop and kill container

func (*DockerContainer) Var

func (c *DockerContainer) Var(key, value string) *DockerContainer

Var adds an environment variable

func (*DockerContainer) Vars

func (c *DockerContainer) Vars(vars map[string]string) *DockerContainer

Vars adds multiple environment variables

type HttpUtilsStruct

type HttpUtilsStruct struct {
	TimeoutSec int
	// contains filtered or unexported fields
}

func HttpUtils

func HttpUtils() *HttpUtilsStruct

HttpUtils is a factory method that acts as a static member

func (*HttpUtilsStruct) New

func (u *HttpUtilsStruct) New(method, url string) *HttpUtilsStruct

func (*HttpUtilsStruct) Send

func (u *HttpUtilsStruct) Send() (*http.Response, error)

func (*HttpUtilsStruct) WithBody

func (u *HttpUtilsStruct) WithBody(body string) *HttpUtilsStruct

func (*HttpUtilsStruct) WithHeader

func (u *HttpUtilsStruct) WithHeader(key, value string) *HttpUtilsStruct

func (*HttpUtilsStruct) WithHeaders

func (u *HttpUtilsStruct) WithHeaders(headers map[string]string) *HttpUtilsStruct

func (*HttpUtilsStruct) WithTimeout

func (u *HttpUtilsStruct) WithTimeout(timeout int) *HttpUtilsStruct

type TokenUtilsStruct

type TokenUtilsStruct struct {
}

func TokenUtils

func TokenUtils() *TokenUtilsStruct

TokenUtils is a factory method that acts as a static member

func (*TokenUtilsStruct) CreateApiKey

func (t *TokenUtilsStruct) CreateApiKey(appName string) (string, error)

CreateApiKey generate API Key from application name

func (*TokenUtilsStruct) CreateToken

func (t *TokenUtilsStruct) CreateToken(claims *jwt.RegisteredClaims) (string, error)

CreateToken build JWT token from Token Data structure

func (*TokenUtilsStruct) ParseApiKey

func (t *TokenUtilsStruct) ParseApiKey(apiKey string) (string, error)

ParseApiKey extract application name from API key

func (*TokenUtilsStruct) ParseToken

func (t *TokenUtilsStruct) ParseToken(tokenString string) (*jwt.RegisteredClaims, error)

ParseToken rebuild Token Data structure from JWT token