update validations to dns subdomain

Signed-off-by: everettraven <[email protected]>

Author: everettraven

api/v1alpha1/clusterextension_types.go

@@ -142,10 +142,10 @@ type CatalogSource struct {
 	// packageName is a reference to the name of the package to be installed
 	// and is used to filter the content from catalogs.
 	//
-	// This field is required, immutable and follows the DNS label standard as
-	// defined in [RFC 1123]. This means that valid values:
-	//   - Contain no more than 63 characters
-	//   - Contain only lowercase alphanumeric characters or '-'
+	// This field is required, immutable and follows the DNS subdomain name
+	// standard as defined in [RFC 1123]. This means that valid entries:
+	//   - Contain no more than 253 characters
+	//   - Contain only lowercase alphanumeric characters, '-', or '.'
 	//   - Start with an alphanumeric character
 	//   - End with an alphanumeric character
 	//
@@ -163,8 +163,8 @@ type CatalogSource struct {
 	//
 	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
 	//
-	//+kubebuilder:validation:MaxLength:=63
-	//+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+	//+kubebuilder:validation:MaxLength:=253
+	//+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="packageName is immutable"
 	PackageName string `json:"packageName"`
 
@@ -262,11 +262,10 @@ type CatalogSource struct {
 	//
 	// When unspecified, upgrade edges across all channels will be used to identify valid automatic upgrade paths.
 	//
-	// This field follows the DNS label name standard as defined in [RFC 1123]
-	// with the addition of '.' and '_' characters being allowed.
-	// This means that valid values:
-	//   - Contain no more than 63 characters
-	//   - Contain only lowercase alphanumeric characters, '-', '.', or '_'
+	// This field follows the DNS subdomain name standard as defined in [RFC
+	// 1123]. This means that valid entries:
+	//   - Contain no more than 253 characters
+	//   - Contain only lowercase alphanumeric characters, '-', or '.'
 	//   - Start with an alphanumeric character
 	//   - End with an alphanumeric character
 	//
@@ -279,17 +278,18 @@ type CatalogSource struct {
 	//   - dev-preview
 	//   - preview
 	//   - community
-	//   - original_40
 	//
 	// Some examples of invalid values are:
 	//   - -some-channel
 	//   - some-channel-
 	//   - thisisareallylongchannelnamethatisgreaterthanthemaximumlength
+	//   - original_40
+	//   - --default-channel
 	//
 	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
 	//
-	//+kubebuilder:validation:MaxLength:=63
-	//+kubebuilder:validation:Pattern:=^[a-z0-9]([\._\-a-z0-9]*[a-z0-9])?$
+	//+kubebuilder:validation:MaxLength:=253
+	//+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
 	//+optional
 	Channel string `json:"channel,omitempty"`
 
@@ -335,8 +335,8 @@ type ServiceAccountReference struct {
 	//
 	// This ServiceAccount is expected to exist in the installNamespace.
 	//
-	// This field follows the DNS subdomain name standard as defined in RFC
-	// 1123. This means that valid values:
+	// This field follows the DNS subdomain name standard as defined in [RFC
+	// 1123]. This means that valid values:
 	//   - Contain no more than 253 characters
 	//   - Contain only lowercase alphanumeric characters, '-', or '.'
 	//   - Start with an alphanumeric character
@@ -353,6 +353,8 @@ type ServiceAccountReference struct {
 	//   - -some-serviceaccount
 	//   - some-serviceaccount-
 	//
+	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
+	//
 	//+kubebuilder:validation:MaxLength:=253
 	//+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="name is immutable"

config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml

@@ -135,8 +135,8 @@ spec:
 
                       This ServiceAccount is expected to exist in the installNamespace.
 
-                      This field follows the DNS subdomain name standard as defined in RFC
-                      1123. This means that valid values:
+                      This field follows the DNS subdomain name standard as defined in [RFC
+                      1123]. This means that valid values:
                         - Contain no more than 253 characters
                         - Contain only lowercase alphanumeric characters, '-', or '.'
                         - Start with an alphanumeric character
@@ -152,6 +152,8 @@ spec:
                       Some examples of invalid values are:
                         - -some-serviceaccount
                         - some-serviceaccount-
+
+                      [RFC 1123]: https://tools.ietf.org/html/rfc1123
                     maxLength: 253
                     pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
                     type: string
@@ -198,11 +200,10 @@ spec:
 
                           When unspecified, upgrade edges across all channels will be used to identify valid automatic upgrade paths.
 
-                          This field follows the DNS label name standard as defined in [RFC 1123]
-                          with the addition of '.' and '_' characters being allowed.
-                          This means that valid values:
-                            - Contain no more than 63 characters
-                            - Contain only lowercase alphanumeric characters, '-', '.', or '_'
+                          This field follows the DNS subdomain name standard as defined in [RFC
+                          1123]. This means that valid entries:
+                            - Contain no more than 253 characters
+                            - Contain only lowercase alphanumeric characters, '-', or '.'
                             - Start with an alphanumeric character
                             - End with an alphanumeric character
 
@@ -215,26 +216,27 @@ spec:
                             - dev-preview
                             - preview
                             - community
-                            - original_40
 
                           Some examples of invalid values are:
                             - -some-channel
                             - some-channel-
                             - thisisareallylongchannelnamethatisgreaterthanthemaximumlength
+                            - original_40
+                            - --default-channel
 
                           [RFC 1123]: https://tools.ietf.org/html/rfc1123
-                        maxLength: 63
-                        pattern: ^[a-z0-9]([\._\-a-z0-9]*[a-z0-9])?$
+                        maxLength: 253
+                        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
                         type: string
                       packageName:
                         description: |-
                           packageName is a reference to the name of the package to be installed
                           and is used to filter the content from catalogs.
 
-                          This field is required, immutable and follows the DNS label standard as
-                          defined in [RFC 1123]. This means that valid values:
-                            - Contain no more than 63 characters
-                            - Contain only lowercase alphanumeric characters or '-'
+                          This field is required, immutable and follows the DNS subdomain name
+                          standard as defined in [RFC 1123]. This means that valid entries:
+                            - Contain no more than 253 characters
+                            - Contain only lowercase alphanumeric characters, '-', or '.'
                             - Start with an alphanumeric character
                             - End with an alphanumeric character
 
@@ -251,8 +253,8 @@ spec:
                             - some.package
 
                           [RFC 1123]: https://tools.ietf.org/html/rfc1123
-                        maxLength: 63
-                        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+                        maxLength: 253
+                        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
                         type: string
                         x-kubernetes-validations:
                         - message: packageName is immutable

internal/controllers/clusterextension_admission_test.go

@@ -72,7 +72,7 @@ func TestClusterExtensionSourceConfig(t *testing.T) {
 }
 
 func TestClusterExtensionAdmissionPackageName(t *testing.T) {
-	tooLongError := "spec.source.catalog.packageName: Too long: may not be longer than 63"
+	tooLongError := "spec.source.catalog.packageName: Too long: may not be longer than 253"
 	regexMismatchError := "spec.source.catalog.packageName in body should match"
 
 	testCases := []struct {
@@ -81,7 +81,7 @@ func TestClusterExtensionAdmissionPackageName(t *testing.T) {
 		errMsg  string
 	}{
 		{"no package name", "", regexMismatchError},
-		{"long package name", strings.Repeat("x", 64), tooLongError},
+		{"long package name", strings.Repeat("x", 254), tooLongError},
 		{"leading digits with hypens", "0my-1package-9name", ""},
 		{"trailing digits with hypens", "my0-package1-name9", ""},
 		{"digits with hypens", "012-345-678-9", ""},
@@ -94,6 +94,8 @@ func TestClusterExtensionAdmissionPackageName(t *testing.T) {
 		{"single hypen", "-", regexMismatchError},
 		{"uppercase letters", "ABC-DEF-GHI-JKL", regexMismatchError},
 		{"special characters", "my-$pecial-package-name", regexMismatchError},
+		{"dot separated", "some.package", ""},
+		{"underscore separated", "some_package", regexMismatchError},
 	}
 
 	t.Parallel()
@@ -223,7 +225,7 @@ func TestClusterExtensionAdmissionVersion(t *testing.T) {
 }
 
 func TestClusterExtensionAdmissionChannel(t *testing.T) {
-	tooLongError := "spec.source.catalog.channel: Too long: may not be longer than 63"
+	tooLongError := "spec.source.catalog.channel: Too long: may not be longer than 253"
 	regexMismatchError := "spec.source.catalog.channel in body should match"
 
 	testCases := []struct {
@@ -235,7 +237,7 @@ func TestClusterExtensionAdmissionChannel(t *testing.T) {
 		{"hypen-separated", "hyphenated-name", ""},
 		{"dot-separated", "dotted.name", ""},
 		{"includes version", "channel-has-version-1.0.1", ""},
-		{"long channel name", strings.Repeat("x", 64), tooLongError},
+		{"long channel name", strings.Repeat("x", 254), tooLongError},
 		{"spaces", "spaces spaces", regexMismatchError},
 		{"capitalized", "Capitalized", regexMismatchError},
 		{"camel case", "camelCase", regexMismatchError},
@@ -244,6 +246,7 @@ func TestClusterExtensionAdmissionChannel(t *testing.T) {
 		{"ends with hyphen", "end-with-hyphen-", regexMismatchError},
 		{"starts with period", ".start-with-period", regexMismatchError},
 		{"ends with period", "end-with-period.", regexMismatchError},
+		{"contains underscore", "some_thing", regexMismatchError},
 	}
 
 	t.Parallel()