Skip to content

Commit

Permalink
fix(apache#4336): Restrict Knative binding provider execution
Browse files Browse the repository at this point in the history
- Only run the binding provider when Knative is installed on the cluster
- Only run the binding provider when referencing a known Knative resource (e.g. broker, channel, service)
  • Loading branch information
christophd committed May 8, 2023
1 parent 05ba24e commit ac7672b
Show file tree
Hide file tree
Showing 2 changed files with 183 additions and 0 deletions.
28 changes: 28 additions & 0 deletions pkg/util/bindings/knative_ref.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ import (
v1 "github.com/apache/camel-k/v2/pkg/apis/camel/v1"
knativeapis "github.com/apache/camel-k/v2/pkg/apis/camel/v1/knative"
v1alpha1 "github.com/apache/camel-k/v2/pkg/apis/camel/v1alpha1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/runtime/schema"

"github.com/apache/camel-k/v2/pkg/util/knative"
"github.com/apache/camel-k/v2/pkg/util/uri"
Expand All @@ -46,6 +48,17 @@ func (k KnativeRefBindingProvider) Translate(ctx BindingContext, endpointCtx End
return nil, nil
}

if ok, err := isKnownKnativeResource(e.Ref); !ok {
// only operates on known Knative endpoint resources (e.g. channels, brokers)
return nil, err
}

if knativeInstalled, _ := knative.IsInstalled(ctx.Client); !knativeInstalled {
// works only when Knative is installed
return nil, errors.New(fmt.Sprintf("integration referencing Knative endpoint '%s' that cannot run, "+
"because Knative is not installed on the cluster", e.Ref.Name))
}

serviceType, err := knative.GetServiceType(*e.Ref)
if err != nil {
return nil, err
Expand Down Expand Up @@ -97,6 +110,21 @@ func (k KnativeRefBindingProvider) Translate(ctx BindingContext, endpointCtx End
}, nil
}

func isKnownKnativeResource(ref *corev1.ObjectReference) (bool, error) {
gv, err := schema.ParseGroupVersion(ref.APIVersion)
if err != nil {
return false, err
}

for _, endpoint := range knative.KnownEndpointKinds {
if endpoint.Group == gv.Group && endpoint.Kind == ref.Kind {
return true, nil
}
}

return false, nil
}

// Order --.
func (k KnativeRefBindingProvider) Order() int {
// Executes as last, as it can be used as fallback for all unknown object references
Expand Down
155 changes: 155 additions & 0 deletions pkg/util/bindings/knative_ref_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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 bindings

import (
"context"
"fmt"
"testing"

"github.com/apache/camel-k/v2/pkg/util/test"
"github.com/stretchr/testify/assert"
v1 "k8s.io/api/core/v1"

camelv1 "github.com/apache/camel-k/v2/pkg/apis/camel/v1"
)

func TestKnativeRefBinding(t *testing.T) {
testcases := []struct {
endpoint camelv1.Endpoint
uri string
}{
{
endpoint: camelv1.Endpoint{
Ref: &v1.ObjectReference{
Kind: "Broker",
Name: "default",
APIVersion: "eventing.knative.dev/v1",
},
},
uri: "knative:event?apiVersion=eventing.knative.dev%2Fv1&kind=Broker&name=default",
},
{
endpoint: camelv1.Endpoint{
Ref: &v1.ObjectReference{
Kind: "Channel",
Name: "mychannel",
APIVersion: "messaging.knative.dev/v1",
},
},
uri: "knative:channel/mychannel?apiVersion=messaging.knative.dev%2Fv1&kind=Channel",
},
{
endpoint: camelv1.Endpoint{
Ref: &v1.ObjectReference{
Kind: "Service",
Name: "myservice",
APIVersion: "serving.knative.dev/v1",
},
},
uri: "knative:endpoint/myservice?apiVersion=serving.knative.dev%2Fv1&kind=Service",
},
}

for i, tc := range testcases {
t.Run(fmt.Sprintf("test-%d-%s", i, tc.endpoint.Ref.Kind), func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

client, err := test.NewFakeClient()
assert.NoError(t, err)

bindingContext := BindingContext{
Ctx: ctx,
Client: client,
Namespace: "test",
Profile: camelv1.TraitProfileKnative,
}

binding, err := KnativeRefBindingProvider{}.Translate(bindingContext, EndpointContext{
Type: camelv1.EndpointTypeSink,
}, tc.endpoint)
assert.NoError(t, err)
assert.NotNil(t, binding)
assert.Equal(t, tc.uri, binding.URI)
assert.Equal(t, camelv1.Traits{}, binding.Traits)
})
}
}

func TestUnsupportedKnativeResource(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

client, err := test.NewFakeClient()
assert.NoError(t, err)

bindingContext := BindingContext{
Ctx: ctx,
Client: client,
Namespace: "test",
Profile: camelv1.TraitProfileKnative,
}

endpoint := camelv1.Endpoint{
Ref: &v1.ObjectReference{
Kind: "Unknown",
Name: "default",
APIVersion: "eventing.knative.dev/v1",
},
}

binding, err := KnativeRefBindingProvider{}.Translate(bindingContext, EndpointContext{
Type: camelv1.EndpointTypeSink,
}, endpoint)
assert.NoError(t, err)
assert.Nil(t, binding)
}

func TestKnativeNotInstalled(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

client, err := test.NewFakeClient()
assert.NoError(t, err)

// disable the knative service api
fakeClient := client.(*test.FakeClient) //nolint
fakeClient.DisableAPIGroupDiscovery("serving.knative.dev/v1")

bindingContext := BindingContext{
Ctx: ctx,
Client: client,
Namespace: "test",
Profile: camelv1.TraitProfileKnative,
}

endpoint := camelv1.Endpoint{
Ref: &v1.ObjectReference{
Kind: "Broker",
Name: "default",
APIVersion: "eventing.knative.dev/v1",
},
}

binding, err := KnativeRefBindingProvider{}.Translate(bindingContext, EndpointContext{
Type: camelv1.EndpointTypeSink,
}, endpoint)
assert.Error(t, err, "integration referencing Knative endpoint 'default' that cannot run, because Knative is not installed on the cluster")
assert.Nil(t, binding)
}

0 comments on commit ac7672b

Please sign in to comment.