-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: ensure global podTemplate configuration is merged correctly
fix #7551 Adjust the behavior of how global Pod templates are merged with TaskRun or PipelineRun. The `env` and `volumes` fields are merged by the `name` value in the array elements.
- Loading branch information
1 parent
47848a0
commit 3d76902
Showing
5 changed files
with
225 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| /* | ||
| Copyright 2024 The Tekton Authors | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package pod | ||
|
|
||
| import ( | ||
| "reflect" | ||
| "testing" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
| ) | ||
|
|
||
| func TestMergeByName(t *testing.T) { | ||
| type testCase struct { | ||
| name string | ||
| base []interface{} | ||
| overrides []interface{} | ||
| expected []interface{} | ||
| } | ||
|
|
||
| testCases := []testCase{ | ||
| { | ||
| name: "empty overrides", | ||
| base: []interface{}{corev1.EnvVar{Name: "foo", Value: "bar"}}, | ||
| overrides: []interface{}{}, | ||
| expected: []interface{}{corev1.EnvVar{Name: "foo", Value: "bar"}}, | ||
| }, | ||
| { | ||
| name: "empty base", | ||
| base: []interface{}{}, | ||
| overrides: []interface{}{corev1.EnvVar{Name: "foo", Value: "bar"}}, | ||
| expected: []interface{}{corev1.EnvVar{Name: "foo", Value: "bar"}}, | ||
| }, | ||
| { | ||
| name: "same name", | ||
| base: []interface{}{corev1.EnvVar{Name: "foo", Value: "bar"}}, | ||
| overrides: []interface{}{corev1.EnvVar{Name: "foo", Value: "baz"}}, | ||
| expected: []interface{}{corev1.EnvVar{Name: "foo", Value: "baz"}}, | ||
| }, | ||
| { | ||
| name: "different name", | ||
| base: []interface{}{corev1.EnvVar{Name: "foo", Value: "bar"}}, | ||
| overrides: []interface{}{corev1.EnvVar{Name: "bar", Value: "baz"}}, | ||
| expected: []interface{}{corev1.EnvVar{Name: "bar", Value: "baz"}, corev1.EnvVar{Name: "foo", Value: "bar"}}, | ||
| }, | ||
| { | ||
| name: "different volume name", | ||
| base: []interface{}{corev1.Volume{Name: "foo", VolumeSource: corev1.VolumeSource{EmptyDir: &corev1.EmptyDirVolumeSource{}}}}, | ||
| overrides: []interface{}{corev1.Volume{Name: "bar", VolumeSource: corev1.VolumeSource{EmptyDir: &corev1.EmptyDirVolumeSource{}}}}, | ||
| expected: []interface{}{ | ||
| corev1.Volume{Name: "bar", VolumeSource: corev1.VolumeSource{EmptyDir: &corev1.EmptyDirVolumeSource{}}}, | ||
| corev1.Volume{Name: "foo", VolumeSource: corev1.VolumeSource{EmptyDir: &corev1.EmptyDirVolumeSource{}}}, | ||
| }, | ||
| }, | ||
| { | ||
| name: "unsupported type", | ||
| base: []interface{}{corev1.EnvVar{Name: "foo", Value: "bar"}}, | ||
| overrides: []interface{}{42}, | ||
| expected: []interface{}{corev1.EnvVar{Name: "foo", Value: "bar"}}, | ||
| }, | ||
| { | ||
| name: "empty name", | ||
| base: []interface{}{corev1.EnvVar{Name: "", Value: "bar"}}, | ||
| overrides: []interface{}{corev1.EnvVar{Name: "", Value: "bar"}}, | ||
| expected: []interface{}{}, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| result := mergeByName(tc.base, tc.overrides) | ||
| if !reflect.DeepEqual(result, tc.expected) { | ||
| t.Errorf("mergeByName(%v, %v) = %v, want %v", tc.base, tc.overrides, result, tc.expected) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestMergePodTemplateWithDefault(t *testing.T) { | ||
| type testCase struct { | ||
| name string | ||
| tpl *PodTemplate | ||
| defaultTpl *PodTemplate | ||
| expected *PodTemplate | ||
| } | ||
|
|
||
| testCases := []testCase{ | ||
| { | ||
| name: "defaultTpl is nil", | ||
| tpl: &PodTemplate{ | ||
| NodeSelector: map[string]string{"foo": "bar"}, | ||
| }, | ||
| defaultTpl: nil, | ||
| expected: &PodTemplate{ | ||
| NodeSelector: map[string]string{"foo": "bar"}, | ||
| }, | ||
| }, | ||
| { | ||
| name: "tpl is nil", | ||
| tpl: nil, | ||
| defaultTpl: &PodTemplate{ | ||
| NodeSelector: map[string]string{"foo": "bar"}, | ||
| }, | ||
| expected: &PodTemplate{ | ||
| NodeSelector: map[string]string{"foo": "bar"}, | ||
| }, | ||
| }, | ||
| { | ||
| name: "override default env", | ||
| tpl: &PodTemplate{ | ||
| Env: []corev1.EnvVar{{Name: "foo", Value: "bar"}}, | ||
| }, | ||
| defaultTpl: &PodTemplate{ | ||
| Env: []corev1.EnvVar{{Name: "foo", Value: "baz"}}, | ||
| }, | ||
| expected: &PodTemplate{ | ||
| Env: []corev1.EnvVar{{Name: "foo", Value: "bar"}}, | ||
| }, | ||
| }, | ||
| { | ||
| name: "merge envs", | ||
| tpl: &PodTemplate{ | ||
| Env: []corev1.EnvVar{{Name: "foo", Value: "bar"}}, | ||
| }, | ||
| defaultTpl: &PodTemplate{ | ||
| Env: []corev1.EnvVar{{Name: "bar", Value: "bar"}}, | ||
| }, | ||
| expected: &PodTemplate{ | ||
| Env: []corev1.EnvVar{ | ||
| {Name: "foo", Value: "bar"}, | ||
| {Name: "bar", Value: "bar"}, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "update host network", | ||
| tpl: &PodTemplate{ | ||
| HostNetwork: false, | ||
| }, | ||
| defaultTpl: &PodTemplate{ | ||
| HostNetwork: true, | ||
| }, | ||
| expected: &PodTemplate{ | ||
| HostNetwork: true, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| result := MergePodTemplateWithDefault(tc.tpl, tc.defaultTpl) | ||
| if !reflect.DeepEqual(result, tc.expected) { | ||
| t.Errorf("mergeByName(%v, %v) = %v, want %v", tc.tpl, tc.defaultTpl, result, tc.expected) | ||
| } | ||
| }) | ||
| } | ||
| } |