badgerauthtest

Documentation

Overview

Package badgerauthtest is roughly inspired by the design of the storj/satellite/metabase/metabasetest package.

Index

• func RunCluster(t *testing.T, c ClusterConfig, ...)
• func RunSingleNode(t *testing.T, config badgerauth.Config, ...)
• type Clock
  • func (step Clock) Check(t testing.TB, node *badgerauth.Node)
• type Cluster
  • func (c *Cluster) Addresses() (addresses []string)
• type ClusterConfig
• type Get
  • func (step Get) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)
• type Put
  • func (step Put) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)
• type PutAtTime
  • func (step PutAtTime) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)
• type Replicate
  • func (step Replicate) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)
• type ReplicationLogEntryWithTTL
  • func CreateFullRecords(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node, count int) (records map[authdb.KeyHash]*authdb.Record, keys []authdb.KeyHash, ...)
• type VerifyReplicationLog
  • func (step VerifyReplicationLog) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)

Functions

func RunCluster

func RunCluster(t *testing.T, c ClusterConfig, fn func(ctx *testcontext.Context, t *testing.T, cluster *Cluster))

RunCluster tests against a multinode cluster of badgerauth.

func RunSingleNode

func RunSingleNode(t *testing.T, config badgerauth.Config, fn func(ctx *testcontext.Context, t *testing.T, log *zap.Logger, node *badgerauth.Node))

RunSingleNode tests against a single node cluster of badgerauth.

Types

type Clock

type Clock struct {
	NodeID badgerauth.NodeID
	Value  int
}

Clock is for verifying the db state of the clock.

func (Clock) Check

func (step Clock) Check(t testing.TB, node *badgerauth.Node)

Check runs the test.

type Cluster

type Cluster struct {
	Nodes []*badgerauth.Node
}

Cluster represents a collection of badgerauth nodes.

func (*Cluster) Addresses

func (c *Cluster) Addresses() (addresses []string)

Addresses returns a slice of all cluster node addresses.

type ClusterConfig

type ClusterConfig struct {
	NodeCount int
	Defaults  badgerauth.Config

	ReconfigureNode func(index int, config *badgerauth.Config)
}

ClusterConfig is used for configuring the cluster.

type Get

type Get struct {
	KeyHash authdb.KeyHash
	Result  *authdb.Record
	Error   error
}

Get is for testing badgerauth.(*DB).Get method.

func (Get) Check

func (step Get) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)

Check runs the test.

type Put

type Put struct {
	KeyHash authdb.KeyHash
	Record  *authdb.Record
	Error   error
}

Put is for testing badgerauth.(*DB).Put method.

func (Put) Check

func (step Put) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)

Check runs the test.

type PutAtTime

type PutAtTime struct {
	KeyHash authdb.KeyHash
	Record  *authdb.Record
	Error   error
	Time    time.Time
}

PutAtTime is for testing badgerauth.(*DB).PutAtTime method.

func (PutAtTime) Check

func (step PutAtTime) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)

Check runs the test.

type Replicate

type Replicate struct {
	Request *pb.ReplicationRequest
	Result  *pb.ReplicationResponse
	Error   error
}

Replicate is for testing the badgerauth.(*Node).Replicate method.

func (Replicate) Check

func (step Replicate) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)

Check runs the test.

type ReplicationLogEntryWithTTL

type ReplicationLogEntryWithTTL struct {
	Entry     badgerauth.ReplicationLogEntry
	ExpiresAt time.Time
}

ReplicationLogEntryWithTTL wraps ReplicationLogEntry with an expiration time, so it's convenient while verifying the state of the replication log.

func CreateFullRecords

func CreateFullRecords(
	ctx *testcontext.Context,
	t testing.TB,
	node *badgerauth.Node,
	count int,
) (
	records map[authdb.KeyHash]*authdb.Record,
	keys []authdb.KeyHash,
	entries []ReplicationLogEntryWithTTL,
)

CreateFullRecords creates count of records with random data at node returning created records and corresponding replication log entries.

type VerifyReplicationLog

type VerifyReplicationLog struct {
	Entries []ReplicationLogEntryWithTTL
}

VerifyReplicationLog is for verifying the state of the replication log.

func (VerifyReplicationLog) Check

func (step VerifyReplicationLog) Check(ctx *testcontext.Context, t testing.TB, node *badgerauth.Node)

Check runs the test.