e2e

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 17, 2024 License: Apache-2.0 Imports: 25 Imported by: 20

Documentation

Index

Constants

View Source 
const (
	ModeValidator Mode = "validator"
	ModeFull      Mode = "full"
	ModeLight     Mode = "light"
	ModeSeed      Mode = "seed"

	ProtocolBuiltin         Protocol = "builtin"
	ProtocolBuiltinConnSync Protocol = "builtin_connsync"
	ProtocolFile            Protocol = "file"
	ProtocolGRPC            Protocol = "grpc"
	ProtocolTCP             Protocol = "tcp"
	ProtocolUNIX            Protocol = "unix"

	PerturbationDisconnect Perturbation = "disconnect"
	PerturbationKill       Perturbation = "kill"
	PerturbationPause      Perturbation = "pause"
	PerturbationRestart    Perturbation = "restart"
	PerturbationUpgrade    Perturbation = "upgrade"

	EvidenceAgeHeight int64         = 14
	EvidenceAgeTime   time.Duration = 1500 * time.Millisecond
)

Variables

This section is empty.

Functions

func LoadZoneLatenciesMatrix added in v1.0.0 

func LoadZoneLatenciesMatrix() ([]string, map[string][]uint32, error)

LoadZoneLatenciesMatrix parses the file containing the matrix of latencies from each zone to another one. It returns the list of all zone IDs, and a map from each zone ID to the latencies to each other zone.

func ParseKeyValueField added in v1.0.0 

func ParseKeyValueField(name string, field string) (key string, value string, err error)

Types

type ErrInvalidZoneID added in v1.0.0 

type ErrInvalidZoneID struct {
	ZoneID string
	Err    error
}

func (ErrInvalidZoneID) Error added in v1.0.0 

func (e ErrInvalidZoneID) Error() string

type InfrastructureData 

type InfrastructureData struct {
	Path string `json:"path"`

	// Provider is the name of infrastructure provider backing the testnet.
	// For example, 'docker' if it is running locally in a docker network or
	// 'digital-ocean', 'aws', 'google', etc. if it is from a cloud provider.
	Provider string `json:"provider"`

	// Instances is a map of all of the machine instances on which to run
	// processes for a testnet.
	// The key of the map is the name of the instance, which each must correspond
	// to the names of one of the testnet nodes defined in the testnet manifest.
	Instances map[string]InstanceData `json:"instances"`

	// Network is the CIDR notation range of IP addresses that all of the instances'
	// IP addresses are expected to be within.
	Network string `json:"network"`
}

InfrastructureData contains the relevant information for a set of existing infrastructure that is to be used for running a testnet.

func InfrastructureDataFromFile 

func InfrastructureDataFromFile(p string) (InfrastructureData, error)

func NewDockerInfrastructureData 

func NewDockerInfrastructureData(m Manifest) (InfrastructureData, error)

type InstanceData 

type InstanceData struct {
	IPAddress          net.IP `json:"ip_address"`
	ExtIPAddress       net.IP `json:"ext_ip_address"`
	RPCPort            uint32 `json:"rpc_port"`
	GRPCPort           uint32 `json:"grpc_port"`
	PrivilegedGRPCPort uint32 `json:"privileged_grpc_port"`
}

InstanceData contains the relevant information for a machine instance backing one of the nodes in the testnet.

type Manifest 

type Manifest struct {
	// IPv6 uses IPv6 networking instead of IPv4. Defaults to IPv4.
	IPv6 bool `toml:"ipv6"`

	// InitialHeight specifies the initial block height, set in genesis. Defaults to 1.
	InitialHeight int64 `toml:"initial_height"`

	// InitialState is an initial set of key/value pairs for the application,
	// set in genesis. Defaults to nothing.
	InitialState map[string]string `toml:"initial_state"`

	// ValidatorsMap is the initial validator set in genesis, given as node names
	// and power:
	//
	// validators = { validator01 = 10; validator02 = 20; validator03 = 30 }
	//
	// Defaults to all nodes that have mode=validator at power 100. Explicitly
	// specifying an empty set will start with no validators in genesis, and
	// the application must return the validator set in InitChain via the
	// setting validator_update.0 (see below).
	ValidatorsMap *map[string]int64 `toml:"validators"`

	// ValidatorUpdatesMap is a map of heights to validator names and their power,
	// and will be returned by the ABCI application. For example, the following
	// changes the power of validator01 and validator02 at height 1000:
	//
	// [validator_update.1000]
	// validator01 = 20
	// validator02 = 10
	//
	// Specifying height 0 returns the validator update during InitChain. The
	// application returns the validator updates as-is, i.e. removing a
	// validator must be done by returning it with power 0, and any validators
	// not specified are not changed.
	ValidatorUpdatesMap map[string]map[string]int64 `toml:"validator_update"`

	// NodesMap specifies the network nodes. At least one node must be given.
	NodesMap map[string]*ManifestNode `toml:"node"`

	// Disable the peer-exchange reactor on all nodes.
	DisablePexReactor bool `toml:"disable_pex"`

	// KeyType sets the curve that will be used by validators.
	// Options are ed25519, secp256k1 and bls12381.
	KeyType string `toml:"key_type"`

	// Evidence indicates the amount of evidence that will be injected into the
	// testnet via the RPC endpoint of a random node. Default is 0
	Evidence int `toml:"evidence"`

	// ABCIProtocol specifies the protocol used to communicate with the ABCI
	// application: "unix", "tcp", "grpc", "builtin" or "builtin_connsync".
	//
	// Defaults to "builtin". "builtin" will build a complete CometBFT node
	// into the application and launch it instead of launching a separate
	// CometBFT process.
	//
	// "builtin_connsync" is basically the same as "builtin", except that it
	// uses a "connection-synchronized" local client creator, which attempts to
	// replicate the same concurrency model locally as the socket client.
	ABCIProtocol string `toml:"abci_protocol"`

	// Add artificial delays to each of the main ABCI calls to mimic computation time
	// of the application
	PrepareProposalDelay time.Duration `toml:"prepare_proposal_delay"`
	ProcessProposalDelay time.Duration `toml:"process_proposal_delay"`
	CheckTxDelay         time.Duration `toml:"check_tx_delay"`
	VoteExtensionDelay   time.Duration `toml:"vote_extension_delay"`
	FinalizeBlockDelay   time.Duration `toml:"finalize_block_delay"`

	// UpgradeVersion specifies to which version nodes need to upgrade.
	// Currently only uncoordinated upgrade is supported
	UpgradeVersion string `toml:"upgrade_version"`

	LoadTxSizeBytes   int `toml:"load_tx_size_bytes"`
	LoadTxBatchSize   int `toml:"load_tx_batch_size"`
	LoadTxConnections int `toml:"load_tx_connections"`
	LoadMaxTxs        int `toml:"load_max_txs"`

	// LogLevel specifies the log level to be set on all nodes.
	LogLevel string `toml:"log_level"`

	// LogFormat specifies the log format to be set on all nodes.
	LogFormat string `toml:"log_format"`

	// Enable or disable Prometheus metrics on all nodes.
	// Defaults to false (disabled).
	Prometheus bool `toml:"prometheus"`

	// BlockMaxBytes specifies the maximum size in bytes of a block. This
	// value will be written to the genesis file of all nodes.
	BlockMaxBytes int64 `toml:"block_max_bytes"`

	// Defines a minimum size for the vote extensions.
	VoteExtensionSize uint `toml:"vote_extension_size"`

	// VoteExtensionsEnableHeight configures the first height during which
	// the chain will use and require vote extension data to be present
	// in precommit messages.
	VoteExtensionsEnableHeight int64 `toml:"vote_extensions_enable_height"`

	// VoteExtensionsUpdateHeight configures the height at which consensus
	// param VoteExtensionsEnableHeight will be set.
	// -1 denotes it is set at genesis.
	// 0 denotes it is set at InitChain.
	VoteExtensionsUpdateHeight int64 `toml:"vote_extensions_update_height"`

	// Upper bound of sleep duration then gossipping votes and block parts
	PeerGossipIntraloopSleepDuration time.Duration `toml:"peer_gossip_intraloop_sleep_duration"`

	// Maximum number of peers to which the node gossips transactions
	ExperimentalMaxGossipConnectionsToPersistentPeers    uint `toml:"experimental_max_gossip_connections_to_persistent_peers"`
	ExperimentalMaxGossipConnectionsToNonPersistentPeers uint `toml:"experimental_max_gossip_connections_to_non_persistent_peers"`

	// Enable or disable e2e tests for CometBFT's expected behavior with respect
	// to ABCI.
	ABCITestsEnabled bool `toml:"abci_tests_enabled"`

	// Default geographical zone ID for simulating latencies, assigned to nodes that don't have a
	// specific zone assigned.
	DefaultZone string `toml:"default_zone"`

	// PbtsEnableHeight configures the first height during which
	// the chain will start using Proposer-Based Timestamps (PBTS)
	// to create and validate new blocks.
	PbtsEnableHeight int64 `toml:"pbts_enable_height"`

	// PbtsUpdateHeight configures the height at which consensus
	// param PbtsEnableHeight will be set.
	// -1 denotes it is set at genesis.
	// 0 denotes it is set at InitChain.
	PbtsUpdateHeight int64 `toml:"pbts_update_height"`

	// Genesis is a set of key-value config entries to write to the
	// produced genesis file. The format is "key = value".
	// Example: "consensus_params.evidence.max_bytes = 1024".
	Genesis []string `toml:"genesis"`

	// Config is a set of key-value config entries to write to CometBFT's
	// configuration files for all nodes. The format is "key = value".
	// Example: "p2p.send_rate = 512000".
	Config []string `toml:"config"`
}

Manifest represents a TOML testnet manifest.

func LoadManifest 

func LoadManifest(file string) (Manifest, error)

LoadManifest loads a testnet manifest from a file.

func (Manifest) Save 

func (m Manifest) Save(file string) error

Save saves the testnet manifest to a file.

type ManifestNode 

type ManifestNode struct {
	// ModeStr specifies the type of node: "validator", "full", "light" or "seed".
	// Defaults to "validator". Full nodes do not get a signing key (a dummy key
	// is generated), and seed nodes run in seed mode with the PEX reactor enabled.
	ModeStr string `toml:"mode"`

	// Version specifies which version of CometBFT this node is. Specifying different
	// versions for different nodes allows for testing the interaction of different
	// node's compatibility. Note that in order to use a node at a particular version,
	// there must be a docker image of the test app tagged with this version present
	// on the machine where the test is being run.
	Version string `toml:"version"`

	// SeedsList is the list of node names to use as P2P seed nodes. Defaults to none.
	SeedsList []string `toml:"seeds"`

	// PersistentPeersList is a list of node names to maintain persistent P2P
	// connections to. If neither seeds nor persistent peers are specified,
	// this defaults to all other nodes in the network. For light clients,
	// this relates to the providers the light client is connected to.
	PersistentPeersList []string `toml:"persistent_peers"`

	// Database specifies the database backend: "goleveldb", "rocksdb",
	// "pebbledb" or "badgerdb". Defaults to "goleveldb".
	Database string `toml:"database"`

	// PrivvalProtocolStr specifies the protocol used to sign consensus messages:
	// "file", "unix", or "tcp". Defaults to "file". For unix and tcp, the ABCI
	// application will launch a remote signer client in a separate goroutine.
	// Only nodes with mode=validator will actually make use of this.
	PrivvalProtocolStr string `toml:"privval_protocol"`

	// StartAt specifies the block height at which the node will be started. The
	// runner will wait for the network to reach at least this block height.
	StartAt int64 `toml:"start_at"`

	// BlockSyncVersion specifies which version of Block Sync to use (currently
	// only "v0", the default value).
	BlockSyncVersion string `toml:"block_sync_version"`

	// StateSync enables state sync. The runner automatically configures trusted
	// block hashes and RPC servers. At least one node in the network must have
	// SnapshotInterval set to non-zero, and the state syncing node must have
	// StartAt set to an appropriate height where a snapshot is available.
	StateSync bool `toml:"state_sync"`

	// PersistIntervalPtr specifies the height interval at which the application
	// will persist state to disk. Defaults to 1 (every height), setting this to
	// 0 disables state persistence.
	PersistIntervalPtr *uint64 `toml:"persist_interval"`

	// SnapshotInterval specifies the height interval at which the application
	// will take state sync snapshots. Defaults to 0 (disabled).
	SnapshotInterval uint64 `toml:"snapshot_interval"`

	// RetainBlocks specifies the number of recent blocks to retain. Defaults to
	// 0, which retains all blocks. Must be greater that PersistInterval,
	// SnapshotInterval and EvidenceAgeHeight.
	RetainBlocks uint64 `toml:"retain_blocks"`

	// EnableCompanionPruning specifies whether or not storage pruning on the
	// node should take a data companion into account.
	EnableCompanionPruning bool `toml:"enable_companion_pruning"`

	// Perturb lists perturbations to apply to the node after it has been
	// started and synced with the network:
	//
	// disconnect: temporarily disconnects the node from the network
	// kill:       kills the node with SIGKILL then restarts it
	// pause:      temporarily pauses (freezes) the node
	// restart:    restarts the node, shutting it down with SIGTERM
	Perturb []string `toml:"perturb"`

	// SendNoLoad determines if the e2e test should send load to this node.
	// It defaults to false so unless the configured, the node will
	// receive load.
	SendNoLoad bool `toml:"send_no_load"`

	// Geographical zone ID for simulating latencies.
	Zone string `toml:"zone"`

	// ExperimentalKeyLayout sets the key representation in the DB
	ExperimentalKeyLayout string `toml:"experimental_db_key_layout"`

	// Compact triggers compaction on the DB after pruning
	Compact bool `toml:"compact"`

	// CompactionInterval sets the number of blocks at which we trigger compaction
	CompactionInterval int64 `toml:"compaction_interval"`

	// DiscardABCIResponses disables abci rsponses
	DiscardABCIResponses bool `toml:"discard_abci_responses"`

	// Indexer sets the indexer, default kv
	Indexer string `toml:"indexer"`

	// Simulated clock skew for this node
	ClockSkew time.Duration `toml:"clock_skew"`

	// Config is a set of key-value config entries to write to CometBFT's
	// configuration files for this node. The format is "key = value".
	// Example: "p2p.send_rate = 512000".
	Config []string `toml:"config"`
}

ManifestNode represents a node in a testnet manifest.

type Mode 

type Mode string

type Node 

type Node struct {
	ManifestNode

	Name                    string
	Testnet                 *Testnet
	Mode                    Mode
	PrivvalKey              crypto.PrivKey
	NodeKey                 crypto.PrivKey
	InternalIP              net.IP
	ExternalIP              net.IP
	RPCProxyPort            uint32
	GRPCProxyPort           uint32
	GRPCPrivilegedProxyPort uint32
	ABCIProtocol            Protocol
	PrivvalProtocol         Protocol
	PersistInterval         uint64
	Seeds                   []*Node
	PersistentPeers         []*Node
	Perturbations           []Perturbation
	Prometheus              bool
	PrometheusProxyPort     uint32
	Zone                    string
}

Node represents a CometBFT node in a testnet. It includes all fields from the associated ManifestNode instance.

func (Node) AddressP2P 

func (n Node) AddressP2P(withID bool) string

Address returns a P2P endpoint address for the node.

func (Node) AddressRPC 

func (n Node) AddressRPC() string

Address returns an RPC endpoint address for the node.

func (Node) Client 

func (n Node) Client() (*rpchttp.HTTP, error)

Client returns an RPC client for the node.

func (Node) ClientInternalIP added in v1.0.0 

func (n Node) ClientInternalIP() (*rpchttp.HTTP, error)

ClientInternalIP returns an RPC client using the node's internal IP. This is useful for running the loader from inside a private DO network.

func (Node) GRPCClient added in v1.0.0 

func (n Node) GRPCClient(ctx context.Context) (grpcclient.Client, error)

GRPCClient creates a gRPC client for the node.

func (Node) GRPCPrivilegedClient added in v1.0.0 

func (n Node) GRPCPrivilegedClient(ctx context.Context) (grpcprivileged.Client, error)

GRPCClient creates a gRPC client for the node.

func (Node) Stateless 

func (n Node) Stateless() bool

Stateless returns true if the node is either a seed node or a light node.

func (Node) Validate 

func (n Node) Validate(testnet Testnet) error

Validate validates a node.

type Perturbation 

type Perturbation string

type Protocol 

type Protocol string

type Testnet 

type Testnet struct {
	Manifest

	Name string
	File string
	Dir  string

	IP               *net.IPNet
	Validators       map[*Node]int64
	ValidatorUpdates map[int64]map[*Node]int64
	Nodes            []*Node

	// Latency Emulation is enabled when all the nodes have a zone assigned.
	LatencyEmulationEnabled bool
}

Testnet represents a single testnet. It includes all fields from the associated Manifest instance.

func LoadTestnet 

func LoadTestnet(file string, ifd InfrastructureData, dir string) (*Testnet, error)

LoadTestnet loads a testnet from a manifest file. The testnet files are generated in the given directory, which is also use to determine the testnet name (the directory's basename). The testnet generation must be deterministic, since it is generated separately by the runner and the test cases. For this reason, testnets use a random seed to generate e.g. keys.

func NewTestnetFromManifest added in v0.38.0 

func NewTestnetFromManifest(manifest Manifest, file string, ifd InfrastructureData, dir string) (*Testnet, error)

NewTestnetFromManifest creates and validates a testnet from a manifest.

func (Testnet) ArchiveNodes 

func (t Testnet) ArchiveNodes() []*Node

ArchiveNodes returns a list of archive nodes that start at the initial height and contain the entire blockchain history. They are used e.g. as light client RPC servers.

func (Testnet) HasPerturbations 

func (t Testnet) HasPerturbations() bool

HasPerturbations returns whether the network has any perturbations.

func (Testnet) IPv6 

func (t Testnet) IPv6() bool

IPv6 returns true if the testnet is an IPv6 network.

func (Testnet) LookupNode 

func (t Testnet) LookupNode(name string) *Node

LookupNode looks up a node by name. For now, simply do a linear search.

func (Testnet) RandomNode 

func (t Testnet) RandomNode() *Node

RandomNode returns a random non-seed node.

func (Testnet) Validate 

func (t Testnet) Validate() error

Validate validates a testnet.

Source Files

View all Source files

Directories

Path Synopsis
grammar-auto/lexer
Package lexer is generated by GoGLL.
 Package lexer is generated by GoGLL.
grammar-auto/parser
Package parser is generated by gogll.
 Package parser is generated by gogll.
grammar-auto/parser/bsr
Package bsr implements a Binary Subtree Representation set as defined in
 Package bsr implements a Binary Subtree Representation set as defined in
grammar-auto/parser/slot
Package slot is generated by gogll.
 Package slot is generated by gogll.
grammar-auto/parser/symbols
Package symbols is generated by gogll.
 Package symbols is generated by gogll.
grammar-auto/sppf
Package sppf implements a Shared Packed Parse Forest as defined in:
 Package sppf implements a Shared Packed Parse Forest as defined in:
grammar-auto/token
Package token is generated by GoGLL.
 Package token is generated by GoGLL.
digitalocean
docker

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.