testutil/compose: safe clean (#601)

Make `compose clean` safe, by checking if config.json is present (and double check that no go files are present).

Note: I deleted my whole charon repo by running `compose clean` in the wrong folder  🤦 

Also pull latest docker image in define step.

category: bug 
ticket: #568

testutil/compose/config.go

@@ -26,6 +26,7 @@ const (
 	defaultNumNodes   = 4
 	defaultThreshold  = 3
 
+	charonImage      = "ghcr.io/obolnetwork/charon"
 	localBinary      = "/compose/charon"
 	containerBinary  = "/usr/local/bin/charon"
 	cmdRun           = "run"

testutil/compose/define.go

@@ -51,6 +51,25 @@ func Clean(ctx context.Context, dir string) error {
 		return errors.Wrap(err, "glob dir")
 	}
 
+	// Make sure we ONLY delete compose artifacts.
+	var (
+		configFound bool
+		goFound     bool
+	)
+	for _, file := range files {
+		if file == configFile {
+			configFound = true
+		} else if strings.HasSuffix(file, ".go") || strings.HasPrefix(file, "go.") {
+			goFound = true
+		}
+	}
+	if !configFound {
+		log.Info(ctx, "Not cleaning since config.json not found")
+		return nil
+	} else if goFound {
+		return errors.New("go files found, compose dir incorrect", z.Str("dir", dir))
+	}
+
 	log.Info(ctx, "Cleaning compose dir", z.Int("files", len(files)))
 
 	for _, file := range files {
@@ -79,6 +98,12 @@ func Define(ctx context.Context, dir string) error {
 		}
 	}
 
+	if conf.ImageTag == "latest" {
+		if err := pullLatest(ctx); err != nil {
+			return err
+		}
+	}
+
 	var data tmplData
 	if conf.KeyGen == keyGenDKG {
 		log.Info(ctx, "Creating node*/p2pkey for ENRs required for charon create dkg")
@@ -138,6 +163,7 @@ func Define(ctx context.Context, dir string) error {
 
 	log.Info(ctx, "Creating config.json")
 
+	conf.Step = stepDefined
 	if err := writeConfig(dir, conf); err != nil {
 		return err
 	}
@@ -152,6 +178,21 @@ func Define(ctx context.Context, dir string) error {
 	return writeDockerCompose(dir, data)
 }
 
+// pullLatest pulls the latest charon docker image.
+func pullLatest(ctx context.Context) error {
+	log.Info(ctx, "Pulling latest charon docker image")
+
+	cmd := exec.CommandContext(ctx, "docker", "pull", charonImage+":latest")
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+
+	if err := cmd.Run(); err != nil {
+		return errors.Wrap(err, "run docker pull")
+	}
+
+	return nil
+}
+
 // buildLocal builds a local charon binary and writes it to the cluster dir. Note this requires CHARON_REPO env var.
 func buildLocal(ctx context.Context, dir string) error {
 	repo, ok := os.LookupEnv("CHARON_REPO")

testutil/compose/new.go

@@ -25,6 +25,10 @@ import (
 
 // New creates a new compose config file from flags.
 func New(ctx context.Context, dir string, conf Config) error {
+	if err := Clean(ctx, dir); err != nil {
+		return err
+	}
+
 	conf.Step = stepNew
 
 	log.Info(ctx, "Writing config to compose dir",