refactor: update tools to support graceful shutdown and periodic tasks

Author: sandrolain

.github/workflows/ci.yml

@@ -19,6 +19,9 @@ on:
       - "context/**"
       - "TODO.md"
       - "examples/**/README.md"
+  schedule:
+    # Run security scan weekly on Mondays at 00:00 UTC
+    - cron: "0 0 * * 1"
 
 jobs:
   test:
@@ -93,3 +96,53 @@ jobs:
             gofmt -s -d .
             exit 1
           fi
+
+  trivy:
+    name: Vulnerability Scan (Trivy)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run Trivy vulnerability scanner
+        uses: aquasecurity/trivy-action@master
+        with:
+          scan-type: "fs"
+          scan-ref: "."
+          format: "sarif"
+          output: "trivy-results.sarif"
+          severity: "CRITICAL,HIGH,MEDIUM"
+
+  dependency-review:
+    name: Dependency Review
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Dependency Review
+        uses: actions/dependency-review-action@v4
+        with:
+          fail-on-severity: moderate
+
+  govulncheck:
+    name: Go Vulnerability Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.25"
+
+      - name: Install govulncheck
+        run: go install golang.org/x/vuln/cmd/govulncheck@latest
+
+      - name: Run govulncheck
+        run: govulncheck $(go list ./... | grep -v '/examples/' | grep -v '/test/')

.github/workflows/security.yml

@@ -18,6 +18,7 @@ import (
 	coaptcp "github.com/plgd-dev/go-coap/v3/tcp"
 	coapudp "github.com/plgd-dev/go-coap/v3/udp"
 
+	"github.com/sandrolain/eventkit/pkg/common"
 	testpayload "github.com/sandrolain/eventkit/pkg/testpayload"
 	toolutil "github.com/sandrolain/eventkit/pkg/toolutil"
 )
@@ -43,15 +44,11 @@ func main() {
 		Use:   "send",
 		Short: "Send periodic CoAP POST requests",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			logger := toolutil.Logger()
-			dur, err := time.ParseDuration(sendInterval)
-			if err != nil {
-				return fmt.Errorf("invalid interval: %w", err)
-			}
-			ticker := time.NewTicker(dur)
-			defer ticker.Stop()
+			ctx, cancel := common.SetupGracefulShutdown()
+			defer cancel()
 
-			logger.Info("Sending CoAP POST periodically", "proto", sendProto, "addr", sendAddress, "path", sendPath, "every", dur)
+			logger := toolutil.Logger()
+			logger.Info("Sending CoAP POST periodically", "proto", sendProto, "addr", sendAddress, "path", sendPath, "interval", sendInterval)
 
 			sendOnce := func() {
 				var body []byte
@@ -123,10 +120,10 @@ func main() {
 				}
 			}
 
-			for range ticker.C {
-				go sendOnce()
-			}
-			select {}
+			return common.StartPeriodicTask(ctx, sendInterval, func() error {
+				sendOnce()
+				return nil
+			})
 		},
 	}
 
@@ -145,14 +142,31 @@ func main() {
 		Use:   "serve",
 		Short: "Run a CoAP server that logs requests",
 		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx, cancel := common.SetupGracefulShutdown()
+			defer cancel()
+
 			logger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelInfo}))
 			logger.Info("Starting coapdbg", "proto", serveProto, "addr", serveAddr)
 
 			router := coapmux.NewRouter()
 			if err := router.Handle("/", SimpleOKHandler(serveProto)); err != nil {
 				return err
 			}
-			return Serve(serveProto, serveAddr, router)
+
+			// Start server in goroutine
+			errChan := make(chan error, 1)
+			go func() {
+				errChan <- Serve(serveProto, serveAddr, router)
+			}()
+
+			// Wait for shutdown or error
+			select {
+			case <-ctx.Done():
+				logger.Info("Shutting down gracefully")
+				return nil
+			case err := <-errChan:
+				return err
+			}
 		},
 	}
 	serveCmd.Flags().StringVar(&serveAddr, "address", ":5683", "Listen address (e.g.: :5683)")

coaptool/coaptool.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"context"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -12,6 +11,7 @@ import (
 	"github.com/go-git/go-git/v5/plumbing"
 	"github.com/go-git/go-git/v5/plumbing/object"
 	"github.com/go-git/go-git/v5/plumbing/transport/http"
+	"github.com/sandrolain/eventkit/pkg/common"
 	"github.com/spf13/cobra"
 )
 
@@ -62,10 +62,8 @@ func main() {
 }
 
 func runGitSend(remote, branch, interval, filename, message, username, password string) error {
-	ctx := context.Background()
-	_ = ctx // reserved for future use
-
-	dur, _ := time.ParseDuration(interval)
+	ctx, cancel := common.SetupGracefulShutdown()
+	defer cancel()
 	// working dir
 	tmpDir, err := os.MkdirTemp("", "gittool-*")
 	if err != nil {
@@ -82,17 +80,16 @@ func runGitSend(remote, branch, interval, filename, message, username, password
 		return err
 	}
 
-	fmt.Printf("Ready. Remote: %s, branch: %s, file: %s. Interval: %s\n", remote, branch, filename, dur)
-	ticker := time.NewTicker(dur)
-	defer ticker.Stop()
-	for range ticker.C {
+	fmt.Printf("Ready. Remote: %s, branch: %s, file: %s. Interval: %s\n", remote, branch, filename, interval)
+
+	return common.StartPeriodicTask(ctx, interval, func() error {
 		if err := doCommit(repo, tmpDir, branch, filename, message, username, password, remote); err != nil {
 			fmt.Fprintf(os.Stderr, "Commit error: %v\n", err)
-		} else {
-			fmt.Printf("Committed to %s/%s at %s\n", remote, branch, time.Now().Format(time.RFC3339))
+			return err
 		}
-	}
-	return nil
+		fmt.Printf("Committed to %s/%s at %s\n", remote, branch, time.Now().Format(time.RFC3339))
+		return nil
+	})
 }
 
 func cloneOrInitRepo(tmpDir, remote, branch, username, password string) (*git.Repository, error) {

gittool/gittool.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"log/slog"
 	"os"
-	"time"
 
+	"github.com/sandrolain/eventkit/pkg/common"
 	toolutil "github.com/sandrolain/eventkit/pkg/toolutil"
 	"github.com/spf13/cobra"
 	"github.com/valyala/fasthttp"
@@ -42,16 +42,12 @@ type sendOptions struct {
 }
 
 func (o *sendOptions) run() error {
-	url := o.address + o.path
+	ctx, cancel := common.SetupGracefulShutdown()
+	defer cancel()
 
-	dur, err := time.ParseDuration(o.interval)
-	if err != nil {
-		return fmt.Errorf("invalid interval: %w", err)
-	}
-	ticker := time.NewTicker(dur)
-	defer ticker.Stop()
+	url := o.address + o.path
 
-	fmt.Printf("Sending %s requests to %s every %s\n", o.method, url, dur)
+	fmt.Printf("Sending %s requests to %s every %s\n", o.method, url, o.interval)
 
 	sendRequest := func() {
 		reqBody, contentType, err := toolutil.BuildPayload(o.payload, o.mime)
@@ -85,11 +81,10 @@ func (o *sendOptions) run() error {
 		printHTTPResponse(o.method, url, w)
 	}
 
-	for range ticker.C {
-		go sendRequest()
-	}
-
-	select {}
+	return common.StartPeriodicTask(ctx, o.interval, func() error {
+		sendRequest()
+		return nil
+	})
 }
 
 func main() {
@@ -136,6 +131,9 @@ func newServeCommand() *cobra.Command {
 		Use:   "serve",
 		Short: "Run an HTTP server that logs requests",
 		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx, cancel := common.SetupGracefulShutdown()
+			defer cancel()
+
 			slog.Info("Starting httpdbg", "addr", serveAddr)
 
 			handler := func(ctx *fasthttp.RequestCtx) {
@@ -157,11 +155,23 @@ func newServeCommand() *cobra.Command {
 				toolutil.PrintColoredMessage("HTTP", sections, ctx.Request.Body(), ct)
 			}
 
-			if err := fasthttp.ListenAndServe(serveAddr, handler); err != nil {
-				slog.Error("error serving httpdbg", "err", err)
+			// Start server in goroutine
+			errChan := make(chan error, 1)
+			go func() {
+				if err := fasthttp.ListenAndServe(serveAddr, handler); err != nil {
+					slog.Error("error serving httpdbg", "err", err)
+					errChan <- err
+				}
+			}()
+
+			// Wait for shutdown or error
+			select {
+			case <-ctx.Done():
+				slog.Info("Shutting down gracefully")
+				return nil
+			case err := <-errChan:
 				return err
 			}
-			return nil
 		},
 	}