feat: badger storage, e2e, improved testability (#4)

* feat: badger storage, e2e, improved testability

* fix: use dedicated context when saving state

Author: Swop

.pre-commit-config.yaml

@@ -12,6 +12,12 @@ repos:
         entry: make test
         types: [go]
         pass_filenames: false
+      - id: go-e2e
+        name: go e2e
+        language: system
+        entry: make e2e
+        types: [ go ]
+        pass_filenames: false
       - id: golangci-lint
         name: golangci-lint
         entry: make lint

Makefile

@@ -4,6 +4,8 @@ LEASE_SERVICE_PORT ?= 9000
 GOOS := $(shell go env GOOS)
 GOARCH := $(shell go env GOARCH)
 
+E2E_GINKGO_VERSION := v2.8.2
+
 default: clean lint test build
 
 .PHONY: help
@@ -13,12 +15,20 @@ help: ## Print this help with list of available commands/targets and their purpo
 lint:  ## run linters on the code base
 	golangci-lint run
 
+clear-state:  ## cleanup storage DB
+	rm -rf /tmp/state
+
 .PHONY: clean
 clean:  ## cleanup test cover output
 	rm -rf cover.out
 
 test:  ## run unit tests
-	go test -race -cover ./...
+	go test -race -cover $(shell go list ./... | grep -v /e2e)
+
+.PHONY: e2e
+e2e:  ## run e2e tests
+	cd e2e && \
+		go run github.com/onsi/ginkgo/v2/ginkgo@$(E2E_GINKGO_VERSION)
 
 .PHONY: build
 build:  ## build the application (server & cli)

cmd/server/main.go

@@ -3,54 +3,75 @@ package main
 import (
 	"flag"
 	"os"
-	"strconv"
+	"os/signal"
+	"syscall"
 
-	"github.com/ankorstore/gh-action-mq-lease-service/internal/config"
-	"github.com/ankorstore/gh-action-mq-lease-service/internal/lease"
 	"github.com/ankorstore/gh-action-mq-lease-service/internal/server"
 	"github.com/ankorstore/gh-action-mq-lease-service/internal/version"
 	"github.com/ankorstore/gh-action-mq-lease-service/pkg/util/logger"
-	"github.com/gofiber/fiber/v2"
 )
 
 var (
-	serverPort uint
-	configPath string
+	serverPort         uint
+	configPath         string
+	logDebug           bool
+	logJSON            bool
+	persistentStateDir string
 )
 
 func init() {
+	// General flags
 	flag.UintVar(&serverPort, "port", 9000, "server listening port")
 	flag.StringVar(&configPath, "config", "./config.yaml", "Configuration path")
 
-	// Register logging flags
-	logger.InitFlags()
+	// Logging flags
+	flag.BoolVar(&logDebug, "log-debug", false, "Enable debug logging")
+	flag.BoolVar(&logJSON, "log-json", true, "Enable console logging format")
+
+	// Persistent state flags
+	flag.StringVar(&persistentStateDir, "persistents-state-dir", "/tmp/state", "Setup the directory for persistent state storage")
 }
 
 func main() {
 	flag.Parse()
 
 	// Logger
-	log := logger.New(version.Version{})
+	log := logger.New(logger.NewOpts{
+		AppInfo: version.Version{},
+		Debug:   logDebug,
+		JSON:    logJSON,
+	})
 
-	// Config
-	cfg, err := config.LoadServerConfig(configPath)
-	if err != nil {
-		log.Error().Msg("Failed loading configuration")
-		os.Exit(1)
+	// Main server
+	s := server.New(server.NewOpts{
+		Port:               int(serverPort),
+		Logger:             &log,
+		ConfigPath:         configPath,
+		PersistentStateDir: persistentStateDir,
+	})
+	if err := s.Init(); err != nil {
+		log.Panic().Err(err).Msg("Failed initializing the server")
 	}
 
-	// Lease provider orchestrator (handling all repos merge queue leases)
-	orchestrator := lease.NewProviderOrchestrator(cfg.Repositories)
+	// Signal handling (SIGTERM) to be able to gracefully shut down the server (both fiber + other resources,
+	// like the storage for ex).
+	c := make(chan os.Signal, 1)
+	signal.Notify(c, os.Interrupt, syscall.SIGTERM)
 
-	// Fiber app
-	app := fiber.New(fiber.Config{DisableStartupMessage: true})
-	app.Use(logger.FiberMiddleware(log))
-	server.RegisterRoutes(app, orchestrator)
+	globShutdown := make(chan struct{}, 1)
 
-	log.Info().Msg("Bootstrap completed, starting...")
+	go func() {
+		<-c
+		log.Warn().Msg("SIGTERM received")
+		if err := s.Shutdown(); err != nil {
+			log.Error().Err(err).Msg("Could not shutdown server gracefully")
+		}
+		globShutdown <- struct{}{}
+	}()
 
-	if err := app.Listen(":" + strconv.Itoa(int(serverPort))); err != nil {
-		log.Err(err).Msg("Fiber server failed")
-		defer os.Exit(1)
+	if err := s.Start(); err != nil {
+		log.Panic().Err(err).Msg("Server error")
 	}
+
+	<-globShutdown
 }