Skip to content

Add debug logs to the CLI #258

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 12 commits into from
Apr 30, 2024
Merged

Add debug logs to the CLI #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1e70c6e
Initial debug implementation
DiogoFerrao Apr 28, 2024
3305419
improve implementation
DiogoFerrao Apr 29, 2024
e18408e
remove unused code
DiogoFerrao Apr 29, 2024
0cfbf27
add documentation
DiogoFerrao Apr 29, 2024
b9db2bc
address PR comments
DiogoFerrao Apr 29, 2024
9e419fd
fix linting
DiogoFerrao Apr 29, 2024
564cd05
sort map keys before building debug string
DiogoFerrao Apr 29, 2024
78c881e
Add testing to debug string builders
DiogoFerrao Apr 29, 2024
3691147
address PR comments
DiogoFerrao Apr 29, 2024
ae12e55
improve debug string construction
DiogoFerrao Apr 29, 2024
fff0490
Debug the input model on all commands
DiogoFerrao Apr 29, 2024
cf974b0
add input model debugging to contribution guidelines
DiogoFerrao Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
14 changes: 13 additions & 1 deletion CONTRIBUTION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,11 +138,23 @@ func parseInput(cmd *cobra.Command, inputArgs []string) (*inputModel, error) {
return nil, &errors.ProjectIdError{}
}

return &inputModel{
model := inputModel{
GlobalFlagModel: globalFlags,
MyArg myArg,
MyFlag: flags.FlagToStringPointer(cmd, myFlag),
}, nil

// Write the input model to the debug logs
if p.IsVerbosityDebug() {
modelStr, err := print.BuildDebugStrFromInputModel(model)
if err != nil {
p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err)
} else {
p.Debug(print.DebugLevel, "parsed input values: %s", modelStr)
}
}

return &model, nil
}

// Build request to the API
Expand Down
17 changes: 14 additions & 3 deletions internal/cmd/argus/grafana/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ func NewCmd(p *print.Printer) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error {
ctx := context.Background()
model, err := parseInput(p, cmd, args)

if err != nil {
return err
}

// Configure API client
apiClient, err := client.ConfigureClient(p)
if err != nil {
Expand Down Expand Up @@ -95,11 +95,22 @@ func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inpu
return nil, &errors.ProjectIdError{}
}

return &inputModel{
model := inputModel{
GlobalFlagModel: globalFlags,
InstanceId: instanceId,
HidePassword: flags.FlagToBoolValue(p, cmd, hidePasswordFlag),
}, nil
}

if p.IsVerbosityDebug() {
modelStr, err := print.BuildDebugStrFromInputModel(model)
if err != nil {
p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err)
} else {
p.Debug(print.DebugLevel, "parsed input values: %s", modelStr)
}
}

return &model, nil
}

func buildGetGrafanaConfigRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiGetGrafanaConfigsRequest {
Expand Down
6 changes: 4 additions & 2 deletions internal/cmd/argus/grafana/describe/describe_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"testing"

"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
Expand Down Expand Up @@ -167,7 +168,8 @@ func TestParseInput(t *testing.T) {

for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
cmd := NewCmd(nil)
p := print.NewPrinter()
cmd := NewCmd(p)
err := globalflags.Configure(cmd.Flags())
if err != nil {
t.Fatalf("configure global flags: %v", err)
Expand Down Expand Up @@ -199,7 +201,7 @@ func TestParseInput(t *testing.T) {
t.Fatalf("error validating flags: %v", err)
}

model, err := parseInput(nil, cmd, tt.argValues)
model, err := parseInput(p, cmd, tt.argValues)

if err != nil {
if !tt.isValid {
Expand Down
15 changes: 13 additions & 2 deletions internal/cmd/argus/grafana/public-read-access/disable/disable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,21 @@ func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inpu
return nil, &errors.ProjectIdError{}
}

return &inputModel{
model := inputModel{
GlobalFlagModel: globalFlags,
InstanceId: instanceId,
}, nil
}

if p.IsVerbosityDebug() {
modelStr, err := print.BuildDebugStrFromInputModel(model)
if err != nil {
p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err)
} else {
p.Debug(print.DebugLevel, "parsed input values: %s", modelStr)
}
}

return &model, nil
}

func buildRequest(ctx context.Context, model *inputModel, apiClient argusUtils.ArgusClient) (argus.ApiUpdateGrafanaConfigsRequest, error) {
Expand Down
6 changes: 4 additions & 2 deletions internal/cmd/argus/grafana/public-read-access/disable/disable_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"testing"

"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
argusUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/argus/utils"
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"

Expand Down Expand Up @@ -184,7 +185,8 @@ func TestParseInput(t *testing.T) {

for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
cmd := NewCmd(nil)
p := print.NewPrinter()
cmd := NewCmd(p)
err := globalflags.Configure(cmd.Flags())
if err != nil {
t.Fatalf("configure global flags: %v", err)
Expand Down Expand Up @@ -216,7 +218,7 @@ func TestParseInput(t *testing.T) {
t.Fatalf("error validating flags: %v", err)
}

model, err := parseInput(nil, cmd, tt.argValues)
model, err := parseInput(p, cmd, tt.argValues)
if err != nil {
if !tt.isValid {
return
Expand Down
15 changes: 13 additions & 2 deletions internal/cmd/argus/grafana/public-read-access/enable/enable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,21 @@ func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inpu
return nil, &errors.ProjectIdError{}
}

return &inputModel{
model := inputModel{
GlobalFlagModel: globalFlags,
InstanceId: instanceId,
}, nil
}

if p.IsVerbosityDebug() {
modelStr, err := print.BuildDebugStrFromInputModel(model)
if err != nil {
p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err)
} else {
p.Debug(print.DebugLevel, "parsed input values: %s", modelStr)
}
}

return &model, nil
}

func buildRequest(ctx context.Context, model *inputModel, apiClient argusUtils.ArgusClient) (argus.ApiUpdateGrafanaConfigsRequest, error) {
Expand Down
6 changes: 4 additions & 2 deletions internal/cmd/argus/grafana/public-read-access/enable/enable_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"testing"

"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
argusUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/argus/utils"
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"

Expand Down Expand Up @@ -184,7 +185,8 @@ func TestParseInput(t *testing.T) {

for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
cmd := NewCmd(nil)
p := print.NewPrinter()
cmd := NewCmd(p)
err := globalflags.Configure(cmd.Flags())
if err != nil {
t.Fatalf("configure global flags: %v", err)
Expand Down Expand Up @@ -216,7 +218,7 @@ func TestParseInput(t *testing.T) {
t.Fatalf("error validating flags: %v", err)
}

model, err := parseInput(nil, cmd, tt.argValues)
model, err := parseInput(p, cmd, tt.argValues)
if err != nil {
if !tt.isValid {
return
Expand Down
15 changes: 13 additions & 2 deletions internal/cmd/argus/grafana/single-sign-on/disable/disable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,21 @@ func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inpu
return nil, &errors.ProjectIdError{}
}

return &inputModel{
model := inputModel{
GlobalFlagModel: globalFlags,
InstanceId: instanceId,
}, nil
}

if p.IsVerbosityDebug() {
modelStr, err := print.BuildDebugStrFromInputModel(model)
if err != nil {
p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err)
} else {
p.Debug(print.DebugLevel, "parsed input values: %s", modelStr)
}
}

return &model, nil
}

func buildRequest(ctx context.Context, model *inputModel, apiClient argusUtils.ArgusClient) (argus.ApiUpdateGrafanaConfigsRequest, error) {
Expand Down
6 changes: 4 additions & 2 deletions internal/cmd/argus/grafana/single-sign-on/disable/disable_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"testing"

"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
argusUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/argus/utils"
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"

Expand Down Expand Up @@ -184,7 +185,8 @@ func TestParseInput(t *testing.T) {

for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
cmd := NewCmd(nil)
p := print.NewPrinter()
cmd := NewCmd(p)
err := globalflags.Configure(cmd.Flags())
if err != nil {
t.Fatalf("configure global flags: %v", err)
Expand Down Expand Up @@ -216,7 +218,7 @@ func TestParseInput(t *testing.T) {
t.Fatalf("error validating flags: %v", err)
}

model, err := parseInput(nil, cmd, tt.argValues)
model, err := parseInput(p, cmd, tt.argValues)
if err != nil {
if !tt.isValid {
return
Expand Down
15 changes: 13 additions & 2 deletions internal/cmd/argus/grafana/single-sign-on/enable/enable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,21 @@ func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inpu
return nil, &errors.ProjectIdError{}
}

return &inputModel{
model := inputModel{
GlobalFlagModel: globalFlags,
InstanceId: instanceId,
}, nil
}

if p.IsVerbosityDebug() {
modelStr, err := print.BuildDebugStrFromInputModel(model)
if err != nil {
p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err)
} else {
p.Debug(print.DebugLevel, "parsed input values: %s", modelStr)
}
}

return &model, nil
}

func buildRequest(ctx context.Context, model *inputModel, apiClient argusUtils.ArgusClient) (argus.ApiUpdateGrafanaConfigsRequest, error) {
Expand Down
6 changes: 4 additions & 2 deletions internal/cmd/argus/grafana/single-sign-on/enable/enable_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"testing"

"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
argusUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/argus/utils"
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"

Expand Down Expand Up @@ -184,7 +185,8 @@ func TestParseInput(t *testing.T) {

for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
cmd := NewCmd(nil)
p := print.NewPrinter()
cmd := NewCmd(p)
err := globalflags.Configure(cmd.Flags())
if err != nil {
t.Fatalf("configure global flags: %v", err)
Expand Down Expand Up @@ -216,7 +218,7 @@ func TestParseInput(t *testing.T) {
t.Fatalf("error validating flags: %v", err)
}

model, err := parseInput(nil, cmd, tt.argValues)
model, err := parseInput(p, cmd, tt.argValues)
if err != nil {
if !tt.isValid {
return
Expand Down
15 changes: 13 additions & 2 deletions internal/cmd/argus/instance/create/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,23 @@ func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) {
}
}

return &inputModel{
model := inputModel{
GlobalFlagModel: globalFlags,
InstanceName: flags.FlagToStringPointer(p, cmd, instanceNameFlag),
PlanId: planId,
PlanName: planName,
}, nil
}

if p.IsVerbosityDebug() {
modelStr, err := print.BuildDebugStrFromInputModel(model)
if err != nil {
p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err)
} else {
p.Debug(print.DebugLevel, "parsed input values: %s", modelStr)
}
}

return &model, nil
}

type argusClient interface {
Expand Down
6 changes: 4 additions & 2 deletions internal/cmd/argus/instance/create/create_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"testing"

"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"

"github.com/google/go-cmp/cmp"
Expand Down Expand Up @@ -173,7 +174,8 @@ func TestParseInput(t *testing.T) {

for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
cmd := NewCmd(nil)
p := print.NewPrinter()
cmd := NewCmd(p)
err := globalflags.Configure(cmd.Flags())
if err != nil {
t.Fatalf("configure global flags: %v", err)
Expand All @@ -197,7 +199,7 @@ func TestParseInput(t *testing.T) {
t.Fatalf("error validating flags: %v", err)
}

model, err := parseInput(nil, cmd)
model, err := parseInput(p, cmd)
if err != nil {
if !tt.isValid {
return
Expand Down
15 changes: 13 additions & 2 deletions internal/cmd/argus/instance/delete/delete.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,21 @@ func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inpu
return nil, &errors.ProjectIdError{}
}

return &inputModel{
model := inputModel{
GlobalFlagModel: globalFlags,
InstanceId: instanceId,
}, nil
}

if p.IsVerbosityDebug() {
modelStr, err := print.BuildDebugStrFromInputModel(model)
if err != nil {
p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err)
} else {
p.Debug(print.DebugLevel, "parsed input values: %s", modelStr)
}
}

return &model, nil
}

func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiDeleteInstanceRequest {
Expand Down
6 changes: 4 additions & 2 deletions internal/cmd/argus/instance/delete/delete_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"testing"

"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
Expand Down Expand Up @@ -136,7 +137,8 @@ func TestParseInput(t *testing.T) {

for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
cmd := NewCmd(nil)
p := print.NewPrinter()
cmd := NewCmd(p)
err := globalflags.Configure(cmd.Flags())
if err != nil {
t.Fatalf("configure global flags: %v", err)
Expand Down Expand Up @@ -168,7 +170,7 @@ func TestParseInput(t *testing.T) {
t.Fatalf("error validating flags: %v", err)
}

model, err := parseInput(nil, cmd, tt.argValues)
model, err := parseInput(p, cmd, tt.argValues)
if err != nil {
if !tt.isValid {
return
Expand Down
Loading