Skip to content

Validate brokerclass exists #3507

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
knative-prow-robot merged 6 commits into from
Jul 6, 2020
Merged

Validate brokerclass exists #3507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
295122c
validate that brokerclass annotations exists
vaikas Jul 4, 2020
cb4b65f
v1beta1 too
vaikas Jul 4, 2020
fc72641
fix testcase names, no code changes
vaikas Jul 4, 2020
33c4ace
fix testcase names, no code changes
vaikas Jul 4, 2020
9e1e3c0
empty annotation test
vaikas Jul 4, 2020
88d79f3
add required annotation for test resource
vaikas Jul 4, 2020
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
9 changes: 8 additions & 1 deletion pkg/apis/eventing/v1/broker_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,14 @@ const (

func (b *Broker) Validate(ctx context.Context) *apis.FieldError {
withNS := apis.AllowDifferentNamespace(apis.WithinParent(ctx, b.ObjectMeta))
return b.Spec.Validate(withNS).ViaField("spec")

// Make sure a BrokerClassAnnotation exists
var errs *apis.FieldError
if bc, ok := b.GetAnnotations()[BrokerClassAnnotationKey]; !ok || bc == "" {
errs = errs.Also(apis.ErrMissingField(BrokerClassAnnotationKey))
}

return errs.Also(b.Spec.Validate(withNS).ViaField("spec"))
}

func (bs *BrokerSpec) Validate(ctx context.Context) *apis.FieldError {
Expand Down
44 changes: 39 additions & 5 deletions pkg/apis/eventing/v1/broker_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ func TestBrokerImmutableFields(t *testing.T) {
"nil original": {
wantErr: nil,
},
"no ChannelTemplateSpec mutation": {
"no BrokerClassAnnotation mutation": {
og: current,
wantErr: nil,
},
"ChannelTemplateSpec mutated": {
"BrokerClassAnnotation mutated": {
og: original,
wantErr: &apis.FieldError{
Message: "Immutable fields changed (-old +new)",
Expand Down Expand Up @@ -80,11 +80,30 @@ func TestValidate(t *testing.T) {
b Broker
want *apis.FieldError
}{{
name: "valid empty",
name: "missing annotation",
b: Broker{},
want: apis.ErrMissingField("eventing.knative.dev/broker.class"),
}, {
name: "empty annotation",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": ""},
},
},
want: apis.ErrMissingField("eventing.knative.dev/broker.class"),
}, {
name: "valid empty",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
},
}, {
name: "valid config",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Namespace: "namespace",
Expand All @@ -97,6 +116,9 @@ func TestValidate(t *testing.T) {
}, {
name: "valid config, no namespace",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Name: "name",
Expand All @@ -108,6 +130,9 @@ func TestValidate(t *testing.T) {
}, {
name: "invalid config, missing name",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Namespace: "namespace",
Expand All @@ -120,6 +145,9 @@ func TestValidate(t *testing.T) {
}, {
name: "invalid config, missing apiVersion",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Namespace: "namespace",
Expand All @@ -132,6 +160,9 @@ func TestValidate(t *testing.T) {
}, {
name: "invalid config, missing kind",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Namespace: "namespace",
Expand All @@ -144,19 +175,22 @@ func TestValidate(t *testing.T) {
}, {
name: "invalid delivery, invalid delay string",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Delivery: &eventingduckv1.DeliverySpec{
BackoffDelay: &invalidString,
},
},
},
want: apis.ErrInvalidValue(invalidString, "spec.delivery.backoffDelay"),
}, {}}
}}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got := test.b.Validate(context.Background())
if diff := cmp.Diff(test.want.Error(), got.Error()); diff != "" {
t.Errorf("BrokerSpec.Validate (-want, +got) = %v", diff)
t.Errorf("Broker.Validate (-want, +got) = %v", diff)
}
})
}
Expand Down
9 changes: 8 additions & 1 deletion pkg/apis/eventing/v1beta1/broker_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,14 @@ const (

func (b *Broker) Validate(ctx context.Context) *apis.FieldError {
withNS := apis.AllowDifferentNamespace(apis.WithinParent(ctx, b.ObjectMeta))
return b.Spec.Validate(withNS).ViaField("spec")

// Make sure a BrokerClassAnnotation exists
var errs *apis.FieldError
if bc, ok := b.GetAnnotations()[BrokerClassAnnotationKey]; !ok || bc == "" {
errs = errs.Also(apis.ErrMissingField(BrokerClassAnnotationKey))
}

return errs.Also(b.Spec.Validate(withNS).ViaField("spec"))
}

func (bs *BrokerSpec) Validate(ctx context.Context) *apis.FieldError {
Expand Down
44 changes: 39 additions & 5 deletions pkg/apis/eventing/v1beta1/broker_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ func TestBrokerImmutableFields(t *testing.T) {
"nil original": {
wantErr: nil,
},
"no ChannelTemplateSpec mutation": {
"no BrokerClassAnnotation mutation": {
og: current,
wantErr: nil,
},
"ChannelTemplateSpec mutated": {
"BrokerClassAnnotation mutated": {
og: original,
wantErr: &apis.FieldError{
Message: "Immutable fields changed (-old +new)",
Expand Down Expand Up @@ -80,11 +80,30 @@ func TestValidate(t *testing.T) {
b Broker
want *apis.FieldError
}{{
name: "valid empty",
name: "missing annotation",
b: Broker{},
want: apis.ErrMissingField("eventing.knative.dev/broker.class"),
}, {
name: "empty annotation",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": ""},
},
},
want: apis.ErrMissingField("eventing.knative.dev/broker.class"),
}, {
name: "valid empty",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
},
}, {
name: "valid config",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Namespace: "namespace",
Expand All @@ -97,6 +116,9 @@ func TestValidate(t *testing.T) {
}, {
name: "valid config, no namespace",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Name: "name",
Expand All @@ -108,6 +130,9 @@ func TestValidate(t *testing.T) {
}, {
name: "invalid config, missing name",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Namespace: "namespace",
Expand All @@ -120,6 +145,9 @@ func TestValidate(t *testing.T) {
}, {
name: "invalid config, missing apiVersion",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Namespace: "namespace",
Expand All @@ -132,6 +160,9 @@ func TestValidate(t *testing.T) {
}, {
name: "invalid config, missing kind",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Namespace: "namespace",
Expand All @@ -144,19 +175,22 @@ func TestValidate(t *testing.T) {
}, {
name: "invalid delivery, invalid delay string",
b: Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
},
Spec: BrokerSpec{
Delivery: &eventingduckv1beta1.DeliverySpec{
BackoffDelay: &invalidString,
},
},
},
want: apis.ErrInvalidValue(invalidString, "spec.delivery.backoffDelay"),
}, {}}
}}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got := test.b.Validate(context.Background())
if diff := cmp.Diff(test.want.Error(), got.Error()); diff != "" {
t.Errorf("BrokerSpec.Validate (-want, +got) = %v", diff)
t.Errorf("Broker.Validate (-want, +got) = %v", diff)
}
})
}
Expand Down
1 change: 1 addition & 0 deletions pkg/reconciler/mtnamespace/resources/broker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ const (
func MakeBroker(ns *corev1.Namespace) *v1beta1.Broker {
return &v1beta1.Broker{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"eventing.knative.dev/broker.class": "MTChannelBasedBroker"},
Copy link
Copy Markdown
Member

@aliok aliok Jul 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some constants available for both of these hardcoded strings if you want to change them.

Copy link
Copy Markdown
Contributor

@n3wscott n3wscott Jul 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#3512

OwnerReferences: []metav1.OwnerReference{
*metav1.NewControllerRef(ns.GetObjectMeta(), schema.GroupVersionKind{
Group: corev1.SchemeGroupVersion.Group,
Expand Down