Add E2E test for default channel #1782
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| // +build e2e | ||
|
|
||
| /* | ||
| Copyright 2019 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 e2e | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "knative.dev/eventing/test/e2e/helpers" | ||
| ) | ||
|
|
||
| // TestChannelClusterDefaulter tests a cluster defaulted channel can be created with the template specified through configmap. | ||
| func TestChannelClusterDefaulter(t *testing.T) { | ||
| helpers.ChannelClusterDefaulterTestHelper(t, channelTestRunner) | ||
| } | ||
|
|
||
| // TestChannelNamespaceDefaulter tests a namespace defaulted channel can be created with the template specified through configmap. | ||
| func TestChannelNamespaceDefaulter(t *testing.T) { | ||
| helpers.ChannelNamespaceDefaulterTestHelper(t, channelTestRunner) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| /* | ||
| Copyright 2019 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 helpers | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/ghodss/yaml" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/util/uuid" | ||
| eventingduck "knative.dev/eventing/pkg/apis/duck/v1alpha1" | ||
| "knative.dev/eventing/pkg/defaultchannel" | ||
| eventingtesting "knative.dev/eventing/pkg/reconciler/testing" | ||
| "knative.dev/eventing/test/base" | ||
| "knative.dev/eventing/test/base/resources" | ||
| "knative.dev/eventing/test/common" | ||
| ) | ||
|
|
||
| const ( | ||
| // configMapName is the name of the ConfigMap that contains the configuration for the default | ||
| // channel CRD. | ||
| configMapName = defaultchannel.ConfigMapName | ||
|
|
||
| // channelDefaulterKey is the key in the ConfigMap to get the name of the default | ||
| // Channel CRD. | ||
| channelDefaulterKey = defaultchannel.ChannelDefaulterKey | ||
| ) | ||
|
|
||
| // ChannelClusterDefaulterTestHelper is the helper function for channel_defaulter_test | ||
| func ChannelClusterDefaulterTestHelper(t *testing.T, channelTestRunner common.ChannelTestRunner) { | ||
| channelTestRunner.RunTests(t, common.FeatureBasic, func(st *testing.T, channel string) { | ||
| // these tests cannot be run in parallel as they have cluster-wide impact | ||
| client := common.Setup(st, false) | ||
| defer common.TearDown(client) | ||
|
|
||
| if err := updateDefaultChannelCM(client, func(conf *defaultchannel.Config) { | ||
| setClusterDefaultChannel(conf, channel) | ||
| }); err != nil { | ||
| st.Fatalf("Failed to update the defaultchannel configmap: %v", err) | ||
| } | ||
|
|
||
| defaultChannelTestHelper(st, client, channel) | ||
| }) | ||
| } | ||
|
|
||
| // ChannelNamespaceDefaulterTestHelper is the helper function for channel_defaulter_test | ||
| func ChannelNamespaceDefaulterTestHelper(t *testing.T, channelTestRunner common.ChannelTestRunner) { | ||
| channelTestRunner.RunTests(t, common.FeatureBasic, func(st *testing.T, channel string) { | ||
| // we cannot run these tests in parallel as the updateDefaultChannelCM function is not thread-safe | ||
| // TODO(Fredy-Z): make updateDefaultChannelCM thread-safe and run in parallel if the tests are taking too long to finish | ||
| client := common.Setup(st, false) | ||
| defer common.TearDown(client) | ||
|
|
||
| if err := updateDefaultChannelCM(client, func(conf *defaultchannel.Config) { | ||
| setNamespaceDefaultChannel(conf, client.Namespace, channel) | ||
| }); err != nil { | ||
| st.Fatalf("Failed to update the defaultchannel configmap: %v", err) | ||
| } | ||
|
|
||
| defaultChannelTestHelper(st, client, channel) | ||
| }) | ||
| } | ||
|
|
||
| func defaultChannelTestHelper(t *testing.T, client *common.Client, expectedChannelKind string) { | ||
| channelName := "e2e-defaulter-channel" | ||
| senderName := "e2e-defaulter-sender" | ||
| subscriptionName := "e2e-defaulter-subscription" | ||
| loggerPodName := "e2e-defaulter-logger-pod" | ||
|
|
||
| // create channel | ||
| client.CreateChannelWithDefaultOrFail(eventingtesting.NewChannel(channelName, client.Namespace)) | ||
|
|
||
| // create logger service as the subscriber | ||
| pod := resources.EventLoggerPod(loggerPodName) | ||
| client.CreatePodOrFail(pod, common.WithService(loggerPodName)) | ||
|
|
||
| // create subscription to subscribe the channel, and forward the received events to the logger service | ||
| client.CreateSubscriptionOrFail( | ||
| subscriptionName, | ||
| channelName, | ||
| common.ChannelTypeMeta, | ||
| resources.WithSubscriberForSubscription(loggerPodName), | ||
| ) | ||
|
|
||
| // wait for all test resources to be ready, so that we can start sending events | ||
| if err := client.WaitForAllTestResourcesReady(); err != nil { | ||
| t.Fatalf("Failed to get all test resources ready: %v", err) | ||
| } | ||
|
|
||
| // check if the defaultchannel creates exactly one underlying channel given the spec | ||
| metaResourceList := resources.NewMetaResourceList(client.Namespace, common.GetChannelTypeMeta(expectedChannelKind)) | ||
| objs, err := base.GetGenericObjectList(client.Dynamic, metaResourceList, &eventingduck.SubscribableType{}) | ||
| if err != nil { | ||
| t.Fatalf("Failed to list the underlying channels: %v", err) | ||
| } | ||
| if len(objs) != 1 { | ||
| t.Fatalf("The defaultchannel is expected to create 1 underlying channel, but got %d", len(objs)) | ||
| } | ||
|
|
||
| // send fake CloudEvent to the channel | ||
| body := fmt.Sprintf("TestSingleEvent %s", uuid.NewUUID()) | ||
| event := &resources.CloudEvent{ | ||
| Source: senderName, | ||
| Type: resources.CloudEventDefaultType, | ||
| Data: fmt.Sprintf(`{"msg":%q}`, body), | ||
| Encoding: resources.CloudEventDefaultEncoding, | ||
| } | ||
|
|
||
| if err := client.SendFakeEventToAddressable(senderName, channelName, common.ChannelTypeMeta, event); err != nil { | ||
| t.Fatalf("Failed to send fake CloudEvent to the channel %q", channelName) | ||
| } | ||
|
|
||
| // verify the logger service receives the event | ||
| if err := client.CheckLog(loggerPodName, common.CheckerContains(body)); err != nil { | ||
| t.Fatalf("String %q not found in logs of logger pod %q: %v", body, loggerPodName, err) | ||
| } | ||
| } | ||
|
|
||
| // updateDefaultChannelCM will update the default channel configmap | ||
| func updateDefaultChannelCM(client *common.Client, updateConfig func(config *defaultchannel.Config)) error { | ||
| systemNamespace := resources.SystemNamespace | ||
| cmInterface := client.Kube.Kube.CoreV1().ConfigMaps(systemNamespace) | ||
| // get the defaultchannel configmap | ||
| configMap, err := cmInterface.Get(configMapName, metav1.GetOptions{}) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // get the defaultchannel config value | ||
| defaultChannelConfig, hasDefault := configMap.Data[channelDefaulterKey] | ||
| config := &defaultchannel.Config{} | ||
| if hasDefault { | ||
| if err := yaml.Unmarshal([]byte(defaultChannelConfig), config); err != nil { | ||
|
Contributor
There was a problem hiding this comment. look at the channelDefaulter.UpdateConfigMap... we are converting the yaml to json, and then doing some update there... I think there was a problem with the casing of the keys otherwise...
Contributor
Author
There was a problem hiding this comment. We'll have to update the |
||
| return err | ||
| } | ||
| } | ||
|
|
||
| // update the defaultchannel config | ||
| updateConfig(config) | ||
| configBytes, err := yaml.Marshal(*config) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // update the defaultchannel configmap | ||
| configMap.Data[channelDefaulterKey] = string(configBytes) | ||
| _, err = cmInterface.Update(configMap) | ||
| return nil | ||
| } | ||
|
|
||
| // setClusterDefaultChannel will set the default channel for cluster-wide | ||
| func setClusterDefaultChannel(config *defaultchannel.Config, channel string) { | ||
| config.ClusterDefault.TypeMeta = *common.GetChannelTypeMeta(channel) | ||
| } | ||
|
|
||
| // setNamespaceDefaultChannel will set the default channel for namespace-wide | ||
| func setNamespaceDefaultChannel(config *defaultchannel.Config, namespace, channel string) { | ||
| namespaceDefaults := config.NamespaceDefaults | ||
| if spec, exists := namespaceDefaults[namespace]; exists { | ||
| spec.TypeMeta = *common.GetChannelTypeMeta(channel) | ||
| } else { | ||
| spec = &eventingduck.ChannelTemplateSpec{ | ||
| TypeMeta: *common.GetChannelTypeMeta(channel), | ||
| } | ||
| namespaceDefaults[namespace] = spec | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you need to do all these programmatic reading and updating of the configMap? and then call the defaulter UpdateConfigMap? Can't you just create a ConfigMap object in memory and set the appropriate value to a key in the Data field?
No need to do it now, but maybe when you add the thread-safety thing...
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I can do that, but I think we still cannot get rid of the
yaml.Unmarshalandyaml.Marshalstuff, since it's not safe to directly change yaml, even in test.