support procedural test style for VM-defined workloads

examples/morpheusvm/tests/e2e/transfer_test.go

@@ -0,0 +1,58 @@
+// Copyright (C) 2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package e2e_test
+
+import (
+	"context"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/ava-labs/hypersdk/api/jsonrpc"
+	"github.com/ava-labs/hypersdk/auth"
+	"github.com/ava-labs/hypersdk/chain"
+	"github.com/ava-labs/hypersdk/crypto/ed25519"
+	"github.com/ava-labs/hypersdk/examples/morpheusvm/actions"
+	"github.com/ava-labs/hypersdk/examples/morpheusvm/vm"
+	"github.com/ava-labs/hypersdk/tests/workload"
+
+	he2e "github.com/ava-labs/hypersdk/tests/e2e"
+	ginkgo "github.com/onsi/ginkgo/v2"
+)
+
+var _ = he2e.RegisterTest("Transfer Transaction", func(t ginkgo.FullGinkgoTInterface, tn workload.TestNetwork) error {
+	require := require.New(t)
+
+	uri := tn.URIs()[0]
+	other, err := ed25519.GeneratePrivateKey()
+	require.NoError(err)
+	aother := auth.NewED25519Address(other.PublicKey())
+
+	lcli := vm.NewJSONRPCClient(uri)
+	parser, err := lcli.Parser(context.Background())
+	require.NoError(err)
+
+	spendingKey, err := tn.WorkloadFactory().GetSpendingKey()
+	require.NoError(err)
+
+	cli := jsonrpc.NewJSONRPCClient(uri)
+	_, tx, _, err := cli.GenerateTransaction(
+		context.Background(),
+		parser,
+		[]chain.Action{&actions.Transfer{
+			To:    aother,
+			Value: 1,
+		}},
+		auth.NewED25519Factory(ed25519.PrivateKey(spendingKey.Bytes)),
+	)
+
+	require.NoError(err)
+
+	timeoutCtx, timeoutCtxFnc := context.WithDeadline(context.Background(), time.Now().Add(2*time.Second))
+	defer timeoutCtxFnc()
+
+	require.NoError(tn.SubmitTxs(timeoutCtx, uri, []*chain.Transaction{tx}))
+	require.NoError(tn.ConfirmTxs(timeoutCtx, uri, []*chain.Transaction{tx}))
+	return nil
+})

examples/morpheusvm/tests/integration/transfer_test.go

@@ -0,0 +1,58 @@
+// Copyright (C) 2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package integration_test
+
+import (
+	"context"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/ava-labs/hypersdk/api/jsonrpc"
+	"github.com/ava-labs/hypersdk/auth"
+	"github.com/ava-labs/hypersdk/chain"
+	"github.com/ava-labs/hypersdk/crypto/ed25519"
+	"github.com/ava-labs/hypersdk/examples/morpheusvm/actions"
+	"github.com/ava-labs/hypersdk/examples/morpheusvm/vm"
+	"github.com/ava-labs/hypersdk/tests/integration"
+	"github.com/ava-labs/hypersdk/tests/workload"
+
+	ginkgo "github.com/onsi/ginkgo/v2"
+)
+
+var _ = integration.RegisterTest("Transfer Transaction", func(t ginkgo.FullGinkgoTInterface, tn workload.TestNetwork) error {
+	require := require.New(t)
+
+	uri := tn.URIs()[0]
+	other, err := ed25519.GeneratePrivateKey()
+	require.NoError(err)
+	aother := auth.NewED25519Address(other.PublicKey())
+
+	lcli := vm.NewJSONRPCClient(uri)
+	parser, err := lcli.Parser(context.Background())
+	require.NoError(err)
+
+	spendingKey, err := tn.WorkloadFactory().GetSpendingKey()
+	require.NoError(err)
+
+	cli := jsonrpc.NewJSONRPCClient(uri)
+	_, tx, _, err := cli.GenerateTransaction(
+		context.Background(),
+		parser,
+		[]chain.Action{&actions.Transfer{
+			To:    aother,
+			Value: 1,
+		}},
+		auth.NewED25519Factory(ed25519.PrivateKey(spendingKey.Bytes)),
+	)
+
+	require.NoError(err)
+
+	timeoutCtx, timeoutCtxFnc := context.WithDeadline(context.Background(), time.Now().Add(2*time.Second))
+	defer timeoutCtxFnc()
+
+	require.NoError(tn.SubmitTxs(timeoutCtx, uri, []*chain.Transaction{tx}))
+	require.NoError(tn.ConfirmTxs(timeoutCtx, uri, []*chain.Transaction{tx}))
+	return nil
+})

examples/morpheusvm/tests/workload/workload.go

@@ -89,6 +89,13 @@ func New(minBlockGap int64) (*genesis.DefaultGenesis, workload.TxWorkloadFactory
 	}, spamKey, nil
 }
 
+func (f *workloadFactory) GetSpendingKey() (*auth.PrivateKey, error) {
+	return &auth.PrivateKey{
+		Address: ed25519Addrs[0],
+		Bytes:   ed25519PrivKeys[0][:],
+	}, nil
+}
+
 func (f *workloadFactory) NewSizedTxWorkload(uri string, size int) (workload.TxWorkloadIterator, error) {
 	cli := jsonrpc.NewJSONRPCClient(uri)
 	lcli := vm.NewJSONRPCClient(uri)

tests/e2e/e2e.go

@@ -20,6 +20,7 @@
 	"github.com/ava-labs/hypersdk/api/state"
 	"github.com/ava-labs/hypersdk/auth"
 	"github.com/ava-labs/hypersdk/chain"
+	"github.com/ava-labs/hypersdk/tests/registry"
 	"github.com/ava-labs/hypersdk/tests/workload"
 	"github.com/ava-labs/hypersdk/throughput"
 	"github.com/ava-labs/hypersdk/utils"
@@ -34,6 +35,8 @@
 	expectedABI       abi.ABI
 	spamKey           *auth.PrivateKey
 	spamHelper        throughput.SpamHelper
+	testRegistry      registry.Registry
+	testNetwork       workload.TestNetwork
 )
 
 func SetWorkload(name string, factory workload.TxWorkloadFactory, abi abi.ABI, chainParser chain.Parser, sh throughput.SpamHelper, key *auth.PrivateKey) {
@@ -256,6 +259,24 @@
 	})
 })
 
+var _ = ginkgo.Describe("[Custom VM Tests]", func() {
+	tc := e2e.NewTestContext()
+	require := require.New(tc)
+
+	for _, test := range testRegistry.List() {
+		ginkgo.It(test.Name, func() {
+			baseURIs := getE2EBaseURIs(tc)
+			testNetwork := &Network{uris: baseURIs}
+			require.NoError(test.Fnc(ginkgo.GinkgoT(), testNetwork), "Test %s failed with an error", test.Name)
+		})
+	}
+})
+
+func RegisterTest(name string, f registry.TestFunc) bool {
+	testRegistry.Add(name, f)
+	return true
+}
+
 func getE2EURIs(tc tests.TestContext, blockchainID ids.ID) []string {
 	nodeURIs := e2e.GetEnv(tc).GetNetwork().GetNodeURIs()
 	uris := make([]string, 0, len(nodeURIs))

tests/e2e/network.go

@@ -0,0 +1,81 @@
+// Copyright (C) 2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package e2e
+
+import (
+	"context"
+	"errors"
+	"time"
+
+	"github.com/ava-labs/hypersdk/api/indexer"
+	"github.com/ava-labs/hypersdk/chain"
+	"github.com/ava-labs/hypersdk/tests/workload"
+)
+
+var (
+	ErrUnableToConfirmTx = errors.New("unable to confirm transaction")
+	ErrInvalidURI        = errors.New("invalid uri")
+)
+
+const (
+	txCheckInterval = 100 * time.Millisecond
+)
+
+type Network struct {
+	uris []string
+}
+
+func (n *Network) ConfirmTxs(ctx context.Context, uri string, txs []*chain.Transaction) error {
+	// this is the wrong way. for integration, we wante to test the block content directly.
+	// instance, err := n.getInstance(uri)
+	// if err != nil {
+	//		return err
+	//	}
+	// expectBlk(instance)(false)
+
+	indexerCli := indexer.NewClient(uri)
+	for _, tx := range txs {
+		success, _, err := indexerCli.WaitForTransaction(ctx, txCheckInterval, tx.ID())
+		if err != nil {
+			return err
+		}
+		if !success {
+			return ErrUnableToConfirmTx
+		}
+	}
+	return nil
+}
+
+func (n *Network) SubmitTxs(ctx context.Context, uri string, txs []*chain.Transaction) error {
+	/*instance, err := n.getInstance(uri)
+	if err != nil {
+		return err
+	}
+	for _, tx := range txs {
+		_, err := instance.cli.SubmitTx(ctx, tx.Bytes())
+		if err != nil {
+			return err
+		}
+	}*/
+	return nil
+}
+
+func (n *Network) URIs() []string {
+	return n.uris
+}
+
+func (n *Network) WorkloadFactory() workload.TxWorkloadFactory {
+	return txWorkloadFactory
+}
+
+/*
+func (n *Network) getInstance(uri string) (instance, error) {
+	for _, instance := range instances {
+		if instance.routerServer.URL == uri {
+			return instance, nil
+		}
+	}
+	return instance{}, ErrInvalidURI
+}
+*/

tests/integration/integration.go

@@ -35,6 +35,7 @@ import (
 	"github.com/ava-labs/hypersdk/extension/externalsubscriber"
 	"github.com/ava-labs/hypersdk/fees"
 	"github.com/ava-labs/hypersdk/pubsub"
+	"github.com/ava-labs/hypersdk/tests/registry"
 	"github.com/ava-labs/hypersdk/tests/workload"
 	"github.com/ava-labs/hypersdk/vm"
 
@@ -58,6 +59,8 @@ var (
 	sendAppGossipCounter int
 	uris                 []string
 	blocks               []snowman.Block
+	testNetwork          workload.TestNetwork
+	testRegistry         registry.Registry
 
 	networkID uint32
 
@@ -116,9 +119,16 @@ func Setup(
 	require.NoError(err)
 	parser = createdParser
 
+	// find all callers named NetworkTest...(signature)
+
 	setInstances()
 }
 
+func RegisterTest(name string, f registry.TestFunc) bool {
+	testRegistry.Add(name, f)
+	return true
+}
+
 func setInstances() {
 	require := require.New(ginkgo.GinkgoT())
 
@@ -265,6 +275,8 @@ func setInstances() {
 		uris[i] = inst.routerServer.URL
 	}
 
+	testNetwork = &Network{uris: uris}
+
 	blocks = []snowman.Block{}
 
 	log.Info("created instances", zap.Int("count", len(instances)))
@@ -648,6 +660,15 @@ var _ = ginkgo.Describe("[Tx Processing]", ginkgo.Serial, func() {
 	})
 })
 
+var _ = ginkgo.Describe("[Custom VM Tests]", func() {
+	require := require.New(ginkgo.GinkgoT())
+	for _, test := range testRegistry.List() {
+		ginkgo.It(test.Name, func() {
+			require.NoError(test.Fnc(ginkgo.GinkgoT(), testNetwork), "Test %s failed with an error", test.Name)
+		})
+	}
+})
+
 func expectBlk(i instance) func(add bool) []*chain.Result {
 	require := require.New(ginkgo.GinkgoT())
 

tests/integration/network.go

@@ -0,0 +1,79 @@
+// Copyright (C) 2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package integration
+
+import (
+	"context"
+	"errors"
+	"time"
+
+	"github.com/ava-labs/hypersdk/api/indexer"
+	"github.com/ava-labs/hypersdk/chain"
+	"github.com/ava-labs/hypersdk/tests/workload"
+)
+
+var (
+	ErrUnableToConfirmTx = errors.New("unable to confirm transaction")
+	ErrInvalidURI        = errors.New("invalid uri")
+)
+
+const (
+	txCheckInterval = 100 * time.Millisecond
+)
+
+type Network struct {
+	uris []string
+}
+
+func (n *Network) ConfirmTxs(ctx context.Context, uri string, txs []*chain.Transaction) error {
+	// this is the wrong way. for integration, we wante to test the block content directly.
+	instance, err := n.getInstance(uri)
+	if err != nil {
+		return err
+	}
+	expectBlk(instance)(false)
+
+	indexerCli := indexer.NewClient(uri)
+	for _, tx := range txs {
+		success, _, err := indexerCli.WaitForTransaction(ctx, txCheckInterval, tx.ID())
+		if err != nil {
+			return err
+		}
+		if !success {
+			return ErrUnableToConfirmTx
+		}
+	}
+	return nil
+}
+
+func (n *Network) SubmitTxs(ctx context.Context, uri string, txs []*chain.Transaction) error {
+	instance, err := n.getInstance(uri)
+	if err != nil {
+		return err
+	}
+	for _, tx := range txs {
+		_, err := instance.cli.SubmitTx(ctx, tx.Bytes())
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func (n *Network) URIs() []string {
+	return n.uris
+}
+
+func (*Network) WorkloadFactory() workload.TxWorkloadFactory {
+	return txWorkloadFactory
+}
+
+func (*Network) getInstance(uri string) (instance, error) {
+	for _, instance := range instances {
+		if instance.routerServer.URL == uri {
+			return instance, nil
+		}
+	}
+	return instance{}, ErrInvalidURI
+}