fix array schema type

emilgelman · Oct 23, 2021 · b3ea6c3 · b3ea6c3
1 parent cb219e9
commit b3ea6c3
Show file tree

Hide file tree

Showing 4 changed files with 118 additions and 5 deletions.
diff --git a/pkg/mapper/mapper.go b/pkg/mapper/mapper.go
@@ -6,6 +6,8 @@ import (
 	"k8s.io/kube-openapi/pkg/validation/spec"
 )
 
+const array = "array"
+
 type Mapper struct {
 }
 
@@ -57,6 +59,12 @@ func (m *Mapper) parseDefinition(rootName, name string, openapiSchema *spec.Sche
 			tfSchema[i] = &schema.Schema{Type: schema.TypeList, Elem: &schema.Resource{Schema: ss}}
 			continue
 		}
+		if prop.SchemaProps.Type[0] == array {
+			path := prop.SchemaProps.Items.Schema.Ref.Ref.GetURL().Path
+			ss := schemas[path]
+			tfSchema[i] = &schema.Schema{Type: schema.TypeList, Elem: &ss}
+			continue
+		}
 		m.parseDefinition(rootName, i, &prop, tfSchema, schemas)
 	}
 	if name == rootName {
@@ -73,6 +81,8 @@ func (m *Mapper) parseDefinition(rootName, name string, openapiSchema *spec.Sche
 	switch tType {
 	case "object":
 		newSchema.Type = schema.TypeMap
+	case array:
+		newSchema.Type = schema.TypeList
 	case "string":
 		newSchema.Type = schema.TypeString
 	}

diff --git a/pkg/mapper/mapper_test.go b/pkg/mapper/mapper_test.go
@@ -3,6 +3,7 @@ package mapper
 import (
 	"testing"
 
+	"github.com/go-openapi/jsonreference"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/stretchr/testify/assert"
 	"k8s.io/kube-openapi/pkg/common"
@@ -41,3 +42,75 @@ func TestMapper(t *testing.T) {
 	}
 	assert.Equal(t, expected, output)
 }
+
+func TestMapArrayDefinition(t *testing.T) {
+	m := New()
+	ref := func(path string) spec.Ref {
+		return spec.Ref{Ref: jsonreference.MustCreateRef(path)}
+	}
+	definitions := map[string]common.OpenAPIDefinition{
+		"engineSpec": {
+			Schema: spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Type: []string{"object"},
+					Properties: map[string]spec.Schema{
+						"cylinders": {
+							SchemaProps: spec.SchemaProps{
+								Type: []string{"array"},
+								Items: &spec.SchemaOrArray{
+									Schema: &spec.Schema{
+										SchemaProps: spec.SchemaProps{
+											Default: map[string]interface{}{},
+											Ref:     ref("cylinder"),
+										},
+									},
+								},
+							},
+						},
+					},
+					Required: []string{"cylinders"},
+				},
+			},
+			Dependencies: []string{
+				"cylinder"},
+		},
+		"cylinder": {
+			Schema: spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Type: []string{"object"},
+					Properties: map[string]spec.Schema{
+						"Number": {
+							SchemaProps: spec.SchemaProps{
+								Default: "",
+								Type:    []string{"string"},
+								Format:  "",
+							},
+						},
+					},
+					Required: []string{"Number"},
+				},
+			},
+		},
+	}
+	output := m.Map(definitions)
+	expected := map[string]map[string]*schema.Schema{
+		"engineSpec": {
+			"cylinders": &schema.Schema{
+				Type:     schema.TypeList,
+				Required: true,
+				Elem: &map[string]*schema.Schema{
+					"Number": {
+						Type:     schema.TypeString,
+						Required: true,
+					},
+				},
+			},
+		},
+		"cylinder": {
+			"Number": &schema.Schema{
+				Type:     schema.TypeString,
+				Required: true,
+			}},
+	}
+	assert.Equal(t, expected, output)
+}
diff --git a/test/input/types.go b/test/input/types.go
@@ -9,5 +9,11 @@ type Car struct {
 
 // +k8s:openapi-gen=true
 type EngineSpec struct {
-	BHP string `json:"bhp"`
+	BHP       string     `json:"bhp"`
+	Cylinders []Cylinder `json:"cylinders"`
+}
+
+// +k8s:openapi-gen=true
+type Cylinder struct {
+	Number string
 }
diff --git a/test/integration_test.go b/test/integration_test.go
@@ -10,21 +10,45 @@ import (
 )
 
 var expectedSchemas = map[string]map[string]*schema.Schema{
-	"GetEngineSpecSchema": {"bhp": &schema.Schema{
-		Type:     schema.TypeString,
-		Required: true,
-	}},
+	"GetEngineSpecSchema": {
+		"bhp": &schema.Schema{
+			Type:     schema.TypeString,
+			Required: true,
+		},
+		"cylinders": &schema.Schema{
+			Type:     schema.TypeList,
+			Required: true,
+			Elem: &map[string]*schema.Schema{"Number": {
+				Type:     schema.TypeString,
+				Required: true,
+			}},
+		},
+	},
 	"GetCarSchema": {
 		"engineSpec": &schema.Schema{
 			Type:     schema.TypeList,
 			Required: true,
 			Elem: &schema.Resource{Schema: map[string]*schema.Schema{
 				"bhp": {Type: schema.TypeString, Required: true},
+				"cylinders": {
+					Type:     schema.TypeList,
+					Required: true,
+					Elem: &map[string]*schema.Schema{"Number": {
+						Type:     schema.TypeString,
+						Required: true,
+					}},
+				},
 			}},
 		},
 		"make":  &schema.Schema{Type: schema.TypeString, Required: true},
 		"model": &schema.Schema{Type: schema.TypeString},
 	},
+	"GetCylinderSchema": {
+		"Number": &schema.Schema{
+			Type:     schema.TypeString,
+			Required: true,
+		},
+	},
 }
 
 func TestGenerator(t *testing.T) {