testament

README

Testament

For all your testing needs.

1. Introduction
2. Development
   • Prerequisite
   • Running Tests
   • Make Examples

Introduction

These are common tools we usually use in our tests.

Function	Description
AssertInError	Check if an error is found in a deeply nested errors
RandomString	Generates a randomly generated string by given length
GetFreeOpenPort	Returns a port that is already claimed.
GetFreePort	Returns a random open port.
RandomString	Returns a randomly generates string with the length of count.
RandomLowerString	Returns a randomly generates lower-cased string with a maximum length.
StringSlice	Return a string slice with the provided length.
RandomStringSlice	Return a random string slice with maximum length.
IntSlice	Returns a slice of int elements with the provided length.
RandIntSlice	Returns a slice of int elements with random length of less than n.
Int32Slice
RandInt32Slice
Int64Slice
RandInt64Slice
IntSliceComparer	Is a go-cmp comparer that doesn't care if the slices are not sorted.
Int32SliceComparer
Int64SliceComparer
StringSliceComparer
RandomEmailAddress	Returns a valid random email address.

Development

Prerequisite

This project supports Go >= 1.18. To run targets from the Makefile you need to install GNU make.

In order to install dependencies:

make dependencies

This also installs reflex to help with development process.

Running Tests

To watch for file changes and run unit_test:

make unit_test_watch
# or to run them with race flag:
make unit_test_race_watch

There is also a integration_test target for running integration tests.

Make Examples

make                           # shows help on targets.
make unit_test
make unit_test run=TestMyTest   # runs a specific test with regexp.
make unit_test dir=./path/...   # runs tests in a package.
make unit_test dir=./path/... run=TestSomethingElse

Please see the Makefile for more targets.

Documentation

Overview

Package testament provides convinience tools in testing.

Error Helper

The error specific functions are helpers for checking nested errors, or gRPC specific codes.

Network Helpers

These helpers can acquire random free network port.

Randomise Helpers

There are some useful helpers for creating random strings, slices, etc.

Comparer Helpers

These helpers are useful to be used with the google's cmp package.

Index

• Variables
• func AssertInError(t *testing.T, haystack, needle error) bool
• func AssertIsCode(t *testing.T, err error, code codes.Code) bool
• func GetFreeOpenPort(t *testing.T) (uint, net.Listener)
• func GetFreePort(t *testing.T) uint
• func Int32Slice(n int) []int32
• func Int64Slice(n int) []int64
• func IntSlice(n int) []int
• func RandInt32Slice(n int) []int32
• func RandInt64Slice(n int) []int64
• func RandIntSlice(n int) []int
• func RandomEmailAddress() string
• func RandomLowerString(count int) string
• func RandomS3Filename() string
• func RandomString(count int) string
• func RandomStringSlice(max int) []string
• func StringSlice(n int) []string

Variables

var Int32SliceComparer = cmp.Comparer(func(a, b []int32) bool {
	return equal(a, b)
})

Int32SliceComparer is a go-cmp comparer that doesn't care if the slices in question is not sorted. The slices are copies and can be safely reused.

var Int64SliceComparer = cmp.Comparer(func(a, b []int64) bool {
	return equal(a, b)
})

Int64SliceComparer is a go-cmp comparer that doesn't care if the slices in question is not sorted. The slices are copies and can be safely reused.

var IntSliceComparer = cmp.Comparer(func(a, b []int) bool {
	return equal(a, b)
})

IntSliceComparer is a go-cmp comparer that doesn't care if the slices in question is not sorted. The slices are copies and can be safely reused.

var StringSliceComparer = cmp.Comparer(func(a, b []string) bool {
	return equal(a, b)
})

StringSliceComparer is a go-cmp comparer that doesn't care if the slices in question is not sorted. The slices are copies and can be safely reused.

Functions

func AssertInError

func AssertInError(t *testing.T, haystack, needle error) bool

AssertInError returns true if the needle is found in stack, which is created either with pkg/errors help, the multierror or Go's error wrap. It will fall back to checking the contents of the needle.Error() is in haystack.Error().

func AssertIsCode

func AssertIsCode(t *testing.T, err error, code codes.Code) bool

AssertIsCode is a helper to assert the err error contains the code.

func GetFreeOpenPort

func GetFreeOpenPort(t *testing.T) (uint, net.Listener)

GetFreeOpenPort returns a port that is already claimed. It closes the listener on test cleanup.

func GetFreePort

func GetFreePort(t *testing.T) uint

GetFreePort returns a random open port.

func Int32Slice

func Int32Slice(n int) []int32

Int32Slice returns a slice of int32 elements with provided length.

func Int64Slice

func Int64Slice(n int) []int64

Int64Slice returns a slice of int64 elements with provided length.

func IntSlice

func IntSlice(n int) []int

IntSlice returns a slice of int elements with the provided length.

func RandInt32Slice

func RandInt32Slice(n int) []int32

RandInt32Slice returns a slice of int32 elements with random length of less than n.

func RandInt64Slice

func RandInt64Slice(n int) []int64

RandInt64Slice returns a slice of int64 elements with random length of less than n.

func RandIntSlice

func RandIntSlice(n int) []int

RandIntSlice returns a slice of int elements with random length of less than n.

func RandomEmailAddress

func RandomEmailAddress() string

RandomEmailAddress returns a random email address.

func RandomLowerString

func RandomLowerString(count int) string

RandomLowerString returns a randomly generates lower-cased string with the length of count.

func RandomS3Filename

func RandomS3Filename() string

RandomS3Filename returns a random S3 filename with a subfolder.

func RandomString

func RandomString(count int) string

RandomString returns a randomly generates string with the length of count.

func RandomStringSlice

func RandomStringSlice(max int) []string

RandomStringSlice return a random string slice with maximum length of max.

func StringSlice

func StringSlice(n int) []string

StringSlice return a string slice with the provided length.