e2e

package

v1.0.0 Latest Latest Go to latest Published: Jul 4, 2023 License: BSD-3-Clause Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/chain4travel/camino-node

Links

Open Source Insights

README ¶

Camino 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" \
--caminogo-path=./build/caminogo

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

Constants ¶

View Source

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 ¶

View Source

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 ¶ added in v1.0.0

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

func (*TestEnvironment) ConfigCluster ¶ added in v1.0.0

func (te *TestEnvironment) ConfigCluster(
	logLevel string,
	networkRunnerGRPCEp string,
	caminoNodeExecPath string,
	caminoLogLevel 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 ¶ added in v1.0.0

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

func (*TestEnvironment) GetRunnerGRPCEndpoint ¶ added in v1.0.0

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

func (*TestEnvironment) GetTestKeys ¶ added in v1.0.0

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

func (*TestEnvironment) GetURIs ¶ added in v1.0.0

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

func (*TestEnvironment) LoadKeys ¶ added in v1.0.0

func (te *TestEnvironment) LoadKeys() error

func (*TestEnvironment) RestoreInitialState ¶ added in v1.0.0

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

func (*TestEnvironment) ShutdownCluster ¶ added in v1.0.0

func (te *TestEnvironment) ShutdownCluster() error

func (*TestEnvironment) SnapInitialState ¶ added in v1.0.0

func (te *TestEnvironment) SnapInitialState() error

func (*TestEnvironment) StartCluster ¶ added in v1.0.0

func (te *TestEnvironment) StartCluster() error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
banff Implements tests for the banff network upgrade.	Implements tests for the banff network upgrade.
p
ping Implements ping tests, requires network-runner cluster.	Implements ping tests, requires network-runner cluster.
static-handlers Implements static handlers tests for avm and platformvm	Implements static handlers tests for avm and platformvm
x
transfer Implements X-chain transfer tests.	Implements X-chain transfer tests.
whitelist-vtx Implements X-Chain whitelist vtx (stop vertex) tests.	Implements X-Chain whitelist vtx (stop vertex) tests.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL