e2e

README

Avalanche e2e test suites

• Works for any environments (e.g., local, test network).
• Compiles to a single binary with customizable configurations.

Running tests

go install -v github.com/onsi/ginkgo/v2/ginkgo@v2.0.0
ACK_GINKGO_RC=true ginkgo build ./tests/e2e
./tests/e2e/e2e.test --help

./tests/e2e/e2e.test \
--network-runner-grpc-endpoint="0.0.0.0:12340" \
--avalanchego-path=./build/avalanchego

See tests.e2e.sh for an example.

Adding tests

Define any flags/configurations in e2e.go.

Create a new package to implement feature-specific tests, or add tests to an existing package. For example:

.
└── e2e
    ├── README.md
    ├── e2e.go
    ├── e2e_test.go
    └── ping
        └── suites.go

e2e.go defines common configurations (e.g., network-runner client) for other test packages. ping/suites.go defines ping tests, annotated by [Ping], which can be selected by ./tests/e2e/e2e.test --ginkgo.focus "\[Local\] \[Ping\]".

Documentation

Overview

e2e implements the e2e tests.

Index

• Constants
• Variables
• func DescribePChain(text string, body func()) bool
• func DescribeXChain(text string, body func()) bool
• type ClusterType
• type TestEnvironment
  • func (te *TestEnvironment) ConfigCluster(logLevel string, networkRunnerGRPCEp string, avalancheGoExecPath string, ...) error
  • func (te *TestEnvironment) GetRunnerClient() (cli runner_sdk.Client)
  • func (te *TestEnvironment) GetRunnerGRPCEndpoint() (ep string)
  • func (te *TestEnvironment) GetTestKeys() ([]*secp256k1.PrivateKey, []ids.ShortID, *secp256k1fx.Keychain)
  • func (te *TestEnvironment) GetURIs() []string
  • func (te *TestEnvironment) LoadKeys() error
  • func (te *TestEnvironment) RestoreInitialState(switchOffNetworkFirst bool) error
  • func (te *TestEnvironment) ShutdownCluster() error
  • func (te *TestEnvironment) SnapInitialState() error
  • func (te *TestEnvironment) StartCluster() error

Constants

const (
	Unknown ClusterType = iota
	StandAlone
	PreExisting

	// Enough for primary.NewWallet to fetch initial UTXOs.
	DefaultWalletCreationTimeout = 5 * time.Second

	// Defines default tx confirmation timeout.
	// Enough for test/custom networks.
	DefaultConfirmTxTimeout = 20 * time.Second

	DefaultShutdownTimeout = 2 * time.Minute
)

Variables

var (
	Env = &TestEnvironment{
		testEnvironmentConfig: &testEnvironmentConfig{
			clusterType: Unknown,
		},
	}
)

Env is the global struct containing all we need to test

Functions

func DescribePChain

func DescribePChain(text string, body func()) bool

DescribePChain annotates the tests for P-Chain. Can run with any type of cluster (e.g., local, fuji, mainnet).

func DescribeXChain

func DescribeXChain(text string, body func()) bool

DescribeXChain annotates the tests for X-Chain. Can run with any type of cluster (e.g., local, fuji, mainnet).

Types

type ClusterType

type ClusterType byte

type TestEnvironment

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

func (*TestEnvironment) ConfigCluster

func (te *TestEnvironment) ConfigCluster(
	logLevel string,
	networkRunnerGRPCEp string,
	avalancheGoExecPath string,
	avalancheGoLogLevel string,
	uris string,
	testKeysFile string,
) error

should be called only once must be called before StartCluster Note that either networkRunnerGRPCEp or uris must be specified

func (*TestEnvironment) GetRunnerClient

func (te *TestEnvironment) GetRunnerClient() (cli runner_sdk.Client)

func (*TestEnvironment) GetRunnerGRPCEndpoint

func (te *TestEnvironment) GetRunnerGRPCEndpoint() (ep string)

func (*TestEnvironment) GetTestKeys

func (te *TestEnvironment) GetTestKeys() ([]*secp256k1.PrivateKey, []ids.ShortID, *secp256k1fx.Keychain)

func (*TestEnvironment) GetURIs

func (te *TestEnvironment) GetURIs() []string

func (*TestEnvironment) LoadKeys

func (te *TestEnvironment) LoadKeys() error

func (*TestEnvironment) RestoreInitialState

func (te *TestEnvironment) RestoreInitialState(switchOffNetworkFirst bool) error

func (*TestEnvironment) ShutdownCluster

func (te *TestEnvironment) ShutdownCluster() error

func (*TestEnvironment) SnapInitialState

func (te *TestEnvironment) SnapInitialState() error

func (*TestEnvironment) StartCluster

func (te *TestEnvironment) StartCluster() error