CLOUDP-358677: Remove crapi internal schema validation (#2948)

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

Author: josvazg

Makefile

@@ -211,13 +211,7 @@ CRD2GO := go tool -modfile=tools/toolbox/go.mod crd2go
 OPENAPI2CRD := tools/openapi2crd/bin/openapi2crd
 SCAFFOLDER := tools/scaffolder/bin/scaffolder
 
-ifdef GEN_OVERRIDE
-  OPENAPI2CRD_OVERRIDE := --force
-  SCAFFOLDER_OVERRIDE := --override
-else
-  OPENAPI2CRD_OVERRIDE :=
-  SCAFFOLDER_OVERRIDE :=
-endif
+SCAFFOLDER_FLAGS ?=
 
 .DEFAULT_GOAL := help
 .PHONY: help
@@ -885,7 +879,7 @@ gen-crds: tools/openapi2crd/bin/openapi2crd
 	@echo "==> Generating CRDs..."
 	$(MAKE) -C tools/openapi2crd build
 	$(OPENAPI2CRD) --config config/openapi2crd.yaml \
-	--output $(realpath .)/config/generated/crd/bases/crds.yaml $(OPENAPI2CRD_OVERRIDE)
+	--output $(realpath .)/config/generated/crd/bases/crds.yaml
 	cp $(realpath .)/config/generated/crd/bases/crds.yaml $(realpath .)/internal/generated/crds/crds.yaml
 
 gen-go-types:
@@ -897,7 +891,7 @@ run-scaffolder: tools/scaffolder/bin/scaffolder
 	@echo "==> Generating Go controller scaffolding and indexers..."
 	$(MAKE) -C tools/scaffolder build
 	$(SCAFFOLDER) --input $(realpath .)/config/generated/crd/bases/crds.yaml \
-	--all $(SCAFFOLDER_OVERRIDE) \
+	--all $(SCAFFOLDER_FLAGS) \
 	--indexer-out $(realpath .)/internal/generated/indexers \
 	--controller-out $(realpath .)/internal/generated/controller
 

go.mod

@@ -31,7 +31,6 @@ require (
 	github.com/nsf/jsondiff v0.0.0-20230430225905-43f6cf3098c1
 	github.com/onsi/ginkgo/v2 v2.27.2
 	github.com/onsi/gomega v1.38.2
-	github.com/santhosh-tekuri/jsonschema/v5 v5.3.1
 	github.com/sethvargo/go-password v0.3.1
 	github.com/stretchr/testify v1.11.1
 	github.com/yudai/gojsondiff v1.0.0

go.sum

@@ -318,8 +318,6 @@ github.com/prometheus/procfs v0.15.1/go.mod h1:fB45yRUv8NstnjriLhBQLuOUt+WW4BsoG
 github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
 github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/santhosh-tekuri/jsonschema/v5 v5.3.1 h1:lZUw3E0/J3roVtGQ+SCrUrg3ON6NgVqpn3+iol9aGu4=
-github.com/santhosh-tekuri/jsonschema/v5 v5.3.1/go.mod h1:uToXkOrWAZ6/Oc07xWQrPOhJotwFIyu2bBVN41fcDUY=
 github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw=
 github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4=
 github.com/sethvargo/go-password v0.3.1 h1:WqrLTjo7X6AcVYfC6R7GtSyuUQR9hGyAj/f1PYQZCJU=

internal/crapi/crapi.go

@@ -37,9 +37,6 @@ type Translator interface {
 
 	// Mappings returns all the OpenAPi custom reference extensions, or an error
 	Mappings() ([]*refs.Mapping, error)
-
-	// Validate checks the given unsttructured object complies with the translated schema
-	Validate(unstructuredObj map[string]any) error
 }
 
 // Request holds common parameters for all translation request
@@ -72,9 +69,6 @@ func ToAPI[T any](r *Request, target *T, source client.Object) error {
 	if err != nil {
 		return fmt.Errorf("failed to convert k8s source value to unstructured: %w", err)
 	}
-	if err := r.Translator.Validate(unstructuredSrc); err != nil {
-		return fmt.Errorf("failed to validate unstructured object input: %w", err)
-	}
 	targetUnstructured := map[string]any{}
 
 	if err := collapseReferences(r, unstructuredSrc, source); err != nil {
@@ -140,9 +134,6 @@ func FromAPI[S any, T any, P refs.PtrClientObj[T]](r *Request, target P, source
 	if err != nil {
 		return nil, fmt.Errorf("failed to process API mappings: %w", err)
 	}
-	if err := r.Translator.Validate(targetUnstructured); err != nil {
-		return nil, fmt.Errorf("failed to validate unstructured object output: %w", err)
-	}
 	if err := unstructured.FromUnstructured(target, targetUnstructured); err != nil {
 		return nil, fmt.Errorf("failed set structured kubernetes object from unstructured: %w", err)
 	}

internal/crapi/crds/crds.go

@@ -15,11 +15,8 @@
 package crds
 
 import (
-	"bytes"
-	"encoding/json"
 	"fmt"
 
-	"github.com/santhosh-tekuri/jsonschema/v5"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 )
 
@@ -41,25 +38,6 @@ func AssertMajorVersion(specVersion *apiextensionsv1.CustomResourceDefinitionVer
 	return nil
 }
 
-// CompileCRDSchema compiles the given JSON properties as a type schema.
-// Enables validating whether or not some JSON or unstructured data comforms
-// with such type schema.
-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)
-	}
-	compiler := jsonschema.NewCompiler()
-	if err := compiler.AddResource("schema.json", bytes.NewReader(schemaBytes)); err != nil {
-		return nil, fmt.Errorf("failed to add schema resource: %w", err)
-	}
-	schema, err := compiler.Compile("schema.json")
-	if err != nil {
-		return nil, fmt.Errorf("failed to compile schema: %w", err)
-	}
-	return schema, nil
-}
-
 // SelectVersion extracts the CRD version definition matching the given version.
 func SelectVersion(spec *apiextensionsv1.CustomResourceDefinitionSpec, version string) *apiextensionsv1.CustomResourceDefinitionVersion {
 	if len(spec.Versions) == 0 {

internal/crapi/crds/crds_test.go

@@ -15,37 +15,14 @@
 package crds_test
 
 import (
-	"bufio"
-	"bytes"
 	"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/crapi/crds"
-	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/crapi/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}

internal/crapi/translator.go

@@ -20,7 +20,6 @@ import (
 	"fmt"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	"github.com/santhosh-tekuri/jsonschema/v5"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"sigs.k8s.io/yaml"
 
@@ -31,9 +30,8 @@ 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 {
-	majorVersion     string
-	validationSchema *jsonschema.Schema
-	mappingSchema    *openapi3.SchemaRef
+	majorVersion  string
+	mappingSchema *openapi3.SchemaRef
 }
 
 // Annotation returns the annotation value from the pinned translated schema
@@ -60,16 +58,6 @@ func (tr *translator) MajorVersion() string {
 	return tr.majorVersion
 }
 
-// Validate would return any errors of the given unstructured object against the
-// pinned schema version being translated, or nil if the object is compliant
-func (tr *translator) Validate(unstructuredObj map[string]any) error {
-	// This correctly uses the validator from crds.CompileCRDSchema
-	if err := tr.validationSchema.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 version. It is also
 // locked into a particular API majorVersion.
 //
@@ -88,10 +76,6 @@ func NewTranslator(crd *apiextensionsv1.CustomResourceDefinition, crdVersion str
 	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)
 	}
-	validationSchema, err := crds.CompileCRDSchema(specVersion.Schema.OpenAPIV3Schema)
-	if err != nil {
-		return nil, fmt.Errorf("failed to compile schema for validation: %w", err)
-	}
 	var mappingSchema openapi3.Schema
 	mappingString, ok := crd.Annotations["api-mappings"]
 	if ok && mappingString != "" {
@@ -105,8 +89,7 @@ func NewTranslator(crd *apiextensionsv1.CustomResourceDefinition, crdVersion str
 	}
 
 	return &translator{
-		majorVersion:     majorVersion,
-		validationSchema: validationSchema,
-		mappingSchema:    &openapi3.SchemaRef{Value: &mappingSchema},
+		majorVersion:  majorVersion,
+		mappingSchema: &openapi3.SchemaRef{Value: &mappingSchema},
 	}, nil
 }