Skip to content

🌱 Ensure BMH name is a valid DNS label #2636

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

Open
nerok wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🌱 Ensure BMH name is a valid DNS label #2636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 19 additions & 11 deletions internal/webhooks/metal3.io/v1alpha1/baremetalhost_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
"fmt"
"net"
"net/url"
"regexp"
"slices"
"strings"

Expand All @@ -30,6 +29,7 @@ import (
corev1 "k8s.io/api/core/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime/schema"
k8svalidation "k8s.io/apimachinery/pkg/util/validation"
)

var (
Expand Down Expand Up @@ -61,7 +61,7 @@ func (webhook *BareMetalHost) validateHost(host *metal3api.BareMetalHost) []erro
errs = append(errs, validateBMCAccess(host.Spec, bmcAccess)...)

if err := validateBMHName(host.Name); err != nil {
errs = append(errs, err)
errs = append(errs, err...)
}

if err := validateDNSName(host.Spec.BMC.Address); err != nil {
Expand Down Expand Up @@ -95,7 +95,13 @@ func (webhook *BareMetalHost) validateChanges(oldObj *metal3api.BareMetalHost, n
var errs []error

if err := webhook.validateHost(newObj); err != nil {
errs = append(errs, err...)
for i := range err {
// ignore length check on changes because the name is immutable anyway, and might have been too
// long from before the IsDNS1123Label validation was added.
if err[i].Error() != k8svalidation.MaxLenError(k8svalidation.DNS1123LabelMaxLength) {
errs = append(errs, err[i])
}
}
}

if oldObj.Spec.BMC.Address != "" &&
Expand Down Expand Up @@ -183,18 +189,20 @@ func validateRAID(r *metal3api.RAIDConfig) []error {
return errs
}

func validateBMHName(bmhname string) error {
invalidname, _ := regexp.MatchString(`[^A-Za-z0-9\.\-\_]`, bmhname)
if invalidname {
return errors.New("BareMetalHost resource name cannot contain characters other than [A-Za-z0-9._-]")
}

func validateBMHName(bmhname string) []error {
errorStrings := k8svalidation.IsDNS1123Label(bmhname)
_, err := uuid.Parse(bmhname)

errs := make([]error, 0, len(errorStrings)+1)

if err == nil {
return errors.New("BareMetalHost resource name cannot be a UUID")
errs = []error{errors.New("BareMetalHost resource name cannot be a UUID")}
}
for i := range errorStrings {
errs = append(errs, errors.New(errorStrings[i]))
}

return nil
return errs
}

func validateDNSName(hostaddress string) error {
Expand Down
72 changes: 71 additions & 1 deletion internal/webhooks/metal3.io/v1alpha1/baremetalhost_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ func TestValidateCreate(t *testing.T) {
Namespace: "test-namespace",
}

om2 := metav1.ObjectMeta{
Name: "test-name",
Namespace: "test-namespace",
}

inom := metav1.ObjectMeta{
Name: "test~",
Namespace: "test-namespace",
Expand All @@ -60,6 +65,26 @@ func TestValidateCreate(t *testing.T) {
Namespace: "test-namespace",
}

inom3 := metav1.ObjectMeta{
Name: "-test",
Namespace: "test-namespace",
}

inom4 := metav1.ObjectMeta{
Name: "test-",
Namespace: "test-namespace",
}

inom5 := metav1.ObjectMeta{
Name: "CapitalizedTest",
Namespace: "test-namespace",
}

inom6 := metav1.ObjectMeta{
Name: "verylongnamewhichshouldreachjustpastthelengthlimitof63characters",
Namespace: "test-namespace",
}

enable := true

// for RAID validation test cases
Expand All @@ -77,6 +102,12 @@ func TestValidateCreate(t *testing.T) {
oldBMH: nil,
wantedErr: "",
},
{
name: "valid2",
newBMH: &metal3api.BareMetalHost{TypeMeta: tm, ObjectMeta: om2, Spec: metal3api.BareMetalHostSpec{}},
oldBMH: nil,
wantedErr: "",
},
{
name: "validExternallyProvisioned",
newBMH: &metal3api.BareMetalHost{TypeMeta: tm, ObjectMeta: om, Spec: metal3api.BareMetalHostSpec{ExternallyProvisioned: true}},
Expand All @@ -86,14 +117,38 @@ func TestValidateCreate(t *testing.T) {
name: "invalidName",
newBMH: &metal3api.BareMetalHost{TypeMeta: tm, ObjectMeta: inom, Spec: metal3api.BareMetalHostSpec{}},
oldBMH: nil,
wantedErr: "BareMetalHost resource name cannot contain characters other than [A-Za-z0-9._-]",
wantedErr: "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')",
},
{
name: "invalidName2",
newBMH: &metal3api.BareMetalHost{TypeMeta: tm, ObjectMeta: inom2, Spec: metal3api.BareMetalHostSpec{}},
oldBMH: nil,
wantedErr: "BareMetalHost resource name cannot be a UUID",
},
{
name: "invalidName3LeadingHyphen",
newBMH: &metal3api.BareMetalHost{TypeMeta: tm, ObjectMeta: inom3, Spec: metal3api.BareMetalHostSpec{}},
oldBMH: nil,
wantedErr: "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')",
},
{
name: "invalidName4TrailingHyphen",
newBMH: &metal3api.BareMetalHost{TypeMeta: tm, ObjectMeta: inom4, Spec: metal3api.BareMetalHostSpec{}},
oldBMH: nil,
wantedErr: "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')",
},
{
name: "invalidName5CapitalChars",
newBMH: &metal3api.BareMetalHost{TypeMeta: tm, ObjectMeta: inom5, Spec: metal3api.BareMetalHostSpec{}},
oldBMH: nil,
wantedErr: "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')",
},
{
name: "invalidName6LengthLimitOf63",
newBMH: &metal3api.BareMetalHost{TypeMeta: tm, ObjectMeta: inom6, Spec: metal3api.BareMetalHostSpec{}},
oldBMH: nil,
wantedErr: "must be no more than 63 characters",
},
{
name: "invalidRAID",
newBMH: &metal3api.BareMetalHost{
Expand Down Expand Up @@ -863,6 +918,8 @@ func TestValidateCreate(t *testing.T) {
{
name: "disablePowerOff",
newBMH: &metal3api.BareMetalHost{
TypeMeta: tm,
ObjectMeta: om,
Spec: metal3api.BareMetalHostSpec{
DisablePowerOff: true,
Online: true,
Expand Down Expand Up @@ -903,6 +960,11 @@ func TestValidateUpdate(t *testing.T) {
Namespace: "test-namespace",
}

om2 := metav1.ObjectMeta{
Name: "verylongnamewhichshouldreachjustpastthelengthlimitof63characters",
Namespace: "test-namespace",
}

tests := []struct {
name string
newBMH *metal3api.BareMetalHost
Expand Down Expand Up @@ -978,6 +1040,14 @@ func TestValidateUpdate(t *testing.T) {
TypeMeta: tm, ObjectMeta: om, Spec: metal3api.BareMetalHostSpec{ExternallyProvisioned: true}},
wantedErr: "externallyProvisioned can not be changed",
},
{
name: "tooLongNameShouldBeAllowedOnChange",
newBMH: &metal3api.BareMetalHost{
TypeMeta: tm, ObjectMeta: om2, Spec: metal3api.BareMetalHostSpec{}},
oldBMH: &metal3api.BareMetalHost{
TypeMeta: tm, ObjectMeta: om2, Spec: metal3api.BareMetalHostSpec{}},
wantedErr: "",
},
}

for _, tt := range tests {
Expand Down