gosttest

type BrowsingContext ¶ added in v0.8.0

type BrowsingContext struct {
	Ctx      context.Context
	Client   http.Client
	Location string
	// contains filtered or unexported fields
}

BrowsingContext implements html.BrowsingContext to help test code depending on a context, e.g, fetch and XHR.

func NewBrowsingContext(t testing.TB, h http.Handler) BrowsingContext

func (c BrowsingContext) Context() context.Context

func (c BrowsingContext) HTTPClient() http.Client

func (c BrowsingContext) LocationHREF() string

func (c BrowsingContext) Logger() *slog.Logger

type EchoHandler ¶

type EchoHandler struct {
	// Requests contains all HTTP requests sent to the handler
	Requests []*http.Request
}

EchoHandler is an http.Handler that echos the requested path in the document heading, i.e., the <h1> element.

func (h *EchoHandler) RequestCount() int

func (h *EchoHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ExpectOption ¶ added in v0.8.0

type ExpectOption func(*expectOptions)

func Context(ctx context.Context) ExpectOption

func FatalOnError() ExpectOption

func Timeout(d time.Duration) ExpectOption

type GomegaSuite ¶

type GomegaSuite struct {
	suite.Suite
}

GomegaSuite is a specialised suite.Suite that provides support for the gomega assertion library by providing a GomegaSuite.Expect function automatically initializes gomega with

func (s *GomegaSuite) Expect(actual interface{}, extra ...interface{}) types.Assertion

type HTTPRequestRecorder ¶ added in v0.6.0

type HTTPRequestRecorder struct {
	T        testing.TB
	Handler  http.Handler
	Requests []*http.Request
}

HTTPRequestRecorder is an HTTPHandler middleware that keeps a record of all incoming request objects.

func NewHTTPRequestRecorder(t testing.TB, handler http.Handler) *HTTPRequestRecorder

func (r *HTTPRequestRecorder) Clear()

func (rec *HTTPRequestRecorder) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (r *HTTPRequestRecorder) Single() *http.Request

func (r HTTPRequestRecorder) URLs() []string

type HandlerOption ¶ added in v0.8.0

type HandlerOption = func(*TestingLogHandler)

func AllowErrors() HandlerOption

func MinLogLevel(lvl slog.Level) HandlerOption

type LogRecorder ¶ added in v0.6.0

type LogRecorder struct {
	Records []slog.Record
}

LogRecorder is an implementation of slog.Handler recording all log entries in a slice.

func (r *LogRecorder) Enabled(context.Context, slog.Level) bool

func (r *LogRecorder) FilterLevel(lvl slog.Level) (ret []slog.Record)

func (r *LogRecorder) Handle(_ context.Context, rec slog.Record) error

func (r *LogRecorder) Reset()

func (r *LogRecorder) WithAttrs(attrs []slog.Attr) slog.Handler

func (r *LogRecorder) WithGroup(name string) slog.Handler

type PipeHandler ¶ added in v0.8.0

type PipeHandler struct {
	T       testing.TB
	BufSize uint
	Req     *http.Request
	// ClientDisconnected tells whther the HTTP client disconnects before the
	// handler has completed.
	ClientDisconnected bool
	// contains filtered or unexported fields
}

PipeHandler is reminescent of an io pipe, connecting an output stream to an input stream. This handler works as an HTTP handler that can be connected to, but client code can control the response.

This is intended to be used in a test context, where it is designed to process exactly one request.

All "write" methods return immediately, and will eventually perform the requested operation on the actual http.ResponseWriter. Errors returned from the ResponseWriter will result in a call to Error on the testing.TB instance.

"Write" methods are sent to a buffered channel. BufSize controls the size of the buffer. If zero, a default value of 16 is used.

If no TB instance is passed, errors are silently ignored.

The zero value is safe to use but will not communicate errors, nor will it cancel on timeout.

func NewPipeHandler(t testing.TB) *PipeHandler

func (h *PipeHandler) Close()

func (h *PipeHandler) Do(f func(http.ResponseWriter))

func (h *PipeHandler) Flush()

func (h *PipeHandler) Print(a ...any)

func (h *PipeHandler) Printf(format string, a ...any)

func (h *PipeHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (h *PipeHandler) WriteHeader(s int)

type StaticFile ¶ added in v0.6.0

type StaticFile struct {
	MIMEType string
	Body     string
}

A simple http.Handler that serves static file content. This type is a pair of MIMEType and body content.

func StaticHTML(html string) StaticFile

func StaticJS(js string) StaticFile

func StaticJSON(json string) StaticFile

func (f StaticFile) ServeHTTP(w http.ResponseWriter, r *http.Request)

type StaticFileServer ¶ added in v0.6.0

type StaticFileServer map[string]http.Handler

StaticFileServer is a simple http.Handler implementing a mux (router) based on a simple map[string]http.Handler, mapping a local path to a handler.

Having a map as an underlying type, you can create the entire http handler as a Go map literal, making it simpler to configure than creating a new mux. Combine with StaticHTML, StaticJS, or StaticJSON (or other variants added after this comment was written), makes it easy to serve static files for test content.

TODO: Give this a new name. The first version was _only_ static files, but after extracting the StaticFile type as a dedicated and valid http.Handler implementation, this has been elevated to a more general use case.

func (s StaticFileServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

type TestLoggerOption ¶ added in v0.8.0

type TestLoggerOption = func(*TestingLogHandler)

type TestingLogHandler ¶ added in v0.6.0

type TestingLogHandler struct {
	testing.TB
	AllowErrors bool
	MinLogLevel slog.Level
}

func (l TestingLogHandler) Enabled(_ context.Context, lvl slog.Level) bool

func (l TestingLogHandler) Handle(_ context.Context, r slog.Record) error

func (l TestingLogHandler) WithAttrs(attrs []slog.Attr) slog.Handler

func (l TestingLogHandler) WithGroup(name string) slog.Handler