feat(terraformrun): passing extra args to init plan and apply cmd (#417)

Co-authored-by: Lucas Marques <[email protected]>

Author: adupays

api/v1alpha1/common.go

@@ -9,6 +9,8 @@ const (
 	DefaultRunRetention int = 10
 )
 
+type ExtraArgs []string
+
 type OverrideRunnerSpec struct {
 	ImagePullSecrets   []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
 	Image              string                        `json:"image,omitempty"`
@@ -22,6 +24,9 @@ type OverrideRunnerSpec struct {
 	Volumes            []corev1.Volume               `json:"volumes,omitempty"`
 	VolumeMounts       []corev1.VolumeMount          `json:"volumeMounts,omitempty"`
 	Metadata           MetadataOverride              `json:"metadata,omitempty"`
+	ExtraInitArgs      ExtraArgs                     `json:"extraInitArgs,omitempty"`
+	ExtraPlanArgs      ExtraArgs                     `json:"extraPlanArgs,omitempty"`
+	ExtraApplyArgs     ExtraArgs                     `json:"extraApplyArgs,omitempty"`
 }
 
 type MetadataOverride struct {
@@ -105,6 +110,9 @@ func GetOverrideRunnerSpec(repository *TerraformRepository, layer *TerraformLaye
 		ImagePullPolicy:    chooseImagePullPolicy(repository.Spec.OverrideRunnerSpec.ImagePullPolicy, layer.Spec.OverrideRunnerSpec.ImagePullPolicy),
 		ServiceAccountName: chooseString(repository.Spec.OverrideRunnerSpec.ServiceAccountName, layer.Spec.OverrideRunnerSpec.ServiceAccountName),
 		ImagePullSecrets:   mergeImagePullSecrets(repository.Spec.OverrideRunnerSpec.ImagePullSecrets, layer.Spec.OverrideRunnerSpec.ImagePullSecrets),
+		ExtraInitArgs:      overrideExtraArgs(repository.Spec.OverrideRunnerSpec.ExtraInitArgs, layer.Spec.OverrideRunnerSpec.ExtraInitArgs),
+		ExtraPlanArgs:      overrideExtraArgs(repository.Spec.OverrideRunnerSpec.ExtraPlanArgs, layer.Spec.OverrideRunnerSpec.ExtraPlanArgs),
+		ExtraApplyArgs:     overrideExtraArgs(repository.Spec.OverrideRunnerSpec.ExtraApplyArgs, layer.Spec.OverrideRunnerSpec.ExtraApplyArgs),
 	}
 }
 
@@ -313,3 +321,13 @@ func mergeMaps(a, b map[string]string) map[string]string {
 	}
 	return result
 }
+
+func overrideExtraArgs(a, b ExtraArgs) ExtraArgs {
+	result := b
+
+	if len(result) == 0 {
+		result = a
+	}
+
+	return result
+}

api/v1alpha1/zz_generated.deepcopy.go

@@ -3,6 +3,7 @@ package terraformrun
 import (
 	"context"
 	"fmt"
+	"strings"
 
 	configv1alpha1 "github.com/padok-team/burrito/api/v1alpha1"
 	"github.com/padok-team/burrito/internal/burrito/config"
@@ -215,6 +216,26 @@ func (r *Reconciler) getPod(run *configv1alpha1.TerraformRun, layer *configv1alp
 	if len(overrideSpec.Image) > 0 {
 		defaultSpec.Containers[0].Image = overrideSpec.Image
 	}
+
+	if len(overrideSpec.ExtraInitArgs) > 0 {
+		defaultSpec.Containers[0].Env = append(defaultSpec.Containers[0].Env, corev1.EnvVar{
+			Name:  "TF_CLI_ARGS_init",
+			Value: strings.Join(overrideSpec.ExtraInitArgs, " "),
+		})
+	}
+	if len(overrideSpec.ExtraPlanArgs) > 0 {
+		defaultSpec.Containers[0].Env = append(defaultSpec.Containers[0].Env, corev1.EnvVar{
+			Name:  "TF_CLI_ARGS_plan",
+			Value: strings.Join(overrideSpec.ExtraPlanArgs, " "),
+		})
+	}
+	if len(overrideSpec.ExtraApplyArgs) > 0 {
+		defaultSpec.Containers[0].Env = append(defaultSpec.Containers[0].Env, corev1.EnvVar{
+			Name:  "TF_CLI_ARGS_apply",
+			Value: strings.Join(overrideSpec.ExtraApplyArgs, " "),
+		})
+	}
+
 	pod := corev1.Pod{
 		Spec: defaultSpec,
 		ObjectMeta: metav1.ObjectMeta{

internal/controllers/terraformrun/pod.go

@@ -0,0 +1,74 @@
+package terraformrun_test
+
+import (
+	"context"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	configv1alpha1 "github.com/padok-team/burrito/api/v1alpha1"
+	"github.com/padok-team/burrito/internal/lock"
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/types"
+)
+
+var _ = Describe("Pod", func() {
+	var run *configv1alpha1.TerraformRun
+	var reconcileError error
+	var err error
+	var name types.NamespacedName
+	Describe("Nominal Case", func() {
+		Describe("When a TerraformRun is created with overridden TF args", Ordered, func() {
+			BeforeAll(func() {
+				name = types.NamespacedName{
+					Name:      "nominal-case-extra-args-plan",
+					Namespace: "default",
+				}
+				_, run, reconcileError, err = getResult(name)
+			})
+			It("should still exists", func() {
+				Expect(err).NotTo(HaveOccurred())
+			})
+			It("should not return an error", func() {
+				Expect(reconcileError).NotTo(HaveOccurred())
+			})
+			It("should end in Initial state", func() {
+				Expect(run.Status.State).To(Equal("Initial"))
+			})
+			It("should have an associated pod", func() {
+				Expect(run.Status.RunnerPod).To(Not(BeEmpty()))
+			})
+			It("should have created a lock on the layer", func() {
+				layer := &configv1alpha1.TerraformLayer{}
+				err := k8sClient.Get(context.TODO(), types.NamespacedName{
+					Name:      run.Spec.Layer.Name,
+					Namespace: run.Namespace,
+				}, layer)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(lock.IsLayerLocked(context.TODO(), k8sClient, layer)).To(BeTrue())
+			})
+			It("should have created a pod", func() {
+				pods, err := reconciler.GetLinkedPods(run)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(len(pods.Items)).To(Equal(1))
+			})
+			It("should have passed the extra args env variables to the pod", func() {
+				pods, err := reconciler.GetLinkedPods(run)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(pods.Items[0].Spec.Containers[0].Env).To(ContainElement(corev1.EnvVar{
+					Name:  "TF_CLI_ARGS_plan",
+					Value: "--target 'module.this.random_pet.this[\"first\"]'",
+				}))
+				Expect(pods.Items[0].Spec.Containers[0].Env).To(ContainElement(corev1.EnvVar{
+					Name:  "TF_CLI_ARGS_apply",
+					Value: "--target 'module.this.random_pet.this[\"first\"]'",
+				}))
+				Expect(pods.Items[0].Spec.Containers[0].Env).To(ContainElement(corev1.EnvVar{
+					Name:  "TF_CLI_ARGS_init",
+					Value: "--upgrade",
+				}))
+
+			})
+		})
+	})
+})

internal/controllers/terraformrun/pod_test.go

@@ -0,0 +1,21 @@
+apiVersion: config.terraform.padok.cloud/v1alpha1
+kind: TerraformRun
+metadata:
+  name: nominal-case-extra-args-plan
+  namespace: default
+spec:
+  action: plan
+  layer:
+    name: pod-nominal-case-extra-args
+    namespace: default
+---
+apiVersion: config.terraform.padok.cloud/v1alpha1
+kind: TerraformRun
+metadata:
+  name: nominal-case-extra-args-apply
+  namespace: default
+spec:
+  action: apply
+  layer:
+    name: pod-nominal-case-extra-args
+    namespace: default

internal/controllers/terraformrun/testdata/concurrent-case.yaml renamed to internal/controllers/terraformrun/testdata/controller/concurrent-case.yaml

@@ -0,0 +1,16 @@
+
+apiVersion: config.terraform.padok.cloud/v1alpha1
+kind: TerraformLayer
+metadata:
+  name: pod-nominal-case-extra-args
+  namespace: default
+spec:
+  branch: main
+  path: terraform/
+  repository:
+    name: burrito
+    namespace: default
+  overrideRunnerSpec:
+    extraPlanArgs: ["--target", "'module.this.random_pet.this[\"first\"]'"]
+    extraApplyArgs: ["--target", "'module.this.random_pet.this[\"first\"]'"]
+    extraInitArgs: ["--upgrade"]