chore: switch to openapiv3 as data format and remove self contained tests (#88)

* chore: switch to openapiv3 as data format and remove slef contained tests

* tests: small test fixture fix

* tests: small test fixture fix

* chore: upgrade to go 1.25 and remove some replacements

* tests: introduce basic e2e test suite for standard k8s cluster

* chore: init logger

* chore: running the linter...

Author: aaronschweig

.golangci.yaml

@@ -0,0 +1,34 @@
+version: "2"
+formatters:
+  enable:
+    - gci
+    - gofmt
+  settings:
+    gci:
+      sections:
+        - standard
+        - default
+        - prefix(k8s.io,sigs.k8s.io)
+        - prefix(sigs.k8s.io/multicluster-runtime)
+        - prefix(github.com/kcp-dev)
+        - prefix(github.com/kcp-dev/multicluster-provider)
+        - blank
+        - dot
+      custom-order: true
+    gofmt:
+      rewrite-rules:
+        - pattern: 'interface{}'
+          replacement: 'any'
+  exclusions:
+    generated: lax
+    paths:
+      - zz_generated.*\.go$
+      - .*conversion.*\.go$
+      - third_party$
+      - builtin$
+      - examples$
+
+linters:
+  exclusions:
+    paths:
+      - watcher_test\.go$

Taskfile.yml

@@ -7,6 +7,7 @@ vars:
   ENVTEST_VERSION: "release-0.20" # https://github.com/kubernetes-sigs/controller-runtime/releases
   MOCKERY_VERSION: v2.52.3 # https://github.com/vektra/mockery/releases
   CONTROLLER_GEN_VERSION: v0.18.0 # https://github.com/kubernetes-sigs/controller-tools/releases
+  GOLANGCI_LINT_VERSION: v2.6.0
 tasks:
   ## Setup
   setup:mockery:
@@ -21,39 +22,21 @@ tasks:
     internal: true
     cmds:
       - test -s {{.LOCAL_BIN}}/controller-gen || GOBIN=$(pwd)/{{.LOCAL_BIN}} go install sigs.k8s.io/controller-tools/cmd/controller-gen@{{.CONTROLLER_GEN_VERSION}}
-  update:crd:
-    desc: "Download the latest CRDs"
-    cmds:
-      - mkdir -p tests/gateway_test/testdata/crd
-      - curl -sSLo tests/gateway_test/testdata/crd/core.platform-mesh.io_accounts.yaml https://raw.githubusercontent.com/platform-mesh/account-operator/main/config/crd/core.platform-mesh.io_accounts.yaml
-      - echo "CRD updated successfully."
   setup:golangci-lint:
     internal: true
     cmds:
-      - test -s {{.LOCAL_BIN}}/golangci-lint || GOBIN=$(pwd)/{{.LOCAL_BIN}} go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+      - test -s {{.LOCAL_BIN}}/golangci-lint || GOBIN=$(pwd)/{{.LOCAL_BIN}} go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@{{.GOLANGCI_LINT_VERSION}}
   setup:go-test-coverage:
     internal: true
     cmds:
       - test -s {{.LOCAL_BIN}}/go-test-coverage || GOBIN=$(pwd)/{{.LOCAL_BIN}} go install github.com/vladopajic/go-test-coverage/v2@latest
 
   ## Code Generation
-  generate:crd:
-    desc: "Generate CRD manifests from Go types"
-    deps: [setup:controller-gen]
-    cmds:
-      - "{{.LOCAL_BIN}}/controller-gen crd:crdVersions=v1 paths=./common/apis/v1alpha1 output:crd:artifacts:config=config/crd"
-      - echo "CRD manifests generated successfully in config/crd/"
-  generate:deepcopy:
-    desc: "Generate deepcopy methods for API types"
-    deps: [setup:controller-gen]
-    cmds:
-      - "{{.LOCAL_BIN}}/controller-gen object paths=./common/apis/v1alpha1"
-      - echo "Deepcopy methods generated successfully"
   generate:
     desc: "Generate all CRD-related files (manifests + deepcopy methods)"
-    deps: [generate:crd, generate:deepcopy]
+    deps: [setup:controller-gen]
     cmds:
-      - echo "All CRD generation completed successfully!"
+      - "{{.LOCAL_BIN}}/controller-gen object crd:crdVersions=v1 paths=./common/apis/v1alpha1 output:crd:artifacts:config=config/crd"
 
   ## Development
   mockery:
@@ -66,14 +49,14 @@ tasks:
   ## Testing
   fmt:
     cmds:
-      - go fmt ./...
+      - "{{.LOCAL_BIN}}/golangci-lint fmt ./..."
   lint:
     deps: [setup:golangci-lint]
     cmds:
       - task: fmt
       - "{{.LOCAL_BIN}}/golangci-lint run --timeout 10m ./..."
   envtest:
-    deps: [mockery]
+    deps: [setup:envtest]
     env:
       KUBEBUILDER_ASSETS:
         sh: $(pwd)/{{.LOCAL_BIN}}/setup-envtest use {{.ENVTEST_K8S_VERSION}} --bin-dir $(pwd)/{{.LOCAL_BIN}} -p path
@@ -86,7 +69,7 @@ tasks:
         vars:
           ADDITIONAL_COMMAND_ARGS: -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
   cover:
-    deps: [ setup:envtest, update:crd, setup:go-test-coverage ]
+    deps: [setup:envtest, setup:go-test-coverage ]
     cmds:
       - task: envtest
         vars:

cmd/gateway.go

@@ -7,15 +7,15 @@ import (
 	"net/http"
 	"time"
 
-	openmfpcontext "github.com/platform-mesh/golang-commons/context"
+	pmcontext "github.com/platform-mesh/golang-commons/context"
 	"github.com/platform-mesh/golang-commons/logger"
 	"github.com/platform-mesh/golang-commons/sentry"
 	"github.com/platform-mesh/golang-commons/traces"
+	"github.com/platform-mesh/kubernetes-graphql-gateway/gateway/manager"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/spf13/cobra"
-	ctrl "sigs.k8s.io/controller-runtime"
 
-	"github.com/platform-mesh/kubernetes-graphql-gateway/gateway/manager"
+	ctrl "sigs.k8s.io/controller-runtime"
 )
 
 var gatewayCmd = &cobra.Command{
@@ -25,7 +25,7 @@ var gatewayCmd = &cobra.Command{
 	Run: func(_ *cobra.Command, _ []string) {
 		log.Info().Str("LogLevel", log.GetLevel().String()).Msg("Starting the Gateway...")
 
-		ctx, _, shutdown := openmfpcontext.StartContext(log, appCfg, 1*time.Second)
+		ctx, _, shutdown := pmcontext.StartContext(log, appCfg, 1*time.Second)
 		defer shutdown()
 
 		if err := initializeSentry(ctx, log); err != nil {
@@ -68,7 +68,7 @@ func initializeSentry(ctx context.Context, log *logger.Logger) error {
 		log.Fatal().Err(err).Msg("Sentry init failed")
 	}
 
-	defer openmfpcontext.Recover(log)
+	defer pmcontext.Recover(log)
 	return nil
 }
 

cmd/listener.go

@@ -4,10 +4,14 @@ import (
 	"context"
 	"crypto/tls"
 
-	kcpapis "github.com/kcp-dev/kcp/sdk/apis/apis/v1alpha1"
-	kcpcore "github.com/kcp-dev/kcp/sdk/apis/core/v1alpha1"
-	kcptenancy "github.com/kcp-dev/kcp/sdk/apis/tenancy/v1alpha1"
+	gatewayv1alpha1 "github.com/platform-mesh/kubernetes-graphql-gateway/common/apis/v1alpha1"
+	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/pkg/apischema"
+	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/pkg/workspacefile"
+	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/reconciler"
+	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/reconciler/clusteraccess"
+	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/reconciler/kcp"
 	"github.com/spf13/cobra"
+
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
@@ -17,26 +21,23 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
 	"sigs.k8s.io/controller-runtime/pkg/metrics/filters"
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
-	"sigs.k8s.io/controller-runtime/pkg/webhook"
-
-	gatewayv1alpha1 "github.com/platform-mesh/kubernetes-graphql-gateway/common/apis/v1alpha1"
-	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/pkg/apischema"
-	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/pkg/workspacefile"
-	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/reconciler"
-	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/reconciler/clusteraccess"
-	"github.com/platform-mesh/kubernetes-graphql-gateway/listener/reconciler/kcp"
-)
 
-var (
-	scheme               = runtime.NewScheme()
-	webhookServer        webhook.Server
-	metricsServerOptions metricsserver.Options
+	kcpapis "github.com/kcp-dev/kcp/sdk/apis/apis/v1alpha1"
+	kcpcore "github.com/kcp-dev/kcp/sdk/apis/core/v1alpha1"
+	kcptenancy "github.com/kcp-dev/kcp/sdk/apis/tenancy/v1alpha1"
 )
 
 var listenCmd = &cobra.Command{
 	Use:     "listener",
 	Example: "KUBECONFIG=<path to kubeconfig file> go run . listener",
-	PreRun: func(cmd *cobra.Command, args []string) {
+	Run: func(cmd *cobra.Command, args []string) {
+		log.Info().Str("LogLevel", log.GetLevel().String()).Msg("Starting the Listener...")
+
+		ctx := ctrl.SetupSignalHandler()
+		restCfg := ctrl.GetConfigOrDie()
+
+		scheme := runtime.NewScheme()
+
 		utilruntime.Must(clientgoscheme.AddToScheme(scheme))
 
 		if appCfg.EnableKcp {
@@ -60,11 +61,7 @@ var listenCmd = &cobra.Command{
 			tlsOpts = []func(c *tls.Config){disableHTTP2}
 		}
 
-		webhookServer = webhook.NewServer(webhook.Options{
-			TLSOpts: tlsOpts,
-		})
-
-		metricsServerOptions = metricsserver.Options{
+		metricsServerOptions := metricsserver.Options{
 			BindAddress:   defaultCfg.Metrics.BindAddress,
 			SecureServing: defaultCfg.Metrics.Secure,
 			TLSOpts:       tlsOpts,
@@ -73,17 +70,10 @@ var listenCmd = &cobra.Command{
 		if defaultCfg.Metrics.Secure {
 			metricsServerOptions.FilterProvider = filters.WithAuthenticationAndAuthorization
 		}
-	},
-	Run: func(cmd *cobra.Command, args []string) {
-		log.Info().Str("LogLevel", log.GetLevel().String()).Msg("Starting the Listener...")
-
-		ctx := ctrl.SetupSignalHandler()
-		restCfg := ctrl.GetConfigOrDie()
 
 		mgrOpts := ctrl.Options{
 			Scheme:                 scheme,
 			Metrics:                metricsServerOptions,
-			WebhookServer:          webhookServer,
 			HealthProbeBindAddress: defaultCfg.HealthProbeBindAddress,
 			LeaderElection:         defaultCfg.LeaderElection.Enabled,
 			LeaderElectionID:       "72231e1f.platform-mesh.io",

cmd/root.go

@@ -1,17 +1,16 @@
 package cmd
 
 import (
-	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
-
-	openmfpconfig "github.com/platform-mesh/golang-commons/config"
+	pmconfig "github.com/platform-mesh/golang-commons/config"
 	"github.com/platform-mesh/golang-commons/logger"
 	"github.com/platform-mesh/kubernetes-graphql-gateway/common/config"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 )
 
 var (
 	appCfg     config.Config
-	defaultCfg *openmfpconfig.CommonServiceConfig
+	defaultCfg *pmconfig.CommonServiceConfig
 	v          *viper.Viper
 	log        *logger.Logger
 )
@@ -25,7 +24,7 @@ func init() {
 	rootCmd.AddCommand(listenCmd)
 
 	var err error
-	v, defaultCfg, err = openmfpconfig.NewDefaultConfig(rootCmd)
+	v, defaultCfg, err = pmconfig.NewDefaultConfig(rootCmd)
 	if err != nil {
 		panic(err)
 	}
@@ -40,12 +39,12 @@ func init() {
 		}
 	})
 
-	err = openmfpconfig.BindConfigToFlags(v, gatewayCmd, &appCfg)
+	err = pmconfig.BindConfigToFlags(v, gatewayCmd, &appCfg)
 	if err != nil {
 		panic(err)
 	}
 
-	err = openmfpconfig.BindConfigToFlags(v, listenCmd, &appCfg)
+	err = pmconfig.BindConfigToFlags(v, listenCmd, &appCfg)
 	if err != nil {
 		panic(err)
 	}

common/auth/config.go

@@ -6,16 +6,15 @@ import (
 	"errors"
 	"fmt"
 
+	gatewayv1alpha1 "github.com/platform-mesh/kubernetes-graphql-gateway/common/apis/v1alpha1"
+
 	authv1 "k8s.io/api/authentication/v1"
 	corev1 "k8s.io/api/core/v1"
-
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/clientcmd"
 	"k8s.io/client-go/tools/clientcmd/api"
 	"sigs.k8s.io/controller-runtime/pkg/client"
-
-	gatewayv1alpha1 "github.com/platform-mesh/kubernetes-graphql-gateway/common/apis/v1alpha1"
 )
 
 // BuildConfig creates a rest.Config from cluster connection parameters
@@ -39,8 +38,8 @@ func BuildConfig(ctx context.Context, host string, auth *gatewayv1alpha1.AuthCon
 			return nil, errors.Join(errors.New("failed to extract CA data"), err)
 		}
 		if caData != nil {
-			config.TLSClientConfig.CAData = caData
-			config.TLSClientConfig.Insecure = false // Use proper TLS verification when CA is provided
+			config.CAData = caData
+			config.Insecure = false // Use proper TLS verification when CA is provided
 		}
 	}
 
@@ -74,8 +73,8 @@ func BuildConfigFromMetadata(host string, authType, token, kubeconfig, certData,
 		if err != nil {
 			return nil, fmt.Errorf("failed to decode CA data: %w", err)
 		}
-		config.TLSClientConfig.CAData = decodedCA
-		config.TLSClientConfig.Insecure = false
+		config.CAData = decodedCA
+		config.Insecure = false
 	}
 
 	// Handle authentication based on type
@@ -109,8 +108,8 @@ func BuildConfigFromMetadata(host string, authType, token, kubeconfig, certData,
 			if err != nil {
 				return nil, fmt.Errorf("failed to decode key data: %w", err)
 			}
-			config.TLSClientConfig.CertData = decodedCert
-			config.TLSClientConfig.KeyData = decodedKey
+			config.CertData = decodedCert
+			config.KeyData = decodedKey
 		}
 	}
 
@@ -247,16 +246,16 @@ func ConfigureAuthentication(ctx context.Context, config *rest.Config, auth *gat
 			return errors.New("client certificate or key not found in secret")
 		}
 
-		config.TLSClientConfig.CertData = certData
-		config.TLSClientConfig.KeyData = keyData
+		config.CertData = certData
+		config.KeyData = keyData
 		return nil
 	}
 
 	if auth.ServiceAccount != nil {
 		var expirationSeconds int64
 		if auth.ServiceAccount.TokenExpiration != nil {
 			// If TokenExpiration is provided, use its value
-			expirationSeconds = int64(auth.ServiceAccount.TokenExpiration.Duration.Seconds())
+			expirationSeconds = int64(auth.ServiceAccount.TokenExpiration.Seconds())
 		} else {
 			// If TokenExpiration is nil, use the desired default (3600 seconds = 1 hour)
 			expirationSeconds = 3600
@@ -346,14 +345,14 @@ func ExtractAuthFromKubeconfig(config *rest.Config, authInfo *api.AuthInfo) erro
 	}
 
 	if len(authInfo.ClientCertificateData) > 0 && len(authInfo.ClientKeyData) > 0 {
-		config.TLSClientConfig.CertData = authInfo.ClientCertificateData
-		config.TLSClientConfig.KeyData = authInfo.ClientKeyData
+		config.CertData = authInfo.ClientCertificateData
+		config.KeyData = authInfo.ClientKeyData
 		return nil
 	}
 
 	if authInfo.ClientCertificate != "" && authInfo.ClientKey != "" {
-		config.TLSClientConfig.CertFile = authInfo.ClientCertificate
-		config.TLSClientConfig.KeyFile = authInfo.ClientKey
+		config.CertFile = authInfo.ClientCertificate
+		config.KeyFile = authInfo.ClientKey
 		return nil
 	}