cscli refact: package cli{support, machine, bouncer}

cmd/crowdsec-cli/bouncers.go → cmd/crowdsec-cli/clibouncer/bouncers.go

@@ -1,4 +1,4 @@
-package main
+package clibouncer
 
 import (
 	"encoding/csv"
@@ -21,19 +21,22 @@
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/cstable"
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/require"
 	middlewares "github.com/crowdsecurity/crowdsec/pkg/apiserver/middlewares/v1"
+	"github.com/crowdsecurity/crowdsec/pkg/csconfig"
 	"github.com/crowdsecurity/crowdsec/pkg/database"
 	"github.com/crowdsecurity/crowdsec/pkg/database/ent"
 	"github.com/crowdsecurity/crowdsec/pkg/database/ent/bouncer"
 	"github.com/crowdsecurity/crowdsec/pkg/emoji"
 	"github.com/crowdsecurity/crowdsec/pkg/types"
 )
 
+type configGetter = func() *csconfig.Config
+
 type cliBouncers struct {
 	db  *database.Client
 	cfg configGetter
 }
 
-func NewCLIBouncers(cfg configGetter) *cliBouncers {
+func New(cfg configGetter) *cliBouncers {
 	return &cliBouncers{
 		cfg: cfg,
 	}
@@ -156,8 +159,11 @@
 	return nil
 }
 
-func (cli *cliBouncers) list(out io.Writer) error {
-	bouncers, err := cli.db.ListBouncers()
+func (cli *cliBouncers) List(out io.Writer, db *database.Client) error {
+	// XXX: must use the provided db object, the one in the struct might be nil
+	// (calling List directly skips the PersistentPreRunE)
+
+	bouncers, err := db.ListBouncers()
 	if err != nil {
 		return fmt.Errorf("unable to list bouncers: %w", err)
 	}
@@ -194,7 +200,7 @@
 		Args:              cobra.ExactArgs(0),
 		DisableAutoGenTag: true,
 		RunE: func(_ *cobra.Command, _ []string) error {
-			return cli.list(color.Output)
+			return cli.List(color.Output, cli.db)
 		},
 	}
 

cmd/crowdsec-cli/clicapi/capi.go

@@ -4,9 +4,11 @@
 	"context"
 	"errors"
 	"fmt"
+	"io"
 	"net/url"
 	"os"
 
+	"github.com/fatih/color"
 	"github.com/go-openapi/strfmt"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -23,7 +25,7 @@
 	"github.com/crowdsecurity/crowdsec/pkg/types"
 )
 
-type configGetter func() *csconfig.Config
+type configGetter = func() *csconfig.Config
 
 type cliCapi struct {
 	cfg configGetter
@@ -147,11 +149,11 @@
 	return cmd
 }
 
-// QueryCAPIStatus checks if the Local API is reachable, and if the credentials are correct. It then checks if the instance is enrolle in the console.
-func QueryCAPIStatus(hub *cwhub.Hub, credURL string, login string, password string) (bool, bool, error) {
+// queryCAPIStatus checks if the Central API is reachable, and if the credentials are correct. It then checks if the instance is enrolle in the console.
+func queryCAPIStatus(hub *cwhub.Hub, credURL string, login string, password string) (bool, bool, error) {
 	apiURL, err := url.Parse(credURL)
 	if err != nil {
-		return false, false, fmt.Errorf("parsing api url: %w", err)
+		return false, false, err
 	}
 
 	itemsForAPI := hub.GetInstalledListForAPI()
@@ -176,7 +178,7 @@
 		},
 	})
 	if err != nil {
-		return false, false, fmt.Errorf("new client api: %w", err)
+		return false, false, err
 	}
 
 	pw := strfmt.Password(password)
@@ -197,10 +199,11 @@
 	if client.IsEnrolled() {
 		return true, true, nil
 	}
+
 	return true, false, nil
 }
 
-func (cli *cliCapi) status() error {
+func (cli *cliCapi) Status(out io.Writer, hub *cwhub.Hub) error {
 	cfg := cli.cfg()
 
 	if err := require.CAPIRegistered(cfg); err != nil {
@@ -209,24 +212,22 @@
 
 	cred := cfg.API.Server.OnlineClient.Credentials
 
-	hub, err := require.Hub(cfg, nil, nil)
-	if err != nil {
-		return err
-	}
-
-	log.Infof("Loaded credentials from %s", cfg.API.Server.OnlineClient.CredentialsFilePath)
-	log.Infof("Trying to authenticate with username %s on %s", cred.Login, cred.URL)
+	fmt.Fprintf(out, "Loaded credentials from %s\n", cfg.API.Server.OnlineClient.CredentialsFilePath)
+	fmt.Fprintf(out, "Trying to authenticate with username %s on %s\n", cred.Login, cred.URL)
 
-	auth, enrolled, err := QueryCAPIStatus(hub, cred.URL, cred.Login, cred.Password)
+	auth, enrolled, err := queryCAPIStatus(hub, cred.URL, cred.Login, cred.Password)
 	if err != nil {
-		return fmt.Errorf("CAPI: failed to authenticate to Central API (CAPI): %s", err)
+		return fmt.Errorf("failed to authenticate to Central API (CAPI): %w", err)
 	}
+
 	if auth {
-		log.Info("You can successfully interact with Central API (CAPI)")
+		fmt.Fprint(out, "You can successfully interact with Central API (CAPI)\n")
 	}
+
 	if enrolled {
-		log.Info("Your instance is enrolled in the console")
+		fmt.Fprint(out, "Your instance is enrolled in the console\n")
 	}
+
 	return nil
 }
 
@@ -237,7 +238,12 @@
 		Args:              cobra.MinimumNArgs(0),
 		DisableAutoGenTag: true,
 		RunE: func(_ *cobra.Command, _ []string) error {
-			return cli.status()
+			hub, err := require.Hub(cli.cfg(), nil, nil)
+			if err != nil {
+				return err
+			}
+
+			return cli.Status(color.Output, hub)
 		},
 	}
 

cmd/crowdsec-cli/clilapi/lapi.go

@@ -4,12 +4,14 @@
 	"context"
 	"errors"
 	"fmt"
+	"io"
 	"net/url"
 	"os"
 	"slices"
 	"sort"
 	"strings"
 
+	"github.com/fatih/color"
 	"github.com/go-openapi/strfmt"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -30,10 +32,10 @@
 
 const LAPIURLPrefix = "v1"
 
-type configGetter func() *csconfig.Config
+type configGetter = func() *csconfig.Config
 
 type cliLapi struct {
-	cfg           configGetter
+	cfg configGetter
 }
 
 func New(cfg configGetter) *cliLapi {
@@ -42,19 +44,19 @@
 	}
 }
 
-// QueryLAPIStatus checks if the Local API is reachable, and if the credentials are correct
-func QueryLAPIStatus(hub *cwhub.Hub, credURL string, login string, password string) error {
+// queryLAPIStatus checks if the Local API is reachable, and if the credentials are correct.
+func queryLAPIStatus(hub *cwhub.Hub, credURL string, login string, password string) (bool, error) {
 	apiURL, err := url.Parse(credURL)
 	if err != nil {
-		return fmt.Errorf("parsing api url: %w", err)
+		return false, err
 	}
 
 	client, err := apiclient.NewDefaultClient(apiURL,
 		LAPIURLPrefix,
 		cwversion.UserAgent(),
 		nil)
 	if err != nil {
-		return fmt.Errorf("init default client: %w", err)
+		return false, err
 	}
 
 	pw := strfmt.Password(password)
@@ -69,30 +71,26 @@
 
 	_, _, err = client.Auth.AuthenticateWatcher(context.Background(), t)
 	if err != nil {
-		return err
+		return false, err
 	}
 
-	return nil
+	return true, nil
 }
 
-func (cli *cliLapi) status() error {
+func (cli *cliLapi) Status(out io.Writer, hub *cwhub.Hub) error {
 	cfg := cli.cfg()
 
 	cred := cfg.API.Client.Credentials
 
-	hub, err := require.Hub(cfg, nil, nil)
-	if err != nil {
-		return err
-	}
-
-	log.Infof("Loaded credentials from %s", cfg.API.Client.CredentialsFilePath)
-	log.Infof("Trying to authenticate with username %s on %s", cred.Login, cred.URL)
+	fmt.Fprintf(out, "Loaded credentials from %s\n", cfg.API.Client.CredentialsFilePath)
+	fmt.Fprintf(out, "Trying to authenticate with username %s on %s\n", cred.Login, cred.URL)
 
-	if err := QueryLAPIStatus(hub, cred.URL, cred.Login, cred.Password); err != nil {
+	_, err := queryLAPIStatus(hub, cred.URL, cred.Login, cred.Password)
+	if err != nil {
 		return fmt.Errorf("failed to authenticate to Local API (LAPI): %w", err)
 	}
 
-	log.Infof("You can successfully interact with Local API (LAPI)")
+	fmt.Fprintf(out, "You can successfully interact with Local API (LAPI)\n")
 
 	return nil
 }
@@ -197,7 +195,12 @@
 		Args:              cobra.MinimumNArgs(0),
 		DisableAutoGenTag: true,
 		RunE: func(_ *cobra.Command, _ []string) error {
-			return cli.status()
+			hub, err := require.Hub(cli.cfg(), nil, nil)
+			if err != nil {
+				return err
+			}
+
+			return cli.Status(color.Output, hub)
 		},
 	}
 

cmd/crowdsec-cli/flag.go → cmd/crowdsec-cli/climachine/flag.go

@@ -1,4 +1,4 @@
-package main
+package climachine
 
 // Custom types for flag validation and conversion.
 

cmd/crowdsec-cli/machines.go → cmd/crowdsec-cli/climachine/machines.go

@@ -1,4 +1,4 @@
-package main
+package climachine
 
 import (
 	"encoding/csv"
@@ -49,12 +49,14 @@
 	return hb, true
 }
 
+type configGetter = func() *csconfig.Config
+
 type cliMachines struct {
 	db  *database.Client
 	cfg configGetter
 }
 
-func NewCLIMachines(cfg configGetter) *cliMachines {
+func New(cfg configGetter) *cliMachines {
 	return &cliMachines{
 		cfg: cfg,
 	}
@@ -208,8 +210,11 @@
 	return nil
 }
 
-func (cli *cliMachines) list(out io.Writer) error {
-	machines, err := cli.db.ListMachines()
+func (cli *cliMachines) List(out io.Writer, db *database.Client) error {
+	// XXX: must use the provided db object, the one in the struct might be nil
+	// (calling List directly skips the PersistentPreRunE)
+
+	machines, err := db.ListMachines()
 	if err != nil {
 		return fmt.Errorf("unable to list machines: %w", err)
 	}
@@ -247,7 +252,7 @@
 		Args:              cobra.NoArgs,
 		DisableAutoGenTag: true,
 		RunE: func(_ *cobra.Command, _ []string) error {
-			return cli.list(color.Output)
+			return cli.List(color.Output, cli.db)
 		},
 	}