util

Documentation

Index

• Variables
• func ErrorContains(contains string) assert.ErrorAssertionFunc
• func ErrorIs(target error) assert.ErrorAssertionFunc
• func HasIntersection(sliceOne, sliceTwo []string) bool
• func RandomHex(n int) (string, error)
• type Anything
• type FileSize
  • func FileSizeFromSize(size int) FileSize
  • func (f FileSize) String() string
• type InAndOut
• type Spy
  • func NewSpy() *Spy
  • func (s *Spy) GetError(method string, args ...interface{}) error
  • func (s *Spy) Register(method string, skip int, err error, args ...interface{}) *Spy
  • func (s *Spy) Reset()

Variables

var Any = Anything{} //nolint:gochecknoglobals // This is a special value, not intended to be modified.

Any is a special value that can be used to match any argument.

Functions

func ErrorContains

func ErrorContains(contains string) assert.ErrorAssertionFunc

ErrorContains returns an assertion to check if the error contains the given string.

func ErrorIs

func ErrorIs(target error) assert.ErrorAssertionFunc

ErrorIs returns an assertion to check if the error is the target error.

func HasIntersection

func HasIntersection(sliceOne, sliceTwo []string) bool

HasIntersection checks if two slices have any common elements.

func RandomHex

func RandomHex(n int) (string, error)

RandomHex generates an n-length, random hex string.

Types

type Anything

type Anything struct{}

Anything is a special type that can be used to match any argument.

type FileSize

type FileSize struct {
	Unit string
	Size int
}

FileSize represents a file size with units.

func FileSizeFromSize

func FileSizeFromSize(size int) FileSize

FileSizeFromSize returns a FileSize instance from the given size.

func (FileSize) String

func (f FileSize) String() string

String returns the string representation of the file size.

type InAndOut

type InAndOut struct {
	Skip  int
	Calls int
	In    []interface{}
	Out   error
}

InAndOut represents the input arguments and return value of a method.

type Spy

type Spy struct {
	Methods map[string][]InAndOut
	// contains filtered or unexported fields
}

Spy is a test spy that can be used to record method calls and their arguments.

func NewSpy

func NewSpy() *Spy

NewSpy creates a new Spy.

func (*Spy) GetError

func (s *Spy) GetError(method string, args ...interface{}) error

GetError returns a pre-defined error for a given method and arguments.

func (*Spy) Register

func (s *Spy) Register(method string, skip int, err error, args ...interface{}) *Spy

Register registers a method with its arguments and return value.

func (*Spy) Reset

func (s *Spy) Reset()