fix: implement review feedback

marceljk · marceljk · commit 7e58730a3d37 · 2025-02-05T17:19:31.000+01:00
diff --git a/internal/cmd/beta/key-pair/describe/describe.go b/internal/cmd/beta/key-pair/describe/describe.go
@@ -71,7 +71,11 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				return fmt.Errorf("read key pair: %w", err)
 			}
 
-			return outputResult(p, model.OutputFormat, model.PublicKey, resp)
+			if keypair := resp; keypair != nil {
+				return outputResult(p, model.OutputFormat, model.PublicKey, *keypair)
+			}
+			p.Outputln("No keypair found.")
+			return nil
 		},
 	}
 	configureFlags(cmd)
@@ -109,11 +113,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APICli
 	return apiClient.GetKeyPair(ctx, model.KeyPairName)
 }
 
-func outputResult(p *print.Printer, outputFormat string, showOnlyPublicKey bool, keyPair *iaas.Keypair) error {
-	if keyPair == nil {
-		p.Outputln("No keypair found.")
-		return nil
-	}
+func outputResult(p *print.Printer, outputFormat string, showOnlyPublicKey bool, keyPair iaas.Keypair) error {
 	switch outputFormat {
 	case print.JSONOutputFormat:
 		details, err := json.MarshalIndent(keyPair, "", "  ")
diff --git a/internal/cmd/beta/key-pair/describe/describe_test.go b/internal/cmd/beta/key-pair/describe/describe_test.go
@@ -191,28 +191,19 @@ func Test_outputResult(t *testing.T) {
 	type args struct {
 		outputFormat      string
 		showOnlyPublicKey bool
-		keyPair           *iaas.Keypair
+		keyPair           iaas.Keypair
 	}
 	tests := []struct {
 		name    string
 		args    args
 		wantErr bool
 	}{
-		{
-			name: "empty",
-			args: args{
-				outputFormat:      "",
-				showOnlyPublicKey: false,
-				keyPair:           nil,
-			},
-			wantErr: false,
-		},
 		{
 			name: "base",
 			args: args{
 				outputFormat:      "",
 				showOnlyPublicKey: false,
-				keyPair:           &iaas.Keypair{},
+				keyPair:           iaas.Keypair{},
 			},
 			wantErr: false,
 		},
diff --git a/internal/cmd/beta/network/list/list.go b/internal/cmd/beta/network/list/list.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"strings"
 
 	"github.com/goccy/go-yaml"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
@@ -165,10 +164,7 @@ func outputResult(p *print.Printer, outputFormat string, networks []iaas.Network
 			if network.Routed != nil {
 				routed = *network.Routed
 			}
-			prefixes := ""
-			if network.Prefixes != nil && len(*network.Prefixes) > 0 {
-				prefixes = strings.Join(*network.Prefixes, ", ")
-			}
+			prefixes := utils.JoinStringPtr(network.Prefixes, ", ")
 
 			table.AddRow(
 				utils.PtrString(network.NetworkId),
diff --git a/internal/cmd/beta/public-ip/list/list.go b/internal/cmd/beta/public-ip/list/list.go
@@ -168,10 +168,7 @@ func outputResult(p *print.Printer, outputFormat string, publicIps []iaas.Public
 		table.SetHeader("ID", "IP ADDRESS", "USED BY")
 
 		for _, publicIp := range publicIps {
-			networkInterfaceId := ""
-			if publicIp.NetworkInterface != nil {
-				networkInterfaceId = *publicIp.GetNetworkInterface()
-			}
+			networkInterfaceId := utils.PtrStringDefault(publicIp.GetNetworkInterface(), "")
 			table.AddRow(
 				utils.PtrString(publicIp.Id),
 				utils.PtrString(publicIp.Ip),
diff --git a/internal/cmd/beta/security-group/rule/list/list.go b/internal/cmd/beta/security-group/rule/list/list.go
@@ -170,10 +170,7 @@ func outputResult(p *print.Printer, outputFormat string, securityGroupRules []ia
 		table.SetHeader("ID", "ETHER TYPE", "DIRECTION", "PROTOCOL", "REMOTE SECURITY GROUP ID")
 
 		for _, securityGroupRule := range securityGroupRules {
-			etherType := ""
-			if securityGroupRule.Ethertype != nil {
-				etherType = *securityGroupRule.Ethertype
-			}
+			etherType := utils.PtrStringDefault(securityGroupRule.Ethertype, "")
 
 			protocolName := ""
 			if securityGroupRule.Protocol != nil {
diff --git a/internal/cmd/beta/server/backup/describe/describe.go b/internal/cmd/beta/server/backup/describe/describe.go
@@ -142,10 +142,7 @@ func outputResult(p *print.Printer, outputFormat string, backup *serverbackup.Ba
 		table.AddRow("EXPIRES AT", utils.PtrString(backup.ExpireAt))
 		table.AddSeparator()
 
-		lastRestored := ""
-		if backup.LastRestoredAt != nil {
-			lastRestored = *backup.LastRestoredAt
-		}
+		lastRestored := utils.PtrStringDefault(backup.LastRestoredAt, "")
 		table.AddRow("LAST RESTORED AT", lastRestored)
 		table.AddSeparator()
 		table.AddRow("VOLUME BACKUPS", len(*backup.VolumeBackups))
diff --git a/internal/cmd/beta/server/backup/list/list.go b/internal/cmd/beta/server/backup/list/list.go
@@ -149,10 +149,7 @@ func outputResult(p *print.Printer, outputFormat string, backups []serverbackup.
 		for i := range backups {
 			s := backups[i]
 
-			lastRestored := ""
-			if s.LastRestoredAt != nil {
-				lastRestored = *s.LastRestoredAt
-			}
+			lastRestored := utils.PtrStringDefault(s.LastRestoredAt, "")
 			table.AddRow(
 				utils.PtrString(s.Id),
 				utils.PtrString(s.Name),
diff --git a/internal/cmd/beta/server/backup/schedule/describe/describe.go b/internal/cmd/beta/server/backup/schedule/describe/describe.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"strings"
 
 	"github.com/goccy/go-yaml"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
@@ -144,11 +143,7 @@ func outputResult(p *print.Printer, outputFormat string, schedule *serverbackup.
 			table.AddRow("BACKUP RETENTION DAYS", *schedule.BackupProperties.RetentionPeriod)
 			table.AddSeparator()
 			ids := schedule.BackupProperties.VolumeIds
-			if ids == nil || len(*ids) == 0 {
-				table.AddRow("BACKUP VOLUME IDS", "")
-			} else {
-				table.AddRow("BACKUP VOLUME IDS", strings.Join(*ids, "\n"))
-			}
+			table.AddRow("BACKUP VOLUME IDS", utils.JoinStringPtr(ids, "\n"))
 		}
 		err := table.Display(p)
 		if err != nil {
diff --git a/internal/cmd/beta/server/backup/schedule/list/list.go b/internal/cmd/beta/server/backup/schedule/list/list.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"strings"
 
 	"github.com/goccy/go-yaml"
 	"github.com/spf13/cobra"
@@ -157,9 +156,7 @@ func outputResult(p *print.Printer, outputFormat string, schedules []serverbacku
 				backupName = utils.PtrString(s.BackupProperties.Name)
 				retentionPeriod = utils.PtrString(s.BackupProperties.RetentionPeriod)
 
-				if s.BackupProperties.VolumeIds != nil && len(*s.BackupProperties.VolumeIds) != 0 {
-					ids = strings.Join(*s.BackupProperties.VolumeIds, ",")
-				}
+				ids = utils.JoinStringPtr(s.BackupProperties.VolumeIds, ",")
 			}
 			table.AddRow(
 				utils.PtrString(s.Id),
diff --git a/internal/cmd/beta/server/command/template/list/list.go b/internal/cmd/beta/server/command/template/list/list.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"strings"
 
 	"github.com/goccy/go-yaml"
 	"github.com/spf13/cobra"
@@ -145,7 +144,7 @@ func outputResult(p *print.Printer, outputFormat string, templates []runcommand.
 
 			var osType string
 			if s.OsType != nil && len(*s.OsType) > 0 {
-				osType = strings.Join(*s.OsType, ",")
+				osType = utils.JoinStringPtr(s.OsType, ",")
 			}
 
 			table.AddRow(
diff --git a/internal/cmd/beta/server/os-update/describe/describe.go b/internal/cmd/beta/server/os-update/describe/describe.go
@@ -132,16 +132,10 @@ func outputResult(p *print.Printer, outputFormat string, update *serverupdate.Up
 		table.AddSeparator()
 		table.AddRow("STATUS", utils.PtrString(update.Status))
 		table.AddSeparator()
-		installedUpdates := "n/a"
-		if update.InstalledUpdates != nil {
-			installedUpdates = utils.PtrString(update.InstalledUpdates)
-		}
+		installedUpdates := utils.PtrStringDefault(update.InstalledUpdates, "n/a")
 		table.AddRow("INSTALLED UPDATES", installedUpdates)
 		table.AddSeparator()
-		failedUpdates := "n/a"
-		if update.FailedUpdates != nil {
-			failedUpdates = utils.PtrString(update.FailedUpdates)
-		}
+		failedUpdates := utils.PtrStringDefault(update.FailedUpdates, "n/a")
 		table.AddRow("FAILED UPDATES", failedUpdates)
 
 		table.AddRow("START DATE", utils.PtrString(update.StartDate))
diff --git a/internal/cmd/beta/server/os-update/list/list.go b/internal/cmd/beta/server/os-update/list/list.go
@@ -151,10 +151,7 @@ func outputResult(p *print.Printer, outputFormat string, updates []serverupdate.
 		for i := range updates {
 			s := updates[i]
 
-			endDate := "n/a"
-			if s.EndDate != nil {
-				endDate = *s.EndDate
-			}
+			endDate := utils.PtrStringDefault(s.EndDate, "n/a")
 
 			installed := "n/a"
 			if s.InstalledUpdates != nil {
diff --git a/internal/cmd/beta/sqlserverflex/user/list/list.go b/internal/cmd/beta/sqlserverflex/user/list/list.go
@@ -160,7 +160,10 @@ func outputResult(p *print.Printer, outputFormat string, users []sqlserverflex.I
 		table.SetHeader("ID", "USERNAME")
 		for i := range users {
 			user := users[i]
-			table.AddRow(utils.PtrString(user.Id), utils.PtrString(user.Username))
+			table.AddRow(
+				utils.PtrString(user.Id),
+				utils.PtrString(user.Username),
+			)
 		}
 		err := table.Display(p)
 		if err != nil {
diff --git a/internal/cmd/load-balancer/describe/describe.go b/internal/cmd/load-balancer/describe/describe.go
@@ -161,10 +161,7 @@ func buildLoadBalancerTable(loadBalancer *loadbalancer.LoadBalancer) tables.Tabl
 		networkId = *networks[0].NetworkId
 	}
 
-	externalAddress := "-"
-	if loadBalancer.ExternalAddress != nil {
-		externalAddress = *loadBalancer.ExternalAddress
-	}
+	externalAddress := utils.PtrStringDefault(loadBalancer.ExternalAddress, "-")
 
 	errorDescriptions := []string{}
 	if loadBalancer.Errors != nil && len((*loadBalancer.Errors)) > 0 {
diff --git a/internal/cmd/load-balancer/list/list.go b/internal/cmd/load-balancer/list/list.go
@@ -154,10 +154,7 @@ func outputResult(p *print.Printer, outputFormat string, loadBalancers []loadbal
 		table.SetHeader("NAME", "STATE", "IP ADDRESS", "LISTENERS", "TARGET POOLS")
 		for i := range loadBalancers {
 			l := loadBalancers[i]
-			externalAdress := "-"
-			if l.ExternalAddress != nil {
-				externalAdress = *l.ExternalAddress
-			}
+			externalAdress := utils.PtrStringDefault(l.ExternalAddress, "-")
 			table.AddRow(
 				utils.PtrString(l.Name),
 				utils.PtrString(l.Status),
diff --git a/internal/cmd/mongodbflex/backup/describe/describe.go b/internal/cmd/mongodbflex/backup/describe/describe.go
@@ -6,7 +6,6 @@ import (
 	"fmt"
 
 	"github.com/goccy/go-yaml"
-	"github.com/inhies/go-bytesize"
 	"github.com/spf13/cobra"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
@@ -152,10 +151,7 @@ func outputResult(p *print.Printer, cmd *cobra.Command, outputFormat, restoreSta
 		table.AddSeparator()
 		table.AddRow("EXPIRES AT", utils.PtrString(backup.EndTime))
 		table.AddSeparator()
-		backupSize := "n/a"
-		if backup.Size != nil {
-			backupSize = bytesize.New(float64(*backup.Size)).String()
-		}
+		backupSize := utils.PtrByteSizeDefault(backup.Size, "n/a")
 		table.AddRow("BACKUP SIZE", backupSize)
 		table.AddSeparator()
 		table.AddRow("RESTORE STATUS", restoreStatus)
diff --git a/internal/cmd/mongodbflex/backup/list/list.go b/internal/cmd/mongodbflex/backup/list/list.go
@@ -6,7 +6,6 @@ import (
 	"fmt"
 
 	"github.com/goccy/go-yaml"
-	"github.com/inhies/go-bytesize"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
@@ -169,10 +168,7 @@ func outputResult(p *print.Printer, outputFormat string, backups []mongodbflex.B
 		for i := range backups {
 			backup := backups[i]
 			restoreStatus := mongodbflexUtils.GetRestoreStatus(*backup.Id, restoreJobs)
-			backupSize := "n/a"
-			if backup.Size != nil {
-				backupSize = bytesize.New(float64(*backup.Size)).String()
-			}
+			backupSize := utils.PtrByteSizeDefault(backup.Size, "n/a")
 			table.AddRow(
 				utils.PtrString(backup.Id),
 				utils.PtrString(backup.StartTime),
diff --git a/internal/cmd/object-storage/credentials/list/list.go b/internal/cmd/object-storage/credentials/list/list.go
@@ -160,10 +160,7 @@ func outputResult(p *print.Printer, outputFormat string, credentials []objectsto
 		for i := range credentials {
 			c := credentials[i]
 
-			expiresAt := "Never"
-			if c.Expires != nil {
-				expiresAt = *c.Expires
-			}
+			expiresAt := utils.PtrStringDefault(c.Expires, "Never")
 			table.AddRow(utils.PtrString(c.KeyId), utils.PtrString(c.DisplayName), expiresAt)
 		}
 		err := table.Display(p)
diff --git a/internal/cmd/postgresflex/backup/describe/describe.go b/internal/cmd/postgresflex/backup/describe/describe.go
@@ -7,7 +7,6 @@ import (
 	"time"
 
 	"github.com/goccy/go-yaml"
-	"github.com/inhies/go-bytesize"
 	"github.com/spf13/cobra"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
@@ -139,10 +138,8 @@ func outputResult(p *print.Printer, cmd *cobra.Command, outputFormat string, bac
 		table.AddSeparator()
 		table.AddRow("EXPIRES AT", backupExpireDate)
 		table.AddSeparator()
-		backupSize := "n/a"
-		if backup.Size != nil {
-			backupSize = bytesize.New(float64(*backup.Size)).String()
-		}
+
+		backupSize := utils.PtrByteSizeDefault(backup.Size, "n/a")
 		table.AddRow("BACKUP SIZE", backupSize)
 
 		err := table.Display(p)
diff --git a/internal/cmd/postgresflex/backup/list/list.go b/internal/cmd/postgresflex/backup/list/list.go
@@ -6,7 +6,6 @@ import (
 	"fmt"
 
 	"github.com/goccy/go-yaml"
-	"github.com/inhies/go-bytesize"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
@@ -164,10 +163,7 @@ func outputResult(p *print.Printer, outputFormat string, backups []postgresflex.
 			}
 			backupExpireDate := backupStartTime.AddDate(backupExpireYearOffset, backupExpireMonthOffset, backupExpireDayOffset).Format(time.DateOnly)
 
-			backupSize := "n/a"
-			if backup.Size != nil {
-				backupSize = bytesize.New(float64(*backup.Size)).String()
-			}
+			backupSize := utils.PtrByteSizeDefault(backup.Size, "n/a")
 			table.AddRow(
 				utils.PtrString(backup.Id),
 				utils.PtrString(backup.StartTime),
diff --git a/internal/pkg/utils/strings.go b/internal/pkg/utils/strings.go
@@ -24,3 +24,12 @@ func JoinStringKeysPtr(m map[string]any, sep string) string {
 	}
 	return JoinStringKeys(m, sep)
 }
+
+// JoinStringPtr concatenates the strings of a string slice pointer, each separatore by the
+// [sep] string.
+func JoinStringPtr(vals *[]string, sep string) string {
+	if vals == nil || len(*vals) == 0 {
+		return ""
+	}
+	return strings.Join(*vals, sep)
+}
diff --git a/internal/pkg/utils/utils.go b/internal/pkg/utils/utils.go
@@ -7,6 +7,7 @@ import (
 	"time"
 
 	"github.com/google/uuid"
+	"github.com/inhies/go-bytesize"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/config"
@@ -89,3 +90,18 @@ func ConvertTimePToDateTimeString(t *time.Time) string {
 	}
 	return t.Format(time.DateTime)
 }
+
+// PtrStringDefault return the value of a pointer [v] as string. If the pointer is nil, it returns the [defaultValue].
+func PtrStringDefault[T any](v *T, defaultValue string) string {
+	if v == nil {
+		return defaultValue
+	}
+	return fmt.Sprintf("%v", *v)
+}
+
+func PtrByteSizeDefault(size *int64, defaultString string) string {
+	if size == nil {
+		return defaultString
+	}
+	return bytesize.New(float64(*size)).String()
+}
