The highest tagged major version is
Documentation
¶
Index ¶
- Constants
- func ContextWithTimeout(tc TestContext, duration time.Duration) context.Context
- func DefaultContext(tc TestContext) context.Context
- func DefaultNotifyContext(duration time.Duration, cleanup func(func())) context.Context
- func GetMetricValue(metrics NodeMetrics, name string, labels metric.Labels) (float64, bool)
- func NewDefaultLogger(prefix string) log.Logger
- func Outf(format string, args ...interface{})
- func WithDefaultContext(tc TestContext) common.Option
- type NodeMetrics
- type NodesMetrics
- type SimpleNodeMetrics
- type SimpleNodesMetrics
- type SimpleTestContext
- func (tc *SimpleTestContext) By(_ string, _ ...func())
- func (tc *SimpleTestContext) Cleanup()
- func (tc *SimpleTestContext) ContextWithTimeout(duration time.Duration) context.Context
- func (tc *SimpleTestContext) DefaultContext() context.Context
- func (tc *SimpleTestContext) DeferCleanup(cleanup func())
- func (tc *SimpleTestContext) Errorf(format string, args ...interface{})
- func (tc *SimpleTestContext) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, msg string)
- func (*SimpleTestContext) FailNow()
- func (tc *SimpleTestContext) Log() log.Logger
- func (tc *SimpleTestContext) Recover()
- func (tc *SimpleTestContext) WithDefaultContext() common.Option
- type TestContext
Constants ¶
const ( Wei = 1 GWei = 1_000_000_000 // 1e9 Wei Ether = 1_000_000_000_000_000_000 // 1e18 Wei )
Ethereum denomination constants These are standard Ethereum units used across the ecosystem
const DefaultTimeout = 2 * time.Minute
A long default timeout used to timeout failed operations but unlikely to induce flaking due to unexpected resource contention.
const (
// TxGas is the base gas cost for a simple transaction
TxGas = 21_000
)
Transaction constants
Variables ¶
This section is empty.
Functions ¶
func ContextWithTimeout ¶
func ContextWithTimeout(tc TestContext, duration time.Duration) context.Context
Helper simplifying use of a timed context by canceling the context with the test context.
func DefaultContext ¶
func DefaultContext(tc TestContext) context.Context
Helper simplifying use of a timed context configured with the default timeout.
func DefaultNotifyContext ¶
DefaultNotifyContext returns a context that is marked done when signals indicating process termination are received. If a non-zero duration is provided, the parent to the notify context will be a context with a timeout for that duration.
func GetMetricValue ¶
GetMetricValue returns the value of the specified metric which has the required labels.
If multiple metrics match the provided labels, the first metric found is returned.
Only Counter and Gauge metrics are supported.
func NewDefaultLogger ¶
func Outf ¶ added in v1.1.11
func Outf(format string, args ...interface{})
Outputs to stdout.
Examples:
- Out("{{green}}{{bold}}hi there %q{{/}}", "aa")
- Out("{{magenta}}{{bold}}hi therea{{/}} {{cyan}}{{underline}}b{{/}}")
See https://github.com/onsi/ginkgo/blob/v2.0.0/formatter/formatter.go#L52-L73 for an exhaustive list of color options.
func WithDefaultContext ¶ added in v0.15.6
func WithDefaultContext(tc TestContext) common.Option
Helper simplifying use via an option of a timed context configured with the default timeout.
Types ¶
type NodeMetrics ¶
type NodeMetrics map[string]*dto.MetricFamily
"metric name" -> "metric value"
func GetNodeMetrics ¶
func GetNodeMetrics(ctx context.Context, nodeURI string) (NodeMetrics, error)
GetNodeMetrics retrieves the specified metrics the provided node URI.
type NodesMetrics ¶
type NodesMetrics map[string]NodeMetrics
URI -> "metric name" -> "metric value"
func GetNodesMetrics ¶
func GetNodesMetrics(ctx context.Context, nodeURIs []string) (NodesMetrics, error)
GetNodesMetrics retrieves the specified metrics for the provided node URIs.
type SimpleNodeMetrics ¶ added in v1.1.11
"metric name" -> "metric value"
func GetMetricsValue ¶ added in v1.1.11
func GetMetricsValue(url string, metrics ...string) (SimpleNodeMetrics, error)
func GetSimpleNodeMetrics ¶ added in v1.1.11
func GetSimpleNodeMetrics(nodeURI string, metricNames ...string) (SimpleNodeMetrics, error)
GetSimpleNodeMetrics retrieves the specified metrics the provided node URI.
type SimpleNodesMetrics ¶ added in v1.1.11
type SimpleNodesMetrics map[string]SimpleNodeMetrics
URI -> "metric name" -> "metric value"
func GetSimpleNodesMetrics ¶ added in v1.1.11
func GetSimpleNodesMetrics(nodeURIs []string, metricNames ...string) (SimpleNodesMetrics, error)
GetSimpleNodesMetrics retrieves the specified metrics for the provided node URIs.
type SimpleTestContext ¶
type SimpleTestContext struct {
// contains filtered or unexported fields
}
func NewTestContext ¶
func NewTestContext(log log.Logger) *SimpleTestContext
func NewTestContextWithArgs ¶ added in v1.11.14
func NewTestContextWithArgs( _ context.Context, log log.Logger, errorfHandler func(format string, args ...any), panicHandler func(r any), ) *SimpleTestContext
NewTestContextWithArgs creates a test context with custom error and panic handlers. This is useful for integration with testing frameworks like Antithesis.
func (*SimpleTestContext) By ¶
func (tc *SimpleTestContext) By(_ string, _ ...func())
func (*SimpleTestContext) Cleanup ¶
func (tc *SimpleTestContext) Cleanup()
Cleanup is intended to be deferred by the caller to ensure cleanup is performed even in the event that a panic occurs.
func (*SimpleTestContext) ContextWithTimeout ¶
func (tc *SimpleTestContext) ContextWithTimeout(duration time.Duration) context.Context
Helper simplifying use of a timed context by canceling the context on ginkgo teardown.
func (*SimpleTestContext) DefaultContext ¶
func (tc *SimpleTestContext) DefaultContext() context.Context
Helper simplifying use of a timed context configured with the default timeout.
func (*SimpleTestContext) DeferCleanup ¶
func (tc *SimpleTestContext) DeferCleanup(cleanup func())
func (*SimpleTestContext) Errorf ¶
func (tc *SimpleTestContext) Errorf(format string, args ...interface{})
func (*SimpleTestContext) Eventually ¶
func (*SimpleTestContext) FailNow ¶
func (*SimpleTestContext) FailNow()
func (*SimpleTestContext) Log ¶
func (tc *SimpleTestContext) Log() log.Logger
func (*SimpleTestContext) Recover ¶ added in v1.11.14
func (tc *SimpleTestContext) Recover()
Recover should be deferred to recover from panics and call custom panic handler if set.
func (*SimpleTestContext) WithDefaultContext ¶ added in v0.15.6
func (tc *SimpleTestContext) WithDefaultContext() common.Option
Helper simplifying use via an option of a timed context configured with the default timeout.
type TestContext ¶
type TestContext interface {
// Ensures the context can be used to instantiate a require instance
require.TestingT
// Ensures compatibility with ginkgo.By
By(text string, callback ...func())
// Provides a simple alternative to ginkgo.DeferCleanup
DeferCleanup(cleanup func())
// Returns a logger that can be used to log test output
Log() log.Logger
// Context helpers requiring cleanup with DeferCleanup
ContextWithTimeout(duration time.Duration) context.Context
DefaultContext() context.Context
WithDefaultContext() common.Option
// Ensures compatibility with require.Eventually
Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, msg string)
}
Source Files
Directories