Move container and pod overrides from GetAllContainers/getPodTemplateSpec to GetPodTemplateSpec

Signed-off-by: Philippe Martin <[email protected]>

Author: feloy

pkg/devfile/generator/generators.go

@@ -238,6 +238,7 @@ func GetPodTemplateSpec(devfileObj parser.DevfileObj, podTemplateParams PodTempl
 	if err != nil {
 		return nil, err
 	}
+
 	podTemplateSpecParams := podTemplateSpecParams{
 		ObjectMeta:     podTemplateParams.ObjectMeta,
 		InitContainers: initContainers,
@@ -254,7 +255,71 @@ func GetPodTemplateSpec(devfileObj parser.DevfileObj, podTemplateParams PodTempl
 	if err != nil {
 		return nil, err
 	}
-	return getPodTemplateSpec(globalAttributes, components, podTemplateSpecParams)
+
+	podTemplateSpec, err := getPodTemplateSpec(podTemplateSpecParams)
+	if err != nil {
+		return nil, err
+	}
+
+	// TODO: apply here patches for Pod Security Admission
+
+	if needsPodOverrides(globalAttributes, components) {
+		patchedPodTemplateSpec, err := applyPodOverrides(globalAttributes, components, podTemplateSpec)
+		if err != nil {
+			return nil, err
+		}
+		patchedPodTemplateSpec.ObjectMeta = podTemplateSpecParams.ObjectMeta
+		podTemplateSpec = patchedPodTemplateSpec
+	}
+
+	podTemplateSpec.Spec.Containers, err = applyContainerOverrides(devfileObj, podTemplateSpec.Spec.Containers)
+	if err != nil {
+		return nil, err
+	}
+	podTemplateSpec.Spec.InitContainers, err = applyContainerOverrides(devfileObj, podTemplateSpec.Spec.InitContainers)
+	if err != nil {
+		return nil, err
+	}
+
+	return podTemplateSpec, nil
+}
+
+func applyContainerOverrides(devfileObj parser.DevfileObj, containers []corev1.Container) ([]corev1.Container, error) {
+	containerComponents, err := devfileObj.Data.GetComponents(common.DevfileOptions{
+		ComponentOptions: common.ComponentOptions{
+			ComponentType: v1.ContainerComponentType,
+		},
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	getContainerByName := func(name string) (*corev1.Container, bool) {
+		for _, container := range containers {
+			if container.Name == name {
+				return &container, true
+			}
+		}
+		return nil, false
+	}
+
+	result := make([]corev1.Container, 0, len(containers))
+	for _, comp := range containerComponents {
+		container, found := getContainerByName(comp.Name)
+		if !found {
+			continue
+		}
+		if comp.Attributes.Exists(ContainerOverridesAttribute) {
+			patched, err := containerOverridesHandler(comp, container)
+			if err != nil {
+				return nil, err
+			}
+			result = append(result, *patched)
+		} else {
+			result = append(result, *container)
+		}
+	}
+	return result, nil
 }
 
 // PVCParams is a struct to create PVC

pkg/devfile/generator/generators_test.go

@@ -49,11 +49,6 @@ func TestGetContainers(t *testing.T) {
 
 	containerNames := []string{"testcontainer1", "testcontainer2", "testcontainer3"}
 	containerImages := []string{"image1", "image2", "image3"}
-	defaultPullPolicy := corev1.PullAlways
-	defaultEnv := []corev1.EnvVar{
-		{Name: "PROJECTS_ROOT", Value: "/projects"},
-		{Name: "PROJECT_SOURCE", Value: "/projects/test-project"},
-	}
 
 	trueMountSources := true
 	falseMountSources := false
@@ -305,36 +300,6 @@ func TestGetContainers(t *testing.T) {
 			name:    "Simulating error case, check if error matches",
 			wantErr: &errMatches,
 		},
-		{
-			name: "container with container-overrides",
-			containerComponents: []v1.Component{
-				{
-					Name: containerNames[0],
-					ComponentUnion: v1.ComponentUnion{
-						Container: &v1.ContainerComponent{
-							Container: v1.Container{
-								Image: containerImages[0],
-							},
-						},
-					},
-					Attributes: attributes.Attributes{}.FromMap(map[string]interface{}{
-						"container-overrides": map[string]interface{}{"securityContext": map[string]int64{"runAsGroup": 3000}},
-					}, nil),
-				},
-			},
-			wantContainerName:  containerNames[0],
-			wantContainerImage: containerImages[0],
-			wantContainerEnv:   defaultEnv,
-			wantContainerOverrideData: &corev1.Container{
-				Name:            containerNames[0],
-				Image:           containerImages[0],
-				Env:             defaultEnv,
-				ImagePullPolicy: defaultPullPolicy,
-				SecurityContext: &corev1.SecurityContext{
-					RunAsGroup: pointer.Int64(3000),
-				},
-			},
-		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

pkg/devfile/generator/utils.go

@@ -241,7 +241,7 @@ type podTemplateSpecParams struct {
 }
 
 // getPodTemplateSpec gets a pod template spec that can be used to create a deployment spec
-func getPodTemplateSpec(globalAttributes attributes.Attributes, components []v1.Component, podTemplateSpecParams podTemplateSpecParams) (*corev1.PodTemplateSpec, error) {
+func getPodTemplateSpec(podTemplateSpecParams podTemplateSpecParams) (*corev1.PodTemplateSpec, error) {
 	podTemplateSpec := &corev1.PodTemplateSpec{
 		ObjectMeta: podTemplateSpecParams.ObjectMeta,
 		Spec: corev1.PodSpec{
@@ -250,14 +250,6 @@ func getPodTemplateSpec(globalAttributes attributes.Attributes, components []v1.
 			Volumes:        podTemplateSpecParams.Volumes,
 		},
 	}
-	if needsPodOverrides(globalAttributes, components) {
-		patchedPodTemplateSpec, err := applyPodOverrides(globalAttributes, components, podTemplateSpec)
-		if err != nil {
-			return nil, err
-		}
-		patchedPodTemplateSpec.ObjectMeta = podTemplateSpecParams.ObjectMeta
-		podTemplateSpec = patchedPodTemplateSpec
-	}
 
 	return podTemplateSpec, nil
 }
@@ -736,16 +728,7 @@ func getAllContainers(devfileObj parser.DevfileObj, options common.DevfileOption
 				return nil, err
 			}
 		}
-		// Check if there is an override attribute
-		if comp.Attributes.Exists(ContainerOverridesAttribute) {
-			patched, err := containerOverridesHandler(comp, container)
-			if err != nil {
-				return nil, err
-			}
-			containers = append(containers, *patched)
-		} else {
-			containers = append(containers, *container)
-		}
+		containers = append(containers, *container)
 	}
 	return containers, nil
 }