Skip to content

Commit

Permalink
Add more unit tests for additional coverage
Browse files Browse the repository at this point in the history 
Signed-off-by: Parthvi Vala <pvala@redhat.com>
  • Loading branch information
@valaparthvi
valaparthvi committed Dec 9, 2022
1 parent 16a439f commit a71988e
Show file tree
Hide file tree
Showing 2 changed files with 198 additions and 102 deletions.
6 changes: 3 additions & 3 deletions pkg/devfile/generator/utils.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -347,13 +347,13 @@ func getPodOverrides(globalAttributes attributes.Attributes, components []v1.Com
}
// Do not allow overriding containers or volumes
if override.Spec.Containers != nil {
return nil, fmt.Errorf("cannot use pod-overrides to override pod containers")
return nil, fmt.Errorf("cannot use %s to override pod containers", PodOverridesAttribute)
}
if override.Spec.InitContainers != nil {
return nil, fmt.Errorf("cannot use pod-overrides to override pod initContainers")
return nil, fmt.Errorf("cannot use %s to override pod initContainers", PodOverridesAttribute)
}
if override.Spec.Volumes != nil {
return nil, fmt.Errorf("cannot use pod-overrides to override pod volumes")
return nil, fmt.Errorf("cannot use %s to override pod volumes", PodOverridesAttribute)
}
patchData := globalAttributes[PodOverridesAttribute]
allOverrides = append(allOverrides, patchData)
Expand Down
294 changes: 195 additions & 99 deletions pkg/devfile/generator/utils_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package generator

import (
"fmt"
"github.com/hashicorp/go-multierror"
"github.com/stretchr/testify/assert"
"k8s.io/utils/pointer"
Expand Down Expand Up @@ -1857,50 +1858,57 @@ func Test_containerOverridesHandler(t *testing.T) {
func Test_applyPodOverrides(t *testing.T) {

name := "runtime"
image := "docker.io/maven:latest"
command := []string{"tail"}
argsSlice := []string{"-f", "/dev/null"}
devfileContainer1 := testingutil.GenerateDummyContainerComponent(name, nil, nil, nil, v1.Annotation{}, pointer.Bool(true))
k8sContainer1 := getContainer(containerParams{Name: name, Image: image, Args: argsSlice, Command: command})
devfileContainer := testingutil.GenerateDummyContainerComponent(name, []v1.VolumeMount{{Name: "volume-1", Path: "/projects/test"}}, nil, nil, v1.Annotation{}, pointer.Bool(true))
k8sContainer := getContainer(containerParams{Name: name, Image: "docker.io/maven:latest"})

defaultPodSpec := corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: "my-nodejs-app",
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{*k8sContainer},
InitContainers: []corev1.Container{
{
Name: "sidecar",
Image: "nginx",
},
},
Volumes: []corev1.Volume{
{
Name: "volume-1",
},
},
},
}

type args struct {
globalAttributes attributes.Attributes
components []v1.Component
podTemplateSpec *corev1.PodTemplateSpec
}
tests := []struct {
name string
args args
want *corev1.PodTemplateSpec
wantErr bool
name string
args args
want *corev1.PodTemplateSpec
wantErr bool
errString *string
}{
// TODO: Add test cases.
{
name: "Should override field as defined inside pod-overrides Devfile level attribute",
args: args{
globalAttributes: attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"serviceAccountName\": \"new-service-account\"}}")},
},
components: []v1.Component{
devfileContainer1,
},
podTemplateSpec: &corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: "my-nodejs-app",
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{*k8sContainer1},
},
},
},
want: &corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: "my-nodejs-app",
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{*k8sContainer1},
ServiceAccountName: "new-service-account",
devfileContainer,
},
podTemplateSpec: &defaultPodSpec,
},
want: func() *corev1.PodTemplateSpec {
podSpec := defaultPodSpec
podSpec.Spec.ServiceAccountName = "new-service-account"
return &podSpec
}(),
wantErr: false,
},
{
Expand All @@ -1911,116 +1919,204 @@ func Test_applyPodOverrides(t *testing.T) {
},
components: []v1.Component{
func() v1.Component {
container := devfileContainer1
container := devfileContainer
container.Attributes = attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"schedulerName\": \"stork\"}}")},
}
return container
}(),
},
podTemplateSpec: &corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: "my-nodejs-app",
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{*k8sContainer1},
},
},
podTemplateSpec: &defaultPodSpec,
},
want: &corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: "my-nodejs-app",
want: func() *corev1.PodTemplateSpec {
podSpec := defaultPodSpec
podSpec.Spec.ServiceAccountName = "new-service-account"
podSpec.Spec.SchedulerName = "stork"
return &podSpec
}(),
},
{
name: "Should override field as defined inside pod-overrides attribute with delete $patch directive",
args: args{
globalAttributes: attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"securityContext\": {\"$patch\": \"delete\"}}}")},
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{*k8sContainer1},
ServiceAccountName: "new-service-account",
SchedulerName: "stork",
components: []v1.Component{devfileContainer},
podTemplateSpec: func() *corev1.PodTemplateSpec {
podSpec := defaultPodSpec
podSpec.Spec.SecurityContext = &corev1.PodSecurityContext{
RunAsNonRoot: pointer.Bool(true),
}
return &podSpec
}(),
},
want: func() *corev1.PodTemplateSpec {
podSpec := defaultPodSpec
podSpec.Spec.SecurityContext = &corev1.PodSecurityContext{}
return &podSpec
}(),
wantErr: false,
},
{
name: "Should override field as defined inside pod-overrides attribute with replace $patch directive",
args: args{
globalAttributes: attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"securityContext\": {\"runAsNonRoot\": false, \"$patch\": \"replace\"}}}\n")},
},
components: []v1.Component{devfileContainer},
podTemplateSpec: func() *corev1.PodTemplateSpec {
podSpec := defaultPodSpec
podSpec.Spec.SecurityContext = &corev1.PodSecurityContext{
RunAsGroup: pointer.Int64(3000),
RunAsUser: pointer.Int64(1000),
RunAsNonRoot: pointer.Bool(true),
}
return &podSpec
}(),
},
want: func() *corev1.PodTemplateSpec {
podSpec := defaultPodSpec
podSpec.Spec.SecurityContext = &corev1.PodSecurityContext{
RunAsNonRoot: pointer.Bool(false),
}
return &podSpec
}(),
wantErr: false,
},
{
name: "Should override field as defined inside pod-overrides attribute with delete $patch directive",
name: "Should fail to override invalid json in pod-overrides attribute defined at Devfile level",
args: args{
globalAttributes: attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"securityContext\": {\"$patch\": \"delete\"}}}")},
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": \"containers\": []}")},
},
components: nil,
podTemplateSpec: &defaultPodSpec,
},
want: nil,
wantErr: true,
errString: pointer.String(fmt.Sprintf("failed to parse %s attribute for pod", PodOverridesAttribute)),
},
{
name: "Should fail to override invalid json in pod-overrides attribute defined at component level",
args: args{
globalAttributes: nil,
components: []v1.Component{
devfileContainer1,
},
podTemplateSpec: &corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: "my-nodejs-app",
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
*k8sContainer1,
},
SecurityContext: &corev1.PodSecurityContext{
RunAsNonRoot: pointer.Bool(true),
},
},
func() v1.Component {
container := devfileContainer
container.Attributes = attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": \"containers\": []}")},
}
return container
}(),
},
podTemplateSpec: &defaultPodSpec,
},
want: &corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: "my-nodejs-app",
want: nil,
wantErr: true,
errString: pointer.String(fmt.Sprintf("failed to parse %s attribute on component %s", PodOverridesAttribute, devfileContainer.Name)),
},
{
name: "Should fail to override restricted fields 'containers' at Devfile attribute level",
args: args{
globalAttributes: attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"containers\": [{\"name\": \"container-1\", \"image\": \"busybox\"}]}}")},
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
*k8sContainer1,
},
SecurityContext: &corev1.PodSecurityContext{},
components: nil,
podTemplateSpec: &defaultPodSpec,
},
want: nil,
wantErr: true,
errString: pointer.String(fmt.Sprintf("cannot use %s to override pod containers", PodOverridesAttribute)),
},
{
name: "Should fail to override restricted fields 'initContainers' at Devfile attribute level",
args: args{
globalAttributes: attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"initContainers\": [{\"name\": \"sidecar-1\", \"image\": \"nginx:1.0.0\"}]}}")},
},
components: nil,
podTemplateSpec: &defaultPodSpec,
},
wantErr: false,
want: nil,
wantErr: true,
errString: pointer.String(fmt.Sprintf("cannot use %s to override pod initContainers", PodOverridesAttribute)),
},
{
name: "Should override field as defined inside pod-overrides attribute with replace $patch directive",
name: "Should fail to override restricted fields 'volumes' at Devfile attribute level",
args: args{
globalAttributes: attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"securityContext\": {\"runAsNonRoot\": false, \"$patch\": \"replace\"}}}\n")},
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"volumes\": [{\"name\": \"volume-2\"}]}}")},
},
components: nil,
podTemplateSpec: &defaultPodSpec,
},
want: nil,
wantErr: true,
errString: pointer.String(fmt.Sprintf("cannot use %s to override pod volumes", PodOverridesAttribute)),
},
{
name: "Should fail to override restricted fields 'containers' at component attribute level",
args: args{
components: []v1.Component{
devfileContainer1,
},
podTemplateSpec: &corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: "my-nodejs-app",
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
*k8sContainer1,
},
SecurityContext: &corev1.PodSecurityContext{
RunAsGroup: pointer.Int64(3000),
RunAsUser: pointer.Int64(1000),
RunAsNonRoot: pointer.Bool(true),
},
},
func() v1.Component {
container := devfileContainer
container.Attributes = attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"containers\": [{\"name\": \"container-1\", \"image\": \"busybox\"}]}}")},
}
return container
}(),
},
podTemplateSpec: &defaultPodSpec,
},
want: &corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: "my-nodejs-app",
want: nil,
wantErr: true,
errString: pointer.String(fmt.Sprintf("cannot use %s to override pod containers (component %s)", PodOverridesAttribute, devfileContainer.Name)),
},
{
name: "Should fail to override restricted fields 'initContainers' at component attribute level",
args: args{
components: []v1.Component{
func() v1.Component {
container := devfileContainer
container.Attributes = attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"initContainers\": [{\"name\": \"sidecar-1\", \"image\": \"nginx:1.0.0\"}]}}")},
}
return container
}(),
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
*k8sContainer1,
},
SecurityContext: &corev1.PodSecurityContext{
RunAsNonRoot: pointer.Bool(false),
},
podTemplateSpec: &defaultPodSpec,
},
want: nil,
wantErr: true,
errString: pointer.String(fmt.Sprintf("cannot use %s to override pod initContainers (component %s)", PodOverridesAttribute, devfileContainer.Name)),
},
{
name: "Should fail to override restricted fields 'volumes' at component attribute level",
args: args{
components: []v1.Component{
func() v1.Component {
container := devfileContainer
container.Attributes = attributes.Attributes{
PodOverridesAttribute: apiextensionsv1.JSON{Raw: []byte("{\"spec\": {\"volumes\": [{\"name\": \"volume-2\"}]}}")},
}
return container
}(),
},
podTemplateSpec: &defaultPodSpec,
},
wantErr: false,
want: nil,
wantErr: true,
errString: pointer.String(fmt.Sprintf("cannot use %s to override pod volumes (component %s)", PodOverridesAttribute, devfileContainer.Name)),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := applyPodOverrides(tt.args.globalAttributes, tt.args.components, tt.args.podTemplateSpec)
if !tt.wantErr == (err != nil) {
t.Errorf("ApplyPodOverrides() error: %v, wantErr %v", err, tt.wantErr)
return
}
if tt.wantErr {
assert.Contains(t, err.Error(), *tt.errString)
}
assert.Equalf(t, tt.want, got, "ApplyPodOverrides(%v, %v, %v)", tt.args.globalAttributes, tt.args.components, tt.args.podTemplateSpec)
})
Expand Down

0 comments on commit a71988e

Please sign in to comment.