feat(zone): add command for listing available devices (#469)

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 `zone devices` and `zone devices show` commands for listing available devices.
+
 ## [3.20.2] - 2025-07-09
 
 ### Changed

go.mod

@@ -6,7 +6,7 @@ toolchain go1.24.2
 
 require (
 	github.com/UpCloudLtd/progress v1.0.3
-	github.com/UpCloudLtd/upcloud-go-api/v8 v8.19.0
+	github.com/UpCloudLtd/upcloud-go-api/v8 v8.21.0
 	github.com/adrg/xdg v0.3.2
 	github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d
 	github.com/gemalto/flume v0.12.0

go.sum

@@ -19,8 +19,8 @@ github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym
 github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU=
 github.com/UpCloudLtd/progress v1.0.3 h1:8SfntHkBPyQc5BL3946Bgi9KYnQOxa5RR2EKdadujdg=
 github.com/UpCloudLtd/progress v1.0.3/go.mod h1:iGxOnb9HvHW0yrLGUjHr0lxHhn7TehgWwh7a8NqK6iQ=
-github.com/UpCloudLtd/upcloud-go-api/v8 v8.19.0 h1:jw1PuZhalunYXiIWM4B+p3JNO6PAxZ4QYdJNHmq2CMs=
-github.com/UpCloudLtd/upcloud-go-api/v8 v8.19.0/go.mod h1:zA0iX1Kjf88t+q3AvOM5UD90iwIZabRH0qjQJ9b9GTc=
+github.com/UpCloudLtd/upcloud-go-api/v8 v8.21.0 h1:gPi3bLwNixV2xo3IFMhP65uOdJcE2KCooXQ5bzPJqEk=
+github.com/UpCloudLtd/upcloud-go-api/v8 v8.21.0/go.mod h1:ImDdnWfVVM6WCRTrskGhAw2W1cRwu5IEkBw+9UCzAv8=
 github.com/adrg/xdg v0.3.2 h1:GUSGQ5pHdev83AYhDSS1A/CX+0JIsxbiWtow2DSA+RU=
 github.com/adrg/xdg v0.3.2/go.mod h1:7I2hH/IT30IsupOpKZ5ue7/qNi3CoKzD6tL3HwpaRMQ=
 github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=

internal/commands/base/base.go

@@ -31,6 +31,7 @@ import (
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands/storage"
 	storagebackup "github.com/UpCloudLtd/upcloud-cli/v3/internal/commands/storage/backup"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands/zone"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands/zone/devices"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/config"
 
 	"github.com/spf13/cobra"
@@ -136,6 +137,8 @@ func BuildCommands(rootCmd *cobra.Command, conf *config.Config) {
 	// Zone
 	zoneCommand := commands.BuildCommand(zone.BaseZoneCommand(), rootCmd, conf)
 	commands.BuildCommand(zone.ListCommand(), zoneCommand.Cobra(), conf)
+	devicesCommand := commands.BuildCommand(devices.DevicesCommand(), zoneCommand.Cobra(), conf)
+	commands.BuildCommand(devices.ShowCommand(), devicesCommand.Cobra(), conf)
 
 	// Databases
 	databaseCommand := commands.BuildCommand(database.BaseDatabaseCommand(), rootCmd, conf)

internal/commands/zone/devices/devices.go

@@ -0,0 +1,53 @@
+package devices
+
+import (
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/format"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/output"
+)
+
+// DevicesCommand creates the "zone devices" command
+func DevicesCommand() commands.Command { //nolint:revive // Does not make sense to add Base prefix here to avoid stuttering warning
+	return &devicesCommand{
+		BaseCommand: commands.New("devices", "List available devices for each zone", "upctl zone devices"),
+	}
+}
+
+type devicesCommand struct {
+	*commands.BaseCommand
+}
+
+// ExecuteWithoutArguments implements commands.NoArgumentCommand
+func (s *devicesCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Output, error) {
+	svc := exec.All()
+	d, err := svc.GetDevicesAvailability(exec.Context())
+	if err != nil {
+		return nil, err
+	}
+
+	rows := []output.TableRow{}
+	for zone, devices := range *d {
+		features := []string{}
+		if len(devices.GPUPlans) > 0 {
+			features = append(features, "GPU")
+		}
+
+		rows = append(rows, output.TableRow{
+			zone,
+			features,
+		})
+	}
+
+	columns := []output.TableColumn{
+		{Key: "zone", Header: "Zone"},
+		{Key: "devices", Header: "Devices", Format: format.StringSliceSingleLineAnd},
+	}
+
+	return output.MarshaledWithHumanOutput{
+		Value: d,
+		Output: output.Table{
+			Columns: columns,
+			Rows:    rows,
+		},
+	}, nil
+}

internal/commands/zone/devices/show.go

@@ -0,0 +1,63 @@
+package devices
+
+import (
+	"sort"
+
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/completion"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/output"
+)
+
+// ShowCommand creates the "zone devices show" command
+func ShowCommand() commands.Command {
+	return &showCommand{
+		BaseCommand: commands.New("show", "Show detailed device availability for the given zone", "upctl zone devices show fi-hel2"),
+	}
+}
+
+type showCommand struct {
+	*commands.BaseCommand
+	completion.Zone
+}
+
+// Execute implements commands.MultipleArgumentCommand
+func (s *showCommand) Execute(exec commands.Executor, zone string) (output.Output, error) {
+	svc := exec.All()
+	d, err := svc.GetDevicesAvailability(exec.Context())
+	if err != nil {
+		return nil, err
+	}
+
+	sections := output.Combined{}
+
+	if len((*d)[zone].GPUPlans) > 0 {
+		rows := []output.TableRow{}
+		for name, data := range (*d)[zone].GPUPlans {
+			rows = append(rows, output.TableRow{
+				name,
+				data.Amount,
+			})
+		}
+
+		sections = append(sections, output.CombinedSection{
+			Key:   "gpu_plans",
+			Title: "GPU plans",
+			Contents: output.Table{
+				Columns: []output.TableColumn{
+					{Key: "name", Header: "Name"},
+					{Key: "amount", Header: "Amount"},
+				},
+				Rows: rows,
+			},
+		})
+
+		sort.Slice(rows, func(i, j int) bool {
+			return rows[i][0].(string) < rows[j][0].(string)
+		})
+	}
+
+	return output.MarshaledWithHumanOutput{
+		Value:  (*d)[zone],
+		Output: sections,
+	}, nil
+}

internal/mock/mock.go

@@ -1504,3 +1504,27 @@ func (m *Service) TagServer(ctx context.Context, r *request.TagServerRequest) (*
 func (m *Service) UntagServer(ctx context.Context, r *request.UntagServerRequest) (*upcloud.ServerDetails, error) {
 	return nil, nil
 }
+
+func (m *Service) WaitForLoadBalancerOperationalState(_ context.Context, r *request.WaitForLoadBalancerOperationalStateRequest) (*upcloud.LoadBalancer, error) {
+	args := m.Called(r)
+	if args[0] == nil {
+		return nil, args.Error(1)
+	}
+	return args[0].(*upcloud.LoadBalancer), args.Error(1)
+}
+
+func (m *Service) WaitForLoadBalancerDeletion(_ context.Context, r *request.WaitForLoadBalancerDeletionRequest) error {
+	args := m.Called(r)
+	if args[0] == nil {
+		return args.Error(0)
+	}
+	return nil
+}
+
+func (m *Service) GetDevicesAvailability(ctx context.Context) (*upcloud.DevicesAvailability, error) {
+	args := m.Called()
+	if args[0] == nil {
+		return nil, args.Error(1)
+	}
+	return args[0].(*upcloud.DevicesAvailability), args.Error(1)
+}