cscli refact: extract table wrapper to own package

cmd/crowdsec-cli/alerts.go

@@ -21,6 +21,7 @@
 
 	"github.com/crowdsecurity/go-cs-lib/maptools"
 
+	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/cstable"
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/require"
 	"github.com/crowdsecurity/crowdsec/pkg/apiclient"
 	"github.com/crowdsecurity/crowdsec/pkg/cwversion"
@@ -54,7 +55,8 @@
 }
 
 func (cli *cliAlerts) alertsToTable(alerts *models.GetAlertsResponse, printMachine bool) error {
-	switch cli.cfg().Cscli.Output {
+	cfg := cli.cfg()
+	switch cfg.Cscli.Output {
 	case "raw":
 		csvwriter := csv.NewWriter(os.Stdout)
 		header := []string{"id", "scope", "value", "reason", "country", "as", "decisions", "created_at"}
@@ -104,7 +106,7 @@
 			return nil
 		}
 
-		alertsTable(color.Output, alerts, printMachine)
+		alertsTable(color.Output, cfg.Cscli.Color, alerts, printMachine)
 	}
 
 	return nil
@@ -138,15 +140,17 @@
 		return err
 	}
 
-	alertDecisionsTable(color.Output, alert)
+	cfg := cli.cfg()
+
+	alertDecisionsTable(color.Output, cfg.Cscli.Color, alert)
 
 	if len(alert.Meta) > 0 {
 		fmt.Printf("\n - Context  :\n")
 		sort.Slice(alert.Meta, func(i, j int) bool {
 			return alert.Meta[i].Key < alert.Meta[j].Key
 		})
 
-		table := newTable(color.Output)
+		table := cstable.New(color.Output, cfg.Cscli.Color)
 		table.SetRowLines(false)
 		table.SetHeaders("Key", "Value")
 
@@ -171,7 +175,7 @@
 		fmt.Printf("\n - Events  :\n")
 
 		for _, event := range alert.Events {
-			alertEventTable(color.Output, event)
+			alertEventTable(color.Output, cfg.Cscli.Color, event)
 		}
 	}
 

cmd/crowdsec-cli/alerts_table.go

@@ -9,11 +9,12 @@
 
 	log "github.com/sirupsen/logrus"
 
+	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/cstable"
 	"github.com/crowdsecurity/crowdsec/pkg/models"
 )
 
-func alertsTable(out io.Writer, alerts *models.GetAlertsResponse, printMachine bool) {
-	t := newTable(out)
+func alertsTable(out io.Writer, wantColor string, alerts *models.GetAlertsResponse, printMachine bool) {
+	t := cstable.New(out, wantColor)
 	t.SetRowLines(false)
 
 	header := []string{"ID", "value", "reason", "country", "as", "decisions", "created_at"}
@@ -51,9 +52,9 @@
 	t.Render()
 }
 
-func alertDecisionsTable(out io.Writer, alert *models.Alert) {
+func alertDecisionsTable(out io.Writer, wantColor string, alert *models.Alert) {
 	foundActive := false
-	t := newTable(out)
+	t := cstable.New(out, wantColor)
 	t.SetRowLines(false)
 	t.SetHeaders("ID", "scope:value", "action", "expiration", "created_at")
 
@@ -90,10 +91,10 @@
 	}
 }
 
-func alertEventTable(out io.Writer, event *models.Event) {
+func alertEventTable(out io.Writer, wantColor string, event *models.Event) {
 	fmt.Fprintf(out, "\n- Date: %s\n", *event.Timestamp)
 
-	t := newTable(out)
+	t := cstable.New(out, wantColor)
 	t.SetHeaders("Key", "Value")
 	sort.Slice(event.Meta, func(i, j int) bool {
 		return event.Meta[i].Key < event.Meta[j].Key

cmd/crowdsec-cli/bouncers.go

@@ -17,6 +17,7 @@
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
+	"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/database"
@@ -90,7 +91,7 @@
 }
 
 func (cli *cliBouncers) listHuman(out io.Writer, bouncers ent.Bouncers) {
-	t := newLightTable(out).Writer
+	t := cstable.NewLight(out, cli.cfg().Cscli.Color).Writer
 	t.AppendHeader(table.Row{"Name", "IP Address", "Valid", "Last API pull", "Type", "Version", "Auth Type"})
 
 	for _, b := range bouncers {
@@ -411,7 +412,7 @@
 }
 
 func (cli *cliBouncers) inspectHuman(out io.Writer, bouncer *ent.Bouncer) {
-	t := newTable(out).Writer
+	t := cstable.NewLight(out, cli.cfg().Cscli.Color).Writer
 
 	t.SetTitle("Bouncer: " + bouncer.Name)
 

cmd/crowdsec-cli/console.go

@@ -276,7 +276,7 @@ func (cli *cliConsole) newStatusCmd() *cobra.Command {
 			consoleCfg := cfg.API.Server.ConsoleConfig
 			switch cfg.Cscli.Output {
 			case "human":
-				cmdConsoleStatusTable(color.Output, *consoleCfg)
+				cmdConsoleStatusTable(color.Output, cfg.Cscli.Color, *consoleCfg)
 			case "json":
 				out := map[string](*bool){
 					csconfig.SEND_MANUAL_SCENARIOS:  consoleCfg.ShareManualDecisions,

cmd/crowdsec-cli/console_table.go

@@ -3,17 +3,19 @@ package main
 import (
 	"io"
 
-	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/table"
+	"github.com/jedib0t/go-pretty/v6/text"
+
+	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/cstable"
 	"github.com/crowdsecurity/crowdsec/pkg/csconfig"
 	"github.com/crowdsecurity/crowdsec/pkg/emoji"
 )
 
-func cmdConsoleStatusTable(out io.Writer, consoleCfg csconfig.ConsoleConfig) {
-	t := newTable(out)
+func cmdConsoleStatusTable(out io.Writer, wantColor string, consoleCfg csconfig.ConsoleConfig) {
+	t := cstable.New(out, wantColor)
 	t.SetRowLines(false)
 
 	t.SetHeaders("Option Name", "Activated", "Description")
-	t.SetHeaderAlignment(table.AlignLeft, table.AlignLeft, table.AlignLeft)
+	t.SetHeaderAlignment(text.AlignLeft, text.AlignLeft, text.AlignLeft)
 
 	for _, option := range csconfig.CONSOLE_CONFIGS {
 		activated := emoji.CrossMark

cmd/crowdsec-cli/prettytable.go → cmd/crowdsec-cli/cstable/cstable.go

@@ -1,39 +1,65 @@
-package main
+package cstable
 
 // transisional file to keep (minimal) backwards compatibility with the old table
 // we can migrate the code to the new dependency later, it can already use the Writer interface
 
 import (
 	"fmt"
 	"io"
+	"os"
+
+	isatty "github.com/mattn/go-isatty"
 
 	"github.com/jedib0t/go-pretty/v6/table"
 	"github.com/jedib0t/go-pretty/v6/text"
 )
 
+func RenderTitle(out io.Writer, title string) {
+	if out == nil {
+		panic("renderTableTitle: out is nil")
+	}
+
+	if title == "" {
+		return
+	}
+
+	fmt.Fprintln(out, title)
+}
+
+func shouldWeColorize(wantColor string) bool {
+	switch wantColor {
+	case "yes":
+		return true
+	case "no":
+		return false
+	default:
+		return isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd())
+	}
+}
+
 type Table struct {
 	Writer      table.Writer
 	output      io.Writer
 	align       []text.Align
 	alignHeader []text.Align
 }
 
-func newTable(out io.Writer) *Table {
+func New(out io.Writer, wantColor string) *Table {
 	if out == nil {
 		panic("newTable: out is nil")
 	}
 
 	t := table.NewWriter()
 
 	// colorize output, use unicode box characters
-	fancy := shouldWeColorize()
+	fancy := shouldWeColorize(wantColor)
 
-	color := table.ColorOptions{}
+	colorOptions := table.ColorOptions{}
 
 	if fancy {
-		color.Header = text.Colors{text.Italic}
-		color.Border = text.Colors{text.FgHiBlack}
-		color.Separator = text.Colors{text.FgHiBlack}
+		colorOptions.Header = text.Colors{text.Italic}
+		colorOptions.Border = text.Colors{text.FgHiBlack}
+		colorOptions.Separator = text.Colors{text.FgHiBlack}
 	}
 
 	// no upper/lower case transformations
@@ -46,7 +72,7 @@
 
 	style := table.Style{
 		Box:     box,
-		Color:   color,
+		Color:   colorOptions,
 		Format:  format,
 		HTML:    table.DefaultHTMLOptions,
 		Options: table.OptionsDefault,
@@ -63,8 +89,8 @@
 	}
 }
 
-func newLightTable(output io.Writer) *Table {
-	t := newTable(output)
+func NewLight(output io.Writer, wantColor string) *Table {
+	t := New(output, wantColor)
 	s := t.Writer.Style()
 	s.Box.Left = ""
 	s.Box.LeftSeparator = ""

cmd/crowdsec-cli/decisions_table.go

@@ -6,10 +6,11 @@ import (
 	"strconv"
 
 	"github.com/crowdsecurity/crowdsec/pkg/models"
+	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/cstable"
 )
 
 func (cli *cliDecisions) decisionsTable(out io.Writer, alerts *models.GetAlertsResponse, printMachine bool) {
-	t := newTable(out)
+	t := cstable.New(out, cli.cfg().Cscli.Color)
 	t.SetRowLines(false)
 
 	header := []string{"ID", "Source", "Scope:Value", "Reason", "Action", "Country", "AS", "Events", "expiration", "Alert ID"}

cmd/crowdsec-cli/hub.go

@@ -72,7 +72,7 @@ func (cli *cliHub) list(all bool) error {
 		}
 	}
 
-	err = listItems(color.Output, cwhub.ItemTypes, items, true, cfg.Cscli.Output)
+	err = listItems(color.Output, cfg.Cscli.Color, cwhub.ItemTypes, items, true, cfg.Cscli.Output)
 	if err != nil {
 		return err
 	}

cmd/crowdsec-cli/hubtest.go

@@ -371,7 +371,7 @@
 
 			switch cfg.Cscli.Output {
 			case "human":
-				hubTestResultTable(color.Output, testResult)
+				hubTestResultTable(color.Output, cfg.Cscli.Color, testResult)
 			case "json":
 				jsonResult := make(map[string][]string, 0)
 				jsonResult["success"] = make([]string, 0)
@@ -480,7 +480,7 @@
 
 			switch cfg.Cscli.Output {
 			case "human":
-				hubTestListTable(color.Output, hubPtr.Tests)
+				hubTestListTable(color.Output, cfg.Cscli.Color, hubPtr.Tests)
 			case "json":
 				j, err := json.MarshalIndent(hubPtr.Tests, " ", "  ")
 				if err != nil {
@@ -578,15 +578,15 @@
 	switch cfg.Cscli.Output {
 	case "human":
 		if showParserCov || showAll {
-			hubTestParserCoverageTable(color.Output, parserCoverage)
+			hubTestParserCoverageTable(color.Output, cfg.Cscli.Color, parserCoverage)
 		}
 
 		if showScenarioCov || showAll {
-			hubTestScenarioCoverageTable(color.Output, scenarioCoverage)
+			hubTestScenarioCoverageTable(color.Output, cfg.Cscli.Color, scenarioCoverage)
 		}
 
 		if showAppsecCov || showAll {
-			hubTestAppsecRuleCoverageTable(color.Output, appsecRuleCoverage)
+			hubTestAppsecRuleCoverageTable(color.Output, cfg.Cscli.Color, appsecRuleCoverage)
 		}
 
 		fmt.Println()

cmd/crowdsec-cli/hubtest_table.go

@@ -4,16 +4,18 @@
 	"fmt"
 	"io"
 
-	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/table"
+	"github.com/jedib0t/go-pretty/v6/text"
+
+	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/cstable"
 	"github.com/crowdsecurity/crowdsec/pkg/emoji"
 	"github.com/crowdsecurity/crowdsec/pkg/hubtest"
 )
 
-func hubTestResultTable(out io.Writer, testResult map[string]bool) {
-	t := newLightTable(out)
+func hubTestResultTable(out io.Writer, wantColor string, testResult map[string]bool) {
+	t := cstable.NewLight(out, wantColor)
 	t.SetHeaders("Test", "Result")
-	t.SetHeaderAlignment(table.AlignLeft)
-	t.SetAlignment(table.AlignLeft)
+	t.SetHeaderAlignment(text.AlignLeft)
+	t.SetAlignment(text.AlignLeft)
 
 	for testName, success := range testResult {
 		status := emoji.CheckMarkButton
@@ -27,11 +29,11 @@
 	t.Render()
 }
 
-func hubTestListTable(out io.Writer, tests []*hubtest.HubTestItem) {
-	t := newLightTable(out)
+func hubTestListTable(out io.Writer, wantColor string, tests []*hubtest.HubTestItem) {
+	t := cstable.NewLight(out, wantColor)
 	t.SetHeaders("Name", "Path")
-	t.SetHeaderAlignment(table.AlignLeft, table.AlignLeft)
-	t.SetAlignment(table.AlignLeft, table.AlignLeft)
+	t.SetHeaderAlignment(text.AlignLeft, text.AlignLeft)
+	t.SetAlignment(text.AlignLeft, text.AlignLeft)
 
 	for _, test := range tests {
 		t.AddRow(test.Name, test.Path)
@@ -40,11 +42,11 @@
 	t.Render()
 }
 
-func hubTestParserCoverageTable(out io.Writer, coverage []hubtest.Coverage) {
-	t := newLightTable(out)
+func hubTestParserCoverageTable(out io.Writer, wantColor string, coverage []hubtest.Coverage) {
+	t := cstable.NewLight(out, wantColor)
 	t.SetHeaders("Parser", "Status", "Number of tests")
-	t.SetHeaderAlignment(table.AlignLeft, table.AlignLeft, table.AlignLeft)
-	t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignLeft)
+	t.SetHeaderAlignment(text.AlignLeft, text.AlignLeft, text.AlignLeft)
+	t.SetAlignment(text.AlignLeft, text.AlignLeft, text.AlignLeft)
 
 	parserTested := 0
 
@@ -61,11 +63,11 @@
 	t.Render()
 }
 
-func hubTestAppsecRuleCoverageTable(out io.Writer, coverage []hubtest.Coverage) {
-	t := newLightTable(out)
+func hubTestAppsecRuleCoverageTable(out io.Writer, wantColor string, coverage []hubtest.Coverage) {
+	t := cstable.NewLight(out, wantColor)
 	t.SetHeaders("Appsec Rule", "Status", "Number of tests")
-	t.SetHeaderAlignment(table.AlignLeft, table.AlignLeft, table.AlignLeft)
-	t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignLeft)
+	t.SetHeaderAlignment(text.AlignLeft, text.AlignLeft, text.AlignLeft)
+	t.SetAlignment(text.AlignLeft, text.AlignLeft, text.AlignLeft)
 
 	parserTested := 0
 
@@ -82,11 +84,11 @@
 	t.Render()
 }
 
-func hubTestScenarioCoverageTable(out io.Writer, coverage []hubtest.Coverage) {
-	t := newLightTable(out)
+func hubTestScenarioCoverageTable(out io.Writer, wantColor string, coverage []hubtest.Coverage) {
+	t := cstable.NewLight(out, wantColor)
 	t.SetHeaders("Scenario", "Status", "Number of tests")
-	t.SetHeaderAlignment(table.AlignLeft, table.AlignLeft, table.AlignLeft)
-	t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignLeft)
+	t.SetHeaderAlignment(text.AlignLeft, text.AlignLeft, text.AlignLeft)
+	t.SetAlignment(text.AlignLeft, text.AlignLeft, text.AlignLeft)
 
 	parserTested := 0