Skip to content

Commit

Permalink
Add service Endpoint Validate() method
Browse files Browse the repository at this point in the history
This method can e.g. be used in webhooks to validate if the
configuration in the CR is correct.
  • Loading branch information
stuggi committed May 7, 2024
1 parent 09a6145 commit 31b40f7
Show file tree
Hide file tree
Showing 2 changed files with 163 additions and 0 deletions.
28 changes: 28 additions & 0 deletions modules/common/service/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,13 @@ limitations under the License.
package service

import (
"fmt"
"time"

"golang.org/x/exp/slices"

corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/util/validation/field"
)

// Endpoint - typedef to enumerate Endpoint verbs
Expand Down Expand Up @@ -60,6 +64,30 @@ func (e *Endpoint) String() string {
return string(*e)
}

// Validate - validates if the endpoint is an allowed one.
func (e *Endpoint) Validate() error {
if !slices.Contains([]Endpoint{EndpointInternal, EndpointPublic}, *e) {
return fmt.Errorf("invalid endpoint type: %s", e.String())
}
return nil
}

// ValidateRoutedOverrides - validates map of RoutedOverrideSpec
func ValidateRoutedOverrides(basePath *field.Path, overrides map[Endpoint]RoutedOverrideSpec) field.ErrorList {
allErrs := field.ErrorList{}

// validate the service override key is valid
for k := range overrides {
path := basePath.Child("override").Child("service").Key(k.String())

if err := k.Validate(); err != nil {
allErrs = append(allErrs, field.Invalid(path, k.String(), err.Error()))
}
}

return allErrs
}

func (p *Protocol) String() string {
return string(*p)
}
Expand Down
135 changes: 135 additions & 0 deletions modules/common/service/types_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
/*
Copyright 2024 Red Hat
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.
*/

// +kubebuilder:object:generate:=true

package service

import (
"fmt"
"testing"

. "github.com/onsi/gomega"
"k8s.io/apimachinery/pkg/util/validation/field"
)

func TestEndpointValidate(t *testing.T) {
tests := []struct {
name string
e Endpoint
want error
}{
{
name: "Valid endpoint",
e: EndpointInternal,
want: nil,
},
{
name: "Wrong endpoint",
e: Endpoint("wrooong"),
want: fmt.Errorf("invalid endpoint type: wrooong"),
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
g := NewWithT(t)

if tt.want == nil {
g.Expect(tt.e.Validate()).To(Succeed())
} else {
g.Expect(tt.e.Validate()).To(Equal(tt.want))
}
})
}
}

func TestValidateRoutedOverrides(t *testing.T) {
basePath := field.NewPath("spec")

tests := []struct {
name string
overrides map[Endpoint]RoutedOverrideSpec
want field.ErrorList
}{
{
name: "Valid override config",
overrides: map[Endpoint]RoutedOverrideSpec{
EndpointInternal: {},
},
want: field.ErrorList{},
},
{
name: "Wrong override endpoint",
overrides: map[Endpoint]RoutedOverrideSpec{
Endpoint("wrooong"): {},
},
want: field.ErrorList{
&field.Error{
Type: field.ErrorTypeInvalid,
Field: "spec.override.service[wrooong]",
BadValue: "wrooong",
Detail: "invalid endpoint type: wrooong",
},
},
},
{
name: "Both good and wrong override endpoint configs",
overrides: map[Endpoint]RoutedOverrideSpec{
EndpointInternal: {},
Endpoint("wrooong"): {},
},
want: field.ErrorList{
&field.Error{
Type: field.ErrorTypeInvalid,
Field: "spec.override.service[wrooong]",
BadValue: "wrooong",
Detail: "invalid endpoint type: wrooong",
},
},
},
{
name: "Multiple wrong override endpoints",
overrides: map[Endpoint]RoutedOverrideSpec{
EndpointInternal: {},
Endpoint("wrooong"): {},
Endpoint("wroooooong"): {},
},
want: field.ErrorList{
&field.Error{
Type: field.ErrorTypeInvalid,
Field: "spec.override.service[wrooong]",
BadValue: "wrooong",
Detail: "invalid endpoint type: wrooong",
},
&field.Error{
Type: field.ErrorTypeInvalid,
Field: "spec.override.service[wroooooong]",
BadValue: "wroooooong",
Detail: "invalid endpoint type: wroooooong",
},
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
g := NewWithT(t)

g.Expect(ValidateRoutedOverrides(basePath, tt.overrides)).To(Equal(tt.want))
})
}
}

0 comments on commit 31b40f7

Please sign in to comment.