utils

Documentation

Index

• func DockerUtils() (du *dockerUtils)
• func HashUtils() *hashUtils
• func JsonUtils() *jsonUtils
• func RecoverAll(cb func(v any))
• func RecoverAny(errors []error, cb func(v any))
• func RecoverOne(e error, cb func(v any))
• func SetAPISecret(secret, vector string) error
• func SetJWTSecret(secret string) error
• func TokenUtils() *tokenUtils
• 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

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 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 SetAPISecret

func SetAPISecret(secret, vector string) error

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

func SetJWTSecret

func SetJWTSecret(secret string) error

SetJWTSecret set the private key to sign JWT token

func TokenUtils

func TokenUtils() *tokenUtils

TokenUtils is a factory method that acts as a static member

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