CLOUDP-350407: Public interface tweaks for translate (#2827)

Author: josvazg

internal/autogen/translate/crds/crds.go

@@ -23,14 +23,14 @@ import (
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 )
 
-// AssertMajorVersion checks the given majorVersion exists for the given kind
-// and CRD version
+// AssertMajorVersion checks the given SDK majorVersion exists for the given
+// Kubernetes kind and CRD version
 func AssertMajorVersion(specVersion *apiextensionsv1.CustomResourceDefinitionVersion, kind string, majorVersion string) error {
-	props, err := GetOpenAPIProperties(kind, specVersion)
+	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)
 	}
@@ -41,7 +41,9 @@ func AssertMajorVersion(specVersion *apiextensionsv1.CustomResourceDefinitionVer
 	return nil
 }
 
-// CompileCRDSchema compiles the given JSON schema properties
+// 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 {
@@ -58,8 +60,7 @@ func CompileCRDSchema(openAPISchema *apiextensionsv1.JSONSchemaProps) (*jsonsche
 	return schema, nil
 }
 
-// SelectVersion returns the version from the CRD spec that matches the given
-// version string
+// SelectVersion extracts the CRD version definition matching the given version.
 func SelectVersion(spec *apiextensionsv1.CustomResourceDefinitionSpec, version string) *apiextensionsv1.CustomResourceDefinitionVersion {
 	if len(spec.Versions) == 0 {
 		return nil
@@ -75,9 +76,9 @@ func SelectVersion(spec *apiextensionsv1.CustomResourceDefinitionSpec, version s
 	return nil
 }
 
-// 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) {
+// getOpenAPIProperties extracts the schema properties of a given CRD version.
+// The kind is passed as a reference of the object this version is from.
+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)
 	}
@@ -93,9 +94,9 @@ func GetOpenAPIProperties(kind string, version *apiextensionsv1.CustomResourceDe
 	return version.Schema.OpenAPIV3Schema.Properties, nil
 }
 
-// GetSpecPropertiesFor takes the properties value of a given field of a kind's
+// 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) {
+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/crds/crds_test.go

@@ -17,7 +17,6 @@ package crds_test
 import (
 	"bufio"
 	"bytes"
-	"fmt"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -108,173 +107,3 @@ func TestSelectVersion(t *testing.T) {
 		})
 	}
 }
-
-func TestGetOpenAPIProperties(t *testing.T) {
-	const kind = "MyTestCRD"
-
-	happyPathVersion := &apiextensionsv1.CustomResourceDefinitionVersion{
-		Name: "v1",
-		Schema: &apiextensionsv1.CustomResourceValidation{
-			OpenAPIV3Schema: &apiextensionsv1.JSONSchemaProps{
-				Properties: map[string]apiextensionsv1.JSONSchemaProps{
-					"spec": {
-						Type: "object",
-						Properties: map[string]apiextensionsv1.JSONSchemaProps{
-							"fieldA": {Type: "string"},
-						},
-					},
-				},
-			},
-		},
-	}
-
-	testCases := []struct {
-		name           string
-		version        *apiextensionsv1.CustomResourceDefinitionVersion
-		wantProperties map[string]apiextensionsv1.JSONSchemaProps
-		wantErrMsg     string
-	}{
-		{
-			name:           "should return properties",
-			version:        happyPathVersion,
-			wantProperties: happyPathVersion.Schema.OpenAPIV3Schema.Properties,
-			wantErrMsg:     "",
-		},
-		{
-			name:           "should return error if version is nil",
-			version:        nil,
-			wantProperties: nil,
-			wantErrMsg:     fmt.Sprintf("missing version (nil) from %v spec", kind),
-		},
-		{
-			name: "should return error if schema is nil",
-			version: &apiextensionsv1.CustomResourceDefinitionVersion{
-				Name:   "v1",
-				Schema: nil, // The point of failure
-			},
-			wantProperties: nil,
-			wantErrMsg:     fmt.Sprintf("missing version schema from %v spec", kind),
-		},
-		{
-			name: "error - should return error if OpenAPIV3Schema is nil",
-			version: &apiextensionsv1.CustomResourceDefinitionVersion{
-				Name: "v1",
-				Schema: &apiextensionsv1.CustomResourceValidation{
-					OpenAPIV3Schema: nil, // The point of failure
-				},
-			},
-			wantProperties: nil,
-			wantErrMsg:     fmt.Sprintf("missing version OpenAPI Schema from %v spec", kind),
-		},
-		{
-			name: "should return error if Properties map is nil",
-			version: &apiextensionsv1.CustomResourceDefinitionVersion{
-				Name: "v1",
-				Schema: &apiextensionsv1.CustomResourceValidation{
-					OpenAPIV3Schema: &apiextensionsv1.JSONSchemaProps{
-						Properties: nil, // The point of failure
-					},
-				},
-			},
-			wantProperties: nil,
-			wantErrMsg:     fmt.Sprintf("missing version OpenAPI Properties from %v spec", kind),
-		},
-	}
-
-	for _, tc := range testCases {
-		t.Run(tc.name, func(t *testing.T) {
-			gotProperties, err := crds.GetOpenAPIProperties(kind, tc.version)
-			if tc.wantErrMsg != "" {
-				require.Error(t, err)
-				require.EqualError(t, err, tc.wantErrMsg)
-				require.Nil(t, gotProperties)
-			} else {
-				require.NoError(t, err)
-				require.Equal(t, tc.wantProperties, gotProperties)
-			}
-		})
-	}
-}
-
-func TestGetSpecPropertiesFor(t *testing.T) {
-	const kind = "MyTestCRD"
-
-	// Reusable properties for the test cases
-	nestedProperties := map[string]apiextensionsv1.JSONSchemaProps{
-		"replicas": {Type: "integer"},
-		"image":    {Type: "string"},
-	}
-
-	testCases := []struct {
-		name           string
-		props          map[string]apiextensionsv1.JSONSchemaProps
-		field          string
-		wantProperties map[string]apiextensionsv1.JSONSchemaProps
-		wantErrMsg     string
-	}{
-		{
-			name: "should return nested properties",
-			props: map[string]apiextensionsv1.JSONSchemaProps{
-				"spec": {
-					Type:       "object",
-					Properties: nestedProperties,
-				},
-				"status": {
-					Type: "object",
-				},
-			},
-			field:          "spec",
-			wantProperties: nestedProperties,
-			wantErrMsg:     "", // Expect no error
-		},
-		{
-			name: "field is missing from properties map",
-			props: map[string]apiextensionsv1.JSONSchemaProps{
-				"status": {Type: "object"},
-			},
-			field:          "spec", // This field does not exist
-			wantProperties: nil,
-			wantErrMsg:     fmt.Sprintf("kind %q spec is missing field %q on", kind, "spec"),
-		},
-		{
-			name: "field is not of type object",
-			props: map[string]apiextensionsv1.JSONSchemaProps{
-				"spec": {Type: "string"}, // The point of failure
-			},
-			field:          "spec",
-			wantProperties: nil,
-			wantErrMsg:     fmt.Sprintf("kind %q field %q expected to be object but is %v", kind, "spec", "string"),
-		},
-		{
-			name: "field is an object but has no nested properties",
-			props: map[string]apiextensionsv1.JSONSchemaProps{
-				"spec": {
-					Type:       "object",
-					Properties: nil, // The nested map is nil
-				},
-			},
-			field:          "spec",
-			wantProperties: nil, // Expecting a nil map is correct here
-			wantErrMsg:     "",
-		},
-	}
-
-	for _, tc := range testCases {
-		t.Run(tc.name, func(t *testing.T) {
-			// Act
-			gotProperties, err := crds.GetSpecPropertiesFor(kind, tc.props, tc.field)
-
-			// Assert
-			if tc.wantErrMsg != "" {
-				// We expect an error
-				require.Error(t, err)
-				require.EqualError(t, err, tc.wantErrMsg)
-				require.Nil(t, gotProperties)
-			} else {
-				// We expect success
-				require.NoError(t, err)
-				require.Equal(t, tc.wantProperties, gotProperties)
-			}
-		})
-	}
-}