-
Notifications
You must be signed in to change notification settings - Fork 630
Add validation for bus parameter names #165
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.
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
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| /* | ||
| * Copyright 2018 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 webhook | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/golang/glog" | ||
| "github.com/knative/eventing/pkg/apis/channels/v1alpha1" | ||
| "github.com/mattbaird/jsonpatch" | ||
| "k8s.io/apimachinery/pkg/util/validation" | ||
| ) | ||
|
|
||
| var ( | ||
| errInvalidBusInput = errors.New("failed to convert input into Bus or ClusterBus") | ||
| errInternalNilBus = errors.New("unexpected internal error: nil Bus or ClusterBus") | ||
| ) | ||
|
|
||
| // ValidateBus is Bus resource specific validation and mutation handler | ||
| func ValidateBus(ctx context.Context) ResourceCallback { | ||
| return func(patches *[]jsonpatch.JsonPatchOperation, old GenericCRD, new GenericCRD) error { | ||
| oldBus, newBus, err := unmarshalBuses(ctx, old, new, "ValidateBus") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return validateBus(oldBus, newBus) | ||
| } | ||
| } | ||
|
|
||
| func validateBus(old, new v1alpha1.GenericBus) error { | ||
| if new.GetSpec().Parameters != nil { | ||
| if new.GetSpec().Parameters.Channel != nil { | ||
| for _, p := range *new.GetSpec().Parameters.Channel { | ||
| errs := validation.IsConfigMapKey(p.Name) | ||
| if len(errs) > 0 { | ||
| return fmt.Errorf("invalid parameter name Spec.Parameters.Channel.%s: %s", p.Name, | ||
| strings.Join(errs, ", ")) | ||
| } | ||
| } | ||
| } | ||
| if new.GetSpec().Parameters.Subscription != nil { | ||
| for _, p := range *new.GetSpec().Parameters.Subscription { | ||
| errs := validation.IsConfigMapKey(p.Name) | ||
| if len(errs) > 0 { | ||
| return fmt.Errorf("invalid parameter name Spec.Parameters.Subscription.%s: %s", p.Name, | ||
| strings.Join(errs, ", ")) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func unmarshalBuses( | ||
| ctx context.Context, old, new GenericCRD, fnName string) (v1alpha1.GenericBus, v1alpha1.GenericBus, error) { | ||
| var oldBus v1alpha1.GenericBus | ||
| if old != nil { | ||
| var ok bool | ||
| oldBus, ok = old.(v1alpha1.GenericBus) | ||
| if !ok { | ||
| return nil, nil, errInvalidBusInput | ||
| } | ||
| } | ||
| glog.Infof("%s: OLD Bus is\n%+v", fnName, oldBus) | ||
|
|
||
| if new == nil { | ||
| return nil, nil, errInternalNilBus | ||
| } | ||
| newBus, ok := new.(v1alpha1.GenericBus) | ||
| if !ok { | ||
| return nil, nil, errInvalidBusInput | ||
| } | ||
| glog.Infof("%s: NEW Bus is\n%+v", fnName, newBus) | ||
|
|
||
| return oldBus, newBus, nil | ||
| } |
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
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.
ValidateBus looks like it will only work for Bus and not ClusterBus. There is a GenericBus interface that is implemented by both bus types.
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.
Ah, correct.
BTW, why isn't
ClusterBusa type alias ofBus?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.
BusandClusterBusstructs share a common spec, but are different types. TheGenericBusinterface has a method to get the spec, which you can then validate.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.
I realize they're different (conceptual) types. But we leveraged type aliases for some of the parts that they share (Spec) but not the rest, hence my question