pkg/crd: support validating internal list items on list types

For kubernetes-sigs#342

Signed-off-by: Alexander Yastrebov <alexander.yastrebov@zalando.de>

pkg/crd/markers/validation.go

@@ -53,6 +53,10 @@ var ValidationMarkers = mustMakeAllWithPrefix("kubebuilder:validation", markers.
 	MinLength(0),
 	Pattern(""),
 
+	ItemMaxLength(0),
+	ItemMinLength(0),
+	ItemPattern(""),
+
 	// slice markers
 
 	MaxItems(0),
@@ -168,6 +172,18 @@ type MinLength int
 // Pattern specifies that this string must match the given regular expression.
 type Pattern string
 
+// +controllertools:marker:generateHelp:category="CRD validation"
+// ItemMinLength specifies the minimum length for string items of this array.
+type ItemMinLength MinLength
+
+// +controllertools:marker:generateHelp:category="CRD validation"
+// ItemMaxLength specifies the maximum length for string items of this array.
+type ItemMaxLength MaxLength
+
+// +controllertools:marker:generateHelp:category="CRD validation"
+// ItemPattern specifies that this array string items must match the given regular expression.
+type ItemPattern Pattern
+
 // +controllertools:marker:generateHelp:category="CRD validation"
 // MaxItems specifies the maximum length for this list.
 type MaxItems int
@@ -266,7 +282,7 @@ type XEmbeddedResource struct{}
 // IntOrString marks a fields as an IntOrString.
 //
 // This is required when applying patterns or other validations to an IntOrString
-// field. Knwon information about the type is applied during the collapse phase
+// field. Known information about the type is applied during the collapse phase
 // and as such is not normally available during marker application.
 type XIntOrString struct{}
 
@@ -387,6 +403,27 @@ func (m Pattern) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
 	return nil
 }
 
+func (m ItemMinLength) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
+	if schema.Type != "array" || schema.Items == nil || schema.Items.Schema == nil {
+		return fmt.Errorf("must apply ItemMinLength to a string array")
+	}
+	return MinLength(m).ApplyToSchema(schema.Items.Schema)
+}
+
+func (m ItemMaxLength) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
+	if schema.Type != "array" || schema.Items == nil || schema.Items.Schema == nil {
+		return fmt.Errorf("must apply ItemMaxLength to a string array")
+	}
+	return MaxLength(m).ApplyToSchema(schema.Items.Schema)
+}
+
+func (m ItemPattern) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
+	if schema.Type != "array" || schema.Items == nil || schema.Items.Schema == nil {
+		return fmt.Errorf("must apply ItemPattern to a string array")
+	}
+	return Pattern(m).ApplyToSchema(schema.Items.Schema)
+}
+
 func (m MaxItems) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
 	if schema.Type != "array" {
 		return fmt.Errorf("must apply maxitem to an array")
@@ -510,6 +547,11 @@ func (m XEmbeddedResource) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
 // which means the "XIntOrString" marker *must* be applied first.
 
 func (m XIntOrString) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
+	if schema.Type == "array" &&
+		schema.Items != nil &&
+		schema.Items.Schema != nil {
+		schema = schema.Items.Schema
+	}
 	schema.XIntOrString = true
 	return nil
 }

pkg/crd/testdata/cronjob_types.go

@@ -252,6 +252,24 @@ type CronJobSpec struct {
 
 	// Checks that arrays work when the type contains a composite literal
 	ArrayUsingCompositeLiteral [len(struct{ X [3]int }{}.X)]string `json:"arrayUsingCompositeLiteral,omitempty"`
+
+	// This tests string slice item validation.
+	// +kubebuilder:validation:ItemMinLength=1
+	// +kubebuilder:validation:ItemMaxLength=255
+	// +kubebuilder:validation:ItemPattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?([.][a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+	Hosts []string `json:"hosts,omitempty"`
+
+	HostsAlias Hosts `json:"hostsAlias,omitempty"`
+
+	// This tests string alias slice item validation.
+	LongerStringArray []LongerString `json:"longerStringArray,omitempty"`
+
+	// This tests that a slice of IntOrString can also have a pattern attached to it.
+	// This can be useful if you want to limit the string to a perecentage or integer.
+	// The XIntOrString marker is a requirement for having a pattern on this type.
+	// +kubebuilder:validation:XIntOrString
+	// +kubebuilder:validation:ItemPattern="^((100|[0-9]{1,2})%|[0-9]+)$"
+	IntOrStringArrayWithAPattern []*intstr.IntOrString `json:"intOrStringArrayWithAPattern,omitempty"`
 }
 
 type ContainsNestedMap struct {
@@ -360,6 +378,12 @@ type LongerString string
 // TotallyABool is a bool that serializes as a string.
 type TotallyABool bool
 
+// This tests string slice item validation.
+// +kubebuilder:validation:ItemMinLength=1
+// +kubebuilder:validation:ItemMaxLength=255
+// +kubebuilder:validation:ItemPattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?([.][a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+type Hosts []string
+
 func (t TotallyABool) MarshalJSON() ([]byte, error) {
 	if t {
 		return []byte(`"true"`), nil

pkg/crd/testdata/testdata.kubebuilder.io_cronjobs.yaml

@@ -196,12 +196,40 @@ spec:
                 description: This tests that exported fields are not skipped in the
                   schema generation
                 type: string
+              hosts:
+                description: This tests string slice item validation.
+                items:
+                  maxLength: 255
+                  minLength: 1
+                  pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?([.][a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                  type: string
+                type: array
+              hostsAlias:
+                description: This tests string slice item validation.
+                items:
+                  maxLength: 255
+                  minLength: 1
+                  pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?([.][a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                  type: string
+                type: array
               int32WithValidations:
                 format: int32
                 maximum: 2
                 minimum: -2
                 multipleOf: 2
                 type: integer
+              intOrStringArrayWithAPattern:
+                description: |-
+                  This tests that a slice of IntOrString can also have a pattern attached to it.
+                  This can be useful if you want to limit the string to a perecentage or integer.
+                  The XIntOrString marker is a requirement for having a pattern on this type.
+                items:
+                  anyOf:
+                  - type: integer
+                  - type: string
+                  pattern: ^((100|[0-9]{1,2})%|[0-9]+)$
+                  x-kubernetes-int-or-string: true
+                type: array
               intOrStringWithAPattern:
                 anyOf:
                 - type: integer
@@ -6609,6 +6637,14 @@ spec:
                 - bar
                 - foo
                 type: object
+              longerStringArray:
+                description: This tests string alias slice item validation.
+                items:
+                  description: This tests that markers that are allowed on both fields
+                    and types are applied to types
+                  minLength: 4
+                  type: string
+                type: array
               mapOfArraysOfFloats:
                 additionalProperties:
                   items: