rpctest

README

rpctest

Package rpctest provides a ecrd-specific RPC testing harness crafting and executing integration tests by driving a ecrd instance via the RPC interface. Each instance of an active harness comes equipped with a simple in-memory HD wallet capable of properly syncing to the generated chain, creating new addresses, and crafting fully signed transactions paying to an arbitrary set of outputs.

This package was designed specifically to act as an RPC testing harness for ecrd. However, the constructs presented are general enough to be adapted to any project wishing to programmatically drive a ecrd instance of its systems/integration tests.

Installation and Updating

$ go get -u github.com/Eacred/eacrd/rpctest

License

Package rpctest is licensed under the copyfree ISC License.

Documentation

Overview

Package rpctest provides a ecrd-specific RPC testing harness crafting and executing integration tests by driving a `ecrd` instance via the `RPC` interface. Each instance of an active harness comes equipped with a simple in-memory HD wallet capable of properly syncing to the generated chain, creating new addresses, and crafting fully signed transactions paying to an arbitrary set of outputs.

This package was designed specifically to act as an RPC testing harness for `ecrd`. However, the constructs presented are general enough to be adapted to any project wishing to programmatically drive a `ecrd` instance of its systems/integration tests.

Index

• Constants
• func ConnectNode(from *Harness, to *Harness) error
• func JoinNodes(nodes []*Harness, joinType JoinType) error
• func NodesConnected(from, to *Harness, allowReverse bool) (bool, error)
• func RemoveNode(from *Harness, to *Harness) error
• func TearDownAll() error
• type Harness
  • func ActiveHarnesses() []*Harness
  • func New(activeNet *chaincfg.Params, handlers *rpcclient.NotificationHandlers, ...) (*Harness, error)
  • func (h *Harness) ConfirmedBalance() dcrutil.Amount
  • func (h *Harness) CreateTransaction(targetOutputs []*wire.TxOut, feeRate dcrutil.Amount) (*wire.MsgTx, error)
  • func (h *Harness) NewAddress() (dcrutil.Address, error)
  • func (h *Harness) RPCConfig() rpcclient.ConnConfig
  • func (h *Harness) SendOutputs(targetOutputs []*wire.TxOut, feeRate dcrutil.Amount) (*chainhash.Hash, error)
  • func (h *Harness) SetUp(createTestChain bool, numMatureOutputs uint32) error
  • func (h *Harness) TearDown() error
  • func (h *Harness) UnlockOutputs(inputs []*wire.TxIn)
• type HarnessTestCase
• type JoinType
• type VotingWallet
  • func NewVotingWallet(hn *Harness) (*VotingWallet, error)
  • func (w *VotingWallet) GenerateBlocks(nb uint32) ([]*chainhash.Hash, error)
  • func (w *VotingWallet) SetErrorReporting(f func(err error))
  • func (w *VotingWallet) SetMiner(f func(uint32) ([]*chainhash.Hash, error))
  • func (w *VotingWallet) Start() error
  • func (w *VotingWallet) Stop()

Constants

const (
	// BlockVersion is the default block version used when generating
	// blocks.
	BlockVersion = 3
)

Functions

func ConnectNode

func ConnectNode(from *Harness, to *Harness) error

ConnectNode establishes a new peer-to-peer connection between the "from" harness and the "to" harness. The connection made is flagged as persistent, therefore in the case of disconnects, "from" will attempt to reestablish a connection to the "to" harness.

func JoinNodes

func JoinNodes(nodes []*Harness, joinType JoinType) error

JoinNodes is a synchronization tool used to block until all passed nodes are fully synced with respect to an attribute. This function will block for a period of time, finally returning once all nodes are synced according to the passed JoinType. This function be used to ensure all active test harnesses are at a consistent state before proceeding to an assertion or check within rpc tests.

func NodesConnected

func NodesConnected(from, to *Harness, allowReverse bool) (bool, error)

NodesConnected verifies whether there is a connection via the p2p interface between the specified nodes. If allowReverse is true, connectivity is also checked in the reverse direction (to->from).

func RemoveNode

func RemoveNode(from *Harness, to *Harness) error

RemoveNode removes the peer-to-peer connection between the "from" harness and the "to" harness. The connection is only removed in this direction, therefore if the reverse connection exists, the nodes may still be connected.

This function returns an error if the nodes were not previously connected.

func TearDownAll

func TearDownAll() error

TearDownAll tears down all active test harnesses.

Types

type Harness

type Harness struct {
	// ActiveNet is the parameters of the blockchain the Harness belongs
	// to.
	ActiveNet *chaincfg.Params

	Node *rpcclient.Client

	sync.Mutex
	// contains filtered or unexported fields
}

Harness fully encapsulates an active ecrd process to provide a unified platform for creating rpc driven integration tests involving ecrd. The active ecrd node will typically be run in simnet mode in order to allow for easy generation of test blockchains. The active ecrd process is fully managed by Harness, which handles the necessary initialization, and teardown of the process along with any temporary directories created as a result. Multiple Harness instances may be run concurrently, in order to allow for testing complex scenarios involving multiple nodes. The harness also includes an in-memory wallet to streamline various classes of tests.

func ActiveHarnesses

func ActiveHarnesses() []*Harness

ActiveHarnesses returns a slice of all currently active test harnesses. A test harness if considered "active" if it has been created, but not yet torn down.

func New

func New(activeNet *chaincfg.Params, handlers *rpcclient.NotificationHandlers, extraArgs []string) (*Harness, error)

New creates and initializes new instance of the rpc test harness. Optionally, websocket handlers and a specified configuration may be passed. In the case that a nil config is passed, a default configuration will be used.

NOTE: This function is safe for concurrent access.

func (*Harness) ConfirmedBalance

func (h *Harness) ConfirmedBalance() dcrutil.Amount

ConfirmedBalance returns the confirmed balance of the Harness' internal wallet.

This function is safe for concurrent access.

func (*Harness) CreateTransaction

func (h *Harness) CreateTransaction(targetOutputs []*wire.TxOut, feeRate dcrutil.Amount) (*wire.MsgTx, error)

CreateTransaction returns a fully signed transaction paying to the specified outputs while observing the desired fee rate. The passed fee rate should be expressed in atoms-per-byte. Any unspent outputs selected as inputs for the crafted transaction are marked as unspendable in order to avoid potential double-spends by future calls to this method. If the created transaction is cancelled for any reason then the selected inputs MUST be freed via a call to UnlockOutputs. Otherwise, the locked inputs won't be returned to the pool of spendable outputs.

This function is safe for concurrent access.

func (*Harness) NewAddress

func (h *Harness) NewAddress() (dcrutil.Address, error)

NewAddress returns a fresh address spendable by the Harness' internal wallet.

This function is safe for concurrent access.

func (*Harness) RPCConfig

func (h *Harness) RPCConfig() rpcclient.ConnConfig

RPCConfig returns the harnesses current rpc configuration. This allows other potential RPC clients created within tests to connect to a given test harness instance.

func (*Harness) SendOutputs

func (h *Harness) SendOutputs(targetOutputs []*wire.TxOut, feeRate dcrutil.Amount) (*chainhash.Hash, error)

SendOutputs creates, signs, and finally broadcasts a transaction spending the harness' available mature coinbase outputs creating new outputs according to targetOutputs.

This function is safe for concurrent access.

func (*Harness) SetUp

func (h *Harness) SetUp(createTestChain bool, numMatureOutputs uint32) error

SetUp initializes the rpc test state. Initialization includes: starting up a simnet node, creating a websockets client and connecting to the started node, and finally: optionally generating and submitting a testchain with a configurable number of mature coinbase outputs coinbase outputs.

NOTE: This method and TearDown should always be called from the same goroutine as they are not concurrent safe.

func (*Harness) TearDown

func (h *Harness) TearDown() error

TearDown stops the running rpc test instance. All created processes are killed, and temporary directories removed.

NOTE: This method and SetUp should always be called from the same goroutine as they are not concurrent safe.

func (*Harness) UnlockOutputs

func (h *Harness) UnlockOutputs(inputs []*wire.TxIn)

UnlockOutputs unlocks any outputs which were previously marked as unspendable due to being selected to fund a transaction via the CreateTransaction method.

This function is safe for concurrent access.

type HarnessTestCase

type HarnessTestCase func(r *Harness, t *testing.T)

HarnessTestCase represents a test-case which utilizes an instance of the Harness to exercise functionality.

type JoinType

type JoinType uint8

JoinType is an enum representing a particular type of "node join". A node join is a synchronization tool used to wait until a subset of nodes have a consistent state with respect to an attribute.

const (
	// Blocks is a JoinType which waits until all nodes share the same
	// block height.
	Blocks JoinType = iota

	// Mempools is a JoinType which blocks until all nodes have identical
	// mempool.
	Mempools
)

type VotingWallet

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

VotingWallet stores the state for a simulated voting wallet. Once it is started, it will receive notifications from the associated harness, purchase tickets and vote on blocks as necessary to keep the chain going.

This currently only implements the bare minimum requirements for maintaining a functioning voting wallet and does not handle reorgs, multiple voting and ticket buying wallets, setting vote bits, expired/missed votes, etc.

All operations (after initial funding) are done solely via stake transactions, so no additional regular transactions are published. This is ideal for use in test suites that require a large (greater than SVH) number of blocks.

func NewVotingWallet

func NewVotingWallet(hn *Harness) (*VotingWallet, error)

NewVotingWallet creates a new minimal voting wallet for the given harness. This wallet should be able to maintain the chain generated by the miner node of the harness working after it has passed SVH (Stake Validation Height) by continuously buying tickets and voting on them.

func (*VotingWallet) GenerateBlocks

func (w *VotingWallet) GenerateBlocks(nb uint32) ([]*chainhash.Hash, error)

GenerateBlocks generates blocks while ensuring the chain will continue past SVH indefinitely. This will generate a block then wait for the votes from this wallet to be sent and tickets to be purchased before either generating the next block or returning.

This function will either return the hashes of the generated blocks or an error if, after generating a candidate block, votes and tickets aren't submitted in a timely fashion.

func (*VotingWallet) SetErrorReporting

func (w *VotingWallet) SetErrorReporting(f func(err error))

SetErrorReporting allows users of the voting wallet to specify a function that will be called whenever an error happens while purchasing tickets or generating votes.

func (*VotingWallet) SetMiner

func (w *VotingWallet) SetMiner(f func(uint32) ([]*chainhash.Hash, error))

SetMiner allows users of the voting wallet to specify a function that will be used to mine new blocks instead of using the regular Generate function of the configured rpcclient.

This allows callers to use a custom function to generate blocks, such as one that allows faster mining in simnet.

func (*VotingWallet) Start

func (w *VotingWallet) Start() error

Start stars the goroutines necessary for this voting wallet to function.

func (*VotingWallet) Stop

func (w *VotingWallet) Stop()

Stop signals all goroutines from this wallet to stop their functions.