cscli: cliconfig - remove global variables and gratuitous pointer (#3414

)

cmd/crowdsec-cli/config_backup.go → cmd/crowdsec-cli/cliconfig/backup.go

@@ -1,4 +1,4 @@
-package main
+package cliconfig
 
 import (
 	"fmt"

cmd/crowdsec-cli/config.go → cmd/crowdsec-cli/cliconfig/config.go

@@ -1,20 +1,26 @@
-package main
+package cliconfig
 
 import (
 	"github.com/spf13/cobra"
+
+	"github.com/crowdsecurity/crowdsec/pkg/csconfig"
 )
 
+type configGetter func() *csconfig.Config
+
+type mergedConfigGetter func() string
+
 type cliConfig struct {
 	cfg configGetter
 }
 
-func NewCLIConfig(cfg configGetter) *cliConfig {
+func New(cfg configGetter) *cliConfig {
 	return &cliConfig{
 		cfg: cfg,
 	}
 }
 
-func (cli *cliConfig) NewCommand() *cobra.Command {
+func (cli *cliConfig) NewCommand(mergedConfigGetter mergedConfigGetter) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "config [command]",
 		Short:             "Allows to view current config",
@@ -23,7 +29,7 @@ func (cli *cliConfig) NewCommand() *cobra.Command {
 	}
 
 	cmd.AddCommand(cli.newShowCmd())
-	cmd.AddCommand(cli.newShowYAMLCmd())
+	cmd.AddCommand(cli.newShowYAMLCmd(mergedConfigGetter))
 	cmd.AddCommand(cli.newBackupCmd())
 	cmd.AddCommand(cli.newRestoreCmd())
 	cmd.AddCommand(cli.newFeatureFlagsCmd())

cmd/crowdsec-cli/config_feature_flags.go → cmd/crowdsec-cli/cliconfig/feature_flags.go

@@ -1,4 +1,4 @@
-package main
+package cliconfig
 
 import (
 	"fmt"
@@ -86,7 +86,7 @@ func (cli *cliConfig) featureFlags(showRetired bool) error {
 	fmt.Println("To enable a feature you can: ")
 	fmt.Println("  - set the environment variable CROWDSEC_FEATURE_<uppercase_feature_name> to true")
 
-	featurePath, err := filepath.Abs(csconfig.GetFeatureFilePath(ConfigFilePath))
+	featurePath, err := filepath.Abs(csconfig.GetFeatureFilePath(cli.cfg().FilePath))
 	if err != nil {
 		// we already read the file, shouldn't happen
 		return err

cmd/crowdsec-cli/config_restore.go → cmd/crowdsec-cli/cliconfig/restore.go

@@ -1,4 +1,4 @@
-package main
+package cliconfig
 
 import (
 	"fmt"

cmd/crowdsec-cli/config_show.go → cmd/crowdsec-cli/cliconfig/show.go

@@ -1,4 +1,4 @@
-package main
+package cliconfig
 
 import (
 	"encoding/json"

cmd/crowdsec-cli/config_showyaml.go → cmd/crowdsec-cli/cliconfig/showyaml.go

@@ -1,24 +1,24 @@
-package main
+package cliconfig
 
 import (
 	"fmt"
 
 	"github.com/spf13/cobra"
 )
 
-func (cli *cliConfig) showYAML() error {
+func (cli *cliConfig) showYAML(mergedConfig string) error {
 	fmt.Println(mergedConfig)
 	return nil
 }
 
-func (cli *cliConfig) newShowYAMLCmd() *cobra.Command {
+func (cli *cliConfig) newShowYAMLCmd(mergedConfigGetter mergedConfigGetter) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "show-yaml",
 		Short:             "Displays merged config.yaml + config.yaml.local",
 		Args:              cobra.NoArgs,
 		DisableAutoGenTag: true,
 		RunE: func(_ *cobra.Command, _ []string) error {
-			return cli.showYAML()
+			return cli.showYAML(mergedConfigGetter())
 		},
 	}
 

cmd/crowdsec-cli/clisupport/support.go

@@ -290,7 +290,7 @@ func (cli *cliSupport) dumpConfigYAML(zw *zip.Writer) error {
 
 	cfg := cli.cfg()
 
-	config, err := os.ReadFile(*cfg.FilePath)
+	config, err := os.ReadFile(cfg.FilePath)
 	if err != nil {
 		return fmt.Errorf("could not read config file: %w", err)
 	}

cmd/crowdsec-cli/main.go

@@ -17,6 +17,7 @@ import (
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/clialert"
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/clibouncer"
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/clicapi"
+	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/cliconfig"
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/cliconsole"
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/clidecision"
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/cliexplain"
@@ -256,7 +257,7 @@ It is meant to allow you to manage bans, parsers/scenarios/etc, api and generall
 
 	cmd.AddCommand(NewCLIDoc().NewCommand(cmd))
 	cmd.AddCommand(NewCLIVersion().NewCommand())
-	cmd.AddCommand(NewCLIConfig(cli.cfg).NewCommand())
+	cmd.AddCommand(cliconfig.New(cli.cfg).NewCommand(func() string { return mergedConfig }))
 	cmd.AddCommand(clihub.New(cli.cfg).NewCommand())
 	cmd.AddCommand(climetrics.New(cli.cfg).NewCommand())
 	cmd.AddCommand(NewCLIDashboard(cli.cfg).NewCommand())

cmd/crowdsec-cli/require/require.go

@@ -27,7 +27,7 @@ func LAPI(c *csconfig.Config) error {
 
 func CAPI(c *csconfig.Config) error {
 	if c.API.Server.OnlineClient == nil {
-		return fmt.Errorf("no configuration for Central API (CAPI) in '%s'", *c.FilePath)
+		return fmt.Errorf("no configuration for Central API (CAPI) in '%s'", c.FilePath)
 	}
 
 	return nil

pkg/csconfig/config.go

@@ -30,7 +30,7 @@ var globalConfig = Config{}
 // Config contains top-level defaults -> overridden by configuration file -> overridden by CLI flags
 type Config struct {
 	// just a path to ourselves :p
-	FilePath     *string             `yaml:"-"`
+	FilePath     string              `yaml:"-"`
 	Self         []byte              `yaml:"-"`
 	Common       *CommonCfg          `yaml:"common,omitempty"`
 	Prometheus   *PrometheusCfg      `yaml:"prometheus,omitempty"`
@@ -45,9 +45,10 @@ type Config struct {
 	Hub          *LocalHubCfg        `yaml:"-"`
 }
 
-func NewConfig(configFile string, disableAgent bool, disableAPI bool, inCli bool) (*Config, string, error) {
+// NewConfig
+func NewConfig(configFile string, disableAgent bool, disableAPI bool, quiet bool) (*Config, string, error) {
 	patcher := yamlpatch.NewPatcher(configFile, ".local")
-	patcher.SetQuiet(inCli)
+	patcher.SetQuiet(quiet)
 
 	fcontent, err := patcher.MergedPatchContent()
 	if err != nil {
@@ -56,7 +57,7 @@ func NewConfig(configFile string, disableAgent bool, disableAPI bool, inCli bool
 
 	configData := csstring.StrictExpand(string(fcontent), os.LookupEnv)
 	cfg := Config{
-		FilePath:     &configFile,
+		FilePath:     configFile,
 		DisableAgent: disableAgent,
 		DisableAPI:   disableAPI,
 	}