gomockctx/README.md

gomockctx

Go package with gomock helpers for matching context.Context.

Import

import "github.com/romdo/gomockctx"

Usage

Match against a specific context or any of its child contexts:

// Create a context with a gomockctx ID value.
ctx := gomockctx.New(context.Background())

// Match against a context with a gomockctx ID.
someMock.EXPECT().
	Get(gomockctx.Eq(ctx), "foo").
	Return("bar", nil)

// Use context with gomockctx ID when calling function.
someMock.Get(ctx, "foo")

Match against a context containing a specific value:

someMock.EXPECT().
	Get(gomockctx.WithValue(myCtxKey, "hello"), "foo").
	Return("bar", nil)

Match against any context:

someMock.EXPECT().
	Get(gomockctx.Any(), "foo").
	Return("bar", nil)

Documentation

Please see the Go Reference.

License

MIT