test

Documentation

Index

• func AccessKey(t *testing.T, key *ecdsa.PrivateKey, claims elephantine.JWTClaims) string
• func Claims(t *testing.T, user string, scope string, units ...string) elephantine.JWTClaims
• func CloneMessage[T proto.Message](msg T) T
• func CommonTimeFields() []string
• func Context(c Cleaner) context.Context
• func Equal[T comparable](t TestingT, want T, got T, format string, a ...any)
• func EqualDiff[T any](t TestingT, want T, got T, format string, a ...any)
• func EqualDiffWithOptions[T any](t TestingT, want T, got T, opts cmp.Options, format string, a ...any)
• func EqualMessage(t TestingT, want proto.Message, got proto.Message, format string, a ...any)
• func EqualMessageWithOptions(t TestingT, want proto.Message, got proto.Message, opts cmp.Options, ...)
• func IsTwirpError(t TestingT, err error, code twirp.ErrorCode)
• func Must(t TestingT, err error, format string, a ...any)
• func MustNot(t TestingT, err error, format string, a ...any)
• func NewLogHandler(t Logger, level slog.Level) slog.Handler
• func NewSigningKey(t *testing.T) *ecdsa.PrivateKey
• func NotNil[T any](t TestingT, v *T, format string, a ...any)
• func Regenerate() bool
• func StandardClaims(t *testing.T, scope string, units ...string) elephantine.JWTClaims
• func TestAgainstGolden[T any](t *testing.T, regenerate bool, got T, goldenPath string, ...)
• func TestMessageAgainstGolden(t *testing.T, regenerate bool, got proto.Message, goldenPath string, ...)
• func TestMessagesAgainstGolden[T proto.Message](t *testing.T, regenerate bool, gotSlice []T, goldenPath string, ...)
• type Cleaner
• type GoldenHelper
• type GoldenHelperForAny
• type IgnoreField
  • func (fi IgnoreField[T]) CmpOpts() cmp.Options
  • func (fi IgnoreField[T]) JSONTransform(value map[string]any) error
• type IgnoreTimestamps
  • func (it IgnoreTimestamps) CmpOpts() cmp.Options
  • func (it IgnoreTimestamps) JSONTransform(value map[string]any) error
• type LogHandler
  • func (h *LogHandler) Enabled(ctx context.Context, level slog.Level) bool
  • func (h *LogHandler) Handle(ctx context.Context, r slog.Record) error
  • func (h *LogHandler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *LogHandler) WithGroup(name string) slog.Handler
  • func (h *LogHandler) Write(data []byte) (int, error)
• type Logger
• type TestingT

Functions

func AccessKey

func AccessKey(
	t *testing.T, key *ecdsa.PrivateKey, claims elephantine.JWTClaims,
) string

AccessKey creates a signed access key from the signing key and claims.

func Claims

func Claims(
	t *testing.T, user string, scope string, units ...string,
) elephantine.JWTClaims

Claims creates an elephantine.JWTClaims struct for use in thesting.

func CloneMessage

func CloneMessage[T proto.Message](msg T) T

CloneMessage allows for type safe cloning of protobuf messages.

func CommonTimeFields

func CommonTimeFields() []string

func Context

func Context(c Cleaner) context.Context

Deprecated: Use testing.T.Context() instead.

func Equal

func Equal[T comparable](t TestingT, want T, got T, format string, a ...any)

func EqualDiff

func EqualDiff[T any](t TestingT,
	want T, got T,
	format string, a ...any,
)

EqualDiff runs a cmp.Diff to do a deep equal check with readable diff output.

func EqualDiffWithOptions

func EqualDiffWithOptions[T any](
	t TestingT,
	want T, got T,
	opts cmp.Options,
	format string, a ...any,
)

EqualMessage runs a cmp.Diff with protobuf-specific options.

func EqualMessage

func EqualMessage(t TestingT,
	want proto.Message, got proto.Message,
	format string, a ...any,
)

EqualMessage runs a cmp.Diff with protobuf-specific options.

func EqualMessageWithOptions

func EqualMessageWithOptions(t TestingT,
	want proto.Message, got proto.Message,
	opts cmp.Options,
	format string, a ...any,
)

EqualMessage runs a cmp.Diff with protobuf-specific options.

func IsTwirpError

func IsTwirpError(
	t TestingT, err error, code twirp.ErrorCode,
)

func Must

func Must(t TestingT, err error, format string, a ...any)

func MustNot

func MustNot(t TestingT, err error, format string, a ...any)

func NewLogHandler

func NewLogHandler(t Logger, level slog.Level) slog.Handler

func NewSigningKey

func NewSigningKey(t *testing.T) *ecdsa.PrivateKey

NewSigningKey creates a signing key for use with a elephantine.NewStaticAuthInfoParser.

func NotNil

func NotNil[T any](t TestingT, v *T, format string, a ...any)

func Regenerate

func Regenerate() bool

Regenerate test fixtures will return true if the environment variable REGENERATE is set to true.

func StandardClaims

func StandardClaims(
	t *testing.T, scope string, units ...string,
) elephantine.JWTClaims

StandardClaims is a helper function that creates standard claims for a test.

func TestAgainstGolden

func TestAgainstGolden[T any](
	t *testing.T,
	regenerate bool,
	got T,
	goldenPath string,
	helpers ...GoldenHelper,
)

TestAgainstGolden compares a result against the contents of the file at the goldenPath. Run with regenerate set to true to create or update the file.

func TestMessageAgainstGolden

func TestMessageAgainstGolden(
	t *testing.T,
	regenerate bool,
	got proto.Message,
	goldenPath string,
	helpers ...GoldenHelper,
)

TestMessageAgainstGolden compares a protobuf message against the contents of the file at the goldenPath. Run with regenerate set to true to create or update the file.

func TestMessagesAgainstGolden

func TestMessagesAgainstGolden[T proto.Message](
	t *testing.T,
	regenerate bool,
	gotSlice []T,
	goldenPath string,
	helpers ...GoldenHelper,
)

TestMessagesAgainstGolden compares a slice of protobuf messages against the contents of the file at the goldenPath. Run with regenerate set to true to create or update the file.

Types

type Cleaner

type Cleaner interface {
	Cleanup(fn func())
}

type GoldenHelper

type GoldenHelper interface {
	CmpOpts() cmp.Options
	JSONTransform(value map[string]any) error
}

type GoldenHelperForAny

type GoldenHelperForAny interface {
	JSONTransformAny(value any) error
}

type IgnoreField

type IgnoreField[T any] struct {
	Name       string
	DummyValue T
	Validator  func(v T) error
}

func (IgnoreField[T]) CmpOpts

func (fi IgnoreField[T]) CmpOpts() cmp.Options

CmpOpts implements GoldenHelper.

func (IgnoreField[T]) JSONTransform

func (fi IgnoreField[T]) JSONTransform(value map[string]any) error

JSONTransform implements GoldenHelper.

type IgnoreTimestamps

type IgnoreTimestamps struct {
	Fields     []string
	DummyValue time.Time
	Format     string
}

func (IgnoreTimestamps) CmpOpts

func (it IgnoreTimestamps) CmpOpts() cmp.Options

func (IgnoreTimestamps) JSONTransform

func (it IgnoreTimestamps) JSONTransform(value map[string]any) error

type LogHandler

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

func (*LogHandler) Enabled

func (h *LogHandler) Enabled(ctx context.Context, level slog.Level) bool

func (*LogHandler) Handle

func (h *LogHandler) Handle(ctx context.Context, r slog.Record) error

func (*LogHandler) WithAttrs

func (h *LogHandler) WithAttrs(attrs []slog.Attr) slog.Handler

func (*LogHandler) WithGroup

func (h *LogHandler) WithGroup(name string) slog.Handler

func (*LogHandler) Write

func (h *LogHandler) Write(data []byte) (int, error)

type Logger

type Logger interface {
	Log(args ...any)
}

type TestingT

type TestingT interface {
	Helper()
	Fatalf(format string, args ...any)
	Logf(format string, args ...any)
}