testutils

Documentation

Overview

Package testutils contains the test utilities and helpers inside the k6 project.

Index

• func FilterEntries(logEntries []logrus.Entry, expLevel logrus.Level, expContents string) []logrus.Entry
• func LogContains(logEntries []logrus.Entry, expLevel logrus.Level, expContents string) bool
• func MakeMemMapFs(t *testing.T, withFiles map[string][]byte) fsext.Fs
• func NewLogger(t testing.TB) logrus.FieldLogger
• func NewTestOutput(t testing.TB) io.Writer
• func Untar(t *testing.T, fileSystem fsext.Fs, fileName string, destination string) error
• type SimpleLogrusHook
  • func NewLogHook(levels ...logrus.Level) *SimpleLogrusHook
  • func NewLoggerWithHook(t testing.TB, levels ...logrus.Level) (logrus.FieldLogger, *SimpleLogrusHook)
  • func (smh *SimpleLogrusHook) Drain() []logrus.Entry
  • func (smh *SimpleLogrusHook) Fire(e *logrus.Entry) error
  • func (smh *SimpleLogrusHook) LastEntry() *logrus.Entry
  • func (smh *SimpleLogrusHook) Levels() []logrus.Level
  • func (smh *SimpleLogrusHook) Lines() []string
  • func (smh *SimpleLogrusHook) Reset()

Functions

func FilterEntries

func FilterEntries(logEntries []logrus.Entry, expLevel logrus.Level, expContents string) []logrus.Entry

FilterEntries is a helper function that checks the provided list of log entries for a messages matching the provided level and contents and returns an array with only them.

func LogContains

func LogContains(logEntries []logrus.Entry, expLevel logrus.Level, expContents string) bool

LogContains is a helper function that checks the provided list of log entries for a message matching the provided level and contents.

func MakeMemMapFs

func MakeMemMapFs(t *testing.T, withFiles map[string][]byte) fsext.Fs

MakeMemMapFs creates a new in-memory filesystem with the given files.

It is particularly useful for testing code that interacts with the filesystem, as it allows to create a filesystem with a known state without having to create temporary directories and files on disk.

The keys of the withFiles map are the paths of the files to create, and the values are the contents of the files. The files are created with 644 mode.

The filesystem is returned as a fsext.Fs.

func NewLogger

func NewLogger(t testing.TB) logrus.FieldLogger

NewLogger returns a new logger instance. If the given argument is not nil, the logger will log everything using its t.Logf() method. If its nil, all messages will be discarded.

func NewTestOutput

func NewTestOutput(t testing.TB) io.Writer

NewTestOutput returns a simple io.Writer implementation that uses the test's logger as an output.

func Untar

func Untar(t *testing.T, fileSystem fsext.Fs, fileName string, destination string) error

Untar a simple test helper that untars a `fileName` file to a `destination` path

Types

type SimpleLogrusHook

type SimpleLogrusHook struct {
	HookedLevels []logrus.Level
	// contains filtered or unexported fields
}

SimpleLogrusHook implements the logrus.Hook interface and could be used to check if log messages were outputted

func NewLogHook

func NewLogHook(levels ...logrus.Level) *SimpleLogrusHook

NewLogHook creates a new SimpleLogrusHook with the given levels and returns it. If no levels are specified, then logrus.AllLevels will be used.

func NewLoggerWithHook

func NewLoggerWithHook(t testing.TB, levels ...logrus.Level) (logrus.FieldLogger, *SimpleLogrusHook)

NewLoggerWithHook calls NewLogger() and attaches a hook with the given levels. If no levels are specified, then logrus.AllLevels will be used and the lowest log level will be Debug.

func (*SimpleLogrusHook) Drain

func (smh *SimpleLogrusHook) Drain() []logrus.Entry

Drain returns the currently stored messages and deletes them from the cache

func (*SimpleLogrusHook) Fire

func (smh *SimpleLogrusHook) Fire(e *logrus.Entry) error

Fire saves whatever message the logrus library passed in the cache

func (*SimpleLogrusHook) LastEntry

func (smh *SimpleLogrusHook) LastEntry() *logrus.Entry

LastEntry returns the last entry that was logged (or nil, if no messages were logged or remain).

func (*SimpleLogrusHook) Levels

func (smh *SimpleLogrusHook) Levels() []logrus.Level

Levels just returns whatever was stored in the HookedLevels slice

func (*SimpleLogrusHook) Lines

func (smh *SimpleLogrusHook) Lines() []string

Lines returns the logged lines.

func (*SimpleLogrusHook) Reset

func (smh *SimpleLogrusHook) Reset()

Reset clears the internal entry buffer.