Scenario End To End Testing

testing/endtoend/BUILD.bazel

@@ -2,13 +2,16 @@ load("@prysm//tools/go:def.bzl", "go_test")
 
 # gazelle:exclude geth_deps.go
 # gazelle:exclude mainnet_e2e_test.go
-# gazelle:exclude multiclient_e2e_test.go
+# gazelle:exclude mainnet_scenario_e2e_test.go
+# gazelle:exclude minimal_scenario_e2e_test.go
 
 go_test(
     name = "go_default_test",
     size = "large",
     testonly = True,
     srcs = [
+        "component_handler_test.go",
+        "endtoend_setup_test.go",
         "endtoend_test.go",
         "minimal_e2e_test.go",
         "minimal_slashing_e2e_test.go",
@@ -66,6 +69,8 @@ go_test(
     size = "large",
     testonly = True,
     srcs = [
+        "component_handler_test.go",
+        "endtoend_setup_test.go",
         "endtoend_test.go",
         "mainnet_e2e_test.go",
     ],
@@ -119,13 +124,14 @@ go_test(
 )
 
 go_test(
-    name = "go_multiclient_test",
+    name = "go_mainnet_scenario_test",
     size = "large",
     testonly = True,
     srcs = [
+        "component_handler_test.go",
+        "endtoend_setup_test.go",
         "endtoend_test.go",
-        "mainnet_e2e_test.go",
-        "multiclient_e2e_test.go",
+        "mainnet_scenario_e2e_test.go",
     ],
     args = ["-test.v"],
     data = [
@@ -143,8 +149,67 @@ go_test(
         "exclusive",
         "mainnet",
         "manual",
-        "multiclient",
         "requires-network",
+        "scenario",
+    ],
+    deps = [
+        "//beacon-chain/blockchain/testing:go_default_library",
+        "//beacon-chain/core/transition:go_default_library",
+        "//beacon-chain/db/testing:go_default_library",
+        "//beacon-chain/operations/slashings:go_default_library",
+        "//beacon-chain/state/stategen:go_default_library",
+        "//build/bazel:go_default_library",
+        "//config/params:go_default_library",
+        "//consensus-types/primitives:go_default_library",
+        "//crypto/bls:go_default_library",
+        "//proto/prysm/v1alpha1:go_default_library",
+        "//testing/assert:go_default_library",
+        "//testing/endtoend/components:go_default_library",
+        "//testing/endtoend/components/eth1:go_default_library",
+        "//testing/endtoend/evaluators:go_default_library",
+        "//testing/endtoend/helpers:go_default_library",
+        "//testing/endtoend/params:go_default_library",
+        "//testing/endtoend/types:go_default_library",
+        "//testing/require:go_default_library",
+        "//testing/slasher/simulator:go_default_library",
+        "//testing/util:go_default_library",
+        "@com_github_pkg_errors//:go_default_library",
+        "@com_github_sirupsen_logrus//:go_default_library",
+        "@com_github_sirupsen_logrus//hooks/test:go_default_library",
+        "@org_golang_google_grpc//:go_default_library",
+        "@org_golang_google_protobuf//types/known/emptypb:go_default_library",
+        "@org_golang_x_sync//errgroup:go_default_library",
+    ],
+)
+
+go_test(
+    name = "go_minimal_scenario_test",
+    size = "large",
+    testonly = True,
+    srcs = [
+        "component_handler_test.go",
+        "endtoend_setup_test.go",
+        "endtoend_test.go",
+        "minimal_scenario_e2e_test.go",
+    ],
+    args = ["-test.v"],
+    data = [
+        "//:prysm_sh",
+        "//cmd/beacon-chain",
+        "//cmd/validator",
+        "//config/params:custom_configs",
+        "//tools/bootnode",
+        "@com_github_ethereum_go_ethereum//cmd/geth",
+        "@web3signer",
+    ],
+    eth_network = "minimal",
+    shard_count = 2,
+    tags = [
+        "exclusive",
+        "manual",
+        "minimal",
+        "requires-network",
+        "scenario",
     ],
     deps = [
         "//beacon-chain/blockchain/testing:go_default_library",

testing/endtoend/component_handler_test.go

@@ -0,0 +1,203 @@
+package endtoend
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/pkg/errors"
+	"github.com/prysmaticlabs/prysm/config/params"
+	"github.com/prysmaticlabs/prysm/testing/endtoend/components"
+	"github.com/prysmaticlabs/prysm/testing/endtoend/components/eth1"
+	"github.com/prysmaticlabs/prysm/testing/endtoend/helpers"
+	e2e "github.com/prysmaticlabs/prysm/testing/endtoend/params"
+	e2etypes "github.com/prysmaticlabs/prysm/testing/endtoend/types"
+	"golang.org/x/sync/errgroup"
+)
+
+type componentHandler struct {
+	t                        *testing.T
+	cfg                      *e2etypes.E2EConfig
+	ctx                      context.Context
+	done                     func()
+	group                    *errgroup.Group
+	keygen                   e2etypes.ComponentRunner
+	tracingSink              e2etypes.ComponentRunner
+	web3Signer               e2etypes.ComponentRunner
+	bootnode                 e2etypes.ComponentRunner
+	eth1Miner                e2etypes.ComponentRunner
+	eth1Nodes                e2etypes.MultipleComponentRunners
+	beaconNodes              e2etypes.MultipleComponentRunners
+	validatorNodes           e2etypes.MultipleComponentRunners
+	lighthouseBeaconNodes    e2etypes.MultipleComponentRunners
+	lighthouseValidatorNodes e2etypes.MultipleComponentRunners
+}
+
+func NewComponentHandler(cfg *e2etypes.E2EConfig, t *testing.T) *componentHandler {
+	return &componentHandler{cfg: cfg, t: t}
+}
+
+func (c *componentHandler) setup() {
+	t, config := c.t, c.cfg
+	t.Logf("Shard index: %d\n", e2e.TestParams.TestShardIndex)
+	t.Logf("Starting time: %s\n", time.Now().String())
+	t.Logf("Log Path: %s\n", e2e.TestParams.LogPath)
+
+	minGenesisActiveCount := int(params.BeaconConfig().MinGenesisActiveValidatorCount)
+	multiClientActive := e2e.TestParams.LighthouseBeaconNodeCount > 0
+	var keyGen e2etypes.ComponentRunner
+	var lighthouseValidatorNodes e2etypes.MultipleComponentRunners
+	var lighthouseNodes *components.LighthouseBeaconNodeSet
+
+	c.ctx, c.done = context.WithCancel(context.Background())
+	g, ctx := errgroup.WithContext(c.ctx)
+
+	tracingSink := components.NewTracingSink(config.TracingSinkEndpoint)
+	g.Go(func() error {
+		return tracingSink.Start(ctx)
+	})
+	c.tracingSink = tracingSink
+
+	if multiClientActive {
+		keyGen = components.NewKeystoreGenerator()
+
+		// Generate lighthouse keystores.
+		g.Go(func() error {
+			return keyGen.Start(ctx)
+		})
+		c.keygen = keyGen
+	}
+
+	var web3RemoteSigner *components.Web3RemoteSigner
+	if config.UseWeb3RemoteSigner {
+		web3RemoteSigner = components.NewWeb3RemoteSigner()
+		g.Go(func() error {
+			if err := web3RemoteSigner.Start(ctx); err != nil {
+				return errors.Wrap(err, "failed to start web3 remote signer")
+			}
+			return nil
+		})
+		c.web3Signer = web3RemoteSigner
+
+	}
+
+	// Boot node.
+	bootNode := components.NewBootNode()
+	g.Go(func() error {
+		if err := bootNode.Start(ctx); err != nil {
+			return errors.Wrap(err, "failed to start bootnode")
+		}
+		return nil
+	})
+	c.bootnode = bootNode
+
+	// ETH1 miner.
+	eth1Miner := eth1.NewMiner()
+	g.Go(func() error {
+		if err := helpers.ComponentsStarted(ctx, []e2etypes.ComponentRunner{bootNode}); err != nil {
+			return errors.Wrap(err, "sending and mining deposits require ETH1 nodes to run")
+		}
+		eth1Miner.SetBootstrapENR(bootNode.ENR())
+		if err := eth1Miner.Start(ctx); err != nil {
+			return errors.Wrap(err, "failed to start the ETH1 miner")
+		}
+		return nil
+	})
+	c.eth1Miner = eth1Miner
+
+	// ETH1 non-mining nodes.
+	eth1Nodes := eth1.NewNodeSet()
+	g.Go(func() error {
+		if err := helpers.ComponentsStarted(ctx, []e2etypes.ComponentRunner{eth1Miner}); err != nil {
+			return errors.Wrap(err, "sending and mining deposits require ETH1 nodes to run")
+		}
+		eth1Nodes.SetMinerENR(eth1Miner.ENR())
+		if err := eth1Nodes.Start(ctx); err != nil {
+			return errors.Wrap(err, "failed to start ETH1 nodes")
+		}
+		return nil
+	})
+	c.eth1Nodes = eth1Nodes
+
+	g.Go(func() error {
+		if err := helpers.ComponentsStarted(ctx, []e2etypes.ComponentRunner{eth1Nodes}); err != nil {
+			return errors.Wrap(err, "sending and mining deposits require ETH1 nodes to run")
+		}
+		if err := components.SendAndMineDeposits(eth1Miner.KeystorePath(), minGenesisActiveCount, 0, true /* partial */); err != nil {
+			return errors.Wrap(err, "failed to send and mine deposits")
+		}
+		return nil
+	})
+
+	// Beacon nodes.
+	beaconNodes := components.NewBeaconNodes(config)
+	g.Go(func() error {
+		if err := helpers.ComponentsStarted(ctx, []e2etypes.ComponentRunner{eth1Nodes, bootNode}); err != nil {
+			return errors.Wrap(err, "beacon nodes require ETH1 and boot node to run")
+		}
+		beaconNodes.SetENR(bootNode.ENR())
+		if err := beaconNodes.Start(ctx); err != nil {
+			return errors.Wrap(err, "failed to start beacon nodes")
+		}
+		return nil
+	})
+	c.beaconNodes = beaconNodes
+
+	if multiClientActive {
+		lighthouseNodes = components.NewLighthouseBeaconNodes(config)
+		g.Go(func() error {
+			if err := helpers.ComponentsStarted(ctx, []e2etypes.ComponentRunner{eth1Nodes, bootNode, beaconNodes}); err != nil {
+				return errors.Wrap(err, "lighthouse beacon nodes require ETH1 and boot node to run")
+			}
+			lighthouseNodes.SetENR(bootNode.ENR())
+			if err := lighthouseNodes.Start(ctx); err != nil {
+				return errors.Wrap(err, "failed to start lighthouse beacon nodes")
+			}
+			return nil
+		})
+		c.lighthouseBeaconNodes = lighthouseNodes
+	}
+	// Validator nodes.
+	validatorNodes := components.NewValidatorNodeSet(config)
+	g.Go(func() error {
+		comps := []e2etypes.ComponentRunner{beaconNodes}
+		if config.UseWeb3RemoteSigner {
+			comps = append(comps, web3RemoteSigner)
+		}
+		if err := helpers.ComponentsStarted(ctx, comps); err != nil {
+			return errors.Wrap(err, "validator nodes require components to run")
+		}
+		if err := validatorNodes.Start(ctx); err != nil {
+			return errors.Wrap(err, "failed to start validator nodes")
+		}
+		return nil
+	})
+	c.validatorNodes = validatorNodes
+
+	if multiClientActive {
+		// Lighthouse Validator nodes.
+		lighthouseValidatorNodes = components.NewLighthouseValidatorNodeSet(config)
+		g.Go(func() error {
+			if err := helpers.ComponentsStarted(ctx, []e2etypes.ComponentRunner{keyGen, lighthouseNodes}); err != nil {
+				return errors.Wrap(err, "validator nodes require beacon nodes to run")
+			}
+			if err := lighthouseValidatorNodes.Start(ctx); err != nil {
+				return errors.Wrap(err, "failed to start validator nodes")
+			}
+			return nil
+		})
+		c.lighthouseValidatorNodes = lighthouseValidatorNodes
+	}
+	c.group = g
+}
+
+func (c *componentHandler) required() []e2etypes.ComponentRunner {
+	multiClientActive := e2e.TestParams.LighthouseBeaconNodeCount > 0
+	requiredComponents := []e2etypes.ComponentRunner{
+		c.tracingSink, c.eth1Nodes, c.bootnode, c.beaconNodes, c.validatorNodes,
+	}
+	if multiClientActive {
+		requiredComponents = append(requiredComponents, []e2etypes.ComponentRunner{c.keygen, c.lighthouseBeaconNodes, c.lighthouseValidatorNodes}...)
+	}
+	return requiredComponents
+}