test

Documentation

Index

• type Client
• type Option
  • func WithDebugLogs() Option
  • func WithPartitions(partitions int) Option
  • func WithReplicas(replicas int) Option
• type Protocol
• type Replica
• type Test
  • func NewTest(protocol Protocol, opts ...Option) *Test
  • func (t *Test) NewClient(clientID string) (atomix.Client, error)
  • func (t *Test) Start() error
  • func (t *Test) Stop() error

Types

type Client

type Client interface {
	// Start starts the client
	Start(driverPort, agentPort int) error
	// Connect connects the client to the given primitive server
	Connect(ctx context.Context, primitive primitive.Type, name string) (*grpc.ClientConn, error)
	// Stop stops the client
	Stop() error
}

Client is an interface for implementing the client for a test protocol

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is a test option

func WithDebugLogs

func WithDebugLogs() Option

WithDebugLogs sets whether to enable debug logs for the test

func WithPartitions

func WithPartitions(partitions int) Option

WithPartitions sets the number of partitions to test

func WithReplicas

func WithReplicas(replicas int) Option

WithReplicas sets the number of replicas to test

type Protocol

type Protocol interface {
	// NewReplica creates a new test replica
	NewReplica(network cluster.Network, replica protocolapi.ProtocolReplica, protocol protocolapi.ProtocolConfig) Replica
	// NewClient creates a new test client
	NewClient(network cluster.Network, clientID string, protocol protocolapi.ProtocolConfig) Client
}

Protocol is a test protocol implementation

type Replica

type Replica interface {
	// Start starts the replica
	Start() error
	// Stop stops the replica
	Stop() error
}

Replica is an interface for implementing a test protocol replica

type Test

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

Test is an Atomix test utility

func NewTest

func NewTest(protocol Protocol, opts ...Option) *Test

NewTest creates a new Atomix test

func (*Test) NewClient

func (t *Test) NewClient(clientID string) (atomix.Client, error)

NewClient creates a new test client

func (*Test) Start

func (t *Test) Start() error

Start starts the test

func (*Test) Stop

func (t *Test) Stop() error

Stop stops the test