testutil

Documentation

Index

• func CollectionNode(t *testing.T, hub *stub.Hub, identity bootstrap.NodeInfo, ...) testmock.CollectionNode
• func CompleteStateFixture(t testing.TB, metric *metrics.NoopCollector, tracer module.Tracer, ...) *testmock.StateFixture
• func ConsensusNode(t *testing.T, hub *stub.Hub, identity *flow.Identity, ...) testmock.ConsensusNode
• func ConsensusNodes(t *testing.T, hub *stub.Hub, nNodes int, chainID flow.ChainID) []testmock.ConsensusNode
• func ExecutionNode(t *testing.T, hub *stub.Hub, identity *flow.Identity, ...) testmock.ExecutionNode
• func GenericNode(t testing.TB, hub *stub.Hub, identity *flow.Identity, root protocol.Snapshot) testmock.GenericNode
• func GenericNodeFromParticipants(t testing.TB, hub *stub.Hub, identity *flow.Identity, ...) testmock.GenericNode
• func GenericNodeWithStateFixture(t testing.TB, stateFixture *testmock.StateFixture, hub *stub.Hub, ...) testmock.GenericNode
• func LocalFixture(t testing.TB, identity *flow.Identity) module.Local
• func VerificationNode(t testing.TB, hub *stub.Hub, verIdentity *flow.Identity, ...) testmock.VerificationNode
• type CheckerMock
• type RoundRobinLeaderSelection
  • func (s *RoundRobinLeaderSelection) DKG(blockID flow.Identifier) (hotstuff.DKG, error)
  • func (s *RoundRobinLeaderSelection) Identities(blockID flow.Identifier) (flow.IdentityList, error)
  • func (s *RoundRobinLeaderSelection) Identity(blockID flow.Identifier, participantID flow.Identifier) (*flow.Identity, error)
  • func (s *RoundRobinLeaderSelection) LeaderForView(view uint64) (flow.Identifier, error)
  • func (s *RoundRobinLeaderSelection) Self() flow.Identifier
• type VerificationOpt
  • func WithChunkConsumer(chunkConsumer *chunkconsumer.ChunkConsumer) VerificationOpt
  • func WithGenericNode(genericNode *testmock.GenericNode) VerificationOpt

Functions

func CollectionNode

func CollectionNode(t *testing.T, hub *stub.Hub, identity bootstrap.NodeInfo, rootSnapshot protocol.Snapshot) testmock.CollectionNode

CollectionNode returns a mock collection node.

func CompleteStateFixture

func CompleteStateFixture(
	t testing.TB,
	metric *metrics.NoopCollector,
	tracer module.Tracer,
	rootSnapshot protocol.Snapshot,
) *testmock.StateFixture

CompleteStateFixture is a test helper that creates, bootstraps, and returns a StateFixture for sake of unit testing.

func ConsensusNode

func ConsensusNode(t *testing.T, hub *stub.Hub, identity *flow.Identity, identities []*flow.Identity, chainID flow.ChainID) testmock.ConsensusNode

func ConsensusNodes

func ConsensusNodes(t *testing.T, hub *stub.Hub, nNodes int, chainID flow.ChainID) []testmock.ConsensusNode

func ExecutionNode

func ExecutionNode(t *testing.T, hub *stub.Hub, identity *flow.Identity, identities []*flow.Identity, syncThreshold int, chainID flow.ChainID) testmock.ExecutionNode

func GenericNode

func GenericNode(
	t testing.TB,
	hub *stub.Hub,
	identity *flow.Identity,
	root protocol.Snapshot,
) testmock.GenericNode

GenericNode returns a generic test node, containing components shared across all node roles. The generic node is used as the core data structure to create other types of flow nodes.

func GenericNodeFromParticipants

func GenericNodeFromParticipants(t testing.TB, hub *stub.Hub, identity *flow.Identity, participants []*flow.Identity, chainID flow.ChainID,
	options ...func(protocol.State)) testmock.GenericNode

GenericNodeFromParticipants is a test helper that creates and returns a generic node. The generic node's state is generated from the given participants, resulting in a root state snapshot.

CAUTION: Please use GenericNode instead for most use-cases so that multiple nodes may share the same root state snapshot.

func GenericNodeWithStateFixture

func GenericNodeWithStateFixture(t testing.TB,
	stateFixture *testmock.StateFixture,
	hub *stub.Hub,
	identity *flow.Identity,
	log zerolog.Logger,
	metrics *metrics.NoopCollector,
	tracer module.Tracer,
	chainID flow.ChainID) testmock.GenericNode

GenericNodeWithStateFixture is a test helper that creates a generic node with specified state fixture.

func LocalFixture

func LocalFixture(t testing.TB, identity *flow.Identity) module.Local

LocalFixture creates and returns a Local module for given identity.

func VerificationNode

func VerificationNode(t testing.TB,
	hub *stub.Hub,
	verIdentity *flow.Identity,
	participants flow.IdentityList,
	assigner module.ChunkAssigner,
	chunksLimit uint,
	chainID flow.ChainID,
	collector module.VerificationMetrics,
	mempoolCollector module.MempoolMetrics,
	opts ...VerificationOpt) testmock.VerificationNode

VerificationNode creates a verification node with all functional engines and actual modules for purpose of (integration) testing.

Types

type CheckerMock

type CheckerMock struct {
	notifications.NoopConsumer // satisfy the FinalizationConsumer interface
}

type RoundRobinLeaderSelection

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

func (*RoundRobinLeaderSelection) DKG

func (s *RoundRobinLeaderSelection) DKG(blockID flow.Identifier) (hotstuff.DKG, error)

func (*RoundRobinLeaderSelection) Identities

func (s *RoundRobinLeaderSelection) Identities(blockID flow.Identifier) (flow.IdentityList, error)

func (*RoundRobinLeaderSelection) Identity

func (s *RoundRobinLeaderSelection) Identity(blockID flow.Identifier, participantID flow.Identifier) (*flow.Identity, error)

func (*RoundRobinLeaderSelection) LeaderForView

func (s *RoundRobinLeaderSelection) LeaderForView(view uint64) (flow.Identifier, error)

func (*RoundRobinLeaderSelection) Self

func (s *RoundRobinLeaderSelection) Self() flow.Identifier

type VerificationOpt

type VerificationOpt func(*testmock.VerificationNode)

func WithChunkConsumer

func WithChunkConsumer(chunkConsumer *chunkconsumer.ChunkConsumer) VerificationOpt

func WithGenericNode

func WithGenericNode(genericNode *testmock.GenericNode) VerificationOpt