Skip to content

Commit f75872e

Browse files
smoshiur1237smoshiur1237
committed
Add image validation for opestack machine
Signed-off-by: smoshiur1237 <moshiur.rahman@est.tech>
1 parent ae9422e commit f75872e

File tree

4 files changed

+89
-9
lines changed

4 files changed

+89
-9
lines changed

‎api/v1beta1/types.go‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ limitations under the License.
1717
package v1beta1
1818

1919
import (
20+
"k8s.io/apimachinery/pkg/util/validation/field"
2021
"k8s.io/utils/ptr"
2122

2223
"sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/optional"
@@ -75,6 +76,24 @@ func (f *ImageFilter) IsZero() bool {
7576
return f.Name == nil && len(f.Tags) == 0
7677
}
7778

79+
// Validate performs validation on [ImageParam], returning a list of field errors using the provided base path.
80+
// It is intended to be used in the validation webhooks of resources containing [ImageParam].
81+
func (i *ImageParam) Validate(base field.Path) field.ErrorList {
82+
var errors field.ErrorList
83+
// Not possible to validate the image if it is missing
84+
if i == nil {
85+
errors = append(errors, field.Required(&base, "Image is required"))
86+
return errors
87+
}
88+
if i.Filter.Name == nil || i.Filter.Tags == nil {
89+
errors = append(errors, field.Required(base.Child("Image filter"), "Either Name or Tags of image are missing"))
90+
}
91+
if i.ImageRef.Name == "" {
92+
errors = append(errors, field.Required(base.Child("ORC image Referecne"), "ORC image is missing"))
93+
}
94+
return errors
95+
}
96+
7897
type ExternalRouterIPParam struct {
7998
// The FixedIP in the corresponding subnet
8099
FixedIP string `json:"fixedIP,omitempty"`

‎pkg/webhooks/openstackmachine_webhook.go‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ type openStackMachineWebhook struct{}
4848
var _ webhook.CustomValidator = &openStackMachineWebhook{}
4949

5050
// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
51-
func (*openStackMachineWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
51+
func (webhook *openStackMachineWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
5252
var allErrs field.ErrorList
5353
newObj, err := castToOpenStackMachine(objRaw)
5454
if err != nil {
@@ -68,12 +68,16 @@ func (*openStackMachineWebhook) ValidateCreate(_ context.Context, objRaw runtime
6868
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "ports"), "cannot have security groups when DisablePortSecurity is set to true"))
6969
}
7070
}
71+
err = webhook.validate(newObj)
72+
if err != nil {
73+
allErrs = append(allErrs, field.NotFound(field.NewPath("Spec", "Image"), "image cannot be found"))
74+
}
7175

7276
return aggregateObjErrors(newObj.GroupVersionKind().GroupKind(), newObj.Name, allErrs)
7377
}
7478

7579
// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
76-
func (*openStackMachineWebhook) ValidateUpdate(_ context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
80+
func (webhook *openStackMachineWebhook) ValidateUpdate(_ context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
7781
newObj, err := castToOpenStackMachine(newObjRaw)
7882
if err != nil {
7983
return nil, err
@@ -117,11 +121,16 @@ func (*openStackMachineWebhook) ValidateUpdate(_ context.Context, oldObjRaw, new
117121
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec"), "cannot be modified"))
118122
}
119123

124+
err = webhook.validate(newObj)
125+
if err != nil {
126+
allErrs = append(allErrs, field.NotFound(field.NewPath("Spec", "Image"), "image cannot be found"))
127+
}
128+
120129
return aggregateObjErrors(newObj.GroupVersionKind().GroupKind(), newObj.Name, allErrs)
121130
}
122131

123132
// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
124-
func (*openStackMachineWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
133+
func (webhook *openStackMachineWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
125134
return nil, nil
126135
}
127136

@@ -132,3 +141,14 @@ func castToOpenStackMachine(obj runtime.Object) (*infrav1.OpenStackMachine, erro
132141
}
133142
return cast, nil
134143
}
144+
145+
func (webhook *openStackMachineWebhook) validate(newObj *infrav1.OpenStackMachine) error {
146+
var allErrs field.ErrorList
147+
148+
allErrs = append(allErrs, newObj.Spec.Image.Validate(*field.NewPath("Spec", "Image"))...)
149+
150+
if len(allErrs) == 0 {
151+
return nil
152+
}
153+
return apierrors.NewInvalid(infrav1.SchemeGroupVersion.WithKind("OpenStackMachine").GroupKind(), newObj.Name, allErrs)
154+
}

‎pkg/webhooks/openstackmachinetemplate_webhook.go‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ type openStackMachineTemplateWebhook struct{}
4848
var _ webhook.CustomValidator = &openStackMachineTemplateWebhook{}
4949

5050
// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
51-
func (*openStackMachineTemplateWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
51+
func (webhook *openStackMachineTemplateWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
5252
newObj, err := castToOpenStackMachineTemplate(objRaw)
5353
if err != nil {
5454
return nil, err
@@ -60,11 +60,15 @@ func (*openStackMachineTemplateWebhook) ValidateCreate(_ context.Context, objRaw
6060
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "template", "spec", "providerID"), "cannot be set in templates"))
6161
}
6262

63+
err = webhook.validate(newObj)
64+
if err != nil {
65+
allErrs = append(allErrs, field.NotFound(field.NewPath("Spec", "Template", "Spec", "Image"), "image cannot be found"))
66+
}
6367
return aggregateObjErrors(newObj.GroupVersionKind().GroupKind(), newObj.Name, allErrs)
6468
}
6569

6670
// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
67-
func (*openStackMachineTemplateWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
71+
func (webhook *openStackMachineTemplateWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
6872
var allErrs field.ErrorList
6973
oldObj, err := castToOpenStackMachineTemplate(oldObjRaw)
7074
if err != nil {
@@ -88,11 +92,16 @@ func (*openStackMachineTemplateWebhook) ValidateUpdate(ctx context.Context, oldO
8892
)
8993
}
9094

95+
err = webhook.validate(newObj)
96+
if err != nil {
97+
allErrs = append(allErrs, field.NotFound(field.NewPath("Spec", "Template", "Spec", "Image"), "image cannot be found"))
98+
}
99+
91100
return aggregateObjErrors(newObj.GroupVersionKind().GroupKind(), newObj.Name, allErrs)
92101
}
93102

94103
// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
95-
func (*openStackMachineTemplateWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
104+
func (webhook *openStackMachineTemplateWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
96105
return nil, nil
97106
}
98107

@@ -103,3 +112,14 @@ func castToOpenStackMachineTemplate(obj runtime.Object) (*infrav1.OpenStackMachi
103112
}
104113
return cast, nil
105114
}
115+
116+
func (webhook *openStackMachineTemplateWebhook) validate(newObj *infrav1.OpenStackMachineTemplate) error {
117+
var allErrs field.ErrorList
118+
119+
allErrs = append(allErrs, newObj.Spec.Template.Spec.Image.Validate(*field.NewPath("Spec", "Template", "Spec", "Image"))...)
120+
121+
if len(allErrs) == 0 {
122+
return nil
123+
}
124+
return apierrors.NewInvalid(infrav1.SchemeGroupVersion.WithKind("OpenStackMachineTemplate").GroupKind(), newObj.Name, allErrs)
125+
}

‎pkg/webhooks/openstackserver_webhook.go‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ type openStackServerWebhook struct{}
5050
var _ webhook.CustomValidator = &openStackServerWebhook{}
5151

5252
// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
53-
func (*openStackServerWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
53+
func (webhook *openStackServerWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
5454
var allErrs field.ErrorList
5555
newObj, err := castToOpenStackServer(objRaw)
5656
if err != nil {
@@ -71,11 +71,16 @@ func (*openStackServerWebhook) ValidateCreate(_ context.Context, objRaw runtime.
7171
}
7272
}
7373

74+
err = webhook.validate(newObj)
75+
if err != nil {
76+
allErrs = append(allErrs, field.NotFound(field.NewPath("Spec", "Image"), "image cannot be found"))
77+
}
78+
7479
return aggregateObjErrors(newObj.GroupVersionKind().GroupKind(), newObj.Name, allErrs)
7580
}
7681

7782
// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
78-
func (*openStackServerWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
83+
func (webhook *openStackServerWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
7984
oldObj, err := castToOpenStackServer(oldObjRaw)
8085
if err != nil {
8186
return nil, err
@@ -120,11 +125,16 @@ func (*openStackServerWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, ne
120125
)
121126
}
122127

128+
err = webhook.validate(newObj)
129+
if err != nil {
130+
allErrs = append(allErrs, field.NotFound(field.NewPath("Spec", "Image"), "image cannot be found"))
131+
}
132+
123133
return aggregateObjErrors(newObj.GroupVersionKind().GroupKind(), newObj.Name, allErrs)
124134
}
125135

126136
// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
127-
func (*openStackServerWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
137+
func (webhook *openStackServerWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
128138
return nil, nil
129139
}
130140

@@ -135,3 +145,14 @@ func castToOpenStackServer(obj runtime.Object) (*infrav1alpha1.OpenStackServer,
135145
}
136146
return cast, nil
137147
}
148+
149+
func (webhook *openStackServerWebhook) validate(newObj *infrav1alpha1.OpenStackServer) error {
150+
var allErrs field.ErrorList
151+
152+
allErrs = append(allErrs, newObj.Spec.Image.Validate(*field.NewPath("Spec", "Image"))...)
153+
154+
if len(allErrs) == 0 {
155+
return nil
156+
}
157+
return apierrors.NewInvalid(infrav1.SchemeGroupVersion.WithKind("OpenStackServer").GroupKind(), newObj.Name, allErrs)
158+
}

0 commit comments

Comments
 (0)