Skip to content

fix: stackit beta network-area commands - add nil pointer checks and tests for the outputResult functions #606

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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: 8 additions & 3 deletions internal/cmd/beta/network-area/create/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
if err != nil {
p.Debug(print.ErrorLevel, "get organization name: %v", err)
orgLabel = *model.OrganizationId
} else if orgLabel == "" {
orgLabel = *model.OrganizationId
}
} else {
p.Debug(print.ErrorLevel, "configure resource manager client: %v", err)
Expand All @@ -103,7 +105,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
return fmt.Errorf("create network area: %w", err)
}

return outputResult(p, model, orgLabel, resp)
return outputResult(p, model.OutputFormat, orgLabel, resp)
},
}
configureFlags(cmd)
Expand Down Expand Up @@ -178,8 +180,11 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APICli
return req.CreateNetworkAreaPayload(payload)
}

func outputResult(p *print.Printer, model *inputModel, orgLabel string, networkArea *iaas.NetworkArea) error {
switch model.OutputFormat {
func outputResult(p *print.Printer, outputFormat, orgLabel string, networkArea *iaas.NetworkArea) error {
if networkArea == nil {
return fmt.Errorf("network area is nil")
}
switch outputFormat {
case print.JSONOutputFormat:
details, err := json.MarshalIndent(networkArea, "", " ")
if err != nil {
Expand Down
35 changes: 35 additions & 0 deletions internal/cmd/beta/network-area/create/create_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -246,3 +246,38 @@ func TestBuildRequest(t *testing.T) {
})
}
}

func Test_outputResult(t *testing.T) {
type args struct {
outputFormat string
orgLabel string
networkArea *iaas.NetworkArea
}
tests := []struct {
name string
args args
wantErr bool
}{
{
name: "empty",
args: args{},
wantErr: true,
},
{
name: "set empty network area",
args: args{
networkArea: &iaas.NetworkArea{},
},
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.orgLabel, tt.args.networkArea); (err != nil) != tt.wantErr {
t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
2 changes: 2 additions & 0 deletions internal/cmd/beta/network-area/delete/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
if err != nil {
p.Debug(print.ErrorLevel, "get network area name: %v", err)
networkAreaLabel = model.AreaId
} else if networkAreaLabel == "" {
networkAreaLabel = model.AreaId
}

if !model.AssumeYes {
Expand Down
22 changes: 14 additions & 8 deletions internal/cmd/beta/network-area/describe/describe.go
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,9 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APICli
}

func outputResult(p *print.Printer, outputFormat string, networkArea *iaas.NetworkArea, attachedProjects []string) error {
if networkArea == nil {
return fmt.Errorf("network area is nil")
}
switch outputFormat {
case print.JSONOutputFormat:
details, err := json.MarshalIndent(networkArea, "", " ")
Expand All @@ -146,16 +149,19 @@ func outputResult(p *print.Printer, outputFormat string, networkArea *iaas.Netwo
return nil
default:
var routes []string
if networkArea.Ipv4.Routes != nil {
for _, route := range *networkArea.Ipv4.Routes {
routes = append(routes, fmt.Sprintf("next hop: %s\nprefix: %s", *route.Nexthop, *route.Prefix))
var networkRanges []string

if networkArea.Ipv4 != nil {
if networkArea.Ipv4.Routes != nil {
for _, route := range *networkArea.Ipv4.Routes {
routes = append(routes, fmt.Sprintf("next hop: %s\nprefix: %s", *route.Nexthop, *route.Prefix))
}
}
}

var networkRanges []string
if networkArea.Ipv4.NetworkRanges != nil {
for _, networkRange := range *networkArea.Ipv4.NetworkRanges {
networkRanges = append(networkRanges, *networkRange.Prefix)
if networkArea.Ipv4.NetworkRanges != nil {
for _, networkRange := range *networkArea.Ipv4.NetworkRanges {
networkRanges = append(networkRanges, *networkRange.Prefix)
}
}
}

Expand Down
35 changes: 35 additions & 0 deletions internal/cmd/beta/network-area/describe/describe_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,38 @@ func TestBuildRequest(t *testing.T) {
})
}
}

func TestOutputResult(t *testing.T) {
type args struct {
outputFormat string
networkArea *iaas.NetworkArea
attachedProjects []string
}
tests := []struct {
name string
args args
wantErr bool
}{
{
name: "empty",
args: args{},
wantErr: true,
},
{
name: "set networkArea",
args: args{
networkArea: &iaas.NetworkArea{},
},
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.networkArea, tt.args.attachedProjects); (err != nil) != tt.wantErr {
t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
2 changes: 2 additions & 0 deletions internal/cmd/beta/network-area/list/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
if err != nil {
p.Debug(print.ErrorLevel, "get organization name: %v", err)
orgLabel = *model.OrganizationId
} else if orgLabel == "" {
orgLabel = *model.OrganizationId
}
} else {
p.Debug(print.ErrorLevel, "configure resource manager client: %v", err)
Expand Down
41 changes: 41 additions & 0 deletions internal/cmd/beta/network-area/list/list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -186,3 +186,44 @@ func TestBuildRequest(t *testing.T) {
})
}
}

func TestOutputResult(t *testing.T) {
type args struct {
outputFormat string
networkAreas []iaas.NetworkArea
}
tests := []struct {
name string
args args
wantErr bool
}{
{
name: "empty",
args: args{},
wantErr: false,
},
{
name: "empty network areas slice",
args: args{
networkAreas: []iaas.NetworkArea{},
},
wantErr: false,
},
{
name: "empty network area in network areas slice",
args: args{
networkAreas: []iaas.NetworkArea{{}},
},
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.networkAreas); (err != nil) != tt.wantErr {
t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
return err
}

return outputResult(p, model, networkAreaLabel, networkRange)
return outputResult(p, model.OutputFormat, networkAreaLabel, networkRange)
},
}
configureFlags(cmd)
Expand Down Expand Up @@ -138,8 +138,8 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APICli
return req.CreateNetworkAreaRangePayload(payload)
}

func outputResult(p *print.Printer, model *inputModel, networkAreaLabel string, networkRange iaas.NetworkRange) error {
switch model.OutputFormat {
func outputResult(p *print.Printer, outputFormat, networkAreaLabel string, networkRange iaas.NetworkRange) error {
switch outputFormat {
case print.JSONOutputFormat:
details, err := json.MarshalIndent(networkRange, "", " ")
if err != nil {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,3 +215,38 @@ func TestBuildRequest(t *testing.T) {
})
}
}

func TestOutputResult(t *testing.T) {
type args struct {
outputFormat string
networkAreaLabel string
networkRange iaas.NetworkRange
}
tests := []struct {
name string
args args
wantErr bool
}{
{
name: "empty",
args: args{},
wantErr: false,
},
{
name: "empty network range",
args: args{
networkRange: iaas.NetworkRange{},
},
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.networkAreaLabel, tt.args.networkRange); (err != nil) != tt.wantErr {
t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,15 @@ func NewCmd(p *print.Printer) *cobra.Command {
if err != nil {
p.Debug(print.ErrorLevel, "get network area name: %v", err)
networkAreaLabel = *model.NetworkAreaId
} else if networkAreaLabel == "" {
networkAreaLabel = *model.NetworkAreaId
}
networkRangeLabel, err := iaasUtils.GetNetworkRangePrefix(ctx, apiClient, *model.OrganizationId, *model.NetworkAreaId, model.NetworkRangeId)
if err != nil {
p.Debug(print.ErrorLevel, "get network range prefix: %v", err)
networkRangeLabel = model.NetworkRangeId
} else if networkRangeLabel == "" {
networkRangeLabel = model.NetworkRangeId
}

if !model.AssumeYes {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APICli
}

func outputResult(p *print.Printer, outputFormat string, networkRange *iaas.NetworkRange) error {
if networkRange == nil {
return fmt.Errorf("network range is nil")
}
switch outputFormat {
case print.JSONOutputFormat:
details, err := json.MarshalIndent(networkRange, "", " ")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,3 +234,37 @@ func TestBuildRequest(t *testing.T) {
})
}
}

func TestOutputResult(t *testing.T) {
type args struct {
outputFormat string
networkRange *iaas.NetworkRange
}
tests := []struct {
name string
args args
wantErr bool
}{
{
name: "empty",
args: args{},
wantErr: true,
},
{
name: "set networkRange",
args: args{
networkRange: &iaas.NetworkRange{},
},
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.networkRange); (err != nil) != tt.wantErr {
t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
5 changes: 4 additions & 1 deletion internal/cmd/beta/network-area/network-range/list/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
"github.com/stackitcloud/stackit-cli/internal/pkg/services/iaas/client"
iaasUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/iaas/utils"
"github.com/stackitcloud/stackit-cli/internal/pkg/tables"
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"
"github.com/stackitcloud/stackit-sdk-go/services/iaas"

"github.com/spf13/cobra"
Expand Down Expand Up @@ -79,6 +80,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
if err != nil {
p.Debug(print.ErrorLevel, "get organization name: %v", err)
networkAreaLabel = *model.NetworkAreaId
} else if networkAreaLabel == "" {
networkAreaLabel = *model.NetworkAreaId
}
p.Info("No network ranges found for SNA %q\n", networkAreaLabel)
return nil
Expand Down Expand Up @@ -162,7 +165,7 @@ func outputResult(p *print.Printer, outputFormat string, networkRanges []iaas.Ne
table.SetHeader("ID", "Network Range")

for _, networkRange := range networkRanges {
table.AddRow(*networkRange.NetworkRangeId, *networkRange.Prefix)
table.AddRow(utils.PtrString(networkRange.NetworkRangeId), utils.PtrString(networkRange.Prefix))
}

p.Outputln(table.Render())
Expand Down
Loading