Skip to content

Commit

Permalink
[release-0.26] Default dead letter sink namespace to the object names…
Browse files Browse the repository at this point in the history
…pace (#5907)

* Default dead letter sink namespace to the object namespace

Signed-off-by: Pierangelo Di Pilato <pierangelodipilato@gmail.com>

* Add unit test

Signed-off-by: Pierangelo Di Pilato <pdipilat@redhat.com>

* Run hack/update-codegen.sh

Signed-off-by: Pierangelo Di Pilato <pdipilat@redhat.com>
  • Loading branch information
pierDipi authored Nov 15, 2021
1 parent 27dbb99 commit 3709c3d
Show file tree
Hide file tree
Showing 22 changed files with 463 additions and 19 deletions.
1 change: 1 addition & 0 deletions pkg/apis/config/zz_generated.deepcopy.go

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

28 changes: 28 additions & 0 deletions pkg/apis/duck/v1/delivery_defaults.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
Copyright 2021 The Knative Authors
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.
*/

package v1

import "context"

func (ds *DeliverySpec) SetDefaults(ctx context.Context) {
if ds == nil {
return
}
if ds.DeadLetterSink != nil {
ds.DeadLetterSink.SetDefaults(ctx)
}
}
85 changes: 85 additions & 0 deletions pkg/apis/duck/v1/delivery_defaults_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
/*
Copyright 2021 The Knative Authors
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.
*/

package v1

import (
"context"
"testing"

"github.com/google/go-cmp/cmp"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"knative.dev/pkg/apis"
duckv1 "knative.dev/pkg/apis/duck/v1"
)

func TestDeliverySpecSetDefaults(t *testing.T) {
t.Parallel()

tt := []struct {
name string
given *DeliverySpec
want *DeliverySpec
ctx context.Context
}{
{
name: "nil",
ctx: context.Background(),
},
{
name: "deadLetterSink nil",
ctx: context.Background(),
given: &DeliverySpec{},
want: &DeliverySpec{},
},
{
name: "deadLetterSink.ref nil",
ctx: context.Background(),
given: &DeliverySpec{DeadLetterSink: &duckv1.Destination{}},
want: &DeliverySpec{DeadLetterSink: &duckv1.Destination{}},
},
{
name: "deadLetterSink.ref.namespace empty string",
ctx: apis.WithinParent(context.Background(), metav1.ObjectMeta{Name: "b", Namespace: "custom"}),
given: &DeliverySpec{DeadLetterSink: &duckv1.Destination{
Ref: &duckv1.KReference{
Kind: "Service",
Namespace: "",
Name: "svc",
APIVersion: "v1",
},
}},
want: &DeliverySpec{DeadLetterSink: &duckv1.Destination{
Ref: &duckv1.KReference{
Kind: "Service",
Namespace: "custom",
Name: "svc",
APIVersion: "v1",
},
}},
},
}

for _, tc := range tt {
tc := tc
t.Run(tc.name, func(t *testing.T) {
tc.given.SetDefaults(tc.ctx)
if diff := cmp.Diff(tc.want, tc.given); diff != "" {
t.Error("(-want, +got)", diff)
}
})
}
}
1 change: 1 addition & 0 deletions pkg/apis/duck/v1/zz_generated.deepcopy.go

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

1 change: 1 addition & 0 deletions pkg/apis/duck/v1beta1/zz_generated.deepcopy.go

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

4 changes: 3 additions & 1 deletion pkg/apis/eventing/v1/broker_defaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,10 @@ import (

eventingduckv1 "knative.dev/eventing/pkg/apis/duck/v1"

"knative.dev/pkg/apis"

"knative.dev/eventing/pkg/apis/config"
"knative.dev/eventing/pkg/apis/eventing"
"knative.dev/pkg/apis"
)

func (b *Broker) SetDefaults(ctx context.Context) {
Expand Down Expand Up @@ -53,4 +54,5 @@ func (bs *BrokerSpec) SetDefaults(ctx context.Context) {
if bs.Config != nil {
bs.Config.SetDefaults(ctx)
}
bs.Delivery.SetDefaults(ctx)
}
59 changes: 58 additions & 1 deletion pkg/apis/eventing/v1/broker_defaults_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,16 @@ import (
"testing"

"k8s.io/utils/pointer"

eventingduckv1 "knative.dev/eventing/pkg/apis/duck/v1"

"github.com/google/go-cmp/cmp"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

duckv1 "knative.dev/pkg/apis/duck/v1"

"knative.dev/eventing/pkg/apis/config"
"knative.dev/eventing/pkg/apis/eventing"
duckv1 "knative.dev/pkg/apis/duck/v1"
)

var (
Expand Down Expand Up @@ -404,6 +406,61 @@ func TestBrokerSetDefaults(t *testing.T) {
},
},
},
"missing deadLetterSink.ref.namespace, defaulted": {
initial: Broker{
ObjectMeta: metav1.ObjectMeta{Name: "broker", Namespace: "custom"},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Kind: "ConfigMap",
Name: "natss-channel",
Namespace: "custom1",
APIVersion: "v1",
},
Delivery: &eventingduckv1.DeliverySpec{
DeadLetterSink: &duckv1.Destination{
Ref: &duckv1.KReference{
Kind: "Service",
Name: "handle-error",
APIVersion: "serving.knative.dev/v1",
},
},
Retry: pointer.Int32Ptr(5),
BackoffPolicy: (*eventingduckv1.BackoffPolicyType)(pointer.StringPtr("linear")),
BackoffDelay: pointer.StringPtr("5s"),
},
},
},
expected: Broker{
ObjectMeta: metav1.ObjectMeta{
Name: "broker",
Namespace: "custom",
Annotations: map[string]string{
eventing.BrokerClassKey: "MTChannelBasedBroker",
},
},
Spec: BrokerSpec{
Config: &duckv1.KReference{
Kind: "ConfigMap",
Namespace: "custom1",
Name: "natss-channel",
APIVersion: "v1",
},
Delivery: &eventingduckv1.DeliverySpec{
DeadLetterSink: &duckv1.Destination{
Ref: &duckv1.KReference{
Kind: "Service",
Namespace: "custom",
Name: "handle-error",
APIVersion: "serving.knative.dev/v1",
},
},
Retry: pointer.Int32Ptr(5),
BackoffPolicy: (*eventingduckv1.BackoffPolicyType)(pointer.StringPtr("linear")),
BackoffDelay: pointer.StringPtr("5s"),
},
},
},
},
}
for n, tc := range testCases {
t.Run(n, func(t *testing.T) {
Expand Down
1 change: 1 addition & 0 deletions pkg/apis/eventing/v1/trigger_defaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ func (ts *TriggerSpec) SetDefaults(ctx context.Context) {
}
// Default the Subscriber namespace
ts.Subscriber.SetDefaults(ctx)
ts.Delivery.SetDefaults(ctx)
}

func setLabels(t *Trigger) {
Expand Down
46 changes: 46 additions & 0 deletions pkg/apis/eventing/v1/trigger_defaults_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ import (
duckv1 "knative.dev/pkg/apis/duck/v1"

"github.com/google/go-cmp/cmp"

eventingduckv1 "knative.dev/eventing/pkg/apis/duck/v1"
)

var (
Expand Down Expand Up @@ -80,6 +82,50 @@ func TestTriggerDefaults(t *testing.T) {
},
}},
},
"deadLetterSink, ns defaulted": {
initial: Trigger{
ObjectMeta: metav1.ObjectMeta{
Namespace: "custom",
},
Spec: TriggerSpec{
Delivery: &eventingduckv1.DeliverySpec{
DeadLetterSink: &duckv1.Destination{
Ref: &duckv1.KReference{
Name: "foo",
},
},
},
Broker: otherBroker,
Subscriber: duckv1.Destination{
Ref: &duckv1.KReference{
Name: "foo",
Namespace: "custom1",
},
}}},
expected: Trigger{
ObjectMeta: v1.ObjectMeta{
Namespace: "custom",
Labels: map[string]string{brokerLabel: otherBroker},
},
Spec: TriggerSpec{
Broker: otherBroker,
Filter: emptyTriggerFilter,
Delivery: &eventingduckv1.DeliverySpec{
DeadLetterSink: &duckv1.Destination{
Ref: &duckv1.KReference{
Name: "foo",
Namespace: "custom",
},
},
},
Subscriber: duckv1.Destination{
Ref: &duckv1.KReference{
Name: "foo",
Namespace: "custom1",
},
},
}},
},
"nil broker and nil filter": {
initial: Trigger{},
expected: defaultTrigger,
Expand Down
1 change: 1 addition & 0 deletions pkg/apis/eventing/v1/zz_generated.deepcopy.go

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

1 change: 1 addition & 0 deletions pkg/apis/eventing/v1beta1/zz_generated.deepcopy.go

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

1 change: 1 addition & 0 deletions pkg/apis/flows/v1/zz_generated.deepcopy.go

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

1 change: 1 addition & 0 deletions pkg/apis/messaging/config/zz_generated.deepcopy.go

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

4 changes: 3 additions & 1 deletion pkg/apis/messaging/v1/channel_defaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ package v1
import (
"context"

"knative.dev/pkg/apis"

"knative.dev/eventing/pkg/apis/messaging"
"knative.dev/eventing/pkg/apis/messaging/config"
"knative.dev/pkg/apis"
)

func (c *Channel) SetDefaults(ctx context.Context) {
Expand All @@ -48,6 +49,7 @@ func (cs *ChannelSpec) SetDefaults(ctx context.Context) {
c.Spec,
}
}
cs.Delivery.SetDefaults(ctx)
}

// ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not
Expand Down
5 changes: 4 additions & 1 deletion pkg/apis/messaging/v1/in_memory_channel_defaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ package v1
import (
"context"

"knative.dev/pkg/apis"

"knative.dev/eventing/pkg/apis/messaging"
)

Expand All @@ -35,9 +37,10 @@ func (imc *InMemoryChannel) SetDefaults(ctx context.Context) {
imc.Annotations[messaging.SubscribableDuckVersionAnnotation] = "v1"
}

ctx = apis.WithinParent(ctx, imc.ObjectMeta)
imc.Spec.SetDefaults(ctx)
}

func (imcs *InMemoryChannelSpec) SetDefaults(ctx context.Context) {
// TODO: Nothing to default here...
imcs.Delivery.SetDefaults(ctx)
}
Loading

0 comments on commit 3709c3d

Please sign in to comment.