p2ptest

Documentation

Overview

Package p2ptest defines utilities for qri peer-2-peer testing

Index

• func ConnectNodes(ctx context.Context, nodes []TestablePeerNode) error
• func ConnectQriNodes(ctx context.Context, nodes []TestablePeerNode) error
• func GetSomeBlocks(capi coreiface.CoreAPI, ref reporef.DatasetRef, num int) []string
• func MakeIPFSNode(ctx context.Context) (*core.IpfsNode, coreiface.CoreAPI, error)
• func MakeIPFSSwarm(ctx context.Context, fullIdentity bool, n int) ([]*core.IpfsNode, []coreiface.CoreAPI, error)
• func MakeRepoFromIPFSNode(node *core.IpfsNode, username string) (qrirepo.Repo, error)
• type NodeMakerFunc
• type TestNodeFactory
  • func NewTestNodeFactory(maker NodeMakerFunc) *TestNodeFactory
  • func (f *TestNodeFactory) New(r repo.Repo) (TestablePeerNode, error)
  • func (f *TestNodeFactory) NewWithConf(r repo.Repo, p2pconf *config.P2P) (TestablePeerNode, error)
  • func (f *TestNodeFactory) NextInfo() *cfgtest.PeerInfo
• type TestablePeerNode
  • func NewAvailableTestNode(r repo.Repo, f *TestNodeFactory) (TestablePeerNode, error)
  • func NewTestDirNetwork(ctx context.Context, f *TestNodeFactory) ([]TestablePeerNode, error)
  • func NewTestNetwork(ctx context.Context, f *TestNodeFactory, num int) ([]TestablePeerNode, error)

Functions

func ConnectNodes

func ConnectNodes(ctx context.Context, nodes []TestablePeerNode) error

ConnectNodes creates a basic connection between the nodes. This connection mirrors the connection that would normally occur between two p2p nodes. The Host.Connect function adds the addresses into the peerstore and dials the remote peer. Take a look at https://github.com/libp2p/go-libp2p-core/host/blob/623ffaa4ef2b8dad77933159d0848a393a91c41e/host.go#L36 for more info Connect should always: - add a connections to the peer - add the addrs of the peer to the peerstore - add a tag for each peer in the connmanager

func ConnectQriNodes

func ConnectQriNodes(ctx context.Context, nodes []TestablePeerNode) error

ConnectQriNodes takes a slice of unconnected nodes and returns a slice of connected nodes that have upgraded qri connections: They support the qri protocol and have exchanged profile

func GetSomeBlocks

func GetSomeBlocks(capi coreiface.CoreAPI, ref reporef.DatasetRef, num int) []string

GetSomeBlocks returns a list of num ids for blocks that are in the referenced dataset.

func MakeIPFSNode

func MakeIPFSNode(ctx context.Context) (*core.IpfsNode, coreiface.CoreAPI, error)

MakeIPFSNode creates a single mock IPFS Node

func MakeIPFSSwarm

func MakeIPFSSwarm(ctx context.Context, fullIdentity bool, n int) ([]*core.IpfsNode, []coreiface.CoreAPI, error)

MakeIPFSSwarm creates and connects n number of mock IPFS Nodes

func MakeRepoFromIPFSNode

func MakeRepoFromIPFSNode(node *core.IpfsNode, username string) (qrirepo.Repo, error)

MakeRepoFromIPFSNode wraps an ipfs node with a mock qri repo

Types

type NodeMakerFunc

type NodeMakerFunc func(repo.Repo, *config.P2P) (TestablePeerNode, error)

NodeMakerFunc is a function that constructs a Node from a Repo and options.

type TestNodeFactory

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

TestNodeFactory can be used to safetly construct nodes for tests

func NewTestNodeFactory

func NewTestNodeFactory(maker NodeMakerFunc) *TestNodeFactory

NewTestNodeFactory returns a new TestNodeFactory

func (*TestNodeFactory) New

func (f *TestNodeFactory) New(r repo.Repo) (TestablePeerNode, error)

New creates a new Node for testing

func (*TestNodeFactory) NewWithConf

func (f *TestNodeFactory) NewWithConf(r repo.Repo, p2pconf *config.P2P) (TestablePeerNode, error)

NewWithConf creates a new Node for testing using a configuration

func (*TestNodeFactory) NextInfo

func (f *TestNodeFactory) NextInfo() *cfgtest.PeerInfo

NextInfo gets the PeerInfo for the next test Node to be constructed

type TestablePeerNode

type TestablePeerNode interface {
	Host() host.Host
	SimplePeerInfo() pstore.PeerInfo
	UpgradeToQriConnection(pstore.PeerInfo) error
	GoOnline() error
}

TestablePeerNode is used by tests only. Implemented by QriNode

func NewAvailableTestNode

func NewAvailableTestNode(r repo.Repo, f *TestNodeFactory) (TestablePeerNode, error)

NewAvailableTestNode constructs a test node that is hooked up and ready to Connect

func NewTestDirNetwork

func NewTestDirNetwork(ctx context.Context, f *TestNodeFactory) ([]TestablePeerNode, error)

NewTestDirNetwork constructs nodes from the testdata directory, for p2p testing Peers are pulled from the "testdata" directory, and come pre-populated with datasets no peers are connected.

func NewTestNetwork

func NewTestNetwork(ctx context.Context, f *TestNodeFactory, num int) ([]TestablePeerNode, error)

NewTestNetwork constructs nodes to test p2p functionality. each of these peers has no datasets and no peers are connected