Skip to content

Logging: update table.Display to use the print package #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DiogoFerrao merged 4 commits into from
Apr 8, 2024
Merged

Logging: update table.Display to use the print package #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
47f6f41
switch prints to p.Info and p.Output
DiogoFerrao Apr 5, 2024
4b790ee
fix linting
DiogoFerrao Apr 5, 2024
52b21b4
address PR comments
DiogoFerrao Apr 5, 2024
018f293
change cmd.outstdout to p.outstdout
DiogoFerrao Apr 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions internal/cmd/argus/instance/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
return fmt.Errorf("read Argus instance: %w", err)
}

return outputResult(cmd, model.OutputFormat, resp, p)
return outputResult(p, model.OutputFormat, resp)
},
}
return cmd
Expand All @@ -85,7 +85,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APICl
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, instance *argus.GetInstanceResponse, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, instance *argus.GetInstanceResponse) error {
switch outputFormat {
case globalflags.PrettyOutputFormat:

Expand All @@ -110,7 +110,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, instance *argus.GetIn
table.AddSeparator()
table.AddRow("GRAFANA URL", *instance.Instance.GrafanaUrl)
table.AddSeparator()
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/argus/instance/list/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
instances = instances[:*model.Limit]
}

return outputResult(cmd, model.OutputFormat, instances, p)
return outputResult(p, model.OutputFormat, instances)
},
}

Expand Down Expand Up @@ -116,7 +116,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APICl
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, instances []argus.ProjectInstanceFull, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, instances []argus.ProjectInstanceFull) error {
switch outputFormat {
case globalflags.JSONOutputFormat:
details, err := json.MarshalIndent(instances, "", " ")
Expand All @@ -133,7 +133,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, instances []argus.Pro
instance := instances[i]
table.AddRow(*instance.Id, *instance.Name, *instance.PlanName, *instance.Status)
}
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/argus/plans/plans.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
plans = plans[:*model.Limit]
}

return outputResult(cmd, model.OutputFormat, plans, p)
return outputResult(p, model.OutputFormat, plans)
},
}

Expand Down Expand Up @@ -116,7 +116,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APICl
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, plans []argus.Plan, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, plans []argus.Plan) error {
switch outputFormat {
case globalflags.JSONOutputFormat:
details, err := json.MarshalIndent(plans, "", " ")
Expand All @@ -135,7 +135,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, plans []argus.Plan, p
table.AddSeparator()
}
table.EnableAutoMergeOnColumns(1)
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
9 changes: 5 additions & 4 deletions internal/cmd/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,26 @@ import (
"github.com/stackitcloud/stackit-cli/internal/cmd/config/set"
"github.com/stackitcloud/stackit-cli/internal/cmd/config/unset"
"github.com/stackitcloud/stackit-cli/internal/pkg/args"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"

"github.com/spf13/cobra"
)

func NewCmd() *cobra.Command {
func NewCmd(p *print.Printer) *cobra.Command {
cmd := &cobra.Command{
Use: "config",
Short: "Provides functionality for CLI configuration options",
Long: "Provides functionality for CLI configuration options.",
Args: args.NoArgs,
Run: utils.CmdHelp,
}
addSubcommands(cmd)
addSubcommands(cmd, p)
return cmd
}

func addSubcommands(cmd *cobra.Command) {
cmd.AddCommand(list.NewCmd())
func addSubcommands(cmd *cobra.Command, p *print.Printer) {
cmd.AddCommand(list.NewCmd(p))
cmd.AddCommand(set.NewCmd())
cmd.AddCommand(unset.NewCmd())
}
5 changes: 3 additions & 2 deletions internal/cmd/config/list/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ import (
"github.com/stackitcloud/stackit-cli/internal/pkg/args"
"github.com/stackitcloud/stackit-cli/internal/pkg/config"
"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
"github.com/stackitcloud/stackit-cli/internal/pkg/tables"

"github.com/spf13/cobra"
"github.com/spf13/viper"
)

func NewCmd() *cobra.Command {
func NewCmd(p *print.Printer) *cobra.Command {
cmd := &cobra.Command{
Use: "list",
Short: "Lists the current CLI configuration values",
Expand Down Expand Up @@ -83,7 +84,7 @@ func NewCmd() *cobra.Command {
table.AddRow(key, valueString)
table.AddSeparator()
}
err = table.Display(cmd)
err = table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
4 changes: 2 additions & 2 deletions internal/cmd/curl/curl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
}
}()

err = outputResponse(model, resp, p)
err = outputResponse(p, model, resp)
if err != nil {
return err
}
Expand Down Expand Up @@ -200,7 +200,7 @@ func buildRequest(model *inputModel, bearerToken string) (*http.Request, error)
return req, nil
}

func outputResponse(model *inputModel, resp *http.Response, p *print.Printer) error {
func outputResponse(p *print.Printer, model *inputModel, resp *http.Response) error {
output := make([]byte, 0)
if model.IncludeResponseHeaders {
respHeader, err := httputil.DumpResponse(resp, false)
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/dns/record-set/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
}
recordSet := resp.Rrset

return outputResult(cmd, model.OutputFormat, recordSet, p)
return outputResult(p, model.OutputFormat, recordSet)
},
}
configureFlags(cmd)
Expand Down Expand Up @@ -101,7 +101,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *dns.APIClie
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, recordSet *dns.RecordSet, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, recordSet *dns.RecordSet) error {
switch outputFormat {
case globalflags.PrettyOutputFormat:
records := *recordSet.Records
Expand All @@ -123,7 +123,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, recordSet *dns.Record
table.AddRow("TYPE", *recordSet.Type)
table.AddSeparator()
table.AddRow("RECORDS DATA", recordsDataJoin)
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/dns/record-set/list/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
p.Info("No record sets found for zone %s matching the criteria\n", zoneLabel)
return nil
}
return outputResult(cmd, model.OutputFormat, recordSets, p)
return outputResult(p, model.OutputFormat, recordSets)
},
}

Expand Down Expand Up @@ -221,7 +221,7 @@ func fetchRecordSets(ctx context.Context, model *inputModel, apiClient dnsClient
return recordSets, nil
}

func outputResult(cmd *cobra.Command, outputFormat string, recordSets []dns.RecordSet, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, recordSets []dns.RecordSet) error {
switch outputFormat {
case globalflags.JSONOutputFormat:
details, err := json.MarshalIndent(recordSets, "", " ")
Expand All @@ -238,7 +238,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, recordSets []dns.Reco
rs := recordSets[i]
table.AddRow(*rs.Id, *rs.Name, *rs.State, *rs.Ttl, *rs.Type)
}
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/dns/zone/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
}
zone := resp.Zone

return outputResult(cmd, model.OutputFormat, zone, p)
return outputResult(p, model.OutputFormat, zone)
},
}
return cmd
Expand All @@ -86,7 +86,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *dns.APIClie
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, zone *dns.Zone, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, zone *dns.Zone) error {
switch outputFormat {
case globalflags.PrettyOutputFormat:
table := tables.NewTable()
Expand Down Expand Up @@ -119,7 +119,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, zone *dns.Zone, p *pr
table.AddRow("EXPIRE TIME", *zone.ExpireTime)
table.AddSeparator()
table.AddRow("NEGATIVE CACHE", *zone.NegativeCache)
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/dns/zone/list/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
return nil
}

return outputResult(cmd, model.OutputFormat, zones, p)
return outputResult(p, model.OutputFormat, zones)
},
}
configureFlags(cmd)
Expand Down Expand Up @@ -209,7 +209,7 @@ func fetchZones(ctx context.Context, model *inputModel, apiClient dnsClient) ([]
return zones, nil
}

func outputResult(cmd *cobra.Command, outputFormat string, zones []dns.Zone, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, zones []dns.Zone) error {
switch outputFormat {
case globalflags.JSONOutputFormat:
// Show details
Expand All @@ -227,7 +227,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, zones []dns.Zone, p *
z := zones[i]
table.AddRow(*z.Id, *z.Name, *z.State, *z.Type, *z.DnsName, *z.RecordCount)
}
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/logme/credentials/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
return fmt.Errorf("describe LogMe credentials: %w", err)
}

return outputResult(cmd, model.OutputFormat, resp, p)
return outputResult(p, model.OutputFormat, resp)
},
}
configureFlags(cmd)
Expand Down Expand Up @@ -99,7 +99,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *logme.APICl
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, credentials *logme.CredentialsResponse, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, credentials *logme.CredentialsResponse) error {
switch outputFormat {
case globalflags.PrettyOutputFormat:
table := tables.NewTable()
Expand All @@ -114,7 +114,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, credentials *logme.Cr
table.AddRow("PASSWORD", *credentials.Raw.Credentials.Password)
table.AddSeparator()
table.AddRow("URI", *credentials.Raw.Credentials.Uri)
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/logme/credentials/list/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
if model.Limit != nil && len(credentials) > int(*model.Limit) {
credentials = credentials[:*model.Limit]
}
return outputResult(cmd, model.OutputFormat, credentials, p)
return outputResult(p, model.OutputFormat, credentials)
},
}
configureFlags(cmd)
Expand Down Expand Up @@ -121,7 +121,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *logme.APICl
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, credentials []logme.CredentialsListItem, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, credentials []logme.CredentialsListItem) error {
switch outputFormat {
case globalflags.JSONOutputFormat:
details, err := json.MarshalIndent(credentials, "", " ")
Expand All @@ -138,7 +138,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, credentials []logme.C
c := credentials[i]
table.AddRow(*c.Id)
}
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/logme/instance/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
return fmt.Errorf("read LogMe instance: %w", err)
}

return outputResult(cmd, model.OutputFormat, resp, p)
return outputResult(p, model.OutputFormat, resp)
},
}
return cmd
Expand All @@ -87,7 +87,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *logme.APICl
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, instance *logme.Instance, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, instance *logme.Instance) error {
switch outputFormat {
case globalflags.PrettyOutputFormat:
table := tables.NewTable()
Expand All @@ -109,7 +109,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, instance *logme.Insta
table.AddRow("ACL", aclStr)
}
}
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/logme/instance/list/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
instances = instances[:*model.Limit]
}

return outputResult(cmd, model.OutputFormat, instances, p)
return outputResult(p, model.OutputFormat, instances)
},
}

Expand Down Expand Up @@ -116,7 +116,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *logme.APICl
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, instances []logme.Instance, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, instances []logme.Instance) error {
switch outputFormat {
case globalflags.JSONOutputFormat:
details, err := json.MarshalIndent(instances, "", " ")
Expand All @@ -133,7 +133,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, instances []logme.Ins
instance := instances[i]
table.AddRow(*instance.InstanceId, *instance.Name, *instance.LastOperation.Type, *instance.LastOperation.State)
}
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/logme/plans/plans.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
plans = plans[:*model.Limit]
}

return outputResult(cmd, model.OutputFormat, plans, p)
return outputResult(p, model.OutputFormat, plans)
},
}

Expand Down Expand Up @@ -116,7 +116,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *logme.APICl
return req
}

func outputResult(cmd *cobra.Command, outputFormat string, plans []logme.Offering, p *print.Printer) error {
func outputResult(p *print.Printer, outputFormat string, plans []logme.Offering) error {
switch outputFormat {
case globalflags.JSONOutputFormat:
details, err := json.MarshalIndent(plans, "", " ")
Expand All @@ -138,7 +138,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, plans []logme.Offerin
table.AddSeparator()
}
table.EnableAutoMergeOnColumns(1)
err := table.Display(cmd)
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
}
Expand Down
Loading