[PRIV-200] Add build args to CTF (#2175)

Author: cedric-cordenier

framework/.changeset/v0.10.33

@@ -0,0 +1 @@
+- Support passing buildArgs to docker when building images

framework/components/clnode/clnode.go

@@ -51,6 +51,7 @@ type NodeInput struct {
 	Name                    string                        `toml:"name"`
 	DockerFilePath          string                        `toml:"docker_file"`
 	DockerContext           string                        `toml:"docker_ctx"`
+	DockerBuildArgs         map[string]string             `toml:"docker_build_args"`
 	PullImage               bool                          `toml:"pull_image"`
 	CapabilitiesBinaryPaths []string                      `toml:"capabilities"`
 	CapabilityContainerDir  string                        `toml:"capabilities_container_dir"`
@@ -340,7 +341,7 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 	}
 	if req.Image == "" {
 		req.Image = TmpImageName
-		if err := framework.BuildImageOnce(once, in.Node.DockerContext, in.Node.DockerFilePath, req.Image); err != nil {
+		if err := framework.BuildImageOnce(once, in.Node.DockerContext, in.Node.DockerFilePath, req.Image, nil); err != nil {
 			return nil, err
 		}
 		req.KeepImage = false

framework/components/jd/jd.go

@@ -111,7 +111,7 @@ func NewJD(in *Input) (*Output, error) {
 	}
 	if req.Image == "" {
 		req.Image = TmpImageName
-		if err := framework.BuildImage(in.DockerContext, in.DockerFilePath, req.Image); err != nil {
+		if err := framework.BuildImage(in.DockerContext, in.DockerFilePath, req.Image, nil); err != nil {
 			return nil, err
 		}
 		req.KeepImage = false

framework/components/simple_node_set/node_set.go

@@ -150,6 +150,7 @@ func sharedDBSetup(in *Input, bcOut *blockchain.Output) (*Output, error) {
 					PullImage:               in.NodeSpecs[overrideIdx].Node.PullImage,
 					DockerFilePath:          in.NodeSpecs[overrideIdx].Node.DockerFilePath,
 					DockerContext:           in.NodeSpecs[overrideIdx].Node.DockerContext,
+					DockerBuildArgs:         in.NodeSpecs[overrideIdx].Node.DockerBuildArgs,
 					CapabilitiesBinaryPaths: in.NodeSpecs[overrideIdx].Node.CapabilitiesBinaryPaths,
 					CapabilityContainerDir:  in.NodeSpecs[overrideIdx].Node.CapabilityContainerDir,
 					TestConfigOverrides:     net,

framework/docker.go

@@ -346,23 +346,33 @@ func SaveContainerLogs(dir string) ([]string, error) {
 	return logFilePaths, nil
 }
 
-func BuildImageOnce(once *sync.Once, dctx, dfile, nameAndTag string) error {
+func BuildImageOnce(once *sync.Once, dctx, dfile, nameAndTag string, buildArgs map[string]string) error {
 	var err error
 	once.Do(func() {
-		err = BuildImage(dctx, dfile, nameAndTag)
+		err = BuildImage(dctx, dfile, nameAndTag, buildArgs)
 		if err != nil {
 			err = fmt.Errorf("failed to build Docker image: %w", err)
 		}
 	})
 	return err
 }
 
-func BuildImage(dctx, dfile, nameAndTag string) error {
+func BuildImage(dctx, dfile, nameAndTag string, buildArgs map[string]string) error {
 	dfilePath := filepath.Join(dctx, dfile)
 	if os.Getenv("CTF_CLNODE_DLV") == "true" {
-		return RunCommand("docker", "build", "--build-arg", `GO_GCFLAGS=all=-N -l`, "--build-arg", "CHAINLINK_USER=chainlink", "--build-arg", "CL_INSTALL_PRIVATE_PLUGINS=false", "-t", nameAndTag, "-f", dfilePath, dctx)
+		commandParts := []string{"docker", "build", "--build-arg", `GO_GCFLAGS=all=-N -l`, "--build-arg", "CHAINLINK_USER=chainlink", "--build-arg", "CL_INSTALL_PRIVATE_PLUGINS=false"}
+		for k, v := range buildArgs {
+			commandParts = append(commandParts, "--build-arg", fmt.Sprintf("%s=%s", k, v))
+		}
+		commandParts = append(commandParts, "-t", nameAndTag, "-f", dfilePath, dctx)
+		return RunCommand(commandParts[0], commandParts[1:]...)
+	}
+	commandParts := []string{"docker", "build", "--build-arg", "CHAINLINK_USER=chainlink", "--build-arg", "CL_INSTALL_PRIVATE_PLUGINS=false"}
+	for k, v := range buildArgs {
+		commandParts = append(commandParts, "--build-arg", fmt.Sprintf("%s=%s", k, v))
 	}
-	return RunCommand("docker", "build", "--build-arg", "CHAINLINK_USER=chainlink", "--build-arg", "CL_INSTALL_PRIVATE_PLUGINS=false", "-t", nameAndTag, "-f", dfilePath, dctx)
+	commandParts = append(commandParts, "-t", nameAndTag, "-f", dfilePath, dctx)
+	return RunCommand(commandParts[0], commandParts[1:]...)
 }
 
 // RemoveTestContainers removes all test containers, volumes and CTF docker network