cmd/crowdsec: refact dump.go, loops (#4158)

* unused parameters

* refact dump.go

* break -> return

* extract unregisterWatcher()

Author: mmetc

cmd/crowdsec/appsec_stub.go

@@ -6,6 +6,6 @@ import (
 	"github.com/crowdsecurity/crowdsec/pkg/cwhub"
 )
 
-func LoadAppsecRules(hub *cwhub.Hub) error {
+func LoadAppsecRules(_ *cwhub.Hub) error {
 	return nil
 }

cmd/crowdsec/crowdsec.go

@@ -111,7 +111,6 @@ func startLPMetrics(ctx context.Context, cConfig *csconfig.Config, apiClient *ap
 		apiClient,
 		lpMetricsDefaultInterval,
 		log.WithField("service", "lpmetrics"),
-		[]string{},
 		datasources,
 		hub,
 	)
@@ -198,8 +197,10 @@ func serveCrowdsec(ctx context.Context, parsers *parser.Parsers, cConfig *csconf
 
 		log.Debugf("everything is dead, return crowdsecTomb")
 
-		if dumpStates {
-			if err := dumpAllStates(); err != nil {
+		if flags.DumpDir != "" {
+			log.Debugf("Dumping parser+bucket states to %s", flags.DumpDir)
+
+			if err := dumpAllStates(flags.DumpDir); err != nil {
 				log.Fatal(err)
 			}
 

cmd/crowdsec/dump.go

@@ -5,52 +5,38 @@ import (
 	"os"
 	"path/filepath"
 
-	log "github.com/sirupsen/logrus"
 	"gopkg.in/yaml.v3"
 
 	leaky "github.com/crowdsecurity/crowdsec/pkg/leakybucket"
 	"github.com/crowdsecurity/crowdsec/pkg/parser"
 )
 
-func dumpAllStates() error {
-	log.Debugf("Dumping parser+bucket states to %s", parser.DumpFolder)
+func dumpAllStates(dir string) error {
+	err := os.MkdirAll(dir, 0o755)
+	if err != nil {
+		return err
+	}
 
-	if err := dumpState(
-		filepath.Join(parser.DumpFolder, "parser-dump.yaml"),
-		parser.StageParseCache,
-	); err != nil {
-		return fmt.Errorf("while dumping parser state: %w", err)
+	if err := dumpState(dir, "parser-dump.yaml", parser.StageParseCache); err != nil {
+		return fmt.Errorf("dumping parser state: %w", err)
 	}
 
-	if err := dumpState(
-		filepath.Join(parser.DumpFolder, "bucket-dump.yaml"),
-		bucketOverflows,
-	); err != nil {
-		return fmt.Errorf("while dumping bucket overflow state: %w", err)
+	if err := dumpState(dir, "bucket-dump.yaml", bucketOverflows); err != nil {
+		return fmt.Errorf("dumping bucket overflow state: %w", err)
 	}
 
-	if err := dumpState(
-		filepath.Join(parser.DumpFolder, "bucketpour-dump.yaml"),
-		leaky.BucketPourCache,
-	); err != nil {
-		return fmt.Errorf("while dumping bucket pour state: %w", err)
+	if err := dumpState(dir, "bucketpour-dump.yaml", leaky.BucketPourCache); err != nil {
+		return fmt.Errorf("dumping bucket pour state: %w", err)
 	}
 
 	return nil
 }
 
-func dumpState(destPath string, obj any) error {
-	dir := filepath.Dir(destPath)
-
-	err := os.MkdirAll(dir, 0o755)
-	if err != nil {
-		return err
-	}
-
+func dumpState(dir, name string, obj any) error {
 	out, err := yaml.Marshal(obj)
 	if err != nil {
 		return err
 	}
 
-	return os.WriteFile(destPath, out, 0o666)
+	return os.WriteFile(filepath.Join(dir, name), out, 0o666)
 }

cmd/crowdsec/flags.go

@@ -28,6 +28,7 @@ type Flags struct {
 	Transform      string
 	OrderEvent     bool
 	CPUProfile     string
+	DumpDir        string
 }
 
 func (f *Flags) haveTimeMachine() bool {
@@ -80,7 +81,7 @@ func (f *Flags) parse() {
 		flag.StringVar(&f.WinSvc, "winsvc", "", "Windows service Action: Install, Remove etc..")
 	}
 
-	flag.StringVar(&dumpFolder, "dump-data", "", "dump parsers/buckets raw outputs")
+	flag.StringVar(&f.DumpDir, "dump-data", "", "dump parsers/buckets raw outputs")
 	flag.StringVar(&f.CPUProfile, "cpu-profile", "", "write cpu profile to file")
 	flag.Parse()
 

cmd/crowdsec/lpmetrics.go

@@ -87,7 +87,7 @@ func getHubState(hub *cwhub.Hub) models.HubItems {
 }
 
 // newStaticMetrics is called when the process starts, or reloads the configuration
-func newStaticMetrics(consoleOptions []string, datasources []acquisition.DataSource, hub *cwhub.Hub) staticMetrics {
+func newStaticMetrics(datasources []acquisition.DataSource, hub *cwhub.Hub) staticMetrics {
 	datasourceMap := map[string]int64{}
 
 	for _, ds := range datasources {
@@ -111,11 +111,10 @@ func NewMetricsProvider(
 	apic *apiclient.ApiClient,
 	interval time.Duration,
 	logger *logrus.Entry,
-	consoleOptions []string,
 	datasources []acquisition.DataSource,
 	hub *cwhub.Hub,
 ) *MetricsProvider {
-	static := newStaticMetrics(consoleOptions, datasources, hub)
+	static := newStaticMetrics(datasources, hub)
 
 	logger.Debugf("Detected %s %s (family: %s)", static.osName, static.osVersion, static.osFamily)
 

cmd/crowdsec/main.go

@@ -101,8 +101,6 @@ func LoadAcquisition(ctx context.Context, cConfig *csconfig.Config) ([]acquisiti
 }
 
 var (
-	dumpFolder       string
-	dumpStates       bool
 	additionalLabels = make(labelsMap)
 )
 
@@ -124,11 +122,9 @@ func LoadConfig(configFile string, disableAgent bool, disableAPI bool, quiet boo
 		}
 	}
 
-	if dumpFolder != "" {
+	if flags.DumpDir != "" {
 		parser.ParseDump = true
-		parser.DumpFolder = dumpFolder
 		leakybucket.BucketPourTrack = true
-		dumpStates = true
 	}
 
 	if flags.haveTimeMachine() {

cmd/crowdsec/output.go

@@ -123,7 +123,7 @@ func runOutput(
 
 			// if the Alert is nil, it's to signal bucket is ready for GC, don't track this
 			// dump after postoveflow processing to avoid missing whitelist info
-			if dumpStates && ov.Alert != nil {
+			if flags.DumpDir != "" && ov.Alert != nil {
 				bucketOverflows = append(bucketOverflows, event)
 			}
 
@@ -141,7 +141,7 @@ func runOutput(
 				}
 			}
 
-			if dumpStates {
+			if flags.DumpDir != "" {
 				continue
 			}
 

cmd/crowdsec/serve.go

@@ -216,6 +216,24 @@ func drainChan(c chan pipeline.Event) {
 	}
 }
 
+func unregisterWatcher(ctx context.Context, cConfig *csconfig.Config) (bool, error) {
+	if cConfig.API == nil || cConfig.API.Client == nil || !cConfig.API.Client.UnregisterOnExit {
+		return false, nil
+	}
+
+	lapiClient, err := apiclient.GetLAPIClient()
+	if err != nil {
+		return false, err
+	}
+
+	_, err = lapiClient.Auth.UnregisterWatcher(ctx)
+	if err != nil {
+		return false, err
+	}
+
+	return true, nil
+}
+
 func HandleSignals(ctx context.Context, cConfig *csconfig.Config) error {
 	var (
 		newConfig *csconfig.Config
@@ -240,7 +258,6 @@ func HandleSignals(ctx context.Context, cConfig *csconfig.Config) error {
 	go func() {
 		defer trace.CatchPanic("crowdsec/HandleSignals")
 
-	Loop:
 		for {
 			s := <-signalChan
 			switch s {
@@ -250,14 +267,12 @@ func HandleSignals(ctx context.Context, cConfig *csconfig.Config) error {
 
 				if err = shutdown(s, cConfig); err != nil {
 					exitChan <- fmt.Errorf("failed shutdown: %w", err)
-
-					break Loop
+					return
 				}
 
 				if newConfig, err = reloadHandler(ctx, s); err != nil {
 					exitChan <- fmt.Errorf("reload handler failure: %w", err)
-
-					break Loop
+					return
 				}
 
 				if newConfig != nil {
@@ -269,8 +284,7 @@ func HandleSignals(ctx context.Context, cConfig *csconfig.Config) error {
 
 				if err = shutdown(s, cConfig); err != nil {
 					exitChan <- fmt.Errorf("failed shutdown: %w", err)
-
-					break Loop
+					return
 				}
 
 				exitChan <- nil
@@ -283,20 +297,11 @@ func HandleSignals(ctx context.Context, cConfig *csconfig.Config) error {
 		log.Warning("Crowdsec service shutting down")
 	}
 
-	if cConfig.API != nil && cConfig.API.Client != nil && cConfig.API.Client.UnregisterOnExit {
-		log.Warning("Unregistering watcher")
-
-		lapiClient, err := apiclient.GetLAPIClient()
-		if err != nil {
-			return err
-		}
-
-		_, err = lapiClient.Auth.UnregisterWatcher(ctx)
-		if err != nil {
-			return fmt.Errorf("failed to unregister watcher: %w", err)
+	if ok, werr := unregisterWatcher(ctx, cConfig); werr != nil {
+		log.WithError(werr).Warning("unregistering watcher")
+		if ok {
+			log.Warning("Watcher unregistered")
 		}
-
-		log.Warning("Watcher unregistered")
 	}
 
 	return err

cmd/crowdsec/win_service.go

@@ -31,7 +31,6 @@ func (m *crowdsec_winservice) Execute(args []string, r <-chan svc.ChangeRequest,
 	changes <- svc.Status{State: svc.Running, Accepts: cmdsAccepted}
 
 	go func() {
-	loop:
 		for {
 			select {
 			case <-tick:
@@ -47,7 +46,7 @@ func (m *crowdsec_winservice) Execute(args []string, r <-chan svc.ChangeRequest,
 						log.Errorf("Error while shutting down: %s", err)
 						// don't return, we still want to notify windows that we are stopped ?
 					}
-					break loop
+					return
 				default:
 					log.Errorf("unexpected control request #%d", c)
 				}

cmd/crowdsec/win_service_manage.go

@@ -10,8 +10,6 @@ import (
 	"fmt"
 	"time"
 
-	//"time"
-
 	"golang.org/x/sys/windows/svc"
 	"golang.org/x/sys/windows/svc/mgr"
 )