testutil

Documentation

Overview

Package testutil provides common testing utility functions.

The functions provided by this package are intended to simplify the process of setting up tests and to provide a consistent way to do so across the codebase.

These functions are intended for use in tests only.

Index

• func CaptureOutput(t *testing.T, fn func()) string
• func Context() context.Context
• func ContextWithHTTPRouterParams(ctx context.Context, params map[string]string) context.Context
• func ContextWithLogObserver(level zapcore.LevelEnabler) (context.Context, *observer.ObservedLogs)
• func ReplaceDateTime(src, repl string) string
• func ReplaceUnixTimestamp(src, repl string) string
• func RouterWithHandler(method, path string, handlerFunc http.HandlerFunc) http.Handler
• type TestHTTPResponseWriter

Functions

func CaptureOutput

func CaptureOutput(t *testing.T, fn func()) string

CaptureOutput hijacks and captures stderr and stdout for testing the given function.

func Context

func Context() context.Context

Context returns a context initialized with a NOP logger for testing.

func ContextWithHTTPRouterParams

func ContextWithHTTPRouterParams(ctx context.Context, params map[string]string) context.Context

ContextWithHTTPRouterParams creates a context copy containing map of URL path segments.

func ContextWithLogObserver

func ContextWithLogObserver(level zapcore.LevelEnabler) (context.Context, *observer.ObservedLogs)

ContextWithLogObserver returns a context initialized with a NOP logger for testing.

func ReplaceDateTime

func ReplaceDateTime(src, repl string) string

ReplaceDateTime replaces a datetime value. This function is useful to compare JSON responses containing variable values.

func ReplaceUnixTimestamp

func ReplaceUnixTimestamp(src, repl string) string

ReplaceUnixTimestamp replaces a unix timestamp. This function is useful to compare JSON responses containing variable values.

func RouterWithHandler

func RouterWithHandler(method, path string, handlerFunc http.HandlerFunc) http.Handler

RouterWithHandler returns a new httprouter instance with the give handler function attached.

Types

type TestHTTPResponseWriter

type TestHTTPResponseWriter interface {
	http.ResponseWriter
}

TestHTTPResponseWriter wraps a standard lib http.ResponseWriter to allow mock generation.