feat: introduce a get query with yaml representation of the resource (#95)

* feat: introduce a get query with yaml representation of the resource

* fix: typo in gha

Author: aaronschweig

.github/workflows/pipeline.yml

@@ -13,6 +13,6 @@ jobs:
       useLocalCoverageConfig: true
       imageTagName: ghcr.io/openmfp/crd-gql-gateway
       coverageThreasholdFile: 0
-      coverageThreasholdPackage: 0
+      coverageThresholdPackage: 0
       coverageThreasholdTotal: 0
 

gateway/resolver/resolver.go

@@ -1,12 +1,15 @@
 package resolver
 
 import (
+	"bytes"
 	"encoding/json"
 	"errors"
 	"fmt"
-	"github.com/rs/zerolog/log"
 	"regexp"
 
+	"github.com/rs/zerolog/log"
+	"gopkg.in/yaml.v3"
+
 	"github.com/graphql-go/graphql"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
@@ -28,6 +31,7 @@ type Provider interface {
 type CrudProvider interface {
 	ListItems(gvk schema.GroupVersionKind) graphql.FieldResolveFn
 	GetItem(gvk schema.GroupVersionKind) graphql.FieldResolveFn
+	GetItemAsYAML(gvk schema.GroupVersionKind) graphql.FieldResolveFn
 	CreateItem(gvk schema.GroupVersionKind) graphql.FieldResolveFn
 	UpdateItem(gvk schema.GroupVersionKind) graphql.FieldResolveFn
 	DeleteItem(gvk schema.GroupVersionKind) graphql.FieldResolveFn
@@ -152,6 +156,26 @@ func (r *Service) GetItem(gvk schema.GroupVersionKind) graphql.FieldResolveFn {
 	}
 }
 
+func (r *Service) GetItemAsYAML(gvk schema.GroupVersionKind) graphql.FieldResolveFn {
+	return func(p graphql.ResolveParams) (interface{}, error) {
+		var span trace.Span
+		p.Context, span = otel.Tracer("").Start(p.Context, "GetItemAsYAML", trace.WithAttributes(attribute.String("kind", gvk.Kind)))
+		defer span.End()
+
+		out, err := r.GetItem(gvk)(p)
+		if err != nil {
+			return "", err
+		}
+
+		var returnYaml bytes.Buffer
+		if err := yaml.NewEncoder(&returnYaml).Encode(out); err != nil {
+			return "", err
+		}
+
+		return returnYaml.String(), nil
+	}
+}
+
 func (r *Service) CreateItem(gvk schema.GroupVersionKind) graphql.FieldResolveFn {
 	return func(p graphql.ResolveParams) (interface{}, error) {
 		ctx, span := otel.Tracer("").Start(p.Context, "CreateItem", trace.WithAttributes(attribute.String("kind", gvk.Kind)))

gateway/schema/schema.go

@@ -116,6 +116,15 @@ func (g *Gateway) generateGraphqlSchema() error {
 				Resolve: g.resolver.GetItem(*gvk),
 			})
 
+			queryGroupType.AddFieldConfig(singular+"Yaml", &graphql.Field{
+				Type: graphql.NewNonNull(graphql.String),
+				Args: resolver.NewFieldConfigArguments().
+					WithNameArg().
+					WithNamespaceArg().
+					Complete(),
+				Resolve: g.resolver.GetItemAsYAML(*gvk),
+			})
+
 			// Mutation definitions
 			mutationGroupType.AddFieldConfig("create"+singular, &graphql.Field{
 				Type: resourceType,

go.mod

@@ -26,6 +26,7 @@ require (
 	go.opentelemetry.io/otel v1.34.0
 	go.opentelemetry.io/otel/trace v1.34.0
 	golang.org/x/text v0.22.0
+	gopkg.in/yaml.v3 v3.0.1
 	k8s.io/api v0.32.2
 	k8s.io/apiextensions-apiserver v0.32.2
 	k8s.io/apimachinery v0.32.2
@@ -109,7 +110,6 @@ require (
 	google.golang.org/protobuf v1.36.5 // indirect
 	gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/apiserver v0.32.2 // indirect
 	k8s.io/component-base v0.32.2 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect