testutil

Documentation

Index

• func AssertNoUnmatchedRequests(t UnmatchedRequestsTestingT)
• func DeleteCreatedEntities(db *gorm.DB) func()
• type BufferLogger
  • func (l *BufferLogger) Bytes() []byte
  • func (l *BufferLogger) ForAccount(acc any) logger.Logger
  • func (l *BufferLogger) ForConnection(conn any) logger.Logger
  • func (l *BufferLogger) ForHandler(handler any) logger.Logger
  • func (l *BufferLogger) Read(p []byte) (n int, err error)
  • func (l *BufferLogger) Reset()
  • func (l *BufferLogger) String() string
  • func (l *BufferLogger) With(fields ...zapcore.Field) logger.Logger
  • func (l *BufferLogger) WithLazy(fields ...zapcore.Field) logger.Logger
• type BufferedLogger
  • func NewBufferedLogger() BufferedLogger
• type JSONRecordScanner
  • func NewJSONRecordScanner(entryProvider io.Reader) *JSONRecordScanner
  • func (s *JSONRecordScanner) Entry() LogRecord
  • func (s *JSONRecordScanner) Scan() error
  • func (s *JSONRecordScanner) ScanAll() ([]LogRecord, error)
• type LockableBuffer
  • func (b *LockableBuffer) Available() int
  • func (b *LockableBuffer) AvailableBuffer() []byte
  • func (b *LockableBuffer) Bytes() []byte
  • func (b *LockableBuffer) Cap() int
  • func (b *LockableBuffer) Grow(n int)
  • func (b *LockableBuffer) Len() int
  • func (b *LockableBuffer) Next(n int) []byte
  • func (b *LockableBuffer) Read(p []byte) (n int, err error)
  • func (b *LockableBuffer) ReadByte() (byte, error)
  • func (b *LockableBuffer) ReadBytes(delim byte) (line []byte, err error)
  • func (b *LockableBuffer) ReadFrom(r io.Reader) (n int64, err error)
  • func (b *LockableBuffer) ReadRune() (r rune, size int, err error)
  • func (b *LockableBuffer) ReadString(delim byte) (line string, err error)
  • func (b *LockableBuffer) Reset()
  • func (b *LockableBuffer) String() string
  • func (b *LockableBuffer) Sync() error
  • func (b *LockableBuffer) Truncate(n int)
  • func (b *LockableBuffer) UnreadByte() error
  • func (b *LockableBuffer) UnreadRune() error
  • func (b *LockableBuffer) Write(p []byte) (n int, err error)
  • func (b *LockableBuffer) WriteByte(c byte) error
  • func (b *LockableBuffer) WriteRune(r rune) (n int, err error)
  • func (b *LockableBuffer) WriteString(s string) (n int, err error)
  • func (b *LockableBuffer) WriteTo(w io.Writer) (n int64, err error)
• type LogRecord
• type ReadBuffer
• type TranslationsExtractor
  • func NewTranslationsExtractor(fileNameTemplate string) *TranslationsExtractor
  • func (t *TranslationsExtractor) GetMapKeys(data map[string]interface{}) []string
  • func (t *TranslationsExtractor) LoadLocale(locale string) (map[string]interface{}, error)
  • func (t *TranslationsExtractor) LoadLocaleKeys(locale string) ([]string, error)
• type UnmatchedRequestsTestingT

Functions

func AssertNoUnmatchedRequests

func AssertNoUnmatchedRequests(t UnmatchedRequestsTestingT)

AssertNoUnmatchedRequests check that gock didn't receive any request that it was not able to match. It will print out an entire request data for every unmatched request.

func DeleteCreatedEntities

func DeleteCreatedEntities(db *gorm.DB) func()

DeleteCreatedEntities sets up GORM `onCreate` hook and return a function that can be deferred to remove all the entities created after the hook was set up. You can use it like this:

func TestSomething(t *testing.T){
    db, _ := gorm.Open(...)
    cleaner := DeleteCreatedEntities(db)
    defer cleaner()
}.

Types

type BufferLogger

type BufferLogger struct {
	logger.Default
	// contains filtered or unexported fields
}

BufferLogger is an implementation of the BufferedLogger.

BufferLogger can be used in tests to match specific log messages. It uses JSON by default (hardcoded for now). It implements fmt.Stringer and provides an adapter to the underlying buffer, which means it can also return Bytes(), can be used like io.Reader and can be cleaned using Reset() method.

Usage:

log := NewBufferedLogger()
// Some other code that works with logger.
fmt.Println(log.String())

func (*BufferLogger) Bytes

func (l *BufferLogger) Bytes() []byte

Bytes is a shorthand for the underlying bytes.Buffer method. Returns byte slice with the buffer contents.

func (*BufferLogger) ForAccount

func (l *BufferLogger) ForAccount(acc any) logger.Logger

func (*BufferLogger) ForConnection

func (l *BufferLogger) ForConnection(conn any) logger.Logger

func (*BufferLogger) ForHandler

func (l *BufferLogger) ForHandler(handler any) logger.Logger

func (*BufferLogger) Read

func (l *BufferLogger) Read(p []byte) (n int, err error)

Read bytes from the logger buffer. io.Reader implementation.

func (*BufferLogger) Reset

func (l *BufferLogger) Reset()

Reset is a shorthand for the underlying bytes.Buffer method. It will reset buffer contents.

func (*BufferLogger) String

func (l *BufferLogger) String() string

String contents of the logger buffer. fmt.Stringer implementation.

func (*BufferLogger) With

func (l *BufferLogger) With(fields ...zapcore.Field) logger.Logger

func (*BufferLogger) WithLazy

func (l *BufferLogger) WithLazy(fields ...zapcore.Field) logger.Logger

type BufferedLogger

type BufferedLogger interface {
	ReadBuffer
	logger.Logger
}

BufferedLogger is a logger that can return the data written to it.

func NewBufferedLogger

func NewBufferedLogger() BufferedLogger

NewBufferedLogger returns new BufferedLogger instance.

type JSONRecordScanner

type JSONRecordScanner struct {
	// contains filtered or unexported fields
}

func NewJSONRecordScanner

func NewJSONRecordScanner(entryProvider io.Reader) *JSONRecordScanner

func (*JSONRecordScanner) Entry

func (s *JSONRecordScanner) Entry() LogRecord

func (*JSONRecordScanner) Scan

func (s *JSONRecordScanner) Scan() error

func (*JSONRecordScanner) ScanAll

func (s *JSONRecordScanner) ScanAll() ([]LogRecord, error)

type LockableBuffer

type LockableBuffer struct {
	// contains filtered or unexported fields
}

func (*LockableBuffer) Available

func (b *LockableBuffer) Available() int

func (*LockableBuffer) AvailableBuffer

func (b *LockableBuffer) AvailableBuffer() []byte

func (*LockableBuffer) Bytes

func (b *LockableBuffer) Bytes() []byte

func (*LockableBuffer) Cap

func (b *LockableBuffer) Cap() int

func (*LockableBuffer) Grow

func (b *LockableBuffer) Grow(n int)

func (*LockableBuffer) Len

func (b *LockableBuffer) Len() int

func (*LockableBuffer) Next

func (b *LockableBuffer) Next(n int) []byte

func (*LockableBuffer) Read

func (b *LockableBuffer) Read(p []byte) (n int, err error)

func (*LockableBuffer) ReadByte

func (b *LockableBuffer) ReadByte() (byte, error)

func (*LockableBuffer) ReadBytes

func (b *LockableBuffer) ReadBytes(delim byte) (line []byte, err error)

func (*LockableBuffer) ReadFrom

func (b *LockableBuffer) ReadFrom(r io.Reader) (n int64, err error)

func (*LockableBuffer) ReadRune

func (b *LockableBuffer) ReadRune() (r rune, size int, err error)

func (*LockableBuffer) ReadString

func (b *LockableBuffer) ReadString(delim byte) (line string, err error)

func (*LockableBuffer) Reset

func (b *LockableBuffer) Reset()

func (*LockableBuffer) String

func (b *LockableBuffer) String() string

func (*LockableBuffer) Sync

func (b *LockableBuffer) Sync() error

Sync is a no-op.

func (*LockableBuffer) Truncate

func (b *LockableBuffer) Truncate(n int)

func (*LockableBuffer) UnreadByte

func (b *LockableBuffer) UnreadByte() error

func (*LockableBuffer) UnreadRune

func (b *LockableBuffer) UnreadRune() error

func (*LockableBuffer) Write

func (b *LockableBuffer) Write(p []byte) (n int, err error)

func (*LockableBuffer) WriteByte

func (b *LockableBuffer) WriteByte(c byte) error

func (*LockableBuffer) WriteRune

func (b *LockableBuffer) WriteRune(r rune) (n int, err error)

func (*LockableBuffer) WriteString

func (b *LockableBuffer) WriteString(s string) (n int, err error)

func (*LockableBuffer) WriteTo

func (b *LockableBuffer) WriteTo(w io.Writer) (n int64, err error)

type LogRecord

type LogRecord struct {
	LevelName  string                 `json:"level_name"`
	DateTime   null.Time              `json:"datetime"`
	Caller     string                 `json:"caller"`
	Message    string                 `json:"message"`
	Handler    string                 `json:"handler,omitempty"`
	Connection string                 `json:"connection,omitempty"`
	Account    string                 `json:"account,omitempty"`
	Context    map[string]interface{} `json:"context,omitempty"`
}

type ReadBuffer

type ReadBuffer interface {
	io.Reader
	fmt.Stringer
	Bytes() []byte
	Reset()
}

ReadBuffer is implemented by the BufferLogger. Its methods give access to the buffer contents and ability to read buffer as an io.Reader or reset its contents.

type TranslationsExtractor

type TranslationsExtractor struct {
	TranslationsFS   fs.FS
	TranslationsPath string
	// contains filtered or unexported fields
}

TranslationsExtractor is a tool to load raw translations data from files or from box. It is feasible to be used in tests in order to check translation files correctness. The easiest way to check correctness is to check keys in translations. TranslationsExtractor IS NOT supposed to check correctness of translations - it's just an extractor. Translations can be checked manually, or via external library like https://github.com/google/go-cmp

func NewTranslationsExtractor

func NewTranslationsExtractor(fileNameTemplate string) *TranslationsExtractor

NewTranslationsExtractor constructor. Use "translate.{}.yml" as template if your translations are named like "translate.en.yml".

func (*TranslationsExtractor) GetMapKeys

func (t *TranslationsExtractor) GetMapKeys(data map[string]interface{}) []string

GetMapKeys returns sorted map keys from map[string]interface{} - useful to check keys in several translation files.

func (*TranslationsExtractor) LoadLocale

func (t *TranslationsExtractor) LoadLocale(locale string) (map[string]interface{}, error)

LoadLocale returns translation file data with provided locale.

func (*TranslationsExtractor) LoadLocaleKeys

func (t *TranslationsExtractor) LoadLocaleKeys(locale string) ([]string, error)

LoadLocaleKeys returns only sorted keys from translation file.

type UnmatchedRequestsTestingT

type UnmatchedRequestsTestingT interface {
	Log(...interface{})
	Logf(string, ...interface{})
	FailNow()
}

UnmatchedRequestsTestingT contains all of *testing.T methods which are needed for AssertNoUnmatchedRequests.