utils

Documentation

Index

• func CancelOnInterrupt(ctx context.Context) context.Context
• func CreateTempFile(t *testing.T, data string) string
• func IsMaxRetries(err error) bool
• func KillContainer(containerName string) error
• func OrStrings(strs ...string) string
• func PullImage(imageName string) error
• func Retry(fn Func, maxRetries int) error
• func RunContainer(containerName string, imageName string, exposedPorts nat.PortSet, ...) error
• func RunContainerWithEnv(containerName string, imageName string, envVariables []string, ...) error
• type Func

Functions

func CancelOnInterrupt

func CancelOnInterrupt(ctx context.Context) context.Context

CancelOnInterrupt creates a context and calls the context cancel function when an interrupt signal is caught

func CreateTempFile

func CreateTempFile(t *testing.T, data string) string

CreateTempFile creates a temporary file for tests with data as content.

func IsMaxRetries

func IsMaxRetries(err error) bool

IsMaxRetries checks whether the error is due to hitting the maximum number of retries or not.

func KillContainer

func KillContainer(containerName string) error

KillContainer stops and removes specified container.

func OrStrings

func OrStrings(strs ...string) string

OrStrings returns the first non empty string in its arguments

func PullImage

func PullImage(imageName string) error

PullImage pulls an image from docker hub if image is not available or not up to date.

func Retry

func Retry(fn Func, maxRetries int) error

Retry keeps trying the function until the second argument returns false, or no error is returned.

func RunContainer

func RunContainer(containerName string, imageName string, exposedPorts nat.PortSet, portBindings nat.PortMap) error

RunContainer reproduces docker run command.

func RunContainerWithEnv

func RunContainerWithEnv(containerName string, imageName string, envVariables []string, exposedPorts nat.PortSet, portBindings nat.PortMap) error

RunContainerWithEnv reproduces docker run command.

Types

type Func

type Func func(attempt int) (retry bool, err error)

Func represents functions that can be retried.