Integration tests for Rbuilder (#335)

This PR adds a new component for the Rbuilder:
- Adds the Rbuilder component.
- Create a new type of data volumes which **does not** use named Docker
volumes but local mount points in temp dirs. This is because with named
Docker volumes, the Reth mdx database fails to be shared with the
Rbuilder component.
- Add a test recipe that test whether the Rbuilder component can work
with the Reth component deployed on the L1 recipe which can be enabled
with the `--rbuilder` flag.

---------

Co-authored-by: Caner Çıdam <canercidam01@gmail.com>

Author: ferranbt

Makefile

@@ -30,6 +30,7 @@ test: ## Run tests
 .PHONY: integration-test
 integration-test: ## Run integration tests
 	INTEGRATION_TESTS=true go test -v -count=1 ./playground/... -run TestRecipe
+	INTEGRATION_TESTS=true go test -v -count=1 ./playground/... -run TestComponent
 
 .PHONY: generate-docs
 generate-docs: ## Auto-generate recipe docs

docs/recipes/buildernet.md

@@ -8,6 +8,7 @@ Deploy a full L1 stack with mev-boost and builder-hub.
 - `builder-config` (string): Builder config in YAML format. Default to ''.
 - `builder-ip` (string): IP address of the external builder to register in BuilderHub. Default to '127.0.0.1'.
 - `latest-fork` (bool): use the latest fork. Default to 'false'.
+- `rbuilder` (bool): include rbuilder in the recipe. Default to 'false'.
 - `secondary-el` (string): Address or port to use for the secondary EL (execution layer); Can be a port number (e.g., '8551') in which case the full URL is derived as `http://localhost:<port>` or a complete URL (e.g., `http://docker-container-name:8551`), use `http://host.docker.internal:<port>` to reach a secondary execution client that runs on your host and not within Docker.. Default to ''.
 - `use-native-reth` (bool): use the native reth binary. Default to 'false'.
 - `use-reth-for-validation` (bool): use reth for validation. Default to 'false'.

docs/recipes/l1.md

@@ -6,6 +6,7 @@ Deploy a full L1 stack with mev-boost.
 
 - `block-time` (duration): Block time to use for the L1. Default to '12s'.
 - `latest-fork` (bool): use the latest fork. Default to 'false'.
+- `rbuilder` (bool): include rbuilder in the recipe. Default to 'false'.
 - `secondary-el` (string): Address or port to use for the secondary EL (execution layer); Can be a port number (e.g., '8551') in which case the full URL is derived as `http://localhost:<port>` or a complete URL (e.g., `http://docker-container-name:8551`), use `http://host.docker.internal:<port>` to reach a secondary execution client that runs on your host and not within Docker.. Default to ''.
 - `use-native-reth` (bool): use the native reth binary. Default to 'false'.
 - `use-reth-for-validation` (bool): use reth for validation. Default to 'false'.

main.go

@@ -588,6 +588,11 @@ func runIt(recipe playground.Recipe) error {
 	slog.Info("Output folder: " + out.Dst())
 	slog.Info("")
 
+	if utils.GetSessionTempDirCount() > 20 {
+		slog.Warn("Too many temp dirs - please later remove " + utils.TempPlaygroundDirPath() + " (auto-removed at reboot)")
+		slog.Info("")
+	}
+
 	// parse the overrides
 	overrides := map[string]string{}
 	for _, val := range withOverrides {

playground/components.go

@@ -7,6 +7,8 @@ import (
 	"strings"
 	"time"
 
+	_ "embed"
+
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	mevboostrelay "github.com/flashbots/builder-playground/mev-boost-relay"
 	"github.com/flashbots/go-boost-utils/bls"
@@ -503,7 +505,7 @@ func (r *RethEL) Apply(ctx *ExContext) *Component {
 		WithRelease(rethELRelease).
 		WithArtifact("/data/genesis.json", "genesis.json").
 		WithArtifact("/data/jwtsecret", "jwtsecret").
-		WithVolume("data", "/data_reth")
+		WithVolume("data", "/data_reth", true)
 
 	UseHealthmon(component, svc, healthmonExecution)
 
@@ -746,6 +748,31 @@ func (m *MevBoost) Apply(ctx *ExContext) *Component {
 	return component
 }
 
+//go:embed utils/rbuilder-config.toml.tmpl
+var rbuilderConfigToml string
+
+type Rbuilder struct{}
+
+func (r *Rbuilder) Apply(ctx *ExContext) *Component {
+	component := NewComponent("rbuilder")
+
+	// TODO: Handle error
+	ctx.Output.WriteFile("rbuilder-config.toml", rbuilderConfigToml)
+
+	component.NewService("rbuilder").
+		WithImage("ghcr.io/flashbots/rbuilder").
+		WithTag("sha-7efdc0b").
+		WithArtifact("/data/rbuilder-config.toml", "rbuilder-config.toml").
+		WithArtifact("/data/genesis.json", "genesis.json").
+		WithVolume("shared:el-data", "/data_reth", true).
+		DependsOnHealthy("el").
+		WithArgs(
+			"run", "/data/rbuilder-config.toml",
+		)
+
+	return component
+}
+
 type nullService struct{}
 
 func (n *nullService) Apply(ctx *ExContext) *Component {

playground/components_test.go

@@ -11,6 +11,7 @@ import (
 	"os"
 	"path/filepath"
 	"regexp"
+	"runtime"
 	"strings"
 	"testing"
 	"time"
@@ -94,6 +95,44 @@ func TestRecipeL1UseNativeReth(t *testing.T) {
 	})
 }
 
+type rbuilderRecipe struct {
+	*mockRecipe
+	l1 *L1Recipe
+}
+
+func (r *rbuilderRecipe) Artifacts() *ArtifactsBuilder {
+	return r.l1.Artifacts()
+}
+
+func (r *rbuilderRecipe) Apply(ctx *ExContext) *Component {
+	c := NewComponent("rbuilder-test-recipe")
+
+	c.AddService(ctx, r.l1)
+	c.AddComponent(ctx, &Rbuilder{})
+
+	return c
+}
+
+func TestComponentRbuilder(t *testing.T) {
+	// TODO: Re-enable this for all architectures when the rbuilder container flow works.
+	if runtime.GOARCH != "arm64" {
+		t.Skip("Skipping rbuilder component test on non-arm64 architecture for now")
+	}
+	tt := newTestFramework(t)
+	defer tt.Close()
+
+	recipe := &rbuilderRecipe{
+		l1: &L1Recipe{
+			// TODO: We might have to change things from rbuilder-config
+			// if the time is lower than 12 seconds.
+			blockTime: 12 * time.Second,
+		},
+	}
+
+	tt.test(recipe, nil)
+	tt.WaitForBlock("el", 1)
+}
+
 func TestRecipeBuilderHub(t *testing.T) {
 	tt := newTestFramework(t)
 	defer tt.Close()
@@ -200,9 +239,12 @@ func (tt *testFramework) test(component ComponentGen, args []string) *Manifest {
 		t.Fatal(err)
 	}
 
+	homeDir, err := GetHomeDir()
+	require.NoError(t, err)
+
 	o := &output{
 		dst:     e2eTestDir,
-		homeDir: filepath.Join(e2eTestDir, "artifacts"),
+		homeDir: homeDir,
 	}
 
 	exCtx := &ExContext{
@@ -264,6 +306,28 @@ func (tt *testFramework) Close() {
 	}
 }
 
+// WaitForBlock waits for the specified service to reach the given block number.
+// It polls the service's HTTP endpoint and fails the test if the block isn't
+// reached within 1 minute or if the runner exits with an error.
+func (tt *testFramework) WaitForBlock(service string, num uint64) {
+	elService := tt.runner.manifest.MustGetService(service)
+	rethURL := fmt.Sprintf("http://localhost:%d", elService.MustGetPort("http").HostPort)
+
+	waitForBlockCh := make(chan error)
+	go func() {
+		waitForBlockCh <- waitForBlock(rethURL, num, 1*time.Minute)
+	}()
+
+	select {
+	case err := <-waitForBlockCh:
+		if err != nil {
+			tt.t.Fatal(err)
+		}
+	case err := <-tt.runner.ExitErr():
+		tt.t.Fatal(err)
+	}
+}
+
 func toSnakeCase(s string) string {
 	// Insert underscore before uppercase letters
 	re := regexp.MustCompile("([a-z0-9])([A-Z])")

playground/custom_recipes_test.go

@@ -399,7 +399,7 @@ func (m *mockRecipe) Description() string {
 }
 
 func (m *mockRecipe) Flags() *flag.FlagSet {
-	return nil
+	return flag.NewFlagSet("", 0)
 }
 
 func (m *mockRecipe) Artifacts() *ArtifactsBuilder {

playground/local_runner.go

@@ -536,10 +536,16 @@ func (d *LocalRunner) toDockerComposeService(s *Service) (map[string]interface{}
 
 	// create the bind volumes
 	var createdVolumes []string
-	for localPath, volumeName := range s.VolumesMapped {
-		dockerVolumeName := d.createVolumeName(s.Name, volumeName)
-		volumes[dockerVolumeName] = localPath
-		createdVolumes = append(createdVolumes, dockerVolumeName)
+	for localPath, volume := range s.VolumesMapped {
+		dockerVolumeName := d.createVolumeName(s.Name, volume.Name)
+
+		if volume.IsLocal {
+			absPath := utils.MustGetVolumeDir(d.manifest.ID, dockerVolumeName)
+			volumes[absPath] = localPath
+		} else {
+			volumes[dockerVolumeName] = localPath
+			createdVolumes = append(createdVolumes, dockerVolumeName)
+		}
 	}
 
 	volumesInLine := []string{}
@@ -803,8 +809,8 @@ func (d *LocalRunner) runOnHost(ss *Service) error {
 
 	// Create the volumes for this service
 	volumesMapped := map[string]string{}
-	for pathInDocker, volumeName := range ss.VolumesMapped {
-		volumeDirAbsPath, err := d.createVolumeDir(ss.Name, volumeName)
+	for pathInDocker, volume := range ss.VolumesMapped {
+		volumeDirAbsPath, err := d.createVolumeDir(ss.Name, volume.Name)
 		if err != nil {
 			return err
 		}

playground/manifest.go

@@ -66,8 +66,8 @@ func (p *Component) AddComponent(ctx *ExContext, gen ComponentGen) {
 	p.Inner = append(p.Inner, gen.Apply(ctx))
 }
 
-func (p *Component) AddService(srv ComponentGen) {
-	p.Inner = append(p.Inner, srv.Apply(nil))
+func (p *Component) AddService(ctx *ExContext, srv ComponentGen) {
+	p.Inner = append(p.Inner, srv.Apply(ctx))
 }
 
 func componentToManifest(p *Component) []*Service {
@@ -359,8 +359,8 @@ type Service struct {
 	Ports    []*Port    `json:"ports,omitempty"`
 	NodeRefs []*NodeRef `json:"node_refs,omitempty"`
 
-	FilesMapped   map[string]string `json:"files_mapped,omitempty"`
-	VolumesMapped map[string]string `json:"volumes_mapped,omitempty"`
+	FilesMapped   map[string]string        `json:"files_mapped,omitempty"`
+	VolumesMapped map[string]*VolumeMapped `json:"volumes_mapped,omitempty"`
 
 	Tag        string `json:"tag,omitempty"`
 	Image      string `json:"image,omitempty"`
@@ -373,6 +373,11 @@ type Service struct {
 	release  *release
 }
 
+type VolumeMapped struct {
+	Name    string
+	IsLocal bool
+}
+
 type DependsOnCondition string
 
 const (
@@ -495,11 +500,18 @@ func (s *Service) WithArgs(args ...string) *Service {
 	return s
 }
 
-func (s *Service) WithVolume(name, localPath string) *Service {
+func (s *Service) WithVolume(name, localPath string, isLocalTri ...bool) *Service {
+	isLocal := false
+	if len(isLocalTri) == 1 {
+		isLocal = isLocalTri[0]
+	}
 	if s.VolumesMapped == nil {
-		s.VolumesMapped = make(map[string]string)
+		s.VolumesMapped = make(map[string]*VolumeMapped)
+	}
+	s.VolumesMapped[localPath] = &VolumeMapped{
+		Name:    name,
+		IsLocal: isLocal,
 	}
-	s.VolumesMapped[localPath] = name
 	return s
 }
 
@@ -751,6 +763,6 @@ func ReadManifest(outputFolder string) (*Manifest, error) {
 
 func (component *Component) RunContenderIfEnabled(ctx *ExContext) {
 	if ctx.Contender.Enabled {
-		component.AddService(ctx.Contender.Contender())
+		component.AddService(ctx, ctx.Contender.Contender())
 	}
 }

playground/recipe_l1.go

@@ -34,6 +34,8 @@ type L1Recipe struct {
 	useNativeReth bool
 
 	useSeparateMevBoost bool
+
+	withRbuilder bool
 }
 
 func (l *L1Recipe) Name() string {
@@ -52,6 +54,7 @@ func (l *L1Recipe) Flags() *flag.FlagSet {
 	flags.StringVar(&l.secondaryEL, "secondary-el", "", "Address or port to use for the secondary EL (execution layer); Can be a port number (e.g., '8551') in which case the full URL is derived as `http://localhost:<port>` or a complete URL (e.g., `http://docker-container-name:8551`), use `http://host.docker.internal:<port>` to reach a secondary execution client that runs on your host and not within Docker.")
 	flags.BoolVar(&l.useNativeReth, "use-native-reth", false, "use the native reth binary")
 	flags.BoolVar(&l.useSeparateMevBoost, "use-separate-mev-boost", false, "use separate mev-boost and mev-boost-relay services")
+	flags.BoolVar(&l.withRbuilder, "rbuilder", false, "include rbuilder in the recipe")
 	return flags
 }
 
@@ -134,6 +137,10 @@ func (l *L1Recipe) Apply(ctx *ExContext) *Component {
 		})
 	}
 
+	if l.withRbuilder {
+		component.AddComponent(ctx, &Rbuilder{})
+	}
+
 	component.RunContenderIfEnabled(ctx)
 	return component
 }