Merge pull request #170 from Liujingfang1/additionalProperties

Add skipmap flag to skip validation for AdditionlPropperties

Author: droot

cmd/internal/codegen/parse/crd.go

@@ -215,28 +215,36 @@ func (b *APIs) parsePrimitiveValidation(t *types.Type, found sets.String, commen
 	return props, buff.String()
 }
 
+type mapTempateArgs struct {
+	Result string
+	SkipMapValidation bool
+}
+
 var mapTemplate = template.Must(template.New("map-template").Parse(
 	`v1beta1.JSONSchemaProps{
     Type:                 "object",
-    AdditionalProperties: &v1beta1.JSONSchemaPropsOrBool{
+    {{if not .SkipMapValidation}}AdditionalProperties: &v1beta1.JSONSchemaPropsOrBool{
         Allows: true,
-        //Schema: &{{.}},
-    },
+        Schema: &{{.Result}},
+    },{{end}}
 }`))
 
 // parseMapValidation returns a JSONSchemaProps object and its serialization in
 // Go that describe the validations for the given map type.
 func (b *APIs) parseMapValidation(t *types.Type, found sets.String, comments []string) (v1beta1.JSONSchemaProps, string) {
-	additionalProps, _ := b.typeToJSONSchemaProps(t.Elem, found, comments)
+	additionalProps, result := b.typeToJSONSchemaProps(t.Elem, found, comments)
 	props := v1beta1.JSONSchemaProps{
 		Type: "object",
-		AdditionalProperties: &v1beta1.JSONSchemaPropsOrBool{
+	}
+    parseOption := b.arguments.CustomArgs.(*ParseOptions)
+	if !parseOption.SkipMapValidation {
+		props.AdditionalProperties = &v1beta1.JSONSchemaPropsOrBool{
 			Allows: true,
-			Schema: &additionalProps},
+			Schema: &additionalProps}
 	}
 
 	buff := &bytes.Buffer{}
-	if err := mapTemplate.Execute(buff, ""); err != nil {
+	if err := mapTemplate.Execute(buff, mapTempateArgs{Result: result, SkipMapValidation: parseOption.SkipMapValidation}); err != nil {
 		log.Fatalf("%v", err)
 	}
 	return props, buff.String()

cmd/internal/codegen/parse/util.go

@@ -26,6 +26,10 @@ import (
 	"k8s.io/gengo/types"
 )
 
+type ParseOptions struct {
+    SkipMapValidation bool
+}
+
 // IsAPIResource returns true if t has a +resource/+kubebuilder:resource comment tag
 func IsAPIResource(t *types.Type) bool {
 	for _, c := range t.CommentLines {

cmd/kubebuilder-gen/codegen/run/generator.go

@@ -22,6 +22,7 @@ import (
 	"github.com/kubernetes-sigs/kubebuilder/cmd/kubebuilder-gen/codegen"
 	"k8s.io/gengo/args"
 	"k8s.io/gengo/generator"
+	"github.com/spf13/pflag"
 )
 
 // CodeGenerator generates code for Kubernetes resources and controllers
@@ -45,12 +46,16 @@ func (g *CodeGenerator) AddResourceGenerator(generator codegen.ResourceGenerator
 	return g
 }
 
-type customArgs struct{}
-
 // Execute parses packages and executes the code generators against the resource and controller packages
 func (g *CodeGenerator) Execute() error {
 	arguments := args.Default()
-	arguments.CustomArgs = &customArgs{}
+
+	// Custom args.
+	customArgs := &parse.ParseOptions{}
+	pflag.CommandLine.BoolVar(&customArgs.SkipMapValidation, "skip-map-validation", true,
+		"if set to true, skip generating validation schema for map type in CRD.")
+	arguments.CustomArgs = customArgs
+
 	arguments.OutputFileBaseName = g.OutputFileBaseName
 
 	err := arguments.Execute(parse.NameSystems(), parse.DefaultNameSystem(), g.packages)

cmd/kubebuilder/create/config/config.go

@@ -57,14 +57,14 @@ kubebuilder create config --crds --output myextensionname.yaml
 			fmt.Printf("Must either specify the name of the extension with --name or set --crds.\n")
 			return
 		}
-		CodeGenerator{}.Execute()
+		CodeGenerator{SkipMapValidation: skipMapValidation}.Execute()
 		log.Printf("Config written to %s", output)
 	},
 }
 
 var (
 	controllerType, controllerImage, name, output, crdNamespace string
-	crds                                                        bool
+	crds, skipMapValidation                                     bool
 )
 
 func AddCreateConfig(cmd *cobra.Command) {
@@ -75,4 +75,5 @@ func AddCreateConfig(cmd *cobra.Command) {
 	configCmd.Flags().StringVar(&controllerImage, "controller-image", "", "name of the controller container to run.")
 	configCmd.Flags().StringVar(&name, "name", "", "name of the installation.  used to generate the namespace and resource names.")
 	configCmd.Flags().StringVar(&output, "output", filepath.Join("hack", "install.yaml"), "location to write yaml to")
+	configCmd.Flags().BoolVar(&skipMapValidation, "skip-map-validation", true, "if set to true, skip generating validation schema for map type in CRD.")
 }

cmd/kubebuilder/create/config/gen.go

@@ -36,7 +36,9 @@ import (
 )
 
 // CodeGenerator generates code for Kubernetes resources and controllers
-type CodeGenerator struct{}
+type CodeGenerator struct{
+	SkipMapValidation bool
+}
 
 var kblabels = map[string]string{
 	"kubebuilder.k8s.io": version.GetVersion().KubeBuilderVersion,
@@ -67,6 +69,8 @@ func (g CodeGenerator) Execute() error {
 		return fmt.Errorf("Failed making a context: %v", err)
 	}
 
+	arguments.CustomArgs = &parse.ParseOptions{SkipMapValidation: g.SkipMapValidation}
+
 	p := parse.NewAPIs(c, arguments)
 	if crds {
 		util.WriteString(output, strings.Join(getCrds(p), "---\n"))

cmd/kubebuilder/docs/gen.go

@@ -32,6 +32,8 @@ func (g CodeGenerator) Execute(dir string) error {
 		return fmt.Errorf("Failed making a context: %v", err)
 	}
 
+	arguments.CustomArgs = &parse.ParseOptions{SkipMapValidation: true}
+
 	p := parse.NewAPIs(c, arguments)
 	path := filepath.Join(dir, outputDir, "config.yaml")
 

test.sh

@@ -150,6 +150,9 @@ function generate_crd_resources {
   sed -i -e "s|type Bee struct|// +kubebuilder:categories=foo,bar\ntype Bee struct|" pkg/apis/insect/v1beta1/bee_types.go
   sed -i -e "s|type BeeController struct {|// +kubebuilder:rbac:groups="",resources=pods,verbs=get;watch;list\ntype BeeController struct {|" pkg/controller/bee/controller.go
 
+  header_text "adding a map type to resource"
+  sed -i -e "s|type BeeSpec struct {|type BeeSpec struct {\n	Request map[string]string \`json:\"request,omitempty\"\`|" pkg/apis/insect/v1beta1/bee_types.go
+
   header_text "generating and testing CRD definition"
   kubebuilder create config --crds --output crd.yaml
   kubebuilder create config --controller-image myimage:v1 --name myextensionname --output install.yaml
@@ -187,6 +190,9 @@ spec:
         metadata:
           type: object
         spec:
+          properties:
+            request:
+              type: object
           type: object
         status:
           type: object
@@ -281,6 +287,9 @@ spec:
         metadata:
           type: object
         spec:
+          properties:
+            request:
+              type: object
           type: object
         status:
           type: object
@@ -429,6 +438,9 @@ spec:
         metadata:
           type: object
         spec:
+          properties:
+            request:
+              type: object
           type: object
         status:
           type: object

test/docs/expected/includes/_generated_bee_v1beta1_insect_concept.md

@@ -39,6 +39,7 @@ Appears In:
 
 Field        | Description
 ------------ | -----------
+`request`<br /> *object*    | 
 
 ### BeeStatus v1beta1