feat(gateway): add command to list plans (#314)

Author: kangasta

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## Added
+
+- Add `gateway plans` command for listing gateway plans.
+
 ## [3.8.1] - 2024-05-24
 
 ### Changed

internal/commands/all/all.go

@@ -202,6 +202,7 @@ func BuildCommands(rootCmd *cobra.Command, conf *config.Config) {
 	gatewayCommand := commands.BuildCommand(gateway.BaseGatewayCommand(), rootCmd, conf)
 	commands.BuildCommand(gateway.DeleteCommand(), gatewayCommand.Cobra(), conf)
 	commands.BuildCommand(gateway.ListCommand(), gatewayCommand.Cobra(), conf)
+	commands.BuildCommand(gateway.PlansCommand(), gatewayCommand.Cobra(), conf)
 
 	// Host operations
 	hostCommand := commands.BuildCommand(host.BaseHostCommand(), rootCmd, conf)

internal/commands/database/properties/show.go

@@ -53,15 +53,15 @@ func (s *showCommand) Execute(exec commands.Executor, key string) (output.Output
 		{Title: "Description:", Key: "description", Value: details.Description},
 		{Title: "Help message:", Key: "user_error", Value: details.UserError},
 		{Title: "Create only:", Key: "createOnly", Value: details.CreateOnly, Format: format.Boolean},
-		{Title: "Type:", Key: "type", Value: details.Type, Format: formatAlternatives},
+		{Title: "Type:", Key: "type", Value: details.Type, Format: format.StringSliceOr},
 		{Title: "Default:", Key: "default", Value: details.Default},
-		{Title: "Possible values:", Key: "enum", Value: details.Enum, Format: formatAlternatives},
+		{Title: "Possible values:", Key: "enum", Value: details.Enum, Format: format.StringSliceOr},
 		{Title: "Pattern:", Key: "pattern", Value: details.Pattern},
 		{Title: "Min length:", Key: "minLength", Value: details.MinLength},
 		{Title: "Minimum:", Key: "minimum", Value: details.Minimum, Format: format.Dereference[float64]},
 		{Title: "Max length:", Key: "maxLength", Value: details.MaxLength},
 		{Title: "Maximum:", Key: "maximum", Value: details.Maximum, Format: format.Dereference[float64]},
-		{Title: "Properties:", Key: "properties", Value: childProperties, Format: formatProperties},
+		{Title: "Properties:", Key: "properties", Value: childProperties, Format: format.StringSliceAnd},
 	}
 
 	return output.MarshaledWithHumanOutput{

internal/commands/database/properties/type.go

@@ -60,8 +60,8 @@ func (s *dbTypeCommand) ExecuteWithoutArguments(exec commands.Executor) (output.
 			Columns: []output.TableColumn{
 				{Key: "property", Header: "Property"},
 				{Key: "createOnly", Header: "Create only", Format: format.Boolean},
-				{Key: "type", Header: "Type", Format: formatAlternatives},
-				{Key: "example", Header: "Example", Format: formatAlternatives},
+				{Key: "type", Header: "Type", Format: format.StringSliceOr},
+				{Key: "example", Header: "Example", Format: format.StringSliceOr},
 			},
 			Rows: rows,
 		},

internal/commands/gateway/plans.go

@@ -0,0 +1,71 @@
+package gateway
+
+import (
+	"sort"
+
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/format"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/output"
+)
+
+// PlansCommand creates the "server plans" command
+func PlansCommand() commands.Command {
+	return &plansCommand{
+		BaseCommand: commands.New("plans", "List gateway plans", "upctl gateway plans"),
+	}
+}
+
+type plansCommand struct {
+	*commands.BaseCommand
+}
+
+// ExecuteWithoutArguments implements commands.NoArgumentCommand
+func (s *plansCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Output, error) {
+	plans, err := exec.All().GetGatewayPlans(exec.Context())
+	if err != nil {
+		return nil, err
+	}
+
+	sort.Slice(plans, func(i, j int) bool {
+		if plans[i].ServerNumber != plans[j].ServerNumber {
+			return plans[i].ServerNumber < plans[j].ServerNumber
+		}
+
+		if plans[i].PerGatewayBandwidthMbps != plans[j].PerGatewayBandwidthMbps {
+			return plans[i].PerGatewayBandwidthMbps < plans[j].PerGatewayBandwidthMbps
+		}
+
+		if plans[i].PerGatewayMaxConnections != plans[j].PerGatewayMaxConnections {
+			return plans[i].PerGatewayMaxConnections < plans[j].PerGatewayMaxConnections
+		}
+
+		return plans[i].VPNTunnelAmount < plans[j].VPNTunnelAmount
+	})
+
+	rows := []output.TableRow{}
+	for _, p := range plans {
+		rows = append(rows, output.TableRow{
+			p.Name,
+			p.ServerNumber,
+			p.SupportedFeatures,
+			p.PerGatewayBandwidthMbps,
+			p.PerGatewayMaxConnections,
+			p.VPNTunnelAmount,
+		})
+	}
+
+	return output.MarshaledWithHumanOutput{
+		Value: plans,
+		Output: output.Table{
+			Columns: []output.TableColumn{
+				{Key: "name", Header: "Name"},
+				{Key: "server_number", Header: "Server count"},
+				{Key: "supported_features", Header: "Features", Format: format.StringSliceAnd},
+				{Key: "per_gateway_bandwidth_mbps", Header: "Max bandwidth (Mbps)"},
+				{Key: "per_gateway_max_connections", Header: "Max connections"},
+				{Key: "vpn_tunnel_amount", Header: "VPN tunnel amount"},
+			},
+			Rows: rows,
+		},
+	}, nil
+}

…l/commands/database/properties/format.go internal/format/stringslice.gointernal/commands/database/properties/format.go renamed to internal/format/stringslice.go internal/commands/database/properties/format.go renamed to internal/format/stringslice.go

@@ -1,17 +1,18 @@
-package databaseproperties
+package format
 
 import (
 	"fmt"
+	"reflect"
 	"strings"
 
 	"github.com/jedib0t/go-pretty/v6/text"
 )
 
-func formatAlternatives(val interface{}) (text.Colors, string, error) {
+func StringSliceOr(val interface{}) (text.Colors, string, error) {
 	return formatStringSlice(val, "or")
 }
 
-func formatProperties(val interface{}) (text.Colors, string, error) {
+func StringSliceAnd(val interface{}) (text.Colors, string, error) {
 	return formatStringSlice(val, "and")
 }
 
@@ -24,19 +25,23 @@ func formatStringSlice(val interface{}, andOrOr string) (text.Colors, string, er
 		return nil, stringVal, nil
 	}
 
-	if ifaceSliceVal, ok := val.([]interface{}); ok {
-		return nil, alternativesString(ifaceSliceVal, andOrOr), nil
+	if ifaceSliceVal, ok := toIfaceSlice(val); ok {
+		return nil, stringSliceString(ifaceSliceVal, andOrOr), nil
 	}
 
-	if stringSliceVal, ok := val.([]string); ok {
+	return nil, fmt.Sprintf("%+v", val), nil
+}
+
+func toIfaceSlice(val interface{}) ([]interface{}, bool) {
+	if reflect.TypeOf(val).Kind() == reflect.Slice {
 		ifaceSliceVal := []interface{}{}
-		for _, i := range stringSliceVal {
-			ifaceSliceVal = append(ifaceSliceVal, i)
+		reflectedVal := reflect.ValueOf(val)
+		for i := 0; i < reflectedVal.Len(); i++ {
+			ifaceSliceVal = append(ifaceSliceVal, reflectedVal.Index(i).Interface())
 		}
-		return nil, alternativesString(ifaceSliceVal, andOrOr), nil
+		return ifaceSliceVal, true
 	}
-
-	return nil, fmt.Sprintf("%+v", val), nil
+	return nil, false
 }
 
 func maxStringLen(strings []string) int {
@@ -49,7 +54,7 @@ func maxStringLen(strings []string) int {
 	return max
 }
 
-func alternativesString(values []interface{}, andOrOr string) string {
+func stringSliceString(values []interface{}, andOrOr string) string {
 	if len(values) == 0 {
 		return ""
 	}
@@ -68,6 +73,6 @@ func alternativesString(values []interface{}, andOrOr string) string {
 		whitespace = "\n"
 	}
 
-	str := strings.Join(strs[:len(strs)-1], ","+whitespace)
-	return str + fmt.Sprintf(" %s%s%s", andOrOr, whitespace, strs[len(values)-1])
+	str := strings.Join(strs[:len(strs)-1], text.FgHiBlack.Sprint(",")+whitespace)
+	return str + fmt.Sprintf(" %s%s%s", text.FgHiBlack.Sprint(andOrOr), whitespace, strs[len(values)-1])
 }