openapi2crd: fix duplicate major versions, filtered parameters (#2957)

* fix filtering parameters

* regenerate crds

* remove unused majorVersions function

Author: s-urbaniak

config/openapi2crd.yaml

@@ -136,51 +136,6 @@ spec:
                 - $.tags
                 - $.terminationProtectionEnabled
                 - $.versionReleaseSystem
-        - majorVersion: v20250312
-          openAPIRef:
-            name: v20250312
-          parameters:
-            path:
-              name: '/api/atlas/v2/groups/{groupId}/clusters'
-              verb: post
-            references:
-              - *groupRef
-          entry:
-            schema: 'ClusterDescription20240805'
-            filters:
-              skipProperties:
-                - $.connectionStrings
-                - $.createDate
-                - $.groupId
-                - $.id
-                - $.links
-                - $.mongoDBVersion
-                - $.replicationSpecs[*].id
-                - $.stateName
-          status:
-            schema: 'ClusterDescription20240805'
-            filters:
-              skipProperties:
-                - $.acceptDataRisksAndForceReplicaSetReconfig
-                - $.backupEnabled
-                - $.biConnector
-                - $.clusterType
-                - $.diskSizeGB
-                - $.diskWarmingMode
-                - $.encryptionAtRestProvider
-                - $.labels
-                - $.links
-                - $.mongoDBMajorVersion
-                - $.name
-                - $.paused
-                - $.pitEnabled
-                - $.replicationSpecs[*].numShards
-                - $.replicationSpecs[*].regionConfigs
-                - $.replicationSpecs[*].zoneName
-                - $.rootCertType
-                - $.tags
-                - $.terminationProtectionEnabled
-                - $.versionReleaseSystem
 
     - gvk:
         version: v1

internal/generated/crds/crds.yaml

@@ -244,7 +244,6 @@ spec:
             description: |-
               Specification of the cluster supporting the following versions:
 
-              - v20250312
               - v20250312
 
               At most one versioned spec can be specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@@ -942,14 +941,6 @@ spec:
                     && has(self.groupRef))
             type: object
             x-kubernetes-validations:
-            - message: 'Only one of the following entries can be set: "v20250312,
-                v20250312"'
-              rule: '!has(self.v20250312) && has(self.v20250312) || has(self.v20250312)
-                && !has(self.v20250312)'
-            - message: spec.connectionSecretRef must be set if spec.v20250312.groupId
-                is set.
-              rule: (has(self.v20250312.groupId) && has(self.connectionSecretRef))
-                || (!has(self.v20250312.groupId))
             - message: spec.connectionSecretRef must be set if spec.v20250312.groupId
                 is set.
               rule: (has(self.v20250312.groupId) && has(self.connectionSecretRef))

tools/openapi2crd/pkg/generator/generator.go

@@ -21,12 +21,12 @@ import (
 	"log"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
-	"sigs.k8s.io/yaml"
-
 	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
 	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/config"
 	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/plugins"
+	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
+	"k8s.io/apimachinery/pkg/util/sets"
+	"sigs.k8s.io/yaml"
 )
 
 type Generator struct {
@@ -66,7 +66,14 @@ func (g *Generator) Generate(ctx context.Context, crdConfig *v1alpha1.CRDConfig)
 		}
 	}
 
+	majorVersions := sets.New[string]()
 	for _, mapping := range crdConfig.Mappings {
+		if majorVersions.Has(mapping.MajorVersion) {
+			return nil, fmt.Errorf("duplicate mapping for major version %q for %v", mapping.MajorVersion, crdConfig.GVK)
+		}
+
+		majorVersions.Insert(mapping.MajorVersion)
+
 		def, ok := g.definitions[mapping.OpenAPIRef.Name]
 		if !ok {
 			return nil, fmt.Errorf("no OpenAPI definition named %q found", mapping.OpenAPIRef.Name)
@@ -136,15 +143,6 @@ func (g *Generator) Generate(ctx context.Context, crdConfig *v1alpha1.CRDConfig)
 	return crd, nil
 }
 
-func (g *Generator) majorVersions(config v1alpha1.CRDConfig) []string {
-	result := make([]string, 0, len(config.Mappings))
-	for _, m := range config.Mappings {
-		result = append(result, "- "+m.MajorVersion)
-	}
-
-	return result
-}
-
 func clearPropertiesWithoutExtensions(schema *openapi3.Schema) bool {
 	if schema == nil {
 		return false

tools/openapi2crd/pkg/generator/generator_test.go

@@ -20,54 +20,15 @@ import (
 	"testing"
 
 	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/config"
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/plugins"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/config"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/plugins"
 )
 
-func TestGeneratorMajorVersions(t *testing.T) {
-	tests := map[string]struct {
-		config         v1alpha1.CRDConfig
-		expectedResult []string
-	}{
-		"mapping with single version": {
-			config: v1alpha1.CRDConfig{
-				Mappings: []v1alpha1.CRDMapping{
-					{
-						MajorVersion: "v1",
-					},
-				},
-			},
-			expectedResult: []string{"- v1"},
-		},
-		"mapping with multiple versions": {
-			config: v1alpha1.CRDConfig{
-				Mappings: []v1alpha1.CRDMapping{
-					{
-						MajorVersion: "v1",
-					},
-					{
-						MajorVersion: "v2",
-					},
-				},
-			},
-			expectedResult: []string{"- v1", "- v2"},
-		},
-	}
-	for name, tt := range tests {
-		t.Run(name, func(t *testing.T) {
-			g := &Generator{}
-			result := g.majorVersions(tt.config)
-			assert.Equal(t, tt.expectedResult, result)
-		})
-	}
-}
-
 func TestClearPropertiesWithoutExtensions(t *testing.T) {
 	tests := map[string]struct {
 		schema         *openapi3.Schema
@@ -233,6 +194,31 @@ func TestGeneratorGenerate(t *testing.T) {
 				},
 			},
 		},
+		"duplicate major versions": {
+			apiDefinitions: map[string]v1alpha1.OpenAPIDefinition{
+				"Pet": {
+					Name: "Pet",
+					Path: "testdata/openapi.yaml",
+				},
+			},
+			config: &v1alpha1.CRDConfig{
+				Mappings: []v1alpha1.CRDMapping{
+					{
+						OpenAPIRef: v1alpha1.LocalObjectReference{
+							Name: "Pet",
+						},
+						MajorVersion: "v1",
+					},
+					{
+						OpenAPIRef: v1alpha1.LocalObjectReference{
+							Name: "Pet",
+						},
+						MajorVersion: "v1",
+					},
+				},
+			},
+			expectError: true,
+		},
 	}
 	for name, tt := range tests {
 		t.Run(name, func(t *testing.T) {

tools/openapi2crd/pkg/plugins/parameters.go

@@ -19,9 +19,8 @@ import (
 	"fmt"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
-
 	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/converter"
+	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 )
 
 // Parameters adds parameters from the OpenAPI spec to the CRD schema.
@@ -71,6 +70,12 @@ func (p *Parameters) Process(req *MappingProcessorRequest) error {
 						Path:                []string{"$", param.Value.Name},
 					},
 				)
+
+				// may have been filtered out by other plugins
+				if props == nil {
+					continue
+				}
+
 				props.Description = param.Value.Description
 				props.XValidations = apiextensions.ValidationRules{
 					{

tools/openapi2crd/pkg/plugins/parameters_test.go

@@ -21,12 +21,11 @@ import (
 	"testing"
 
 	"github.com/getkin/kin-openapi/openapi3"
+	configv1alpha1 "github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/converter"
 	"github.com/stretchr/testify/assert"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 	"k8s.io/utils/ptr"
-
-	configv1alpha1 "github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/converter"
 )
 
 func TestParameterName(t *testing.T) {
@@ -40,6 +39,14 @@ func TestParameterProcess(t *testing.T) {
 		expectedVersionSpec apiextensions.JSONSchemaProps
 		expectedErr         error
 	}{
+		"parameter filtered out": {
+			request: groupMappingRequest(t, groupBaseCRDWithMajorVersion(t), entryInitialExtensionsSchema(t), parameterConverterNilMock(t)),
+			expectedVersionSpec: apiextensions.JSONSchemaProps{
+				Description: "The spec of the group resource for version v20250312.",
+				Type:        "object",
+				Properties:  map[string]apiextensions.JSONSchemaProps{},
+			},
+		},
 		"add parameter schema to the CRD": {
 			request: groupMappingRequest(t, groupBaseCRDWithMajorVersion(t), entryInitialExtensionsSchema(t), parameterConverterMock(t)),
 			expectedVersionSpec: apiextensions.JSONSchemaProps{
@@ -399,6 +406,14 @@ func parameterConverterMock(t *testing.T) converterFuncMock {
 	}
 }
 
+func parameterConverterNilMock(t *testing.T) converterFuncMock {
+	t.Helper()
+
+	return func(input converter.PropertyConvertInput) *apiextensions.JSONSchemaProps {
+		return nil
+	}
+}
+
 type converterFuncMock func(input converter.PropertyConvertInput) *apiextensions.JSONSchemaProps
 
 type dummyConverter struct {