Skip to content

chore(sqlserverflex): Add nil pointer checks and tests for the output… #625

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
merged 1 commit into from
Feb 25, 2025
Merged

chore(sqlserverflex): Add nil pointer checks and tests for the output… #625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions internal/cmd/beta/sqlserverflex/database/create/create.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 {
}
s.Stop()

return outputResult(p, model, resp)
return outputResult(p, model.OutputFormat, model.DatabaseName, resp)
},
}
configureFlags(cmd)
Expand Down Expand Up @@ -132,8 +132,11 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *sqlserverfl
return req
}

func outputResult(p *print.Printer, model *inputModel, resp *sqlserverflex.CreateDatabaseResponse) error {
switch model.OutputFormat {
func outputResult(p *print.Printer, outputFormat, databaseName string, resp *sqlserverflex.CreateDatabaseResponse) error {
if resp == nil {
return fmt.Errorf("sqlserverflex response is empty")
}
switch outputFormat {
case print.JSONOutputFormat:
details, err := json.MarshalIndent(resp, "", " ")
if err != nil {
Expand All @@ -151,7 +154,7 @@ func outputResult(p *print.Printer, model *inputModel, resp *sqlserverflex.Creat

return nil
default:
p.Outputf("Created database %q\n", model.DatabaseName)
p.Outputf("Created database %q\n", databaseName)
return nil
}
}
42 changes: 38 additions & 4 deletions internal/cmd/beta/sqlserverflex/database/create/create_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ import (
"context"
"testing"

"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
"github.com/stackitcloud/stackit-sdk-go/services/sqlserverflex"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/google/uuid"
"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
"github.com/stackitcloud/stackit-sdk-go/services/sqlserverflex"
)

var projectIdFlag = globalflags.ProjectIdFlag
Expand Down Expand Up @@ -255,3 +254,38 @@ func TestBuildRequest(t *testing.T) {
})
}
}

func TestOutputResult(t *testing.T) {
type args struct {
outputFormat string
databaseName string
resp *sqlserverflex.CreateDatabaseResponse
}
tests := []struct {
name string
args args
wantErr bool
}{
{
name: "empty",
args: args{},
wantErr: true,
},
{
name: "only sql response as argument",
args: args{
resp: &sqlserverflex.CreateDatabaseResponse{},
},
wantErr: false,
},
}
p := print.NewPrinter()
p.Cmd = NewCmd(p)
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if err := outputResult(p, tt.args.outputFormat, tt.args.databaseName, tt.args.resp); (err != nil) != tt.wantErr {
t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
11 changes: 7 additions & 4 deletions internal/cmd/beta/sqlserverflex/database/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,26 +109,29 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *sqlserverfl
return req
}

func outputResult(p *print.Printer, outputFormat string, database *sqlserverflex.GetDatabaseResponse) error {
func outputResult(p *print.Printer, outputFormat string, resp *sqlserverflex.GetDatabaseResponse) error {
if resp == nil || resp.Database == nil {
return fmt.Errorf("database response is empty")
}
switch outputFormat {
case print.JSONOutputFormat:
details, err := json.MarshalIndent(database, "", " ")
details, err := json.MarshalIndent(resp, "", " ")
if err != nil {
return fmt.Errorf("marshal SQLServer Flex database: %w", err)
}
p.Outputln(string(details))

return nil
case print.YAMLOutputFormat:
details, err := yaml.MarshalWithOptions(database, yaml.IndentSequence(true), yaml.UseJSONMarshaler())
details, err := yaml.MarshalWithOptions(resp, yaml.IndentSequence(true), yaml.UseJSONMarshaler())
if err != nil {
return fmt.Errorf("marshal SQLServer Flex database: %w", err)
}
p.Outputln(string(details))

return nil
default:
database := database.Database
database := resp.Database
table := tables.NewTable()
table.AddRow("ID", utils.PtrString(database.Id))
table.AddSeparator()
Expand Down
48 changes: 44 additions & 4 deletions internal/cmd/beta/sqlserverflex/database/describe/describe_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ import (
"context"
"testing"

"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
"github.com/stackitcloud/stackit-sdk-go/services/sqlserverflex"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/google/uuid"
"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
"github.com/stackitcloud/stackit-sdk-go/services/sqlserverflex"
)

var projectIdFlag = globalflags.ProjectIdFlag
Expand Down Expand Up @@ -237,3 +236,44 @@ func TestBuildRequest(t *testing.T) {
})
}
}

func TestOutputResult(t *testing.T) {
type args struct {
outputFormat string
resp *sqlserverflex.GetDatabaseResponse
}
tests := []struct {
name string
args args
wantErr bool
}{
{
name: "empty",
args: args{},
wantErr: true,
},
{
name: "empty response",
args: args{
resp: &sqlserverflex.GetDatabaseResponse{},
},
wantErr: true,
},
{
name: "only database as argument",
args: args{
resp: &sqlserverflex.GetDatabaseResponse{Database: &sqlserverflex.SingleDatabase{}},
},
wantErr: false,
},
}
p := print.NewPrinter()
p.Cmd = NewCmd(p)
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if err := outputResult(p, tt.args.outputFormat, tt.args.resp); (err != nil) != tt.wantErr {
t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
43 changes: 38 additions & 5 deletions internal/cmd/beta/sqlserverflex/database/list/list_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@ import (
"context"
"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/stackitcloud/stackit-sdk-go/services/sqlserverflex"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/google/uuid"
"github.com/spf13/cobra"
"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/stackitcloud/stackit-sdk-go/services/sqlserverflex"
)

var projectIdFlag = globalflags.ProjectIdFlag
Expand Down Expand Up @@ -210,3 +209,37 @@ func TestBuildRequest(t *testing.T) {
})
}
}

func TestOutputResult(t *testing.T) {
type args struct {
outputFormat string
databases []sqlserverflex.Database
}
tests := []struct {
name string
args args
wantErr bool
}{
{
name: "empty",
args: args{},
wantErr: false,
},
{
name: "empty database in databases slice",
args: args{
databases: []sqlserverflex.Database{{}},
},
wantErr: false,
},
}
p := print.NewPrinter()
p.Cmd = NewCmd(p)
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if err := outputResult(p, tt.args.outputFormat, tt.args.databases); (err != nil) != tt.wantErr {
t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
3 changes: 3 additions & 0 deletions internal/cmd/beta/sqlserverflex/instance/create/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,9 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient sqlServerFle
}

func outputResult(p *print.Printer, model *inputModel, projectLabel string, resp *sqlserverflex.CreateInstanceResponse) error {
if resp == nil {
return fmt.Errorf("sqlserverflex response is empty")
}
switch model.OutputFormat {
case print.JSONOutputFormat:
details, err := json.MarshalIndent(resp, "", " ")
Expand Down
43 changes: 39 additions & 4 deletions internal/cmd/beta/sqlserverflex/instance/create/create_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@ import (
"fmt"
"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"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/google/uuid"
"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/stackitcloud/stackit-sdk-go/services/sqlserverflex"
)

Expand Down Expand Up @@ -492,3 +491,39 @@ func TestBuildRequest(t *testing.T) {
})
}
}

func TestOutputResult(t *testing.T) {
type args struct {
model *inputModel
projectLabel string
resp *sqlserverflex.CreateInstanceResponse
}
tests := []struct {
name string
args args
wantErr bool
}{
{
name: "empty",
args: args{},
wantErr: true,
},
{
name: "sql instance as argument",
args: args{
model: fixtureInputModel(),
resp: &sqlserverflex.CreateInstanceResponse{},
},
wantErr: false,
},
}
p := print.NewPrinter()
p.Cmd = NewCmd(p)
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if err := outputResult(p, tt.args.model, tt.args.projectLabel, tt.args.resp); (err != nil) != tt.wantErr {
t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
24 changes: 15 additions & 9 deletions internal/cmd/beta/sqlserverflex/instance/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *sqlserverfl
}

func outputResult(p *print.Printer, outputFormat string, instance *sqlserverflex.Instance) error {
if instance == nil {
return fmt.Errorf("instance response is empty")
}
switch outputFormat {
case print.JSONOutputFormat:
details, err := json.MarshalIndent(instance, "", " ")
Expand Down Expand Up @@ -130,21 +133,24 @@ func outputResult(p *print.Printer, outputFormat string, instance *sqlserverflex
table.AddSeparator()
table.AddRow("STATUS", utils.PtrString(instance.Status))
table.AddSeparator()
table.AddRow("STORAGE SIZE (GB)", utils.PtrString(instance.Storage.Size))
table.AddSeparator()
if instance.Storage != nil {
table.AddRow("STORAGE SIZE (GB)", utils.PtrString(instance.Storage.Size))
table.AddSeparator()
}
table.AddRow("VERSION", utils.PtrString(instance.Version))
table.AddSeparator()
table.AddRow("BACKUP SCHEDULE (UTC)", utils.PtrString(instance.BackupSchedule))
table.AddSeparator()
table.AddRow("ACL", acls)
table.AddSeparator()
table.AddRow("FLAVOR DESCRIPTION", utils.PtrString(instance.Flavor.Description))
table.AddSeparator()
table.AddRow("CPU", utils.PtrString(instance.Flavor.Cpu))
table.AddSeparator()
table.AddRow("RAM (GB)", utils.PtrString(instance.Flavor.Memory))
table.AddSeparator()

if instance.Flavor != nil {
table.AddRow("FLAVOR DESCRIPTION", utils.PtrString(instance.Flavor.Description))
table.AddSeparator()
table.AddRow("CPU", utils.PtrString(instance.Flavor.Cpu))
table.AddSeparator()
table.AddRow("RAM (GB)", utils.PtrString(instance.Flavor.Memory))
table.AddSeparator()
}
err := table.Display(p)
if err != nil {
return fmt.Errorf("render table: %w", err)
Expand Down
Loading
Loading