Documentation
¶
Overview ¶
Package testkit provides testing utilities including fake clocks, in-memory GCS clients, and controllable backends.
Index ¶
- Constants
- func NewAcceleratedClock(multiplier int) clockwork.Clock
- func NewGCSClient(ctx context.Context, t testing.TB, logging bool) *storage.Client
- func NewLogger(tb testing.TB, opts *slog.HandlerOptions) *slog.Logger
- func NewSelfAdvanceClock(t *testing.T) clockwork.Clock
- type StallBackend
- func (b *StallBackend) Delete(ctx context.Context, path string) error
- func (b *StallBackend) DeleteIf(ctx context.Context, path string, expected backend.Version) error
- func (b *StallBackend) ReleaseStalled()
- func (b *StallBackend) SetTagsIf(ctx context.Context, path string, expected backend.Version, t backend.Tags) (backend.Metadata, error)
- func (b *StallBackend) StallWrites()
- func (b *StallBackend) StopStalling()
- func (b *StallBackend) WaitForStalled()
- func (b *StallBackend) Write(ctx context.Context, path string, value []byte, t backend.Tags) (backend.Metadata, error)
- func (b *StallBackend) WriteIf(ctx context.Context, path string, value []byte, expected backend.Version, ...) (backend.Metadata, error)
- func (b *StallBackend) WriteIfNotExists(ctx context.Context, path string, value []byte, t backend.Tags) (backend.Metadata, error)
Constants ¶
const RaceEnabled = false
RaceEnabled is true when the package was compiled with the go race detector enabled.
Not sure of any better way to do it as of writing this.
Variables ¶
This section is empty.
Functions ¶
func NewAcceleratedClock ¶
NewAcceleratedClock creates a clock that runs faster than real time by the given multiplier.
func NewGCSClient ¶
NewGCSClient creates a GCS storage client backed by an in-memory fake server for testing.
Types ¶
type StallBackend ¶
StallBackend is a backend where writes can be paused and resumed.
When a write is stalled, it returns immediately with an error. It will complete asynchronously only when released.
func NewStallBackend ¶
func NewStallBackend(inner backend.Backend) *StallBackend
NewStallBackend wraps a backend so that writes can be paused, stalled, and released.
func (*StallBackend) Delete ¶
func (b *StallBackend) Delete(ctx context.Context, path string) error
Delete removes an object at the given path, stalling if stalling is enabled.
func (*StallBackend) DeleteIf ¶
func (b *StallBackend) DeleteIf( ctx context.Context, path string, expected backend.Version, ) error
DeleteIf removes an object conditionally, stalling if stalling is enabled.
func (*StallBackend) ReleaseStalled ¶
func (b *StallBackend) ReleaseStalled()
ReleaseStalled allows all previously stalled write operations to complete.
func (*StallBackend) SetTagsIf ¶
func (b *StallBackend) SetTagsIf( ctx context.Context, path string, expected backend.Version, t backend.Tags, ) (backend.Metadata, error)
SetTagsIf sets tags on a path conditionally, stalling if stalling is enabled.
func (*StallBackend) StallWrites ¶
func (b *StallBackend) StallWrites()
StallWrites causes all subsequent write operations to be held until released.
func (*StallBackend) StopStalling ¶
func (b *StallBackend) StopStalling()
StopStalling allows new write operations to proceed normally without stalling.
func (*StallBackend) WaitForStalled ¶
func (b *StallBackend) WaitForStalled()
WaitForStalled blocks until all stalled write operations have been queued.
Source Files
Directories