fix: normalize {} to [] for slice defaults in CRDs

Signed-off-by: Andrei Kvapil <[email protected]>

Author: kvaps

pkg/crd/markers/validation.go

@@ -552,15 +552,83 @@ func (m Nullable) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
 	return nil
 }
 
+func coerceDefaultValueToSchema(val interface{}, schema *apiext.JSONSchemaProps) interface{} {
+	switch schema.Type {
+	case "array":
+		switch v := val.(type) {
+		case string:
+			s := strings.TrimSpace(v)
+			if s == "[]" || s == "{}" || s == "" {
+				return []interface{}{}
+			}
+			return v
+		case map[string]interface{}:
+			if len(v) == 0 {
+				return []interface{}{}
+			}
+			return v
+		case []interface{}:
+			if schema.Items != nil {
+				if schema.Items.Schema != nil {
+					for i := range v {
+						v[i] = coerceDefaultValueToSchema(v[i], schema.Items.Schema)
+					}
+				} else if len(schema.Items.JSONSchemas) > 0 {
+					for i := range v {
+						if i < len(schema.Items.JSONSchemas) {
+							v[i] = coerceDefaultValueToSchema(v[i], &schema.Items.JSONSchemas[i])
+						}
+					}
+				}
+			}
+			return v
+		default:
+			return val
+		}
+	case "object":
+		switch v := val.(type) {
+		case string:
+			if strings.TrimSpace(v) == "{}" {
+				return map[string]interface{}{}
+			}
+			return v
+		case map[string]interface{}:
+			for name, p := range schema.Properties {
+				if child, ok := v[name]; ok {
+					v[name] = coerceDefaultValueToSchema(child, &p)
+				}
+			}
+			if schema.AdditionalProperties != nil && schema.AdditionalProperties.Schema != nil {
+				for k, child := range v {
+					if _, known := schema.Properties[k]; known {
+						continue
+					}
+					v[k] = coerceDefaultValueToSchema(child, schema.AdditionalProperties.Schema)
+				}
+			}
+			return v
+		default:
+			return val
+		}
+	default:
+		return val
+	}
+}
+
 // Defaults are only valid CRDs created with the v1 API
 func (m Default) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
-	marshalledDefault, err := json.Marshal(m.Value)
+	val := m.Value
+	val = coerceDefaultValueToSchema(val, schema)
+
+	marshalledDefault, err := json.Marshal(val)
 	if err != nil {
 		return err
 	}
+
 	if schema.Type == "array" && string(marshalledDefault) == "{}" {
 		marshalledDefault = []byte("[]")
 	}
+
 	schema.Default = &apiext.JSON{Raw: marshalledDefault}
 	return nil
 }

pkg/crd/testdata/cronjob_types.go

@@ -122,6 +122,14 @@ type CronJobSpec struct {
 	// +kubebuilder:title=DefaultedSlice
 	DefaultedSlice []string `json:"defaultedSlice"`
 
+	// +kubebuilder:default:={"md0":{"gpus":{}}}
+	// Expect: default.md0.gpus == []
+	DefaultedNestedProfiles Profiles `json:"defaultedNestedProfiles,omitempty"`
+
+	// +kubebuilder:default:={"md0":{}}
+	// Expect: default.md0 == []
+	DefaultedNestedSliceMap map[string][]string `json:"defaultedNestedSliceMap,omitempty"`
+
 	// This tests that slice and object defaulting can be performed.
 	// +kubebuilder:default={{nested: {foo: "baz", bar: true}},{nested: {foo: "qux", bar: false}}}
 	// +kubebuilder:example={{nested: {foo: "baz", bar: true}},{nested: {foo: "qux", bar: false}}}
@@ -420,6 +428,15 @@ type CronJobSpec struct {
 	FieldLevelLocalDeclarationOverride LongerString `json:"fieldLevelLocalDeclarationOverride,omitempty"`
 }
 
+// NodeProfile is used to verify nested array defaulting inside an object.
+// gpus is a slice; when default supplies {}, it must become [].
+type NodeProfile struct {
+	Gpus []string `json:"gpus,omitempty"`
+}
+
+// Profiles map verifies nested coercion under properties.
+type Profiles map[string]NodeProfile
+
 type InlineAlias = EmbeddedStruct
 
 // EmbeddedStruct is for testing that embedded struct is handled correctly when it is used through an alias type.

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

@@ -133,6 +133,31 @@ spec:
                   type: string
                 title: '{}'
                 type: array
+              defaultedNestedProfiles:
+                additionalProperties:
+                  description: |-
+                    NodeProfile is used to verify nested array defaulting inside an object.
+                    gpus is a slice; when default supplies {}, it must become [].
+                  properties:
+                    gpus:
+                      items:
+                        type: string
+                      type: array
+                  type: object
+                default:
+                  md0:
+                    gpus: []
+                description: 'Expect: default.md0.gpus == []'
+                type: object
+              defaultedNestedSliceMap:
+                additionalProperties:
+                  items:
+                    type: string
+                  type: array
+                default:
+                  md0: []
+                description: 'Expect: default.md0 == []'
+                type: object
               defaultedObject:
                 default:
                 - nested: