101 lines
3.5 KiB
Go
101 lines
3.5 KiB
Go
/*
|
|
Copyright 2025 The Kubernetes 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 content
|
|
|
|
import (
|
|
"regexp"
|
|
"strings"
|
|
)
|
|
|
|
const labelKeyCharFmt string = "[A-Za-z0-9]"
|
|
const labelKeyExtCharFmt string = "[-A-Za-z0-9_.]"
|
|
const labelKeyFmt string = "(" + labelKeyCharFmt + labelKeyExtCharFmt + "*)?" + labelKeyCharFmt
|
|
const labelKeyErrMsg string = "must consist of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character"
|
|
const labelKeyMaxLength int = 63
|
|
|
|
var labelKeyRegexp = regexp.MustCompile("^" + labelKeyFmt + "$")
|
|
|
|
// IsQualifiedName tests whether the value passed is what Kubernetes calls a
|
|
// "qualified name", which is the same as a label key.
|
|
//
|
|
// Deprecated: use IsLabelKey instead.
|
|
var IsQualifiedName = IsLabelKey
|
|
|
|
// IsLabelKey tests whether the value passed is a valid label key. This format
|
|
// is used to validate many fields in the Kubernetes API.
|
|
// Label keys consist of an optional prefix and a name, separated by a '/'.
|
|
// If the value is not valid, a list of error strings is returned. Otherwise, an
|
|
// empty list (or nil) is returned.
|
|
func IsLabelKey(value string) []string {
|
|
var errs []string
|
|
parts := strings.Split(value, "/")
|
|
var name string
|
|
switch len(parts) {
|
|
case 1:
|
|
name = parts[0]
|
|
case 2:
|
|
var prefix string
|
|
prefix, name = parts[0], parts[1]
|
|
if len(prefix) == 0 {
|
|
errs = append(errs, "prefix part "+EmptyError())
|
|
} else if msgs := IsDNS1123Subdomain(prefix); len(msgs) != 0 {
|
|
errs = append(errs, prefixEach(msgs, "prefix part ")...)
|
|
}
|
|
default:
|
|
return append(errs, "a valid label key "+RegexError(labelKeyErrMsg, labelKeyFmt, "MyName", "my.name", "123-abc")+
|
|
" with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')")
|
|
}
|
|
|
|
if len(name) == 0 {
|
|
errs = append(errs, "name part "+EmptyError())
|
|
} else if len(name) > labelKeyMaxLength {
|
|
errs = append(errs, "name part "+MaxLenError(labelKeyMaxLength))
|
|
}
|
|
if !labelKeyRegexp.MatchString(name) {
|
|
errs = append(errs, "name part "+RegexError(labelKeyErrMsg, labelKeyFmt, "MyName", "my.name", "123-abc"))
|
|
}
|
|
return errs
|
|
}
|
|
|
|
const labelValueFmt string = "(" + labelKeyFmt + ")?"
|
|
const labelValueErrMsg string = "a valid label must be an empty string or consist of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character"
|
|
|
|
// LabelValueMaxLength is a label's max length
|
|
const LabelValueMaxLength int = 63
|
|
|
|
var labelValueRegexp = regexp.MustCompile("^" + labelValueFmt + "$")
|
|
|
|
// IsLabelValue tests whether the value passed is a valid label value. If
|
|
// the value is not valid, a list of error strings is returned. Otherwise an
|
|
// empty list (or nil) is returned.
|
|
func IsLabelValue(value string) []string {
|
|
var errs []string
|
|
if len(value) > LabelValueMaxLength {
|
|
errs = append(errs, MaxLenError(LabelValueMaxLength))
|
|
}
|
|
if !labelValueRegexp.MatchString(value) {
|
|
errs = append(errs, RegexError(labelValueErrMsg, labelValueFmt, "MyValue", "my_value", "12345"))
|
|
}
|
|
return errs
|
|
}
|
|
|
|
func prefixEach(msgs []string, prefix string) []string {
|
|
for i := range msgs {
|
|
msgs[i] = prefix + msgs[i]
|
|
}
|
|
return msgs
|
|
}
|