Skip to content

allow invalid ingressClass for update events without ingressClass change. #2005

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

Merged
merged 1 commit into from
May 13, 2021
Merged

allow invalid ingressClass for update events without ingressClass change. #2005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 30 additions & 11 deletions webhooks/networking/ingress_validator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package networking

import (
"context"
awssdk "github.com/aws/aws-sdk-go/aws"
"github.com/go-logr/logr"
"github.com/pkg/errors"
networking "k8s.io/api/networking/v1beta1"
Expand Down Expand Up @@ -54,7 +55,7 @@ func (v *ingressValidator) ValidateCreate(ctx context.Context, obj runtime.Objec
if err := v.checkGroupNameAnnotationUsage(ing, nil); err != nil {
return err
}
if err := v.checkIngressClassUsage(ctx, ing); err != nil {
if err := v.checkIngressClassUsage(ctx, ing, nil); err != nil {
return err
}
return nil
Expand All @@ -69,7 +70,7 @@ func (v *ingressValidator) ValidateUpdate(ctx context.Context, obj runtime.Objec
if err := v.checkGroupNameAnnotationUsage(ing, oldIng); err != nil {
return err
}
if err := v.checkIngressClassUsage(ctx, ing); err != nil {
if err := v.checkIngressClassUsage(ctx, ing, oldIng); err != nil {
return err
}
return nil
Expand Down Expand Up @@ -125,20 +126,38 @@ func (v *ingressValidator) checkGroupNameAnnotationUsage(ing *networking.Ingress
usedInOldIng = true
}
}
if !usedInOldIng && usedInNewIng {
return errors.Errorf("new usage of `%s/%s` annotation is forbidden", annotations.AnnotationPrefixIngress, annotations.IngressSuffixGroupName)
}
if usedInOldIng && usedInNewIng && (oldGroupName != newGroupName) {
return errors.Errorf("new value of `%s/%s` annotation is forbidden", annotations.AnnotationPrefixIngress, annotations.IngressSuffixGroupName)

if usedInNewIng {
if !usedInOldIng || (newGroupName != oldGroupName) {
return errors.Errorf("new usage of `%s/%s` annotation is forbidden", annotations.AnnotationPrefixIngress, annotations.IngressSuffixGroupName)
}
}
return nil
}

func (v *ingressValidator) checkIngressClassUsage(ctx context.Context, ing *networking.Ingress) error {
// checkIngressClassUsage checks the usage of "ingressClassName" field.
// if ingressClassName is mutated, it must refer to a existing & valid IngressClass.
func (v *ingressValidator) checkIngressClassUsage(ctx context.Context, ing *networking.Ingress, oldIng *networking.Ingress) error {
usedInNewIng := false
usedInOldIng := false
newIngressClassName := ""
oldIngressClassName := ""

if ing.Spec.IngressClassName != nil {
_, err := v.classLoader.Load(ctx, ing)
if err != nil {
return err
usedInNewIng = true
newIngressClassName = awssdk.StringValue(ing.Spec.IngressClassName)
}
if oldIng != nil && oldIng.Spec.IngressClassName != nil {
usedInOldIng = true
oldIngressClassName = awssdk.StringValue(oldIng.Spec.IngressClassName)
}

if usedInNewIng {
if !usedInOldIng || (newIngressClassName != oldIngressClassName) {
_, err := v.classLoader.Load(ctx, ing)
if err != nil {
return err
}
}
}
return nil
Expand Down
117 changes: 109 additions & 8 deletions webhooks/networking/ingress_validator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ func Test_ingressValidator_checkGroupNameAnnotationUsage(t *testing.T) {
},
},
},
wantErr: errors.New("new value of `alb.ingress.kubernetes.io/group.name` annotation is forbidden"),
wantErr: errors.New("new usage of `alb.ingress.kubernetes.io/group.name` annotation is forbidden"),
},
}
for _, tt := range tests {
Expand Down Expand Up @@ -479,7 +479,8 @@ func Test_ingressValidator_checkIngressClassUsage(t *testing.T) {
}

type args struct {
ing *networking.Ingress
ing *networking.Ingress
oldIng *networking.Ingress
}
tests := []struct {
name string
Expand All @@ -488,7 +489,7 @@ func Test_ingressValidator_checkIngressClassUsage(t *testing.T) {
wantErr error
}{
{
name: "IngressClassName isn't specified",
name: "ingress creation without IngressClassName",
env: env{},
args: args{
ing: &networking.Ingress{
Expand All @@ -504,7 +505,7 @@ func Test_ingressValidator_checkIngressClassUsage(t *testing.T) {
wantErr: nil,
},
{
name: "IngressClass didn't exists",
name: "ingress creation with IngressClassName that refers to non-existent IngressClass",
env: env{},
args: args{
ing: &networking.Ingress{
Expand All @@ -520,7 +521,7 @@ func Test_ingressValidator_checkIngressClassUsage(t *testing.T) {
wantErr: errors.New("invalid ingress class: ingressclasses.networking.k8s.io \"awesome-class\" not found"),
},
{
name: "IngressClass exists but IngressClassParams unspecified",
name: "ingress creation with IngressClassName that refers to IngressClass without params",
env: env{
ingClassList: []*networking.IngressClass{
{
Expand All @@ -544,7 +545,7 @@ func Test_ingressValidator_checkIngressClassUsage(t *testing.T) {
wantErr: nil,
},
{
name: "IngressClass exists and IngressClassParams exists, and namespaceSelector mismatches",
name: "ingress creation with IngressClassName that refers to IngressClass with IngressClassParams with mismatch namespaceSelector",
env: env{
nsList: []*corev1.Namespace{
{
Expand Down Expand Up @@ -600,7 +601,7 @@ func Test_ingressValidator_checkIngressClassUsage(t *testing.T) {
wantErr: errors.New("invalid ingress class: namespaceSelector of IngressClassParams awesome-class-params mismatch"),
},
{
name: "IngressClass exists and IngressClassParams exists, and namespaceSelector matches",
name: "ingress creation with IngressClassName that refers to IngressClass with IngressClassParams with matches namespaceSelector",
env: env{
nsList: []*corev1.Namespace{
{
Expand Down Expand Up @@ -651,6 +652,106 @@ func Test_ingressValidator_checkIngressClassUsage(t *testing.T) {
},
wantErr: nil,
},
{
name: "ingress updates with removed IngressClassName",
env: env{},
args: args{
ing: &networking.Ingress{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-ing",
},
Spec: networking.IngressSpec{
IngressClassName: nil,
},
},
oldIng: &networking.Ingress{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-ing",
},
Spec: networking.IngressSpec{
IngressClassName: awssdk.String("awesome-class"),
},
},
},
wantErr: nil,
},
{
name: "ingress updates with changed IngressClassName that refers to non-existent IngressClass",
env: env{},
args: args{
ing: &networking.Ingress{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-ing",
},
Spec: networking.IngressSpec{
IngressClassName: awssdk.String("awesome-class"),
},
},
oldIng: &networking.Ingress{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-ing",
},
Spec: networking.IngressSpec{
IngressClassName: awssdk.String("old-awesome-class"),
},
},
},
wantErr: errors.New("invalid ingress class: ingressclasses.networking.k8s.io \"awesome-class\" not found"),
},
{
name: "ingress updates with added IngressClassName that refers to non-existent IngressClass",
env: env{},
args: args{
ing: &networking.Ingress{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-ing",
},
Spec: networking.IngressSpec{
IngressClassName: awssdk.String("awesome-class"),
},
},
oldIng: &networking.Ingress{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-ing",
},
Spec: networking.IngressSpec{
IngressClassName: nil,
},
},
},
wantErr: errors.New("invalid ingress class: ingressclasses.networking.k8s.io \"awesome-class\" not found"),
},
{
name: "ingress updates with unchanged IngressClassName that refers to non-existent IngressClass",
env: env{},
args: args{
ing: &networking.Ingress{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-ing",
},
Spec: networking.IngressSpec{
IngressClassName: awssdk.String("awesome-class"),
},
},
oldIng: &networking.Ingress{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-ing",
},
Spec: networking.IngressSpec{
IngressClassName: awssdk.String("awesome-class"),
},
},
},
wantErr: nil,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand All @@ -675,7 +776,7 @@ func Test_ingressValidator_checkIngressClassUsage(t *testing.T) {
v := &ingressValidator{
classLoader: ingress.NewDefaultClassLoader(k8sClient),
}
err := v.checkIngressClassUsage(ctx, tt.args.ing)
err := v.checkIngressClassUsage(ctx, tt.args.ing, tt.args.oldIng)
if tt.wantErr != nil {
assert.EqualError(t, err, tt.wantErr.Error())
} else {
Expand Down