testinstance

Documentation

Index

• func Close(instances []Instance) error
• func ConnectInstances(instances []Instance)
• type Instance
  • func NewInstance(ctx context.Context, net tn.Network, tempDir string, diskBasedDatastore bool) (Instance, error)
  • func (i *Instance) Blockstore() blockstore.Blockstore
  • func (i *Instance) Close() error
  • func (i *Instance) SetBlockstoreLatency(t time.Duration) time.Duration
• type InstanceGenerator
  • func NewTestInstanceGenerator(ctx context.Context, net tn.Network, tempDirGenerator TempDirGenerator, ...) InstanceGenerator
  • func (g *InstanceGenerator) Close() error
  • func (g *InstanceGenerator) Instances(n int) ([]Instance, error)
  • func (g *InstanceGenerator) Next() (Instance, error)
• type TempDirGenerator

Functions

func Close

func Close(instances []Instance) error

Close closes multiple instances at once

func ConnectInstances

func ConnectInstances(instances []Instance)

ConnectInstances connects the given instances to each other

Types

type Instance

type Instance struct {
	Peer       peer.ID
	Loader     ipld.Loader
	Storer     ipld.Storer
	BlockStore blockstore.Blockstore
	Graphsync  graphsync.GraphExchange
	Manager    datatransfer.Manager
	Adapter    dtnet.DataTransferNetwork
	// contains filtered or unexported fields
}

Instance is a test instance of bitswap + dependencies for integration testing

func NewInstance

func NewInstance(ctx context.Context, net tn.Network, tempDir string, diskBasedDatastore bool) (Instance, error)

NewInstance creates a test bitswap instance.

NB: It's easy make mistakes by providing the same peer ID to two different instances. To safeguard, use the InstanceGenerator to generate instances. It's just a much better idea.

func (*Instance) Blockstore

func (i *Instance) Blockstore() blockstore.Blockstore

Blockstore returns the block store for this test instance

func (*Instance) Close

func (i *Instance) Close() error

Close closes the associated datastore

func (*Instance) SetBlockstoreLatency

func (i *Instance) SetBlockstoreLatency(t time.Duration) time.Duration

SetBlockstoreLatency customizes the artificial delay on receiving blocks from a blockstore test instance.

type InstanceGenerator

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

InstanceGenerator generates new test instances of bitswap+dependencies

func NewTestInstanceGenerator

func NewTestInstanceGenerator(ctx context.Context, net tn.Network, tempDirGenerator TempDirGenerator, diskBasedDatastore bool) InstanceGenerator

NewTestInstanceGenerator generates a new InstanceGenerator for the given testnet

func (*InstanceGenerator) Close

func (g *InstanceGenerator) Close() error

Close closes the clobal context, shutting down all test instances

func (*InstanceGenerator) Instances

func (g *InstanceGenerator) Instances(n int) ([]Instance, error)

Instances creates N test instances of bitswap + dependencies and connects them to each other

func (*InstanceGenerator) Next

func (g *InstanceGenerator) Next() (Instance, error)

Next generates a new instance of graphsync + dependencies

type TempDirGenerator

type TempDirGenerator interface {
	TempDir() string
}

TempDirGenerator is any interface that can generate temporary directories