fix: failed make optional on ancestor node

Signed-off-by: thxCode <thxcode0824@gmail.com>

Author: thxCode

pkg/resourcedefinitions/helper.go

@@ -538,7 +538,11 @@ func refillVariableSchemaRef(
 					return
 				}
 
-				v.Default = def
+				// Refill the default value to the root,
+				// but ignore this refilling when it is an array item.
+				if !strings.HasSuffix(key, ".0") {
+					v.Default = def
+				}
 			}
 
 			for k := range v.Properties {
@@ -575,18 +579,18 @@ func refillVariableSchemaRef(
 			if !strings.HasSuffix(key, ".0") {
 				v.Default = def
 			}
+		}
 
-			// Turn property to optional if found different defaults.
-			pName := pNames[len(pNames)-1]
-			pSchema := pSchemas[len(pSchemas)-1]
-			dropRequired(pSchema, pName)
+		// Turn property to optional if found different defaults.
+		pName := pNames[len(pNames)-1]
+		pSchema := pSchemas[len(pSchemas)-1]
+		dropRequired(pSchema, v, pName)
 
-			// Effect to the parent node also if the node has no required property.
-			if len(pSchema.Required) == 0 && len(pSchemas) > 1 {
-				ppName := pNames[len(pNames)-2]
-				ppSchema := pSchemas[len(pSchemas)-2]
-				dropRequired(ppSchema, ppName)
-			}
+		// Effect to the parent node also if the node has no required property.
+		if len(pSchemas) > 1 {
+			ppName := pNames[len(pNames)-2]
+			ppSchema := pSchemas[len(pSchemas)-2]
+			dropRequired(ppSchema, pSchema, ppName)
 		}
 
 		return
@@ -626,43 +630,50 @@ func refillVariableSchemaRef(
 		// Turn property to optional if found different defaults.
 		pName := pNames[len(pNames)-1]
 		pSchema := pSchemas[len(pSchemas)-1]
-		dropRequired(pSchema, pName)
+		dropRequired(pSchema, v, pName)
 
 		// Effect to the parent node also if the node has no required property.
-		if len(pSchema.Required) == 0 && len(pSchemas) > 1 {
+		if len(pSchemas) > 1 {
 			ppName := pNames[len(pNames)-2]
 			ppSchema := pSchemas[len(pSchemas)-2]
-			dropRequired(ppSchema, ppName)
+			dropRequired(ppSchema, pSchema, ppName)
 		}
 	}
 }
 
-// dropRequired drops the given property name from the required of the schema.
-func dropRequired(s *openapi3.Schema, n string) {
-	switch s.Type {
+// dropRequired drops the given property name from the parent schema required list,
+// if the property schema's required list is empty.
+func dropRequired(parentSchema, propSchema *openapi3.Schema, propName string) {
+	// Return directly, if required list is not empty.
+	if len(propSchema.Required) != 0 {
+		return
+	}
+
+	// Otherwise, drop the property from the required list.
+	switch parentSchema.Type {
 	default:
 		return
 	case openapi3.TypeObject:
 	case openapi3.TypeArray:
-		s = s.Items.Value
+		parentSchema = parentSchema.Items.Value
 	}
 
 	var i int
-	for ; i < len(s.Required); i++ {
-		if s.Required[i] == n {
+	for ; i < len(parentSchema.Required); i++ {
+		if parentSchema.Required[i] == propName {
 			break
 		}
 	}
 
 	switch i {
-	case len(s.Required):
+	case len(parentSchema.Required):
 		return
 	case 0:
-		s.Required = s.Required[1:]
-	case len(s.Required) - 1:
-		s.Required = s.Required[:i]
+		parentSchema.Required = parentSchema.Required[1:]
+	case len(parentSchema.Required) - 1:
+		parentSchema.Required = parentSchema.Required[:i]
 	default:
-		s.Required = append(s.Required[:i], s.Required[i+1:]...)
+		parentSchema.Required = append(parentSchema.Required[:i], parentSchema.Required[i+1:]...)
 	}
 }
 

pkg/resourcedefinitions/testdata/refill_variable_schema_ref/complex/default.1.json

@@ -0,0 +1,37 @@
+{
+  "map": {
+    "key1": "value1",
+    "key2": "value2"
+  },
+  "list_map": [
+    {
+      "key1": "value1"
+    }
+  ],
+  "object_object_complex": {
+    "object": {
+      "object": {
+        "name": "myoperation",
+        "value": "myvalue"
+      }
+    }
+  },
+  "list_object_list_complex": [
+    {
+      "array": [
+        {
+          "name": "myoperation",
+          "value": "myvalue"
+        },
+        {
+          "name": "myoperation2",
+          "value": "myvalue2"
+        }
+      ],
+      "map": {
+        "key1": "value1",
+        "key2": "value2"
+      }
+    }
+  ]
+}

pkg/resourcedefinitions/testdata/refill_variable_schema_ref/complex/default.2.json

@@ -0,0 +1,33 @@
+{
+  "map": {
+    "key2": "value2",
+    "key1": "value1"
+  },
+  "list_map": [
+    {
+      "key1": "value1"
+    }
+  ],
+  "object_object_complex": {
+    "object": {
+      "object": {
+        "name": "myoperation2",
+        "value": "myvalue"
+      }
+    }
+  },
+  "list_object_list_complex": [
+    {
+      "array": [
+        {
+          "name": "myoperation",
+          "value": "myvalue"
+        }
+      ],
+      "map": {
+        "key2": "value2",
+        "key1": "value1"
+      }
+    }
+  ]
+}

pkg/resourcedefinitions/testdata/refill_variable_schema_ref/complex/expected.yaml

@@ -0,0 +1,64 @@
+info:
+  title: OpenAPI schema for resource definition type "dummy"
+  version: v0.0.0
+paths:
+openapi: 3.0.3
+components:
+  schemas:
+    variables:
+      type: object
+      required:
+        - object_object_complex
+      properties:
+        map:
+          type: object
+          additionalProperties:
+            type: string
+        list_map:
+          type: array
+          default:
+            - key1: "value1"
+          items:
+            additionalProperties:
+              type: string
+            type: object
+        object_object_complex:
+          type: object
+          required:
+            - map
+          properties:
+            object:
+              type: object
+              properties:
+                object:
+                  type: object
+                  properties:
+                    name:
+                      type: string
+                    value:
+                      type: string
+                      default: "myvalue"
+                map:
+                  type: object
+                  additionalProperties:
+                    type: string
+        list_object_list_complex:
+          type: array
+          items:
+            type: object
+            properties:
+              array:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    name:
+                      type: string
+                      default: "myoperation"
+                    value:
+                      type: string
+                      default: "myvalue"
+              map:
+                type: object
+                additionalProperties:
+                  type: string

pkg/resourcedefinitions/testdata/refill_variable_schema_ref/complex/given.yaml

@@ -0,0 +1,83 @@
+info:
+  title: OpenAPI schema for resource definition type "dummy"
+  version: v0.0.0
+paths:
+openapi: 3.0.3
+components:
+  schemas:
+    variables:
+      type: object
+      required:
+        - map                      # expected: remove this.
+        - list_map                 # expected: remove this.
+        - object_object_complex
+        - list_object_list_complex # expected: remove this.
+      properties:
+        map:
+          type: object
+          default:                 # expected: remove this, as the given defaults are not the same.
+            key1: "value1"
+            key2: "value2"
+          additionalProperties:
+            type: string
+        list_map:
+          type: array
+          default:                 # expected: replace this, as the given defaults are the same.
+            - key1: "value1"
+            - key2: "value2"
+          items:
+            additionalProperties:
+              type: string
+            type: object
+        object_object_complex:
+          type: object
+          required:
+            - object              # expected: remove this, as there are defaults.
+            - map
+          properties:
+            object:
+              type: object
+                                  # expected: no default, as the given defaults are not the same.
+              properties:
+                object:
+                  type: object
+                  required:       # expected: remove this, as there are defaults.
+                    - name
+                    - value
+                  properties:
+                    name:
+                      type: string
+                    value:
+                      type: string
+                                 # expected: default, as the given defaults are the same.
+                map:
+                  type: object
+                  additionalProperties:
+                    type: string
+        list_object_list_complex:
+          type: array
+          items:
+            type: object
+            required:             # expected: remove this, as there are defaults.
+              - array
+              - map
+            properties:
+              array:
+                type: array
+                items:
+                  type: object
+                  required:       # expected: remove this, as there are defaults.
+                    - name
+                    - value
+                                  # expected: no default, as the given defaults are not the same.
+                  properties:
+                    name:
+                      type: string
+                                  # expected: default, as the given defaults are the same.
+                    value:
+                      type: string
+                                  # expected: default, as the given defaults are the same.
+              map:
+                type: object
+                additionalProperties:
+                  type: string

pkg/resourcedefinitions/testdata/refill_variable_schema_ref/complex/nb.json

@@ -0,0 +1,3 @@
+{
+  "variables": {}
+}

pkg/resourcedefinitions/testdata/refill_variable_schema_ref/optional/default.1.json

@@ -21,17 +21,5 @@
   "infrastructure": {
     "vpc_id": "abc",
     "publicly_accessible": true
-  },
-  "operation_labels": {
-    "key1": "value1",
-    "key2": "value2"
-  },
-  "operation_pool_labels": [
-    {
-      "key1": "value1"
-    },
-    {
-      "key2": "value2"
-    }
-  ]
+  }
 }

pkg/resourcedefinitions/testdata/refill_variable_schema_ref/optional/default.2.json

@@ -21,17 +21,5 @@
   "infrastructure": {
     "vpc_id": "edf",
     "publicly_accessible": true
-  },
-  "operation_labels": {
-    "key1": "value1",
-    "key2": "value2"
-  },
-  "operation_pool_labels": [
-    {
-      "key1": "value1"
-    },
-    {
-      "key2": "value2"
-    }
-  ]
+  }
 }

pkg/resourcedefinitions/testdata/refill_variable_schema_ref/optional/expected.yaml

@@ -275,24 +275,6 @@ components:
             group: Basic
             order: 4
             showIf: architecture=replication
-        operation_labels:
-          default:
-            key1: "value1"
-            key2: "value2"
-          additionalProperties:
-            type: string
-          title: Operation Labels
-          type: object
-        operation_pool_labels:
-          default:
-            - key1: "value1"
-            - key2: "value2"
-          items:
-            additionalProperties:
-              type: string
-            type: object
-          title: Operation Pool Labels
-          type: array
       x-walrus-ui:
         groupOrder:
           - Basic