utils

Documentation

Overview

Package utils contains a collection of utility functions that can be used throughout the Go application.

Index

• func AddInfoIfErr(err error, info ...string) error
• func Panics(doesItPanic func()) (panics bool)
• func RunSingleArgumentTestCases[T, R any](t *testing.T, testName string, runFn func(T) R, ...)
• func RunThreeArgumentTestCases[T, U, V, R any](t *testing.T, testName string, runFn func(T, U, V) R, ...)
• func RunTwoArgumentTestCases[T, U, R any](t *testing.T, testName string, runFn func(T, U) R, ...)
• func TestingSlicesEqualWithoutOrder[R any](a, b []R) bool
• type GenericTestCase
• type GenericTestCaseWithNoWant
• type Option
  • func NewOption[V any](value V) Option[V]
  • func (o Option[V]) IsNil() bool
  • func (o Option[V]) IsSome() bool
  • func (o Option[V]) Unwrap() V
  • func (o Option[V]) UnwrapOr(defaultValue V) V
  • func (o Option[V]) UnwrapOrElse(f func() V) V
• type Result
  • func NewResult[V any](value V, err error) *Result[V]
  • func NewResultWithIgnoredErrs[V any](value V, err error, ignoredErrs ...error) *Result[V]
  • func (w *Result[V]) AddInfoIfErr(info ...string) bool
  • func (w *Result[V]) Destruct() (V, error)
  • func (w *Result[V]) FailTestIfErr(t *testing.T)
  • func (w *Result[V]) FailTestIfErrf(t *testing.T, format string, args ...interface{})
  • func (w *Result[V]) FailTestIfOk(t *testing.T)
  • func (w *Result[V]) FailTestIfOkf(t *testing.T, format string, args ...interface{})
  • func (w *Result[V]) IsErr() bool
  • func (w *Result[V]) IsOk() bool
  • func (w *Result[V]) Msg() string
  • func (w *Result[V]) Unwrap() V
  • func (w *Result[V]) UnwrapOr(defaultValue V) V
• type SingleArgumentTestCasesArgsType
• type ThreeArgumentTestCasesArgsType
• type TwoArgumentTestCasesArgsType

Functions

func AddInfoIfErr

func AddInfoIfErr(err error, info ...string) error

AddInfoIfErr adds info to the error that is passed in.

func Panics

func Panics(doesItPanic func()) (panics bool)

Panics returns true if the provided function panics. Source: https://www.reddit.com/r/golang/comments/2tj8b3/comment/cnzy3kc

func RunSingleArgumentTestCases

func RunSingleArgumentTestCases[T, R any](
	t *testing.T,
	testName string,
	runFn func(T) R,
	testCases []GenericTestCase[SingleArgumentTestCasesArgsType[T], R],
)

RunSingleArgumentTestCases runs a sets of test cases for a function that takes a single argument.

func RunThreeArgumentTestCases

func RunThreeArgumentTestCases[T, U, V, R any](
	t *testing.T,
	testName string,
	runFn func(T, U, V) R,
	testCases []GenericTestCase[ThreeArgumentTestCasesArgsType[T, U, V], R],
)

RunThreeArgumentTestCases runs a sets of test cases for a function that takes three arguments.

func RunTwoArgumentTestCases

func RunTwoArgumentTestCases[T, U, R any](
	t *testing.T,
	testName string,
	runFn func(T, U) R,
	testCases []GenericTestCase[TwoArgumentTestCasesArgsType[T, U], R],
)

RunTwoArgumentTestCases runs a sets of test cases for a function that takes two arguments.

func TestingSlicesEqualWithoutOrder

func TestingSlicesEqualWithoutOrder[R any](a, b []R) bool

TestingSlicesEqualWithoutOrder checks whether two slices are equal without order. Used for slices where order is not important or not defined, e.g. maps, sets, random samples.

Types

type GenericTestCase

type GenericTestCase[A any, W any] struct {
	Name string
	Args A
	Want W
}

GenericTestCase is a generic test case.

type GenericTestCaseWithNoWant

type GenericTestCaseWithNoWant[A any] struct {
	Name string
	Args A
}

GenericTestCaseWithNoWant is a generic test case with an option want.

type Option

type Option[V any] struct {
	Value *V
}

Option is a wrapper around a value that can be nil.

func NewOption

func NewOption[V any](value V) Option[V]

NewOption returns a new Option.

func (Option[V]) IsNil

func (o Option[V]) IsNil() bool

IsNil returns true if the Option is nil.

func (Option[V]) IsSome

func (o Option[V]) IsSome() bool

IsSome returns true if the Option is not nil.

func (Option[V]) Unwrap

func (o Option[V]) Unwrap() V

Unwrap returns the value of the Option or panics.

func (Option[V]) UnwrapOr

func (o Option[V]) UnwrapOr(defaultValue V) V

UnwrapOr returns the value of the Option or the provided default value.

func (Option[V]) UnwrapOrElse

func (o Option[V]) UnwrapOrElse(f func() V) V

UnwrapOrElse returns the value of the Option or the result of the provided function.

type Result

type Result[V any] struct {
	Value V
	Error error
	// contains filtered or unexported fields
}

func NewResult

func NewResult[V any](value V, err error) *Result[V]

NewResult returns a new Result with the given value and error.

func NewResultWithIgnoredErrs

func NewResultWithIgnoredErrs[V any](value V, err error, ignoredErrs ...error) *Result[V]

NewResultWithIgnoredErrs returns a new Result with the given value and error.

func (*Result[V]) AddInfoIfErr

func (w *Result[V]) AddInfoIfErr(info ...string) bool

AddInfoIfErr adds info to the error if Error is not nil. Returns true if the result contained an error.

func (*Result[V]) Destruct

func (w *Result[V]) Destruct() (V, error)

Destruct returns the value and error of the Result.

func (*Result[V]) FailTestIfErr

func (w *Result[V]) FailTestIfErr(t *testing.T)

FailTestIfErr fails the test if the Result is an error.

func (*Result[V]) FailTestIfErrf

func (w *Result[V]) FailTestIfErrf(t *testing.T, format string, args ...interface{})

func (*Result[V]) FailTestIfOk

func (w *Result[V]) FailTestIfOk(t *testing.T)

FailTestIfOk fails the test if the Result is ok.

func (*Result[V]) FailTestIfOkf

func (w *Result[V]) FailTestIfOkf(t *testing.T, format string, args ...interface{})

func (*Result[V]) IsErr

func (w *Result[V]) IsErr() bool

IsErr returns true if the Result is nil.

func (*Result[V]) IsOk

func (w *Result[V]) IsOk() bool

IsOk returns true if the Result is not nil.

func (*Result[V]) Msg

func (w *Result[V]) Msg() string

Msg returns the error message of the Result.

func (*Result[V]) Unwrap

func (w *Result[V]) Unwrap() V

Unwrap returns the value of the Result or panics with the error.

func (*Result[V]) UnwrapOr

func (w *Result[V]) UnwrapOr(defaultValue V) V

UnwrapOr returns the value of the Result or the provided default value.

type SingleArgumentTestCasesArgsType

type SingleArgumentTestCasesArgsType[T any] struct {
	A T
}

SingleArgumentTestCasesArgsType is the type of the arguments for a single argument test case.

type ThreeArgumentTestCasesArgsType

type ThreeArgumentTestCasesArgsType[T, U, V any] struct {
	A T
	B U
	C V
}

ThreeArgumentTestCasesArgsType is the type of the arguments for a three argument test case.

type TwoArgumentTestCasesArgsType

type TwoArgumentTestCasesArgsType[T, U any] struct {
	A T
	B U
}

TwoArgumentTestCasesArgsType is the type of the arguments for a two argument test case.