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

validation: take parentRef.port into account #1995

Merged
merged 4 commits into from
May 5, 2023
Merged

validation: take parentRef.port into account #1995

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
b9228d9
validation: take parentRef.port into account
howardjohn May 4, 2023
ac4a2fb
add test
howardjohn May 4, 2023
175cfd6
typo
howardjohn May 5, 2023
e5c6544
fix test
howardjohn May 5, 2023
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
34 changes: 26 additions & 8 deletions apis/v1beta1/validation/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,30 +35,48 @@ func ValidateParentRefs(parentRefs []gatewayv1b1.ParentReference, path *field.Pa
namespace gatewayv1b1.Namespace
kind gatewayv1b1.Kind
}
parentRefsSectionMap := make(map[sameKindParentRefs][]gatewayv1b1.SectionName)
type parentQualifier struct {
section gatewayv1b1.SectionName
port gatewayv1b1.PortNumber
}
parentRefsSectionMap := make(map[sameKindParentRefs]sets.Set[parentQualifier])
for i, p := range parentRefs {
targetParentRefs := sameKindParentRefs{name: p.Name, namespace: *new(gatewayv1b1.Namespace), kind: *new(gatewayv1b1.Kind)}
targetSection := new(gatewayv1b1.SectionName)
pq := parentQualifier{}
if p.Namespace != nil {
targetParentRefs.namespace = *p.Namespace
}
if p.Kind != nil {
targetParentRefs.kind = *p.Kind
}
if p.SectionName != nil {
targetSection = p.SectionName
pq.section = *p.SectionName
}
if p.Port != nil {
pq.port = *p.Port
}
if s, ok := parentRefsSectionMap[targetParentRefs]; ok {
if len(s[0]) == 0 || len(*targetSection) == 0 {
errs = append(errs, field.Required(path.Child("parentRefs"), "sectionNames must be specified when more than one parentRef refers to the same parent"))
if s.UnsortedList()[0] == (parentQualifier{}) || pq == (parentQualifier{}) {
errs = append(errs, field.Required(path.Child("parentRefs"), "sectionNames or ports must be specified when more than one parentRef refers to the same parent"))
return errs
}
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"))
if s.Has(pq) {
fieldPath := path.Index(i).Child("parentRefs")
var val any
if len(pq.section) > 0 {
fieldPath = fieldPath.Child("sectionName")
val = pq.section
} else {
fieldPath = fieldPath.Child("port")
val = pq.port
}
errs = append(errs, field.Invalid(fieldPath, val, "must be unique when ParentRefs includes 2 or more references to the same parent"))
return errs
}
parentRefsSectionMap[targetParentRefs].Insert(pq)
} else {
parentRefsSectionMap[targetParentRefs] = sets.New(pq)
}
parentRefsSectionMap[targetParentRefs] = append(parentRefsSectionMap[targetParentRefs], *targetSection)
}
return errs
}
Expand Down
110 changes: 98 additions & 12 deletions apis/v1beta1/validation/common_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package validation

import (
"strings"
"testing"

"k8s.io/apimachinery/pkg/util/validation/field"
Expand All @@ -36,7 +37,7 @@ func TestValidateParentRefs(t *testing.T) {
tests := []struct {
name string
parentRefs []gatewayv1b1.ParentReference
errCount int
err string
}{{
name: "valid ParentRefs includes 1 reference",
parentRefs: []gatewayv1b1.ParentReference{
Expand All @@ -47,7 +48,7 @@ func TestValidateParentRefs(t *testing.T) {
SectionName: &sectionA,
},
},
errCount: 0,
err: "",
}, {
name: "valid ParentRefs includes 2 references",
parentRefs: []gatewayv1b1.ParentReference{
Expand All @@ -64,7 +65,7 @@ func TestValidateParentRefs(t *testing.T) {
SectionName: &sectionB,
},
},
errCount: 0,
err: "",
}, {
name: "valid ParentRefs when different references have the same section name",
parentRefs: []gatewayv1b1.ParentReference{
Expand All @@ -81,7 +82,7 @@ func TestValidateParentRefs(t *testing.T) {
SectionName: &sectionA,
},
},
errCount: 0,
err: "",
}, {
name: "valid ParentRefs includes more references to the same parent",
parentRefs: []gatewayv1b1.ParentReference{
Expand All @@ -104,7 +105,7 @@ func TestValidateParentRefs(t *testing.T) {
SectionName: &sectionC,
},
},
errCount: 0,
err: "",
}, {
name: "invalid ParentRefs due to the same section names to the same parentRefs",
parentRefs: []gatewayv1b1.ParentReference{
Expand All @@ -121,7 +122,7 @@ func TestValidateParentRefs(t *testing.T) {
SectionName: &sectionA,
},
},
errCount: 1,
err: "must be unique when ParentRefs",
}, {
name: "invalid ParentRefs due to section names not set to the same ParentRefs",
parentRefs: []gatewayv1b1.ParentReference{
Expand All @@ -132,7 +133,7 @@ func TestValidateParentRefs(t *testing.T) {
Name: "example",
},
},
errCount: 1,
err: "sectionNames or ports must be specified",
}, {
name: "invalid ParentRefs due to more same section names to the same ParentRefs",
parentRefs: []gatewayv1b1.ParentReference{
Expand All @@ -157,7 +158,7 @@ func TestValidateParentRefs(t *testing.T) {
SectionName: &sectionA,
},
},
errCount: 1,
err: "sectionNames or ports must be specified",
}, {
name: "invalid ParentRefs when one ParentRef section name not set to the same ParentRefs",
parentRefs: []gatewayv1b1.ParentReference{
Expand All @@ -172,7 +173,7 @@ func TestValidateParentRefs(t *testing.T) {
SectionName: &sectionA,
},
},
errCount: 1,
err: "sectionNames or ports must be specified",
}, {
name: "invalid ParentRefs when next ParentRef section name not set to the same ParentRefs",
parentRefs: []gatewayv1b1.ParentReference{
Expand All @@ -187,7 +188,84 @@ func TestValidateParentRefs(t *testing.T) {
SectionName: nil,
},
},
errCount: 1,
err: "sectionNames or ports must be specified",
}, {
name: "valid ParentRefs with multiple port references to the same parent",
parentRefs: []gatewayv1b1.ParentReference{
{
Name: "example",
Namespace: &namespace,
Port: ptrTo(gatewayv1b1.PortNumber(80)),
},
{
Name: "example",
Namespace: &namespace,
Port: ptrTo(gatewayv1b1.PortNumber(81)),
},
},
err: "",
}, {
name: "valid ParentRefs with multiple mixed references to the same parent",
robscott marked this conversation as resolved.
Show resolved Hide resolved
parentRefs: []gatewayv1b1.ParentReference{
{
Name: "example",
Namespace: &namespace,
Port: ptrTo(gatewayv1b1.PortNumber(80)),
},
{
Name: "example",
Namespace: &namespace,
SectionName: &sectionA,
},
},
err: "",
}, {
name: "invalid ParentRefs due to same port references to the same parent",
parentRefs: []gatewayv1b1.ParentReference{
{
Name: "example",
Namespace: &namespace,
Port: ptrTo(gatewayv1b1.PortNumber(80)),
},
{
Name: "example",
Namespace: &namespace,
Port: ptrTo(gatewayv1b1.PortNumber(80)),
},
},
err: "port: Invalid value: 80: must be unique when ParentRefs",
}, {
name: "invalid ParentRefs due to mixed port references to the same parent",
parentRefs: []gatewayv1b1.ParentReference{
{
Name: "example",
Namespace: &namespace,
Port: ptrTo(gatewayv1b1.PortNumber(80)),
},
{
Name: "example",
Namespace: &namespace,
Port: nil,
},
},
err: "Required value: sectionNames or ports must be specified",
}, {
name: "valid ParentRefs with multiple same port references to different section of a parent",
parentRefs: []gatewayv1b1.ParentReference{
{
Name: "example",
Namespace: &namespace,
Port: ptrTo(gatewayv1b1.PortNumber(80)),
SectionName: &sectionA,
},
{
Name: "example",
Namespace: &namespace,
Port: ptrTo(gatewayv1b1.PortNumber(80)),
SectionName: &sectionB,
},
},
err: "",
}}

for _, tc := range tests {
Expand All @@ -196,8 +274,16 @@ func TestValidateParentRefs(t *testing.T) {
ParentRefs: tc.parentRefs,
}
errs := ValidateParentRefs(spec.ParentRefs, path.Child("spec"))
if len(errs) != tc.errCount {
t.Errorf("got %d errors, want %d errors: %s", len(errs), tc.errCount, errs)
if tc.err == "" {
if len(errs) != 0 {
t.Errorf("got %d errors, want none: %s", len(errs), errs)
}
} else {
if errs == nil {
t.Errorf("got no errors, want %q", tc.err)
} else if !strings.Contains(errs.ToAggregate().Error(), tc.err) {
t.Errorf("got %d errors, want %q: %s", len(errs), tc.err, errs)
}
}
})
}
Expand Down