Address comments: change flag name and add tests

Author: Liujingfang1

cmd/internal/codegen/parse/crd.go

@@ -217,13 +217,13 @@ func (b *APIs) parsePrimitiveValidation(t *types.Type, found sets.String, commen
 
 type mapTempateArgs struct {
 	Result string
-	SkipMap bool
+	SkipMapValidation bool
 }
 
 var mapTemplate = template.Must(template.New("map-template").Parse(
 	`v1beta1.JSONSchemaProps{
     Type:                 "object",
-    {{if not .SkipMap}}AdditionalProperties: &v1beta1.JSONSchemaPropsOrBool{
+    {{if not .SkipMapValidation}}AdditionalProperties: &v1beta1.JSONSchemaPropsOrBool{
         Allows: true,
         Schema: &{{.Result}},
     },{{end}}
@@ -237,14 +237,14 @@ func (b *APIs) parseMapValidation(t *types.Type, found sets.String, comments []s
 		Type: "object",
 	}
     parseOption := b.arguments.CustomArgs.(*ParseOptions)
-	if !parseOption.SkipMap {
+	if !parseOption.SkipMapValidation {
 		props.AdditionalProperties = &v1beta1.JSONSchemaPropsOrBool{
 			Allows: true,
 			Schema: &additionalProps}
 	}
 
 	buff := &bytes.Buffer{}
-	if err := mapTemplate.Execute(buff, mapTempateArgs{result, parseOption.SkipMap}); 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

@@ -27,7 +27,7 @@ import (
 )
 
 type ParseOptions struct {
-    SkipMap bool
+    SkipMapValidation bool
 }
 
 // IsAPIResource returns true if t has a +resource/+kubebuilder:resource comment tag

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

@@ -52,8 +52,8 @@ func (g *CodeGenerator) Execute() error {
 
 	// Custom args.
 	customArgs := &parse.ParseOptions{}
-	pflag.CommandLine.BoolVar(&customArgs.SkipMap, "skip-map", true,
-		"If set true, skip map types.")
+	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

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{SkipMap: skipmap}.Execute()
+		CodeGenerator{SkipMapValidation: skipMapValidation}.Execute()
 		log.Printf("Config written to %s", output)
 	},
 }
 
 var (
 	controllerType, controllerImage, name, output, crdNamespace string
-	crds, skipmap                                               bool
+	crds, skipMapValidation                                     bool
 )
 
 func AddCreateConfig(cmd *cobra.Command) {
@@ -75,5 +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(&skipmap, "skip-map", true, "if set to true, skip validation of map in CRD")
+	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

@@ -37,7 +37,7 @@ import (
 
 // CodeGenerator generates code for Kubernetes resources and controllers
 type CodeGenerator struct{
-	SkipMap bool
+	SkipMapValidation bool
 }
 
 var kblabels = map[string]string{
@@ -69,7 +69,7 @@ func (g CodeGenerator) Execute() error {
 		return fmt.Errorf("Failed making a context: %v", err)
 	}
 
-	arguments.CustomArgs = &parse.ParseOptions{SkipMap: g.SkipMap}
+	arguments.CustomArgs = &parse.ParseOptions{SkipMapValidation: g.SkipMapValidation}
 
 	p := parse.NewAPIs(c, arguments)
 	if crds {

cmd/kubebuilder/docs/gen.go

@@ -32,7 +32,7 @@ func (g CodeGenerator) Execute(dir string) error {
 		return fmt.Errorf("Failed making a context: %v", err)
 	}
 
-	arguments.CustomArgs = &parse.ParseOptions{SkipMap: true}
+	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