Add Resource scope information to APISchema (#99)

* expose scope information in x-openmfp-scope extension

* cleanup useless tests and mv mocks

* bump mockery to latest

Author: fourthisle

.mockery.yaml

@@ -1,30 +1,10 @@
+issue-845-fix: True
+resolve-type-alias: False
 with-expecter: true
 packages:
-  github.com/openmfp/crd-gql-gateway/listener/apischema:
-    config:
-      dir: listener/apischema/mocks
-      outpkg: mocks
-    interfaces:
-      Resolver:
-
-  github.com/openmfp/crd-gql-gateway/listener/discoveryclient:
-    config:
-      dir: listener/discoveryclient/mocks
-      outpkg: mocks
-    interfaces:
-      Factory:
-
-  github.com/openmfp/crd-gql-gateway/listener/workspacefile:
-    config:
-      dir: listener/workspacefile/mocks
-      outpkg: mocks
-    interfaces:
-      IOHandler:
-
   sigs.k8s.io/controller-runtime/pkg/client:
     config:
-      dir: listener/controller/mocks
+      dir: gateway/resolver/mocks
       outpkg: mocks
     interfaces:
-      Client:
       WithWatch:

Taskfile.yml

@@ -5,12 +5,13 @@ vars:
   LOCAL_BIN: bin
   ENVTEST_K8S_VERSION: "1.29.0"
   ENVTEST_VERSION: release-0.17
+  MOCKERY_VERSION: v2.52.3
 tasks:
   ## Setup
   setup:mockery:
     internal: true
     cmds:
-      - test -s {{.LOCAL_BIN}}/mockery || GOBIN=$(pwd)/{{.LOCAL_BIN}} go install github.com/vektra/mockery/v2@v2.43.2
+      - test -s {{.LOCAL_BIN}}/mockery || GOBIN=$(pwd)/{{.LOCAL_BIN}} go install github.com/vektra/mockery/v2@{{.MOCKERY_VERSION}}
   setup:envtest:
     internal: true
     cmds:

listener/controller/mocks/mock_WithWatch.go renamed to gateway/resolver/mocks/mock_WithWatch.go

@@ -2,8 +2,10 @@ package resolver
 
 import (
 	"context"
+	"testing"
+
 	"github.com/graphql-go/graphql"
-	"github.com/openmfp/crd-gql-gateway/listener/controller/mocks"
+	"github.com/openmfp/crd-gql-gateway/gateway/resolver/mocks"
 	"github.com/openmfp/golang-commons/logger"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
@@ -12,7 +14,6 @@ import (
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"sigs.k8s.io/controller-runtime/pkg/client"
-	"testing"
 )
 
 func getResolver(runtimeClientMock client.WithWatch) (*Service, error) {

gateway/resolver/resolver_test.go

@@ -10,6 +10,8 @@ import (
 
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/client-go/discovery"
 	"k8s.io/client-go/openapi"
 	"k8s.io/kube-openapi/pkg/validation/spec"
@@ -23,10 +25,11 @@ var (
 
 type CRDResolver struct {
 	*discovery.DiscoveryClient
+	meta.RESTMapper
 }
 
 func (cr *CRDResolver) Resolve() ([]byte, error) {
-	return resolveSchema(cr.DiscoveryClient)
+	return resolveSchema(cr.DiscoveryClient, cr.RESTMapper)
 }
 
 func (cr *CRDResolver) ResolveApiSchema(crd *apiextensionsv1.CustomResourceDefinition) ([]byte, error) {
@@ -45,7 +48,7 @@ func (cr *CRDResolver) ResolveApiSchema(crd *apiextensionsv1.CustomResourceDefin
 		return nil, fmt.Errorf("failed to filter server preferred resources: %w", err)
 	}
 
-	return resolveForPaths(cr.OpenAPIV3(), preferredApiGroups)
+	return resolveForPaths(cr.OpenAPIV3(), preferredApiGroups, cr.RESTMapper)
 }
 
 func errorIfCRDNotInPreferredApiGroups(gvk *metav1.GroupVersionKind, apiResLists []*metav1.APIResourceList) ([]string, error) {
@@ -112,7 +115,7 @@ func getSchemaForPath(preferredApiGroups []string, path string, gv openapi.Group
 	return resp.Components.Schemas, nil
 }
 
-func resolveForPaths(oc openapi.Client, preferredApiGroups []string) ([]byte, error) {
+func resolveForPaths(oc openapi.Client, preferredApiGroups []string, rm meta.RESTMapper) ([]byte, error) {
 	apiv3Paths, err := oc.Paths()
 	if err != nil {
 		return nil, fmt.Errorf("failed to get OpenAPI paths: %w", err)
@@ -127,9 +130,15 @@ func resolveForPaths(oc openapi.Client, preferredApiGroups []string) ([]byte, er
 		}
 		maps.Copy(schemas, schema)
 	}
+
+	scopedSchemas, err := addScopeInfo(schemas, rm)
+	if err != nil {
+		return nil, fmt.Errorf("failed to add scope info to v3 schema: %w", err)
+	}
+
 	v3JSON, err := json.Marshal(&schemaResponse{
 		Components: schemasComponentsWrapper{
-			Schemas: schemas,
+			Schemas: scopedSchemas,
 		},
 	})
 	if err != nil {
@@ -143,7 +152,7 @@ func resolveForPaths(oc openapi.Client, preferredApiGroups []string) ([]byte, er
 	return v2JSON, nil
 }
 
-func resolveSchema(dc discovery.DiscoveryInterface) ([]byte, error) {
+func resolveSchema(dc discovery.DiscoveryInterface, rm meta.RESTMapper) ([]byte, error) {
 	preferredApiGroups := []string{}
 	apiResList, err := dc.ServerPreferredResources()
 	if err != nil {
@@ -153,5 +162,5 @@ func resolveSchema(dc discovery.DiscoveryInterface) ([]byte, error) {
 		preferredApiGroups = append(preferredApiGroups, apiRes.GroupVersion)
 	}
 
-	return resolveForPaths(dc.OpenAPIV3(), preferredApiGroups)
+	return resolveForPaths(dc.OpenAPIV3(), preferredApiGroups, rm)
 }

listener/apischema/crd_resolver.go

@@ -1,6 +1,7 @@
 package apischema
 
 import (
+	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/client-go/discovery"
 	"k8s.io/kube-openapi/pkg/validation/spec"
 )
@@ -18,16 +19,16 @@ type schemaResponse struct {
 }
 
 type Resolver interface {
-	Resolve(dc discovery.DiscoveryInterface) ([]byte, error)
+	Resolve(dc discovery.DiscoveryInterface, rm meta.RESTMapper) ([]byte, error)
 }
 
-func NewResolver() *ResolverImpl {
-	return &ResolverImpl{}
+type resolverImpl struct {
 }
 
-type ResolverImpl struct {
+func NewResolver() *resolverImpl {
+	return &resolverImpl{}
 }
 
-func (r *ResolverImpl) Resolve(dc discovery.DiscoveryInterface) ([]byte, error) {
-	return resolveSchema(dc)
+func (r *resolverImpl) Resolve(dc discovery.DiscoveryInterface, rm meta.RESTMapper) ([]byte, error) {
+	return resolveSchema(dc, rm)
 }