CLOUDP-365467: Add Schema to Translator

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

Author: josvazg

internal/crapi/crapi.go

@@ -16,6 +16,7 @@
 package crapi
 
 import (
+	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/crapi/refs"
@@ -26,6 +27,9 @@ import (
 // A translator is an immutable configuration object, it can be safely shared
 // across goroutines
 type Translator interface {
+	// Scheme returns the Kubernetes scheme used to translate the CRD.
+	Scheme() *runtime.Scheme
+
 	// MajorVersion returns the pinned SDK major version
 	MajorVersion() string
 

internal/crapi/crapi_test.go

@@ -28,8 +28,11 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	akoscheme "k8s.io/client-go/kubernetes/scheme"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	akov2 "github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/crapi"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/crapi/crds"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/crapi/testdata"
@@ -401,10 +404,11 @@ func TestFromAPI(t *testing.T) {
 }
 
 func testFromAPI[S any](t *testing.T, kind string, target client.Object, input *S, want client.Object, wantDeps ...client.Object) {
+	scheme := testScheme(t)
 	crdsYML := bytes.NewBuffer(testdata.SampleCRDs)
 	crd, err := extractCRD(kind, bufio.NewScanner(crdsYML))
 	require.NoError(t, err)
-	tr, err := crapi.NewTranslator(crd, version, sdkVersion)
+	tr, err := crapi.NewTranslator(scheme, crd, version, sdkVersion)
 	require.NoError(t, err)
 	results, err := tr.FromAPI(target, input)
 	require.NoError(t, err)
@@ -517,8 +521,7 @@ func TestToAPIAllRefs(t *testing.T) {
 						"webhookSecret": ([]byte)("sample-webhook-secret"),
 					},
 				},
-				&corev1.Secret{
-					TypeMeta:   metav1.TypeMeta{Kind: "Secret", APIVersion: "v1"},
+				&corev1.Secret{ // works without type meta set as well
 					ObjectMeta: metav1.ObjectMeta{Name: "alert-secrets-1", Namespace: "ns"},
 					Data: map[string][]byte{
 						"webhookUrl": ([]byte)("sample-webhook-url"),
@@ -571,10 +574,11 @@ func TestToAPIAllRefs(t *testing.T) {
 		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
+			scheme := testScheme(t)
 			crdsYML := bytes.NewBuffer(testdata.SampleCRDs)
 			crd, err := extractCRD(tc.crd, bufio.NewScanner(crdsYML))
 			require.NoError(t, err)
-			tr, err := crapi.NewTranslator(crd, version, sdkVersion)
+			tr, err := crapi.NewTranslator(scheme, crd, version, sdkVersion)
 			require.NoError(t, err)
 			require.NoError(t, tr.ToAPI(&tc.target, tc.input, tc.deps...))
 			assert.Equal(t, tc.want, tc.target)
@@ -2015,3 +2019,12 @@ func extractCRD(kind string, scanner *bufio.Scanner) (*apiextensionsv1.CustomRes
 		}
 	}
 }
+
+func testScheme(t *testing.T) *runtime.Scheme {
+	t.Helper()
+
+	scheme := runtime.NewScheme()
+	require.NoError(t, akov2.AddToScheme(scheme))
+	require.NoError(t, akoscheme.AddToScheme(scheme))
+	return scheme
+}

internal/crapi/refs/kube.go

@@ -75,6 +75,13 @@ func (km KubeMapping) fetchReferencedValue(mc *kubeset, target string, reference
 		return nil, fmt.Errorf("failed to find Kubernetes resource %q: %w", refName, err)
 	}
 	gvk := resource.GetObjectKind().GroupVersionKind()
+	if gvk.Kind == "" || gvk.GroupVersion().String() == "" {
+		gvks, _, err := mc.scheme.ObjectKinds(resource)
+		if err != nil || len(gvks) == 0 {
+			return nil, fmt.Errorf("failed to infer GroupVersionKind for resource %q from scheme: %w", refName, err)
+		}
+		gvk = gvks[0]
+	}
 	if km.Type.Kind != "" && !km.equal(gvk) {
 		return nil, fmt.Errorf("resource %q had to be a %q but got %q", refName, km.gvk(), gvk)
 	}

internal/crapi/refs/kubeset.go

@@ -14,22 +14,26 @@
 
 package refs
 
-import "sigs.k8s.io/controller-runtime/pkg/client"
+import (
+	"k8s.io/apimachinery/pkg/runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
 
 // kubeset holds to the main Kubernetes object being translated,
 // and related existing & added Kubernetes dependencies
 type kubeset struct {
-	main  client.Object
-	m     map[client.ObjectKey]client.Object
-	added []client.Object
+	scheme *runtime.Scheme
+	main   client.Object
+	m      map[client.ObjectKey]client.Object
+	added  []client.Object
 }
 
-func newKubeset(main client.Object, deps []client.Object) *kubeset {
+func newKubeset(scheme *runtime.Scheme, main client.Object, deps []client.Object) *kubeset {
 	m := map[client.ObjectKey]client.Object{}
 	for _, obj := range deps {
 		m[client.ObjectKeyFromObject(obj)] = obj
 	}
-	return &kubeset{main: main, m: m}
+	return &kubeset{scheme: scheme, main: main, m: m}
 }
 
 func (mc *kubeset) find(name string) client.Object {

internal/crapi/refs/kubeset_test.go

@@ -21,7 +21,11 @@ import (
 	"github.com/stretchr/testify/require"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	akoscheme "k8s.io/client-go/kubernetes/scheme"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	akov2 "github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1"
 )
 
 var (
@@ -38,7 +42,7 @@ var (
 )
 
 func TestNewKubeset(t *testing.T) {
-	ctx := newKubeset(mainObj, []client.Object{dep1, dep2})
+	ctx := newKubeset(testScheme(t), mainObj, []client.Object{dep1, dep2})
 
 	require.NotNil(t, ctx, "context should not be nil")
 	assert.Equal(t, mainObj, ctx.main, "main object should be set correctly")
@@ -53,7 +57,7 @@ func TestNewKubeset(t *testing.T) {
 }
 
 func TestKubesetFindAndHas(t *testing.T) {
-	ctx := newKubeset(mainObj, []client.Object{dep1})
+	ctx := newKubeset(testScheme(t), mainObj, []client.Object{dep1})
 
 	testCases := []struct {
 		name              string
@@ -93,7 +97,7 @@ func TestKubesetFindAndHas(t *testing.T) {
 }
 
 func TestKubesetAdd(t *testing.T) {
-	ctx := newKubeset(mainObj, []client.Object{dep1})
+	ctx := newKubeset(testScheme(t), mainObj, []client.Object{dep1})
 	require.Len(t, ctx.m, 1, "pre-condition failed: map should have 1 item")
 	require.Len(t, ctx.added, 0, "pre-condition failed: added slice should be empty")
 
@@ -122,3 +126,12 @@ func TestKubesetAdd(t *testing.T) {
 	assert.Contains(t, ctx.added, newDep, "added slice should still contain the first added object")
 	assert.Contains(t, ctx.added, anotherDep, "added slice should contain the second added object")
 }
+
+func testScheme(t *testing.T) *runtime.Scheme {
+	t.Helper()
+
+	scheme := runtime.NewScheme()
+	require.NoError(t, akov2.AddToScheme(scheme))
+	require.NoError(t, akoscheme.AddToScheme(scheme))
+	return scheme
+}

internal/crapi/refs/ref.go

@@ -21,6 +21,7 @@ import (
 	"sort"
 
 	"github.com/getkin/kin-openapi/openapi3"
+	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/crapi/unstructured"
@@ -63,8 +64,8 @@ func FindMappings(schema *openapi3.Schema, path []string) ([]*Mapping, error) {
 // ExpandAll takes a list of mappings and expands the ones found in the given
 // CR unstructured object. CR corresponds to the main typed object and deps
 // are other kubernetes objects related with such main object
-func ExpandAll(mappings []*Mapping, main client.Object, deps []client.Object, cr map[string]any) ([]client.Object, error) {
-	ks := newKubeset(main, deps)
+func ExpandAll(scheme *runtime.Scheme, mappings []*Mapping, main client.Object, deps []client.Object, cr map[string]any) ([]client.Object, error) {
+	ks := newKubeset(scheme, main, deps)
 	for _, mapping := range mappings {
 		if err := mapping.expand(ks, cr); err != nil {
 			return nil, fmt.Errorf("failed to expand reference for %q: %w", mapping.propertyName, err)
@@ -77,8 +78,8 @@ func ExpandAll(mappings []*Mapping, main client.Object, deps []client.Object, cr
 // given request unstructured object. The SDK request must map to the main typed
 //
 //	object and deps are other kubernetes objects related with such main object
-func CollapseAll(mappings []*Mapping, main client.Object, deps []client.Object, req map[string]any) error {
-	ks := newKubeset(main, deps)
+func CollapseAll(scheme *runtime.Scheme, mappings []*Mapping, main client.Object, deps []client.Object, req map[string]any) error {
+	ks := newKubeset(scheme, main, deps)
 	for _, mapping := range mappings {
 		if err := mapping.collapse(ks, req); err != nil {
 			return fmt.Errorf("failed to expand reference for %q: %w", mapping.propertyName, err)

internal/crapi/refs/ref_test.go

@@ -27,8 +27,11 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	akoscheme "k8s.io/client-go/kubernetes/scheme"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	akov2 "github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/crapi"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/crapi/crds"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/crapi/refs"
@@ -90,10 +93,11 @@ func TestMappings(t *testing.T) {
 		},
 	} {
 		t.Run(tc.title, func(t *testing.T) {
+			scheme := testScheme(t)
 			crdsYML := bytes.NewBuffer(testdata.SampleCRDs)
 			crd, err := extractCRD(tc.kind, bufio.NewScanner(crdsYML))
 			require.NoError(t, err)
-			tr, err := crapi.NewTranslator(crd, version, sdkVersion)
+			tr, err := crapi.NewTranslator(scheme, crd, version, sdkVersion)
 			require.NoError(t, err)
 			got, err := tr.Mappings()
 			require.NoError(t, err)
@@ -364,7 +368,7 @@ func TestExpandAll(t *testing.T) {
 			require.NoError(t, err)
 			require.NotEmpty(t, refMappings)
 
-			added, err := refs.ExpandAll(refMappings, mainObj, tc.deps, tc.obj)
+			added, err := refs.ExpandAll(testScheme(t), refMappings, mainObj, tc.deps, tc.obj)
 
 			if tc.wantErr != "" {
 				assert.ErrorContains(t, err, tc.wantErr)
@@ -571,7 +575,7 @@ func TestCollapseReferences(t *testing.T) {
 			refMappings, err := refs.FindMappings(schema, []string{})
 			require.NoError(t, err)
 
-			err = refs.CollapseAll(refMappings, mainObj, tc.deps, tc.obj)
+			err = refs.CollapseAll(testScheme(t), refMappings, mainObj, tc.deps, tc.obj)
 
 			if tc.wantErr != "" {
 				assert.ErrorContains(t, err, tc.wantErr)
@@ -594,3 +598,12 @@ func mappingSchemaFrom(obj map[string]any) (*openapi3.Schema, error) {
 	}
 	return &mappingSchema, nil
 }
+
+func testScheme(t *testing.T) *runtime.Scheme {
+	t.Helper()
+
+	scheme := runtime.NewScheme()
+	require.NoError(t, akov2.AddToScheme(scheme))
+	require.NoError(t, akoscheme.AddToScheme(scheme))
+	return scheme
+}

internal/crapi/translator.go

@@ -22,6 +22,7 @@ import (
 
 	"github.com/getkin/kin-openapi/openapi3"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/yaml"
 
@@ -33,6 +34,7 @@ import (
 // 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 {
+	scheme        *runtime.Scheme
 	majorVersion  string
 	mappingSchema *openapi3.SchemaRef
 }
@@ -130,6 +132,11 @@ func (tr *translator) MajorVersion() string {
 	return tr.majorVersion
 }
 
+// Scheme returns the Kubernetes scheme used to translate the CRD.
+func (tr *translator) Scheme() *runtime.Scheme {
+	return tr.scheme
+}
+
 // NewTranslator creates a translator for a particular CRD version. It is also
 // locked into a particular API majorVersion.
 //
@@ -143,7 +150,7 @@ func (tr *translator) MajorVersion() string {
 //	  v20250312:
 //
 // In the above case crdVersion is "v1" and majorVersion is "v20250312".
-func NewTranslator(crd *apiextensionsv1.CustomResourceDefinition, crdVersion string, majorVersion string) (Translator, error) {
+func NewTranslator(scheme *runtime.Scheme, 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)
@@ -161,6 +168,7 @@ func NewTranslator(crd *apiextensionsv1.CustomResourceDefinition, crdVersion str
 	}
 
 	return &translator{
+		scheme:        scheme,
 		majorVersion:  majorVersion,
 		mappingSchema: &openapi3.SchemaRef{Value: &mappingSchema},
 	}, nil
@@ -216,7 +224,7 @@ func collapseReferences(tr Translator, req map[string]any, main client.Object, o
 	if err != nil {
 		return fmt.Errorf("failed to extract mappings to collapse: %w", err)
 	}
-	return refs.CollapseAll(mappings, main, objs, req)
+	return refs.CollapseAll(tr.Scheme(), mappings, main, objs, req)
 }
 
 // expandReferences finds all API fields that must be referenced, and expand
@@ -227,7 +235,7 @@ func expandReferences(tr Translator, cr map[string]any, main client.Object, objs
 	if err != nil {
 		return nil, fmt.Errorf("failed to extract mappings to expand: %w", err)
 	}
-	return refs.ExpandAll(mappings, main, objs, cr)
+	return refs.ExpandAll(tr.Scheme(), mappings, main, objs, cr)
 }
 
 func propertyValueOrNil(schema *openapi3.Schema, propertyName string) *openapi3.Schema {