-
Notifications
You must be signed in to change notification settings - Fork 451
/
operatingsystemconfig.go
215 lines (170 loc) · 8.97 KB
/
operatingsystemconfig.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
// Copyright 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 validation
import (
"slices"
"strings"
"github.com/go-test/deep"
apiequality "k8s.io/apimachinery/pkg/api/equality"
apivalidation "k8s.io/apimachinery/pkg/api/validation"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/validation/field"
extensionsv1alpha1 "github.com/gardener/gardener/pkg/apis/extensions/v1alpha1"
)
// ValidateOperatingSystemConfig validates a OperatingSystemConfig object.
func ValidateOperatingSystemConfig(osc *extensionsv1alpha1.OperatingSystemConfig) field.ErrorList {
pathsFromFiles := sets.New[string]()
for _, file := range append(osc.Spec.Files, osc.Status.ExtensionFiles...) {
pathsFromFiles.Insert(file.Path)
}
allErrs := field.ErrorList{}
allErrs = append(allErrs, apivalidation.ValidateObjectMeta(&osc.ObjectMeta, true, apivalidation.NameIsDNSSubdomain, field.NewPath("metadata"))...)
allErrs = append(allErrs, ValidateOperatingSystemConfigSpec(&osc.Spec, pathsFromFiles, field.NewPath("spec"))...)
allErrs = append(allErrs, ValidateOperatingSystemConfigStatus(&osc.Status, pathsFromFiles, field.NewPath("status"))...)
allErrs = append(allErrs, validateFileDuplicates(osc)...)
return allErrs
}
// ValidateOperatingSystemConfigUpdate validates a OperatingSystemConfig object before an update.
func ValidateOperatingSystemConfigUpdate(new, old *extensionsv1alpha1.OperatingSystemConfig) field.ErrorList {
allErrs := field.ErrorList{}
allErrs = append(allErrs, apivalidation.ValidateObjectMetaUpdate(&new.ObjectMeta, &old.ObjectMeta, field.NewPath("metadata"))...)
allErrs = append(allErrs, ValidateOperatingSystemConfigSpecUpdate(&new.Spec, &old.Spec, new.DeletionTimestamp != nil, field.NewPath("spec"))...)
allErrs = append(allErrs, ValidateOperatingSystemConfig(new)...)
return allErrs
}
// ValidateOperatingSystemConfigSpec validates the specification of a OperatingSystemConfig object.
func ValidateOperatingSystemConfigSpec(spec *extensionsv1alpha1.OperatingSystemConfigSpec, pathsFromFiles sets.Set[string], fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
if len(spec.Type) == 0 {
allErrs = append(allErrs, field.Required(fldPath.Child("type"), "field is required"))
}
if len(spec.Purpose) == 0 {
allErrs = append(allErrs, field.Required(fldPath.Child("purpose"), "field is required"))
} else {
if spec.Purpose != extensionsv1alpha1.OperatingSystemConfigPurposeProvision && spec.Purpose != extensionsv1alpha1.OperatingSystemConfigPurposeReconcile {
allErrs = append(allErrs, field.NotSupported(fldPath.Child("purpose"), spec.Purpose, []string{string(extensionsv1alpha1.OperatingSystemConfigPurposeProvision), string(extensionsv1alpha1.OperatingSystemConfigPurposeReconcile)}))
}
}
allErrs = append(allErrs, ValidateUnits(spec.Units, pathsFromFiles, fldPath.Child("units"))...)
allErrs = append(allErrs, ValidateFiles(spec.Files, fldPath.Child("files"))...)
return allErrs
}
// ValidateOperatingSystemConfigStatus validates the status of a OperatingSystemConfig object.
func ValidateOperatingSystemConfigStatus(status *extensionsv1alpha1.OperatingSystemConfigStatus, pathsFromFiles sets.Set[string], fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
allErrs = append(allErrs, ValidateUnits(status.ExtensionUnits, pathsFromFiles, fldPath.Child("extensionUnits"))...)
allErrs = append(allErrs, ValidateFiles(status.ExtensionFiles, fldPath.Child("extensionFiles"))...)
return allErrs
}
// ValidateUnits validates operating system config units.
func ValidateUnits(units []extensionsv1alpha1.Unit, pathsFromFiles sets.Set[string], fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
for i, unit := range units {
idxPath := fldPath.Index(i)
if len(unit.Name) == 0 {
allErrs = append(allErrs, field.Required(idxPath.Child("name"), "field is required"))
}
for j, dropIn := range unit.DropIns {
jdxPath := idxPath.Child("dropIns").Index(j)
if len(dropIn.Name) == 0 {
allErrs = append(allErrs, field.Required(jdxPath.Child("name"), "field is required"))
}
if len(dropIn.Content) == 0 {
allErrs = append(allErrs, field.Required(jdxPath.Child("content"), "field is required"))
}
}
allErrs = append(allErrs, validateFilePaths(unit.FilePaths, pathsFromFiles, idxPath.Child("filePaths"))...)
}
return allErrs
}
func validateFileDuplicates(osc *extensionsv1alpha1.OperatingSystemConfig) field.ErrorList {
allErrs := field.ErrorList{}
paths := sets.New[string]()
check := func(files []extensionsv1alpha1.File, fldPath *field.Path) {
for i, file := range files {
idxPath := fldPath.Index(i)
if file.Path != "" {
if paths.Has(file.Path) {
allErrs = append(allErrs, field.Duplicate(idxPath.Child("path"), file.Path))
}
paths.Insert(file.Path)
}
}
}
check(osc.Spec.Files, field.NewPath("spec.files"))
check(osc.Status.ExtensionFiles, field.NewPath("status.extensionFiles"))
return allErrs
}
func validateFilePaths(filePaths []string, paths sets.Set[string], fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
for i, filePath := range filePaths {
idxPath := fldPath.Index(i)
if !paths.Has(filePath) {
allErrs = append(allErrs, field.Invalid(idxPath, filePath, "'filePath' requires a matching 'path' in 'spec.files'"))
}
}
return allErrs
}
// ValidateFiles validates operating system config files.
func ValidateFiles(files []extensionsv1alpha1.File, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
for i, file := range files {
idxPath := fldPath.Index(i)
if len(file.Path) == 0 {
allErrs = append(allErrs, field.Required(idxPath.Child("path"), "field is required"))
}
switch {
case file.Content.SecretRef == nil && file.Content.Inline == nil && file.Content.ImageRef == nil:
allErrs = append(allErrs, field.Required(idxPath.Child("content"), "either 'secretRef', 'inline' or 'imageRef' must be provided"))
case file.Content.SecretRef != nil && file.Content.Inline != nil || file.Content.SecretRef != nil && file.Content.ImageRef != nil || file.Content.Inline != nil && file.Content.ImageRef != nil:
allErrs = append(allErrs, field.Invalid(idxPath.Child("content"), file.Content, "either 'secretRef', 'inline' or 'imageRef' must be provided, not multiple at the same time"))
case file.Content.SecretRef != nil:
if len(file.Content.SecretRef.Name) == 0 {
allErrs = append(allErrs, field.Required(idxPath.Child("content", "secretRef", "name"), "field is required"))
}
if len(file.Content.SecretRef.DataKey) == 0 {
allErrs = append(allErrs, field.Required(idxPath.Child("content", "secretRef", "dataKey"), "field is required"))
}
case file.Content.Inline != nil:
encodings := []string{string(extensionsv1alpha1.PlainFileCodecID), string(extensionsv1alpha1.B64FileCodecID)}
if !slices.Contains(encodings, file.Content.Inline.Encoding) {
allErrs = append(allErrs, field.NotSupported(idxPath.Child("content", "inline", "encoding"), file.Content.Inline.Encoding, encodings))
}
if len(file.Content.Inline.Data) == 0 {
allErrs = append(allErrs, field.Required(idxPath.Child("content", "inline", "data"), "field is required"))
}
case file.Content.ImageRef != nil:
if len(file.Content.ImageRef.Image) == 0 {
allErrs = append(allErrs, field.Required(idxPath.Child("content", "imageRef", "image"), "field is required"))
}
if len(file.Content.ImageRef.FilePathInImage) == 0 {
allErrs = append(allErrs, field.Required(idxPath.Child("content", "imageRef", "filePathInImage"), "field is required"))
}
}
}
return allErrs
}
// ValidateOperatingSystemConfigSpecUpdate validates the spec of a OperatingSystemConfig object before an update.
func ValidateOperatingSystemConfigSpecUpdate(new, old *extensionsv1alpha1.OperatingSystemConfigSpec, deletionTimestampSet bool, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
if deletionTimestampSet && !apiequality.Semantic.DeepEqual(new, old) {
if diff := deep.Equal(new, old); diff != nil {
return field.ErrorList{field.Forbidden(fldPath, strings.Join(diff, ","))}
}
return apivalidation.ValidateImmutableField(new, old, fldPath)
}
allErrs = append(allErrs, apivalidation.ValidateImmutableField(new.Type, old.Type, fldPath.Child("type"))...)
allErrs = append(allErrs, apivalidation.ValidateImmutableField(new.Purpose, old.Purpose, fldPath.Child("purpose"))...)
return allErrs
}