feat(gateway): correct plural form (#207)

* used flect to pluralize

On-behalf-of: @SAP [email protected]
Signed-off-by: Artem Shcherbatiuk <[email protected]>

---------

Signed-off-by: Artem Shcherbatiuk <[email protected]>

Author: vertex451

gateway/schema/exports_test.go

@@ -1,3 +1,15 @@
 package schema
 
-var StringMapScalar = stringMapScalar
+import "k8s.io/apimachinery/pkg/runtime/schema"
+
+var StringMapScalarForTest = stringMapScalar
+
+func GetGatewayForTest(typeNameRegistry map[string]string) *Gateway {
+	return &Gateway{
+		typeNameRegistry: typeNameRegistry,
+	}
+}
+
+func (g *Gateway) GetNamesForTest(gvk *schema.GroupVersionKind) (singular, plural string) {
+	return g.getNames(gvk)
+}

gateway/schema/scalars_test.go

@@ -29,7 +29,7 @@ func TestStringMapScalar_ParseValue(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		out := schema.StringMapScalar.ParseValue(test.input)
+		out := schema.StringMapScalarForTest.ParseValue(test.input)
 		if !reflect.DeepEqual(out, test.expected) {
 			t.Errorf("ParseValue(%v) = %v; want %v", test.input, out, test.expected)
 		}
@@ -68,7 +68,7 @@ func TestStringMapScalar_ParseLiteral(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			out := schema.StringMapScalar.ParseLiteral(tt.input)
+			out := schema.StringMapScalarForTest.ParseLiteral(tt.input)
 			if !reflect.DeepEqual(out, tt.expected) {
 				t.Errorf("ParseLiteral() = %v, want %v", out, tt.expected)
 			}

gateway/schema/schema.go

@@ -6,10 +6,10 @@ import (
 	"regexp"
 	"strings"
 
-	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
-
 	"github.com/go-openapi/spec"
+	"github.com/gobuffalo/flect"
 	"github.com/graphql-go/graphql"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 
 	"github.com/openmfp/golang-commons/logger"
@@ -33,7 +33,7 @@ type Gateway struct {
 	// inputTypesCache stores generated GraphQL input object types(input fields) to prevent redundant repeated generation.
 	inputTypesCache map[string]*graphql.InputObject
 	// Prevents naming conflict in case of the same Kind name in different groups/versions
-	typeNameRegistry map[string]string
+	typeNameRegistry map[string]string // map[Kind]GroupVersion
 
 	// categoryRegistry stores resources by category for typeByCategory query
 	typeByCategory map[string][]resolver.TypeByCategory
@@ -275,28 +275,24 @@ func (g *Gateway) processSingleResource(
 
 func (g *Gateway) getNames(gvk *schema.GroupVersionKind) (singular string, plural string) {
 	kind := gvk.Kind
-	singularName := kind
+	singular = kind
+	plural = flect.Pluralize(singular)
 
 	// Check if the kind name has already been used for a different group/version
 	if existingGroupVersion, exists := g.typeNameRegistry[kind]; exists {
 		if existingGroupVersion != gvk.GroupVersion().String() {
-			// Conflict detected, append group and version
-			groupVersion := strings.ReplaceAll(gvk.GroupVersion().String(), "/", "")
-			singularName = kind + groupVersion
+			// Conflict detected, append group and version to the kind for uniqueness
+			// we don't add new entry to the registry, because we already have one with the same kind
+			group := strings.ReplaceAll(gvk.Group, ".", "") // dots are allowed in k8s group, but not in graphql
+			singular = strings.Join([]string{kind, group, gvk.Version}, "_")
+			plural = strings.Join([]string{plural, group, gvk.Version}, "_")
 		}
 	} else {
 		// No conflict, register the kind with its group and version
 		g.typeNameRegistry[kind] = gvk.GroupVersion().String()
 	}
 
-	var pluralName string
-	if singularName[len(singularName)-1] == 's' {
-		pluralName = singularName + "es"
-	} else {
-		pluralName = singularName + "s"
-	}
-
-	return singularName, pluralName
+	return singular, plural
 }
 
 func (g *Gateway) getDefinitionsByGroup(filteredDefinitions spec.Definitions) map[string]spec.Definitions {

gateway/schema/schema_test.go

@@ -0,0 +1,48 @@
+package schema_test
+
+import (
+	"testing"
+
+	"k8s.io/apimachinery/pkg/runtime/schema"
+
+	gatewaySchema "github.com/openmfp/kubernetes-graphql-gateway/gateway/schema"
+)
+
+func TestGateway_getNames(t *testing.T) {
+	type testCase struct {
+		name         string
+		registry     map[string]string
+		gvk          schema.GroupVersionKind
+		wantSingular string
+		wantPlural   string
+	}
+
+	tests := []testCase{
+		{
+			name:         "no_conflict",
+			registry:     map[string]string{},
+			gvk:          schema.GroupVersionKind{Group: "core", Version: "v1", Kind: "Pod"},
+			wantSingular: "Pod",
+			wantPlural:   "Pods",
+		},
+		{
+			name:         "same_kind_different_group_version",
+			registry:     map[string]string{"Pod": "core/v1"},
+			gvk:          schema.GroupVersionKind{Group: "custom.io", Version: "v2", Kind: "Pod"},
+			wantSingular: "Pod_customio_v2",
+			wantPlural:   "Pods_customio_v2",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			g := gatewaySchema.GetGatewayForTest(tt.registry)
+			gotSingular, gotPlural := g.GetNamesForTest(&tt.gvk)
+
+			if gotSingular != tt.wantSingular || gotPlural != tt.wantPlural {
+				t.Errorf("getNames() = (%q, %q), want (%q, %q)",
+					gotSingular, gotPlural, tt.wantSingular, tt.wantPlural)
+			}
+		})
+	}
+}

go.mod

@@ -11,6 +11,7 @@ replace github.com/graphql-go/handler => github.com/vertex451/handler v0.0.0-202
 require (
 	github.com/fsnotify/fsnotify v1.9.0
 	github.com/go-openapi/spec v0.21.0
+	github.com/gobuffalo/flect v1.0.3
 	github.com/golang-jwt/jwt/v5 v5.2.2
 	github.com/google/gnostic-models v0.6.9
 	github.com/graphql-go/graphql v0.8.1

go.sum

@@ -63,6 +63,8 @@ github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1v
 github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8=
 github.com/go-viper/mapstructure/v2 v2.2.1 h1:ZAaOCxANMuZx5RCeg0mBdEZk7DZasvvZIxtHqx8aGss=
 github.com/go-viper/mapstructure/v2 v2.2.1/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
+github.com/gobuffalo/flect v1.0.3 h1:xeWBM2nui+qnVvNM4S3foBhCAL2XgPU+a7FdpelbTq4=
+github.com/gobuffalo/flect v1.0.3/go.mod h1:A5msMlrHtLqh9umBSnvabjsMrCcCpAyzglnDvkbYKHs=
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
 github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=