set field requirement properly (#2876)

Author: helderjs

tools/openapi2crd/cmd/run.go

@@ -36,14 +36,23 @@ const (
 	outputOption = "output"
 	configOption = "config"
 	forceOption  = "force"
+	crdsOption   = "crds"
 
-	readOnly = os.O_RDONLY
+	crdsDefaultValue = "all"
+	readOnly         = os.O_RDONLY
 )
 
 func initConfig() {
 	viper.AutomaticEnv()
 }
 
+type RunnerConfig struct {
+	Input     string
+	Output    string
+	Overwrite bool
+	Kinds     map[string]struct{}
+}
+
 func RunCmd(ctx context.Context) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:           "openapi2crd SPEC_FILE",
@@ -57,41 +66,59 @@ func RunCmd(ctx context.Context) *cobra.Command {
 			configPath := viper.GetString(configOption)
 			outputPath := viper.GetString(outputOption)
 			forceOverwrite := viper.GetBool(forceOption)
+			crds := viper.GetString(crdsOption)
+
+			c := &RunnerConfig{
+				Input:     configPath,
+				Output:    outputPath,
+				Overwrite: forceOverwrite,
+				Kinds:     make(map[string]struct{}),
+			}
+
+			if crds != crdsDefaultValue {
+				kinds := strings.Split(crds, ",")
+				c.Kinds = make(map[string]struct{}, len(kinds))
+				for _, kind := range kinds {
+					c.Kinds[strings.TrimSpace(kind)] = struct{}{}
+				}
+			}
 
 			fs := afero.NewOsFs()
 
-			return runOpenapi2crd(ctx, fs, configPath, outputPath, forceOverwrite)
+			return runOpenapi2crd(ctx, fs, c)
 		},
 	}
 
 	cmd.Flags().StringP(outputOption, "o", "", "Path to output file (required)")
 	_ = cmd.MarkFlagRequired(outputOption)
 	cmd.Flags().StringP(configOption, "c", "", "Path to the config file (required)")
+	_ = cmd.MarkFlagRequired(configOption)
 	cmd.Flags().BoolP(forceOption, "f", false, "Force overwrite the output file if it exists")
+	cmd.Flags().String(crdsOption, crdsDefaultValue, "One or more Kind names to generate, separated by comma. Use 'all' to generate all CRDs.")
 	cobra.OnInitialize(initConfig)
 
 	viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
 
 	return cmd
 }
 
-func runOpenapi2crd(ctx context.Context, fs afero.Fs, input, output string, overwrite bool) error {
-	file, err := fs.OpenFile(input, readOnly, 0o644)
+func runOpenapi2crd(ctx context.Context, fs afero.Fs, runnerConfig *RunnerConfig) error {
+	file, err := fs.OpenFile(runnerConfig.Input, readOnly, 0o644)
 	if err != nil {
-		return fmt.Errorf("error opening the file %s: %w", input, err)
+		return fmt.Errorf("error opening the file %s: %w", runnerConfig.Input, err)
 	}
 
 	configData, err := afero.ReadAll(file)
 	if err != nil {
-		return fmt.Errorf("error reading the file %s: %w", input, err)
+		return fmt.Errorf("error reading the file %s: %w", runnerConfig.Input, err)
 	}
 
 	cfg, err := config.Parse(configData)
 	if err != nil {
 		return fmt.Errorf("error parsing config: %w", err)
 	}
 
-	fsExporter, err := exporter.New(fs, output, overwrite)
+	fsExporter, err := exporter.New(fs, runnerConfig.Output, runnerConfig.Overwrite)
 	if err != nil {
 		return fmt.Errorf("error creating the exporter: %w", err)
 	}
@@ -116,6 +143,11 @@ func runOpenapi2crd(ctx context.Context, fs afero.Fs, input, output string, over
 	atlasLoader := config.NewAtlas(openapiLoader)
 
 	for _, crdConfig := range cfg.Spec.CRDConfig {
+		_, shouldGen := runnerConfig.Kinds[crdConfig.GVK.Kind]
+		if len(runnerConfig.Kinds) > 0 && !shouldGen {
+			continue
+		}
+
 		pluginSet, err := plugins.GetPluginSet(pluginSets, crdConfig.PluginSet)
 		if err != nil {
 			return fmt.Errorf("error getting plugin set %q: %w", crdConfig.PluginSet, err)

tools/openapi2crd/cmd/run_test.go

@@ -47,7 +47,13 @@ func TestRunOpenapi2crd(t *testing.T) {
 			err = afero.WriteFile(fs, "./testdata/openapi.yaml", []byte(openapiFile()), 0o644)
 			require.NoError(t, err)
 
-			err = runOpenapi2crd(context.Background(), fs, tt.input, tt.output, tt.overwrite)
+			c := &RunnerConfig{
+				Input:     tt.input,
+				Output:    tt.output,
+				Overwrite: tt.overwrite,
+			}
+
+			err = runOpenapi2crd(context.Background(), fs, c)
 			assert.Equal(t, tt.expectedErr, err)
 		})
 	}

tools/openapi2crd/pkg/plugins/parameters.go

@@ -18,10 +18,10 @@ package plugins
 import (
 	"fmt"
 
+	"tools/openapi2crd/pkg/converter"
+
 	"github.com/getkin/kin-openapi/openapi3"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
-
-	"tools/openapi2crd/pkg/converter"
 )
 
 // Parameters adds parameters from the OpenAPI spec to the CRD schema.
@@ -79,7 +79,10 @@ func (p *Parameters) Process(req *MappingProcessorRequest) error {
 					},
 				}
 				majorVersionSpec.Properties[param.Value.Name] = *props
-				majorVersionSpec.Required = append(majorVersionSpec.Required, param.Value.Name)
+
+				if param.Value.Required {
+					majorVersionSpec.Required = append(majorVersionSpec.Required, param.Value.Name)
+				}
 			}
 		}
 	}

tools/openapi2crd/pkg/plugins/parameters_test.go

@@ -56,8 +56,18 @@ func TestParameterProcess(t *testing.T) {
 							},
 						},
 					},
+					"test": {
+						Description: "required parameter for testing purposes",
+						Type:        "object",
+						XValidations: apiextensions.ValidationRules{
+							{
+								Rule:    "self == oldSelf",
+								Message: "test cannot be modified after creation",
+							},
+						},
+					},
 				},
-				Required: []string{"projectOwnerId"},
+				Required: []string{"test"},
 			},
 		},
 		"missing path in OpenAPI spec": {
@@ -132,8 +142,18 @@ func TestParameterProcess(t *testing.T) {
 							},
 						},
 					},
+					"test": {
+						Description: "required parameter for testing purposes",
+						Type:        "object",
+						XValidations: apiextensions.ValidationRules{
+							{
+								Rule:    "self == oldSelf",
+								Message: "test cannot be modified after creation",
+							},
+						},
+					},
 				},
-				Required: []string{"projectOwnerId"},
+				Required: []string{"test"},
 			},
 		},
 	}
@@ -203,6 +223,20 @@ func groupMappingRequest(
 										},
 									},
 								},
+								&openapi3.ParameterRef{
+									Value: &openapi3.Parameter{
+										Name:        "test",
+										In:          "query",
+										Description: "required parameter for testing purposes",
+										Schema: &openapi3.SchemaRef{
+											Value: &openapi3.Schema{
+												Type:    &openapi3.Types{"boolean"},
+												Default: false,
+											},
+										},
+										Required: true,
+									},
+								},
 							},
 							RequestBody: &openapi3.RequestBodyRef{
 								Value: &openapi3.RequestBody{