Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.6.0 review updates #1601

Merged
merged 4 commits into from
Dec 15, 2022
Merged

v0.6.0 review updates #1601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c0e30a
chore: replace "element in set" helper function
shaneutt Dec 14, 2022
a60ec06
refactor: use t.Fatalf instead of Errorf+FailNow
shaneutt Dec 14, 2022
168963d
refactor: improve validation test readability
shaneutt Dec 14, 2022
934faec
chore: run generators
shaneutt Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 7 additions & 29 deletions apis/v1alpha2/validation/tlsroute_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,40 +27,20 @@ import (
func TestValidateTLSRoute(t *testing.T) {
t.Parallel()

portNumber := gatewayv1a2.PortNumber(9080)
var portNumber int32 = 9080

tests := []struct {
name string
rules []gatewayv1a2.TLSRouteRule
errs field.ErrorList
}{
{
name: "valid TLSRoute with 1 backendRef",
rules: []gatewayv1a2.TLSRouteRule{
{
BackendRefs: []gatewayv1a2.BackendRef{
{
BackendObjectReference: gatewayv1a2.BackendObjectReference{
Port: &portNumber,
},
},
},
},
},
name: "valid TLSRoute with 1 backendRef",
rules: makeRouteRules[gatewayv1a2.TLSRouteRule](&portNumber),
},
{
name: "invalid TLSRoute with 1 backendRef (missing port)",
rules: []gatewayv1a2.TLSRouteRule{
{
BackendRefs: []gatewayv1a2.BackendRef{
{
BackendObjectReference: gatewayv1a2.BackendObjectReference{
Port: nil,
},
},
},
},
},
name: "invalid TLSRoute with 1 backendRef (missing port)",
rules: makeRouteRules[gatewayv1a2.TLSRouteRule](nil),
errs: field.ErrorList{
{
Type: field.ErrorTypeRequired,
Expand All @@ -79,15 +59,13 @@ func TestValidateTLSRoute(t *testing.T) {
route := gatewayv1a2.TLSRoute{Spec: gatewayv1a2.TLSRouteSpec{Rules: tc.rules}}
errs := ValidateTLSRoute(&route)
if len(errs) != len(tc.errs) {
t.Errorf("got %d errors, want %d errors: %s", len(errs), len(tc.errs), errs)
t.FailNow()
t.Fatalf("got %d errors, want %d errors: %s", len(errs), len(tc.errs), errs)
}
for i := 0; i < len(errs); i++ {
realErr := errs[i].Error()
expectedErr := tc.errs[i].Error()
if realErr != expectedErr {
t.Errorf("expect error message: %s, but got: %s", expectedErr, realErr)
t.FailNow()
t.Fatalf("expect error message: %s, but got: %s", expectedErr, realErr)
}
}
})
Expand Down
36 changes: 7 additions & 29 deletions apis/v1alpha2/validation/udproute_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,40 +27,20 @@ import (
func TestValidateUDPRoute(t *testing.T) {
t.Parallel()

portNumber := gatewayv1a2.PortNumber(9080)
var portNumber int32 = 9080

tests := []struct {
name string
rules []gatewayv1a2.UDPRouteRule
errs field.ErrorList
}{
{
name: "valid UDPRoute with 1 backendRef",
rules: []gatewayv1a2.UDPRouteRule{
{
BackendRefs: []gatewayv1a2.BackendRef{
{
BackendObjectReference: gatewayv1a2.BackendObjectReference{
Port: &portNumber,
},
},
},
},
},
name: "valid UDPRoute with 1 backendRef",
rules: makeRouteRules[gatewayv1a2.UDPRouteRule](&portNumber),
},
{
name: "invalid UDPRoute with 1 backendRef (missing port)",
rules: []gatewayv1a2.UDPRouteRule{
{
BackendRefs: []gatewayv1a2.BackendRef{
{
BackendObjectReference: gatewayv1a2.BackendObjectReference{
Port: nil,
},
},
},
},
},
name: "invalid UDPRoute with 1 backendRef (missing port)",
rules: makeRouteRules[gatewayv1a2.UDPRouteRule](nil),
errs: field.ErrorList{
{
Type: field.ErrorTypeRequired,
Expand All @@ -79,15 +59,13 @@ func TestValidateUDPRoute(t *testing.T) {
route := gatewayv1a2.UDPRoute{Spec: gatewayv1a2.UDPRouteSpec{Rules: tc.rules}}
errs := ValidateUDPRoute(&route)
if len(errs) != len(tc.errs) {
t.Errorf("got %d errors, want %d errors: %s", len(errs), len(tc.errs), errs)
t.FailNow()
t.Fatalf("got %d errors, want %d errors: %s", len(errs), len(tc.errs), errs)
}
for i := 0; i < len(errs); i++ {
realErr := errs[i].Error()
expectedErr := tc.errs[i].Error()
if realErr != expectedErr {
t.Errorf("expect error message: %s, but got: %s", expectedErr, realErr)
t.FailNow()
t.Fatalf("expect error message: %s, but got: %s", expectedErr, realErr)
}
}
})
Expand Down
27 changes: 18 additions & 9 deletions apis/v1beta1/util/validation/common.go → apis/v1alpha2/validation/utils_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,24 @@ limitations under the License.

package validation

import gatewayv1b1 "sigs.k8s.io/gateway-api/apis/v1beta1"
import (
gatewayv1a2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
"sigs.k8s.io/gateway-api/apis/v1beta1"
)

// ContainsInSectionNameSlice checks whether the provided SectionName
// is in the target SectionName slice.
func ContainsInSectionNameSlice(items []gatewayv1b1.SectionName, item *gatewayv1b1.SectionName) bool {
for _, eachItem := range items {
if eachItem == *item {
return true
}
type routeRule interface {
gatewayv1a2.TLSRouteRule | gatewayv1a2.UDPRouteRule
}

func makeRouteRules[T routeRule](ports ...*int32) (rules []T) {
for _, port := range ports {
rules = append(rules, T{
BackendRefs: []gatewayv1a2.BackendRef{{
BackendObjectReference: gatewayv1a2.BackendObjectReference{
Port: (*v1beta1.PortNumber)(port),
},
}},
})
}
return false
return
}
57 changes: 0 additions & 57 deletions apis/v1beta1/util/validation/common_test.go
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions apis/v1beta1/validation/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ limitations under the License.
package validation

import (
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/validation/field"

gatewayv1b1 "sigs.k8s.io/gateway-api/apis/v1beta1"
utils "sigs.k8s.io/gateway-api/apis/v1beta1/util/validation"
)

// ValidateParentRefs validates ParentRefs SectionName must be set and unique
Expand Down Expand Up @@ -53,8 +53,8 @@ func ValidateParentRefs(parentRefs []gatewayv1b1.ParentReference, path *field.Pa
errs = append(errs, field.Required(path.Child("parentRefs"), "sectionNames must be specified when more than one parentRef refers to the same parent"))
return errs
}
if utils.ContainsInSectionNameSlice(s, targetSection) {
errs = append(errs, field.Invalid(path.Index(i).Child("parentRefs").Child("sectionName"), targetSection, "must be unique when parentRefs includes 2 or more references to the same parent"))
if sets.New(s...).Has(*targetSection) {
errs = append(errs, field.Invalid(path.Index(i).Child("parentRefs").Child("sectionName"), targetSection, "must be unique when ParentRefs includes 2 or more references to the same parent"))
return errs
}
}
Expand Down
30 changes: 16 additions & 14 deletions config/crd/experimental/gateway.networking.k8s.io_gatewayclasses.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

64 changes: 34 additions & 30 deletions config/crd/experimental/gateway.networking.k8s.io_gateways.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading