testutil

Documentation

Overview

Package testutil contains testing utilities for storage providers and backends.

Index

• func MustAddObserver(ctx context.Context, t *testing.T, leader, observer storage.Provider)
• func MustAddVoter(ctx context.Context, t *testing.T, leader, voter storage.Provider)
• func MustBootstrapProvider(ctx context.Context, t *testing.T, provider storage.Provider)
• func MustStartProvider(ctx context.Context, t *testing.T, provider storage.Provider)
• func SkipOnCI(t *testing.T, reason string)
• func TestConsensusStorageConformance(ctx context.Context, t *testing.T, raftStorage storage.ConsensusStorage)
• func TestDualStorageConformance(ctx context.Context, t *testing.T, dualStorage storage.DualStorage)
• func TestMeshStateStorageConformance(t *testing.T, builder NewMeshStateFunc)
• func TestMeshStorageConformance(ctx context.Context, t *testing.T, meshStorage storage.MeshStorage)
• func TestNetworkingStorageConformance(t *testing.T, builder NewNetworkingFunc)
• func TestPeerGraphstoreConformance(t *testing.T, builder NewPeerGraphStore)
• func TestPeerStorageConformance(t *testing.T, builder NewPeersFunc)
• func TestRBACStorageConformance(t *testing.T, builder NewRBACFunc)
• func TestSingleNodeProviderConformance(ctx context.Context, t *testing.T, provider storage.Provider)
• func TestStorageProviderConformance(ctx context.Context, t *testing.T, newProviders NewProvidersFunc)
• type Condition
• type DropStorage
• type Eventually
  • func (e Eventually[T]) Should(after time.Duration, tick time.Duration, condition func(T) bool) bool
  • func (e Eventually[T]) ShouldEqual(after time.Duration, tick time.Duration, expected T) bool
  • func (e Eventually[T]) ShouldError(after time.Duration, tick time.Duration) bool
  • func (e Eventually[T]) ShouldErrorWith(after time.Duration, tick time.Duration, expected error) bool
  • func (e Eventually[T]) ShouldNotEqual(after time.Duration, tick time.Duration, expected T) bool
  • func (e Eventually[T]) ShouldNotError(after time.Duration, tick time.Duration) bool
• type NewMeshStateFunc
• type NewNetworkingFunc
• type NewPeerGraphStore
• type NewPeersFunc
• type NewProvidersFunc
• type NewRBACFunc

Functions

func MustAddObserver

func MustAddObserver(ctx context.Context, t *testing.T, leader, observer storage.Provider)

MustAddObserver is a helper function that adds an observer to the consensus group and fails the test if there is an error.

func MustAddVoter

func MustAddVoter(ctx context.Context, t *testing.T, leader, voter storage.Provider)

MustAddVoter is a helper function that adds a voter to the consensus group and fails the test if there is an error.

func MustBootstrapProvider

func MustBootstrapProvider(ctx context.Context, t *testing.T, provider storage.Provider)

MustBootstrapProvider is a helper function that calls Bootstrap and fails the test if there is an error.

func MustStartProvider

func MustStartProvider(ctx context.Context, t *testing.T, provider storage.Provider)

MustStartProvider is a helper function that calls Start and fails the test if there is an error.

func SkipOnCI

func SkipOnCI(t *testing.T, reason string)

SkipOnCI skips the test if the CI environment variable is set for the given reason.

func TestConsensusStorageConformance

func TestConsensusStorageConformance(ctx context.Context, t *testing.T, raftStorage storage.ConsensusStorage)

TestConsensusStorageConformance tests that the ConsensusStorage interface is implemented correctly.

func TestDualStorageConformance

func TestDualStorageConformance(ctx context.Context, t *testing.T, dualStorage storage.DualStorage)

TestDualStorageConformance tests that the DualStorage interface is implemented correctly.

func TestMeshStateStorageConformance

func TestMeshStateStorageConformance(t *testing.T, builder NewMeshStateFunc)

TestMeshStateStorageConformance tests that a MeshState implementation conforms to the interface.

func TestMeshStorageConformance

func TestMeshStorageConformance(ctx context.Context, t *testing.T, meshStorage storage.MeshStorage)

TestMeshStorageConformance tests that the MeshStorage interface is implemented correctly.

func TestNetworkingStorageConformance

func TestNetworkingStorageConformance(t *testing.T, builder NewNetworkingFunc)

TestNetworkingStorageConformance tests that a Networking implementation conforms to the interface.

func TestPeerGraphstoreConformance

func TestPeerGraphstoreConformance(t *testing.T, builder NewPeerGraphStore)

TestPeerGraphstoreConformance tests that a PeerGraphStore implementation conforms to the interface.

func TestPeerStorageConformance

func TestPeerStorageConformance(t *testing.T, builder NewPeersFunc)

TestPeerStorageConformance tests that a Peers implementation conforms to the interface.

func TestRBACStorageConformance

func TestRBACStorageConformance(t *testing.T, builder NewRBACFunc)

TestRBACStorageConformance tests that an RBAC implementation conforms to the interface.

func TestSingleNodeProviderConformance

func TestSingleNodeProviderConformance(ctx context.Context, t *testing.T, provider storage.Provider)

TestSingleNodeProviderConformance is a helper for testing a single node provider.

func TestStorageProviderConformance

func TestStorageProviderConformance(ctx context.Context, t *testing.T, newProviders NewProvidersFunc)

TestStorageProviderConformance tests that the storage provider conforms to the storage provider interface.

Types

type Condition

type Condition[T comparable] func(T) bool

Condition is a function that returns true if the condition is met.

type DropStorage

type DropStorage interface {
	// DropAll drops all data from the storage. This is primarily used
	// for testing.
	DropAll(ctx context.Context) error
}

DropStorage is a storage interface that can be dropped entirely. This is primarily used for testing.

type Eventually

type Eventually[T comparable] func() T

Eventually is a function that should eventually meet the given condition.

func (Eventually[T]) Should

func (e Eventually[T]) Should(after time.Duration, tick time.Duration, condition func(T) bool) bool

Should eventually meet the given condition.

func (Eventually[T]) ShouldEqual

func (e Eventually[T]) ShouldEqual(after time.Duration, tick time.Duration, expected T) bool

ShouldEqual eventually should equal the given value.

func (Eventually[T]) ShouldError

func (e Eventually[T]) ShouldError(after time.Duration, tick time.Duration) bool

ShouldError eventually should error.

func (Eventually[T]) ShouldErrorWith

func (e Eventually[T]) ShouldErrorWith(after time.Duration, tick time.Duration, expected error) bool

ShouldErrorWith eventually should error with the given error.

func (Eventually[T]) ShouldNotEqual

func (e Eventually[T]) ShouldNotEqual(after time.Duration, tick time.Duration, expected T) bool

ShouldNotEqual eventually should not equal the given value.

func (Eventually[T]) ShouldNotError

func (e Eventually[T]) ShouldNotError(after time.Duration, tick time.Duration) bool

ShouldNotError eventually should not error.

type NewMeshStateFunc

type NewMeshStateFunc func(t *testing.T) storage.MeshState

NewMeshStateFunc is a function that creates a new MeshState implementation.

type NewNetworkingFunc

type NewNetworkingFunc func(t *testing.T) storage.Networking

NewNetworkingFunc is a function that creates a new Networking implementation.

type NewPeerGraphStore

type NewPeerGraphStore func(t *testing.T) types.PeerGraphStore

NewPeerGraphStore is a function that creates a new PeerGraphStore implementation.

type NewPeersFunc

type NewPeersFunc func(t *testing.T) storage.Peers

NewPeersFunc is a function that creates a new Peers implementation.

type NewProvidersFunc

type NewProvidersFunc func(t *testing.T, count int) []storage.Provider

NewProvidersFunc is a function that returns new storage providers. Each should have unique identifying properties for and not be started or bootstrapped. The providers listen port must be available on localhost if applicable to the storage provider. It must at least not be zero.

type NewRBACFunc

type NewRBACFunc func() storage.RBAC

NewRBACFunc is a function that creates a new RBAC implementation.