testutil

Documentation

Overview

Package testutil defines common unit test utils such as asserting logs.

Index

• func AssertLogsContain(t *testing.T, hook *test.Hook, want string)
• func AssertLogsDoNotContain(t *testing.T, hook *test.Hook, want string)
• func BazelDirectoryNonEmpty(filePath string) (bool, error)
• func BazelFileBytes(filePaths ...string) ([]byte, error)
• func BlockSignature(bState *stateTrie.BeaconState, block *ethpb.BeaconBlock, ...) (*bls.Signature, error)
• func DepositTrieFromDeposits(deposits []*ethpb.Deposit) (*trieutil.SparseMerkleTrie, [][32]byte, error)
• func DeterministicDepositTrie(size int) (*trieutil.SparseMerkleTrie, [][32]byte, error)
• func DeterministicDepositsAndKeys(numDeposits uint64) ([]*ethpb.Deposit, []*bls.SecretKey, error)
• func DeterministicDepositsAndKeysSameValidator(numDeposits uint64) ([]*ethpb.Deposit, []*bls.SecretKey, error)
• func DeterministicEth1Data(size int) (*ethpb.Eth1Data, error)
• func DeterministicGenesisState(t testing.TB, numValidators uint64) (*stateTrie.BeaconState, []*bls.SecretKey)
• func GenerateAttestations(bState *stateTrie.BeaconState, privs []*bls.SecretKey, numToGen uint64, ...) ([]*ethpb.Attestation, error)
• func GenerateAttesterSlashingForValidator(bState *stateTrie.BeaconState, priv *bls.SecretKey, idx uint64) (*ethpb.AttesterSlashing, error)
• func GenerateFullBlock(bState *stateTrie.BeaconState, privs []*bls.SecretKey, conf *BlockGenConfig, ...) (*ethpb.SignedBeaconBlock, error)
• func GenerateProposerSlashingForValidator(bState *stateTrie.BeaconState, priv *bls.SecretKey, idx uint64) (*ethpb.ProposerSlashing, error)
• func NewBeaconState() *stateTrie.BeaconState
• func RandaoReveal(beaconState *stateTrie.BeaconState, epoch uint64, privKeys []*bls.SecretKey) ([]byte, error)
• func Random32Bytes(t *testing.T) []byte
• func ResetCache()
• func RunBlockOperationTest(t *testing.T, folderPath string, body *ethpb.BeaconBlockBody, ...)
• func RunEpochOperationTest(t *testing.T, testFolderPath string, operationFn epochOperation)
• func TempDir() string
• func TestFolders(t *testing.T, config string, folderPath string) ([]os.FileInfo, string)
• func UnmarshalYaml(y []byte, dest interface{}) error
• func WaitForLog(t *testing.T, hook *test.Hook, want string)
• func WaitTimeout(wg *sync.WaitGroup, timeout time.Duration) bool
• type BlockGenConfig
  • func DefaultBlockGenConfig() *BlockGenConfig

Functions

func AssertLogsContain

func AssertLogsContain(t *testing.T, hook *test.Hook, want string)

AssertLogsContain checks that the desired string is a subset of the current log output. Set exitOnFail to true to immediately exit the test on failure

func AssertLogsDoNotContain

func AssertLogsDoNotContain(t *testing.T, hook *test.Hook, want string)

AssertLogsDoNotContain is the inverse check of AssertLogsContain

func BazelDirectoryNonEmpty

func BazelDirectoryNonEmpty(filePath string) (bool, error)

BazelDirectoryNonEmpty returns true if directory exists and is not empty.

func BazelFileBytes

func BazelFileBytes(filePaths ...string) ([]byte, error)

BazelFileBytes returns the byte array of the bazel file path given.

func BlockSignature

func BlockSignature(
	bState *stateTrie.BeaconState,
	block *ethpb.BeaconBlock,
	privKeys []*bls.SecretKey,
) (*bls.Signature, error)

BlockSignature calculates the post-state root of the block and returns the signature.

func DepositTrieFromDeposits

func DepositTrieFromDeposits(deposits []*ethpb.Deposit) (*trieutil.SparseMerkleTrie, [][32]byte, error)

DepositTrieFromDeposits takes an array of deposits and returns the deposit trie.

func DeterministicDepositTrie

func DeterministicDepositTrie(size int) (*trieutil.SparseMerkleTrie, [][32]byte, error)

DeterministicDepositTrie returns a merkle trie of the requested size from the deterministic deposits.

func DeterministicDepositsAndKeys

func DeterministicDepositsAndKeys(numDeposits uint64) ([]*ethpb.Deposit, []*bls.SecretKey, error)

DeterministicDepositsAndKeys returns the entered amount of deposits and secret keys. The deposits are configured such that for deposit n the validator account is key n and the withdrawal account is key n+1. As such, if all secret keys for n validators are required then numDeposits should be n+1.

func DeterministicDepositsAndKeysSameValidator

func DeterministicDepositsAndKeysSameValidator(numDeposits uint64) ([]*ethpb.Deposit, []*bls.SecretKey, error)

DeterministicDepositsAndKeysSameValidator returns the entered amount of deposits and secret keys of the same validator. This is for negative test cases such as same deposits from same validators in a block don't result in duplicated validator indices.

func DeterministicEth1Data

func DeterministicEth1Data(size int) (*ethpb.Eth1Data, error)

DeterministicEth1Data takes an array of deposits and returns the eth1Data made from the deposit trie.

func DeterministicGenesisState

func DeterministicGenesisState(t testing.TB, numValidators uint64) (*stateTrie.BeaconState, []*bls.SecretKey)

DeterministicGenesisState returns a genesis state made using the deterministic deposits.

func GenerateAttestations

func GenerateAttestations(bState *stateTrie.BeaconState, privs []*bls.SecretKey, numToGen uint64, slot uint64, randomRoot bool) ([]*ethpb.Attestation, error)

GenerateAttestations creates attestations that are entirely valid, for all the committees of the current state slot. This function expects attestations requested to be cleanly divisible by committees per slot. If there is 1 committee in the slot, and numToGen is set to 4, then it will return 4 attestations for the same data with their aggregation bits split uniformly.

If you request 4 attestations, but there are 8 committees, you will get 4 fully aggregated attestations.

func GenerateAttesterSlashingForValidator

func GenerateAttesterSlashingForValidator(
	bState *stateTrie.BeaconState,
	priv *bls.SecretKey,
	idx uint64,
) (*ethpb.AttesterSlashing, error)

GenerateAttesterSlashingForValidator for a specific validator index.

func GenerateFullBlock

func GenerateFullBlock(
	bState *stateTrie.BeaconState,
	privs []*bls.SecretKey,
	conf *BlockGenConfig,
	slot uint64,
) (*ethpb.SignedBeaconBlock, error)

GenerateFullBlock generates a fully valid block with the requested parameters. Use BlockGenConfig to declare the conditions you would like the block generated under.

func GenerateProposerSlashingForValidator

func GenerateProposerSlashingForValidator(
	bState *stateTrie.BeaconState,
	priv *bls.SecretKey,
	idx uint64,
) (*ethpb.ProposerSlashing, error)

GenerateProposerSlashingForValidator for a specific validator index.

func NewBeaconState

func NewBeaconState() *stateTrie.BeaconState

NewBeaconState creates a beacon state with minimum marshalable fields.

func RandaoReveal

func RandaoReveal(beaconState *stateTrie.BeaconState, epoch uint64, privKeys []*bls.SecretKey) ([]byte, error)

RandaoReveal returns a signature of the requested epoch using the beacon proposer private key.

func Random32Bytes

func Random32Bytes(t *testing.T) []byte

Random32Bytes generates a random 32 byte slice.

func ResetCache

func ResetCache()

ResetCache clears out the old trie, private keys and deposits.

func RunBlockOperationTest

func RunBlockOperationTest(
	t *testing.T,
	folderPath string,
	body *ethpb.BeaconBlockBody,
	operationFn blockOperation,
)

RunBlockOperationTest takes in the prestate and the beacon block body, processes it through the passed in block operation function and checks the post state with the expected post state.

func RunEpochOperationTest

func RunEpochOperationTest(
	t *testing.T,
	testFolderPath string,
	operationFn epochOperation,
)

RunEpochOperationTest takes in the prestate and processes it through the passed in epoch operation function and checks the post state with the expected post state.

func TempDir

func TempDir() string

TempDir returns a directory path for temporary test storage.

func TestFolders

func TestFolders(t *testing.T, config string, folderPath string) ([]os.FileInfo, string)

TestFolders sets the proper config and returns the result of ReadDir on the passed in eth2-spec-tests directory along with its path.

func UnmarshalYaml

func UnmarshalYaml(y []byte, dest interface{}) error

UnmarshalYaml using a customized json encoder that supports "spec-name" override tag.

func WaitForLog

func WaitForLog(t *testing.T, hook *test.Hook, want string)

WaitForLog waits for the desired string to appear the logs within a time period. If it does not appear within the limit, the function will throw an error.

func WaitTimeout

func WaitTimeout(wg *sync.WaitGroup, timeout time.Duration) bool

WaitTimeout will wait for a WaitGroup to resolve within a timeout interval. Returns true if the waitgroup exceeded the timeout.

Types

type BlockGenConfig

type BlockGenConfig struct {
	NumProposerSlashings uint64
	NumAttesterSlashings uint64
	NumAttestations      uint64
	NumDeposits          uint64
	NumVoluntaryExits    uint64
}

BlockGenConfig is used to define the requested conditions for block generation.

func DefaultBlockGenConfig

func DefaultBlockGenConfig() *BlockGenConfig

DefaultBlockGenConfig returns the block config that utilizes the current params in the beacon config.