Wrap CRD code closer together and test it

Signed-off-by: jose.vazquez <[email protected]>

Author: josvazg

internal/autogen/translate/crd.go internal/autogen/translate/crds/crds.gointernal/autogen/translate/crd.go renamed to internal/autogen/translate/crds/crds.go

@@ -11,9 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
-package translate
+package crds
 
 import (
 	"bytes"
@@ -24,64 +23,13 @@ import (
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 )
 
-// crdTranslator implements Translator to translate from a given CRD to and from
-// a given SDK version using the same upstream OpenAPI schema
-type crdTranslator struct {
-	majorVersion string
-	jsonSchema   *jsonschema.Schema
-	annotations  map[string]string
-}
-
-func (tr *crdTranslator) Annotation(annotation string) string {
-	return tr.annotations[annotation]
-}
-
-func (tr *crdTranslator) MajorVersion() string {
-	return tr.majorVersion
-}
-
-func (tr *crdTranslator) Validate(unstructuredObj map[string]any) error {
-	if err := tr.jsonSchema.Validate(unstructuredObj); err != nil {
-		return fmt.Errorf("object validation failed against CRD schema: %w", err)
-	}
-	return nil
-}
-
-// NewTranslator creates a translator for a particular CRD and major version pairs,
-// and with a particular set of known Kubernetes object dependencies.
-//
-// Given the following example resource:
-//
-//	apiVersion: atlas.generated.mongodb.com/v1
-//	kind: SearchIndex
-//	metadata:
-//	  name: search-index
-//	spec:
-//	  v20250312:
-//
-// In the above case crdVersion is "v1" and majorVersion is "v20250312".
-func NewTranslator(crd *apiextensionsv1.CustomResourceDefinition, crdVersion string, majorVersion string) (Translator, error) {
-	specVersion := selectVersion(&crd.Spec, crdVersion)
-	if err := assertMajorVersion(specVersion, crd.Spec.Names.Kind, majorVersion); err != nil {
-		return nil, fmt.Errorf("failed to assert major version %s in CRD: %w", majorVersion, err)
-	}
-	schema, err := compileCRDSchema(specVersion.Schema.OpenAPIV3Schema)
-	if err != nil {
-		return nil, fmt.Errorf("failed to compile schema: %w", err)
-	}
-	return &crdTranslator{
-		majorVersion: majorVersion,
-		jsonSchema:   schema,
-		annotations:  crd.Annotations,
-	}, nil
-}
-
-func assertMajorVersion(specVersion *apiextensionsv1.CustomResourceDefinitionVersion, kind string, majorVersion string) error {
-	props, err := getOpenAPIProperties(kind, specVersion)
+// AssertMajorVersion checks the given majorVersion exists for the given kind and CRD version
+func AssertMajorVersion(specVersion *apiextensionsv1.CustomResourceDefinitionVersion, kind string, majorVersion string) error {
+	props, err := GetOpenAPIProperties(kind, specVersion)
 	if err != nil {
 		return fmt.Errorf("failed to enumerate CRD schema properties: %w", err)
 	}
-	specProps, err := getSpecPropertiesFor(kind, props, "spec")
+	specProps, err := GetSpecPropertiesFor(kind, props, "spec")
 	if err != nil {
 		return fmt.Errorf("failed to enumerate CRD spec properties: %w", err)
 	}
@@ -92,7 +40,8 @@ func assertMajorVersion(specVersion *apiextensionsv1.CustomResourceDefinitionVer
 	return nil
 }
 
-func compileCRDSchema(openAPISchema *apiextensionsv1.JSONSchemaProps) (*jsonschema.Schema, error) {
+// CompileCRDSchema compiles the given JSON schema properties
+func CompileCRDSchema(openAPISchema *apiextensionsv1.JSONSchemaProps) (*jsonschema.Schema, error) {
 	schemaBytes, err := json.Marshal(openAPISchema)
 	if err != nil {
 		return nil, fmt.Errorf("failed to marshal CRD schema to JSON: %w", err)
@@ -108,8 +57,8 @@ func compileCRDSchema(openAPISchema *apiextensionsv1.JSONSchemaProps) (*jsonsche
 	return schema, nil
 }
 
-// selectVersion returns the version from the CRD spec that matches the given version string
-func selectVersion(spec *apiextensionsv1.CustomResourceDefinitionSpec, version string) *apiextensionsv1.CustomResourceDefinitionVersion {
+// SelectVersion returns the version from the CRD spec that matches the given version string
+func SelectVersion(spec *apiextensionsv1.CustomResourceDefinitionSpec, version string) *apiextensionsv1.CustomResourceDefinitionVersion {
 	if len(spec.Versions) == 0 {
 		return nil
 	}
@@ -124,7 +73,8 @@ func selectVersion(spec *apiextensionsv1.CustomResourceDefinitionSpec, version s
 	return nil
 }
 
-func getOpenAPIProperties(kind string, version *apiextensionsv1.CustomResourceDefinitionVersion) (map[string]apiextensionsv1.JSONSchemaProps, error) {
+// GetOpenAPIProperties digs up the schema properties of a given kind on a given CRD version
+func GetOpenAPIProperties(kind string, version *apiextensionsv1.CustomResourceDefinitionVersion) (map[string]apiextensionsv1.JSONSchemaProps, error) {
 	if version == nil {
 		return nil, fmt.Errorf("missing version (nil) from %v spec", kind)
 	}
@@ -140,7 +90,8 @@ func getOpenAPIProperties(kind string, version *apiextensionsv1.CustomResourceDe
 	return version.Schema.OpenAPIV3Schema.Properties, nil
 }
 
-func getSpecPropertiesFor(kind string, props map[string]apiextensionsv1.JSONSchemaProps, field string) (map[string]apiextensionsv1.JSONSchemaProps, error) {
+// GetSpecPropertiesFor takes the properties value of a given field of a kind's properties set
+func GetSpecPropertiesFor(kind string, props map[string]apiextensionsv1.JSONSchemaProps, field string) (map[string]apiextensionsv1.JSONSchemaProps, error) {
 	prop, ok := props[field]
 	if !ok {
 		return nil, fmt.Errorf("kind %q spec is missing field %q on", kind, field)

internal/autogen/translate/crd_test.go …rnal/autogen/translate/crds/crds_test.gointernal/autogen/translate/crd_test.go renamed to internal/autogen/translate/crds/crds_test.go internal/autogen/translate/crd_test.go renamed to internal/autogen/translate/crds/crds_test.go

@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2025 MongoDB Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,16 +12,41 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package translate
+package crds_test
 
 import (
+	"bufio"
+	"bytes"
 	"fmt"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+
+	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/autogen/translate/crds"
+	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/autogen/translate/testdata"
+)
+
+const (
+	expectedVersion = "v1"
 )
 
+func TestParseAssertAndCompile(t *testing.T) {
+	scanner := bufio.NewScanner(bytes.NewBuffer(testdata.SampleCRDs))
+	for range 2 { // CRDs sample file has at least 2 CRDs
+		def, err := crds.Parse(scanner)
+		require.NoError(t, err)
+		assert.NotNil(t, def)
+		kind := def.Spec.Names.Kind
+		specVersion := crds.SelectVersion(&def.Spec, expectedVersion)
+		crds.AssertMajorVersion(specVersion, kind, expectedVersion)
+		schema, err := crds.CompileCRDSchema(specVersion.Schema.OpenAPIV3Schema)
+		require.NoError(t, err)
+		assert.NotNil(t, schema)
+	}
+}
+
 func TestSelectVersion(t *testing.T) {
 	// Define some sample versions to be reused in the tests
 	v1 := apiextensionsv1.CustomResourceDefinitionVersion{Name: "v1", Served: true}
@@ -78,7 +103,7 @@ func TestSelectVersion(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			got := selectVersion(tc.spec, tc.version)
+			got := crds.SelectVersion(tc.spec, tc.version)
 			require.Equal(t, tc.want, got)
 		})
 	}
@@ -158,7 +183,7 @@ func TestGetOpenAPIProperties(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			gotProperties, err := getOpenAPIProperties(kind, tc.version)
+			gotProperties, err := crds.GetOpenAPIProperties(kind, tc.version)
 			if tc.wantErrMsg != "" {
 				require.Error(t, err)
 				require.EqualError(t, err, tc.wantErrMsg)
@@ -237,7 +262,7 @@ func TestGetSpecPropertiesFor(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			// Act
-			gotProperties, err := getSpecPropertiesFor(kind, tc.props, tc.field)
+			gotProperties, err := crds.GetSpecPropertiesFor(kind, tc.props, tc.field)
 
 			// Assert
 			if tc.wantErrMsg != "" {

internal/autogen/translate/crds/parse_test.go

@@ -1,3 +1,17 @@
+// Copyright 2025 MongoDB Inc
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package refs
 
 import "sigs.k8s.io/controller-runtime/pkg/client"

internal/autogen/translate/refs/context.go

@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2025 MongoDB Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

internal/autogen/translate/refs/names.go

@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2025 MongoDB Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -17,8 +17,9 @@ package refs_test
 import (
 	"testing"
 
-	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/autogen/translate/refs"
 	"github.com/stretchr/testify/assert"
+
+	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/autogen/translate/refs"
 )
 
 func TestPrefixedName(t *testing.T) {

internal/autogen/translate/refs/names_test.go

@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2025 MongoDB Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

internal/autogen/translate/testdata/testdata.go

@@ -20,12 +20,12 @@ import (
 	"fmt"
 	"reflect"
 
+	"github.com/go-logr/logr"
+	"github.com/stretchr/testify/assert/yaml"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	"github.com/go-logr/logr"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/autogen/translate/refs"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/autogen/translate/unstructured"
-	"github.com/stretchr/testify/assert/yaml"
 )
 
 const (

internal/autogen/translate/translate.go

@@ -0,0 +1,77 @@
+// Copyright 2025 MongoDB Inc
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+package translate
+
+import (
+	"fmt"
+
+	"github.com/santhosh-tekuri/jsonschema/v5"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+
+	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/autogen/translate/crds"
+)
+
+// translator implements Translator to translate from a given CRD to and from
+// a given SDK version using the same upstream OpenAPI schema
+type translator struct {
+	majorVersion string
+	jsonSchema   *jsonschema.Schema
+	annotations  map[string]string
+}
+
+func (tr *translator) Annotation(annotation string) string {
+	return tr.annotations[annotation]
+}
+
+func (tr *translator) MajorVersion() string {
+	return tr.majorVersion
+}
+
+func (tr *translator) Validate(unstructuredObj map[string]any) error {
+	if err := tr.jsonSchema.Validate(unstructuredObj); err != nil {
+		return fmt.Errorf("object validation failed against CRD schema: %w", err)
+	}
+	return nil
+}
+
+// NewTranslator creates a translator for a particular CRD and major version pairs,
+// and with a particular set of known Kubernetes object dependencies.
+//
+// Given the following example resource:
+//
+//	apiVersion: atlas.generated.mongodb.com/v1
+//	kind: SearchIndex
+//	metadata:
+//	  name: search-index
+//	spec:
+//	  v20250312:
+//
+// In the above case crdVersion is "v1" and majorVersion is "v20250312".
+func NewTranslator(crd *apiextensionsv1.CustomResourceDefinition, crdVersion string, majorVersion string) (Translator, error) {
+	specVersion := crds.SelectVersion(&crd.Spec, crdVersion)
+	if err := crds.AssertMajorVersion(specVersion, crd.Spec.Names.Kind, majorVersion); err != nil {
+		return nil, fmt.Errorf("failed to assert major version %s in CRD: %w", majorVersion, err)
+	}
+	schema, err := crds.CompileCRDSchema(specVersion.Schema.OpenAPIV3Schema)
+	if err != nil {
+		return nil, fmt.Errorf("failed to compile schema: %w", err)
+	}
+	return &translator{
+		majorVersion: majorVersion,
+		jsonSchema:   schema,
+		annotations:  crd.Annotations,
+	}, nil
+}