Chore: harmonize listener and gateway (#118)

* one config to rule them all

* single gitignore

* single taskfile

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

Author: vertex451

.gitignore

@@ -1,16 +1,11 @@
-# If you prefer the allow list template instead of the deny list, see community template:
-# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
-#
 # Binaries for programs and plugins
 *.exe
 *.exe~
 *.dll
 *.so
 *.dylib
-.vscode
-.idea
-.secret
-.env
+bin/*
+Dockerfile.cross
 bin
 
 # Test binary, built with `go test -c`
@@ -20,14 +15,29 @@ bin
 *.out
 coverage.html
 
-# Dependency directories (remove the comment below to include it)
-# vendor/
+# Kubernetes Generated files - skip generated files, except for vendored files
+!vendor/**/zz_generated.*
+
+# editor and IDE paraphernalia
+.idea
+.vscode
+*.swp
+*.swo
+*~
+
+# MacOS
+**/.DS_Store
+
+# KCP local files
+**/.kcp/
+.kcp
+
+# Secrets and environment files
+.secret
+.env
 
 # Go workspace file
 go.work
 
 # binary files
-main
-
-# kcp
-.kcp
+main

Dockerfile

@@ -3,14 +3,10 @@ WORKDIR /app
 COPY . .
 RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags '-w -s' main.go
 
-FROM alpine
 
+FROM scratch
 WORKDIR /app
-
-
 COPY --from=builder  /app/main .
-
 USER 1001:1001
-
 ENTRYPOINT ["./main"]
-CMD ["gateway"]
+CMD ["listener"]

Taskfile.yml

@@ -3,9 +3,9 @@ version: '3'
 dotenv: ['.taskenv', '.secret/.env', '{{.HOME}}/.env' ]
 vars:
   LOCAL_BIN: bin
-  ENVTEST_K8S_VERSION: "1.29.0"
-  ENVTEST_VERSION: release-0.17
-  MOCKERY_VERSION: v2.52.3
+  ENVTEST_K8S_VERSION: "1.30.0" # to get latest version run $(pwd)/bin/setup-envtest list
+  ENVTEST_VERSION: "release-0.20" # https://github.com/kubernetes-sigs/controller-runtime/releases
+  MOCKERY_VERSION: v2.52.3 # https://github.com/vektra/mockery/releases
 tasks:
   ## Setup
   setup:mockery:
@@ -15,7 +15,7 @@ tasks:
   setup:envtest:
     internal: true
     cmds:
-      - test -s {{.LOCAL_BIN}}/setup-envtest|| GOBIN=$(pwd)/{{.LOCAL_BIN}} go install sigs.k8s.io/controller-runtime/tools/setup-envtest@{{.ENVTEST_VERSION}}
+      - test -s {{.LOCAL_BIN}}/setup-envtest || GOBIN=$(pwd)/{{.LOCAL_BIN}} go install sigs.k8s.io/controller-runtime/tools/setup-envtest@{{.ENVTEST_VERSION}}
   setup:golangci-lint:
     internal: true
     cmds:
@@ -30,9 +30,6 @@ tasks:
     deps: [ setup:mockery ]
     cmds:
       - "{{.LOCAL_BIN}}/mockery"
-  build:
-    cmds:
-      - go build ./...
   docker:
     cmds:
       - docker build -t ghcr.io/openmfp/kubernetes-graphql-gateway .
@@ -59,11 +56,12 @@ tasks:
         vars:
           ADDITIONAL_COMMAND_ARGS: -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
   cover:
-    deps: [setup:envtest]
+    deps: [setup:envtest, setup:go-test-coverage]
     cmds:
       - task: envtest
         vars:
           ADDITIONAL_COMMAND_ARGS: -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
+      - "{{.LOCAL_BIN}}/go-test-coverage --profile cover.out --config ./.testcoverage.yml"
   validate:
     cmds:
       - task: mockery

cmd/gateway.go

@@ -14,7 +14,7 @@ import (
 
 	"github.com/openmfp/golang-commons/logger"
 
-	appCfg "github.com/openmfp/kubernetes-graphql-gateway/gateway/config"
+	appConfig "github.com/openmfp/kubernetes-graphql-gateway/common/config"
 	"github.com/openmfp/kubernetes-graphql-gateway/gateway/manager"
 )
 
@@ -25,7 +25,7 @@ var gatewayCmd = &cobra.Command{
 	RunE: func(cmd *cobra.Command, args []string) error {
 		start := time.Now()
 
-		appCfg, err := appCfg.NewFromEnv()
+		appCfg, err := appConfig.NewFromEnv()
 		if err != nil {
 			log.Fatal().Err(err).Msg("Error getting app restCfg, exiting")
 		}

cmd/listener.go

@@ -22,9 +22,8 @@ import (
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
-	"github.com/openmfp/kubernetes-graphql-gateway/listener/flags"
+	"github.com/openmfp/kubernetes-graphql-gateway/common/config"
 	"github.com/openmfp/kubernetes-graphql-gateway/listener/kcp"
-	// +kubebuilder:scaffold:imports
 )
 
 func init() {
@@ -36,7 +35,7 @@ var (
 	setupLog             = ctrl.Log.WithName("setup")
 	webhookServer        webhook.Server
 	metricsServerOptions metricsserver.Options
-	opFlags              *flags.Flags
+	appCfg               *config.Config
 )
 
 var listenCmd = &cobra.Command{
@@ -49,15 +48,14 @@ var listenCmd = &cobra.Command{
 		utilruntime.Must(kcpcore.AddToScheme(scheme))
 		utilruntime.Must(kcptenancy.AddToScheme(scheme))
 		utilruntime.Must(apiextensionsv1.AddToScheme(scheme))
-		// +kubebuilder:scaffold:scheme
 
 		opts := zap.Options{
 			Development: true,
 		}
 		ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))
 
 		var err error
-		opFlags, err = flags.NewFromEnv()
+		appCfg, err = config.NewFromEnv()
 		if err != nil {
 			setupLog.Error(err, "failed to get operator flags from env, exiting...")
 			os.Exit(1)
@@ -69,7 +67,7 @@ var listenCmd = &cobra.Command{
 		}
 
 		var tlsOpts []func(*tls.Config)
-		if !opFlags.EnableHTTP2 {
+		if !appCfg.EnableHTTP2 {
 			tlsOpts = []func(c *tls.Config){disableHTTP2}
 		}
 
@@ -78,12 +76,12 @@ var listenCmd = &cobra.Command{
 		})
 
 		metricsServerOptions = metricsserver.Options{
-			BindAddress:   opFlags.MetricsAddr,
-			SecureServing: opFlags.SecureMetrics,
+			BindAddress:   appCfg.MetricsAddr,
+			SecureServing: appCfg.SecureMetrics,
 			TLSOpts:       tlsOpts,
 		}
 
-		if opFlags.SecureMetrics {
+		if appCfg.SecureMetrics {
 			metricsServerOptions.FilterProvider = filters.WithAuthenticationAndAuthorization
 		}
 	},
@@ -94,12 +92,12 @@ var listenCmd = &cobra.Command{
 			Scheme:                 scheme,
 			Metrics:                metricsServerOptions,
 			WebhookServer:          webhookServer,
-			HealthProbeBindAddress: opFlags.ProbeAddr,
-			LeaderElection:         opFlags.EnableLeaderElection,
+			HealthProbeBindAddress: appCfg.ProbeAddr,
+			LeaderElection:         appCfg.EnableLeaderElection,
 			LeaderElectionID:       "72231e1f.openmfp.io",
 		}
 
-		newMgrFunc := kcp.ManagerFactory(opFlags)
+		newMgrFunc := kcp.ManagerFactory(appCfg)
 
 		mgr, err := newMgrFunc(cfg, mgrOpts)
 		if err != nil {
@@ -110,10 +108,10 @@ var listenCmd = &cobra.Command{
 		reconcilerOpts := kcp.ReconcilerOpts{
 			Scheme:                 scheme,
 			Config:                 cfg,
-			OpenAPIDefinitionsPath: opFlags.OpenApiDefinitionsPath,
+			OpenAPIDefinitionsPath: appCfg.OpenApiDefinitionsPath,
 		}
 
-		newReconcilerFunc := kcp.ReconcilerFactory(opFlags)
+		newReconcilerFunc := kcp.ReconcilerFactory(appCfg)
 
 		reconciler, err := newReconcilerFunc(reconcilerOpts)
 		if err != nil {
@@ -125,7 +123,6 @@ var listenCmd = &cobra.Command{
 			setupLog.Error(err, "unable to create controller")
 			os.Exit(1)
 		}
-		// +kubebuilder:scaffold:builder
 
 		if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
 			setupLog.Error(err, "unable to set up health check")

common/config/config.go

@@ -0,0 +1,48 @@
+package config
+
+import (
+	"github.com/vrischmann/envconfig"
+)
+
+type Config struct {
+	Listener
+	Gateway
+
+	OpenApiDefinitionsPath string `envconfig:"default=./bin/definitions"`
+	EnableKcp              bool   `envconfig:"default=true,optional"`
+	LocalDevelopment       bool   `envconfig:"default=false,optional"`
+}
+
+type Gateway struct {
+	Port              string `envconfig:"default=8080,optional"`
+	LogLevel          string `envconfig:"default=INFO,optional"`
+	UserNameClaim     string `envconfig:"default=email,optional"`
+	ShouldImpersonate bool   `envconfig:"default=true,optional"`
+
+	HandlerCfg struct {
+		Pretty     bool `envconfig:"default=true,optional"`
+		Playground bool `envconfig:"default=true,optional"`
+		GraphiQL   bool `envconfig:"default=true,optional"`
+	}
+
+	Cors struct {
+		Enabled        bool     `envconfig:"default=false,optional"`
+		AllowedOrigins []string `envconfig:"default=*,optional"`
+		AllowedHeaders []string `envconfig:"default=*,optional"`
+	}
+}
+
+type Listener struct {
+	MetricsAddr          string `envconfig:"default=0,optional"`
+	EnableLeaderElection bool   `envconfig:"default=false,optional"`
+	ProbeAddr            string `envconfig:"default=:8081,optional"`
+	SecureMetrics        bool   `envconfig:"default=true,optional"`
+	EnableHTTP2          bool   `envconfig:"default=false,optional"`
+}
+
+// NewFromEnv creates a Gateway from environment values
+func NewFromEnv() (*Config, error) {
+	cfg := &Config{}
+	err := envconfig.Init(cfg)
+	return cfg, err
+}

gateway/config/config.go

@@ -16,14 +16,16 @@ import (
 	"github.com/graphql-go/graphql"
 	"github.com/graphql-go/handler"
 	"github.com/kcp-dev/logicalcluster/v3"
-	"github.com/openmfp/golang-commons/logger"
-	appConfig "github.com/openmfp/kubernetes-graphql-gateway/gateway/config"
-	"github.com/openmfp/kubernetes-graphql-gateway/gateway/resolver"
-	"github.com/openmfp/kubernetes-graphql-gateway/gateway/schema"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/kcp"
 	"sigs.k8s.io/controller-runtime/pkg/kontext"
+
+	"github.com/openmfp/golang-commons/logger"
+
+	appConfig "github.com/openmfp/kubernetes-graphql-gateway/common/config"
+	"github.com/openmfp/kubernetes-graphql-gateway/gateway/resolver"
+	"github.com/openmfp/kubernetes-graphql-gateway/gateway/schema"
 )
 
 type Provider interface {
@@ -37,7 +39,7 @@ type FileWatcher interface {
 }
 
 type Service struct {
-	appCfg   appConfig.Config
+	appCfg   *appConfig.Config
 	handlers map[string]*graphqlHandler
 	log      *logger.Logger
 	mu       sync.RWMutex
@@ -51,7 +53,7 @@ type graphqlHandler struct {
 	handler http.Handler
 }
 
-func NewManager(log *logger.Logger, cfg *rest.Config, appCfg appConfig.Config) (*Service, error) {
+func NewManager(log *logger.Logger, cfg *rest.Config, appCfg *appConfig.Config) (*Service, error) {
 	watcher, err := fsnotify.NewWatcher()
 	if err != nil {
 		return nil, err