testutils

Documentation

Index

• func RunEqualTests(t *testing.T, tests map[string]ConfigEqualTest)
• func RunPrecompileTests(t *testing.T, module modules.Module, ...)
• func RunPredicateBenchmarks(b *testing.B, predicateTests map[string]PredicateTest)
• func RunPredicateTests(t *testing.T, predicateTests map[string]PredicateTest)
• func RunVerifyTests(t *testing.T, tests map[string]ConfigVerifyTest)
• type ConfigEqualTest
• type ConfigVerifyTest
• type PrecompileRunparams
• type PrecompileTest
  • func (test PrecompileTest) Bench(b *testing.B, module modules.Module, state contract.StateDB)
  • func (test PrecompileTest) Run(t *testing.T, module modules.Module, state contract.StateDB)
• type PredicateTest
  • func (test PredicateTest) Run(t testing.TB)
  • func (test PredicateTest) RunBenchmark(b *testing.B)

Functions

func RunEqualTests

func RunEqualTests(t *testing.T, tests map[string]ConfigEqualTest)

func RunPrecompileTests

func RunPrecompileTests(t *testing.T, module modules.Module, newStateDB func(t testing.TB) contract.StateDB, contractTests map[string]PrecompileTest)

func RunPredicateBenchmarks

func RunPredicateBenchmarks(b *testing.B, predicateTests map[string]PredicateTest)

func RunPredicateTests

func RunPredicateTests(t *testing.T, predicateTests map[string]PredicateTest)

func RunVerifyTests

func RunVerifyTests(t *testing.T, tests map[string]ConfigVerifyTest)

Types

type ConfigEqualTest

type ConfigEqualTest struct {
	Config   precompileconfig.Config
	Other    precompileconfig.Config
	Expected bool
}

ConfigEqualTest is a test case for comparing two configs

type ConfigVerifyTest

type ConfigVerifyTest struct {
	Config        precompileconfig.Config
	ChainConfig   precompileconfig.ChainConfig
	ExpectedError string
}

ConfigVerifyTest is a test case for verifying a config

type PrecompileRunparams

type PrecompileRunparams struct {
	AccessibleState contract.AccessibleState
	Caller          common.Address
	ContractAddress common.Address
	Input           []byte
	SuppliedGas     uint64
	ReadOnly        bool
}

type PrecompileTest

type PrecompileTest struct {
	// Caller is the address of the precompile caller
	Caller common.Address
	// Input the raw input bytes to the precompile
	Input []byte
	// InputFn is a function that returns the raw input bytes to the precompile
	// If specified, Input will be ignored.
	InputFn func(t testing.TB) []byte
	// SuppliedGas is the amount of gas supplied to the precompile
	SuppliedGas uint64
	// ReadOnly is whether the precompile should be called in read only
	// mode. If true, the precompile should not modify the state.
	ReadOnly bool
	// Config is the config to use for the precompile
	// It should be the same precompile config that is used in the
	// precompile's configurator.
	// If nil, Configure will not be called.
	Config precompileconfig.Config
	// BeforeHook is called before the precompile is called.
	BeforeHook func(t testing.TB, state contract.StateDB)
	// SetupBlockContext sets the expected calls on MockBlockContext for the test execution.
	SetupBlockContext func(*contract.MockBlockContext)
	// AfterHook is called after the precompile is called.
	AfterHook func(t testing.TB, state contract.StateDB)
	// ExpectedRes is the expected raw byte result returned by the precompile
	ExpectedRes []byte
	// ExpectedErr is the expected error returned by the precompile
	ExpectedErr string
	// ChainConfig is the chain config to use for the precompile's block context
	// If nil, the default chain config will be used.
	ChainConfig precompileconfig.ChainConfig
}

PrecompileTest is a test case for a precompile

func (PrecompileTest) Bench

func (test PrecompileTest) Bench(b *testing.B, module modules.Module, state contract.StateDB)

func (PrecompileTest) Run

func (test PrecompileTest) Run(t *testing.T, module modules.Module, state contract.StateDB)

type PredicateTest

type PredicateTest struct {
	Config precompileconfig.Config

	PredicateContext *precompileconfig.PredicateContext

	PredicateBytes []byte
	Gas            uint64
	GasErr         error
	ExpectedErr    error
}

PredicateTest defines a unit test/benchmark for verifying a precompile predicate.

func (PredicateTest) Run

func (test PredicateTest) Run(t testing.TB)

func (PredicateTest) RunBenchmark

func (test PredicateTest) RunBenchmark(b *testing.B)