Skip to content

Add validation for vpcID in tgb spec #3663

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
merged 4 commits into from
May 7, 2024
Merged

Add validation for vpcID in tgb spec #3663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
875793d
Add validation for vpcID in tgb spec
shraddhabang Apr 23, 2024
65a4dde
Add validation for vpcID in tgb spec
shraddhabang Apr 23, 2024
c317d25
Merge branch 'kubernetes-sigs:main' into main
shraddhabang May 2, 2024
57a49d9
Addressing comments
shraddhabang May 2, 2024
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
6 changes: 6 additions & 0 deletions webhooks/elbv2/targetgroupbinding_validator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package elbv2

import (
"context"
"regexp"
"strings"

awssdk "github.com/aws/aws-sdk-go/aws"
Expand All @@ -20,6 +21,8 @@ import (

const apiPathValidateELBv2TargetGroupBinding = "/validate-elbv2-k8s-aws-v1beta1-targetgroupbinding"

var vpcIDPatternRegex = regexp.MustCompile("^(?:vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$")

// NewTargetGroupBindingValidator returns a validator for TargetGroupBinding CRD.
func NewTargetGroupBindingValidator(k8sClient client.Client, elbv2Client services.ELBV2, vpcID string, logger logr.Logger) *targetGroupBindingValidator {
return &targetGroupBindingValidator{
Expand Down Expand Up @@ -165,6 +168,9 @@ func (v *targetGroupBindingValidator) checkTargetGroupVpcID(ctx context.Context,
if tgb.Spec.VpcID == "" {
return nil
}
if !vpcIDPatternRegex.MatchString(tgb.Spec.VpcID) {
return errors.Errorf("ValidationError: vpcID %v failed to satisfy constraint: VPC Id must begin with 'vpc-' followed by 8 or 17 lowercase letters (a-f) or numbers.", tgb.Spec.VpcID)
}
vpcID, err := v.getVpcIDFromAWS(ctx, tgb.Spec.TargetGroupARN)
if err != nil {
return errors.Wrap(err, "unable to get target group VpcID")
Expand Down
34 changes: 23 additions & 11 deletions webhooks/elbv2/targetgroupbinding_validator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func Test_targetGroupBindingValidator_ValidateCreate(t *testing.T) {
}
instanceTargetType := elbv2api.TargetTypeInstance
ipTargetType := elbv2api.TargetTypeIP
clusterVpcID := "vpcid-02"
clusterVpcID := "vpc-123456ab"
tests := []struct {
name string
fields fields
Expand Down Expand Up @@ -264,11 +264,11 @@ func Test_targetGroupBindingValidator_ValidateCreate(t *testing.T) {
TargetGroupARN: "tg-2",
TargetType: &instanceTargetType,
IPAddressType: &targetGroupIPAddressTypeIPv6,
VpcID: "vpcid-01",
VpcID: "vpc-1234567a",
},
},
},
wantErr: errors.New("invalid VpcID vpcid-01 doesnt match VpcID from TargetGroup tg-2"),
wantErr: errors.New("invalid VpcID vpc-1234567a doesnt match VpcID from TargetGroup tg-2"),
},
}
for _, tt := range tests {
Expand Down Expand Up @@ -691,27 +691,27 @@ func Test_targetGroupBindingValidator_checkImmutableFields(t *testing.T) {
wantErr: errors.New("TargetGroupBinding update may not change these fields: spec.ipAddressType"),
},
{
name: "VpcID modified from vpc-01 to vpc-02",
name: "VpcID modified from vpc-0aaaaaaa to vpc-0bbbbbbb",
args: args{
tgb: &elbv2api.TargetGroupBinding{
Spec: elbv2api.TargetGroupBindingSpec{
TargetGroupARN: "tg-2",
TargetType: &ipTargetType,
VpcID: "vpc-02",
VpcID: "vpc-0bbbbbbb",
},
},
oldTGB: &elbv2api.TargetGroupBinding{
Spec: elbv2api.TargetGroupBindingSpec{
TargetGroupARN: "tg-2",
TargetType: &ipTargetType,
VpcID: "vpc-01",
VpcID: "vpc-0aaaaaaa",
},
},
},
wantErr: errors.New("TargetGroupBinding update may not change these fields: spec.vpcID"),
},
{
name: "VpcID modified from vpc-01 to nil",
name: "VpcID modified from vpc-0aaaaaaa to nil",
args: args{
tgb: &elbv2api.TargetGroupBinding{
Spec: elbv2api.TargetGroupBindingSpec{
Expand All @@ -723,20 +723,20 @@ func Test_targetGroupBindingValidator_checkImmutableFields(t *testing.T) {
Spec: elbv2api.TargetGroupBindingSpec{
TargetGroupARN: "tg-2",
TargetType: &ipTargetType,
VpcID: "vpc-01",
VpcID: "vpc-0aaaaaaa",
},
},
},
wantErr: errors.New("TargetGroupBinding update may not change these fields: spec.vpcID"),
},
{
name: "VpcID modified from nil to vpc-01",
name: "VpcID modified from nil to vpc-0aaaaaaa",
args: args{
tgb: &elbv2api.TargetGroupBinding{
Spec: elbv2api.TargetGroupBindingSpec{
TargetGroupARN: "tg-2",
TargetType: &ipTargetType,
VpcID: "vpc-01",
VpcID: "vpc-0aaaaaaa",
},
},
oldTGB: &elbv2api.TargetGroupBinding{
Expand Down Expand Up @@ -1118,12 +1118,24 @@ func Test_targetGroupBindingValidator_checkTargetGroupVpcID(t *testing.T) {
obj: &elbv2api.TargetGroupBinding{
Spec: elbv2api.TargetGroupBindingSpec{
TargetGroupARN: "tg-2",
VpcID: "vpcid-01",
VpcID: "vpc-b234567a",
},
},
},
wantErr: errors.New("unable to get target group VpcID: vpcid not found"),
},
{
name: "[err] vpcID is not valid",
args: args{
obj: &elbv2api.TargetGroupBinding{
Spec: elbv2api.TargetGroupBindingSpec{
TargetGroupARN: "tg-2",
VpcID: "vpcid-123",
},
},
},
wantErr: errors.New("ValidationError: vpcID vpcid-123 failed to satisfy constraint: VPC Id must begin with 'vpc-' followed by 8 or 17 lowercase letters (a-f) or numbers."),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down