feat: add command to list available zones

Author: kangasta

CHANGELOG.md

@@ -6,6 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Add `zone list` command that lists available zones.
+
 ### Fixed
 - Do not display usage if execution fails because of missing credentials
 

internal/commands/all/all.go

@@ -12,6 +12,7 @@ import (
 	"github.com/UpCloudLtd/upcloud-cli/internal/commands/serverfirewall"
 	"github.com/UpCloudLtd/upcloud-cli/internal/commands/serverstorage"
 	"github.com/UpCloudLtd/upcloud-cli/internal/commands/storage"
+	"github.com/UpCloudLtd/upcloud-cli/internal/commands/zone"
 	"github.com/UpCloudLtd/upcloud-cli/internal/config"
 
 	"github.com/spf13/cobra"
@@ -93,6 +94,10 @@ func BuildCommands(rootCmd *cobra.Command, conf *config.Config) {
 	accountCommand := commands.BuildCommand(account.BaseAccountCommand(), rootCmd, conf)
 	commands.BuildCommand(account.ShowCommand(), accountCommand.Cobra(), conf)
 
+	// Zone
+	zoneCommand := commands.BuildCommand(zone.BaseZoneCommand(), rootCmd, conf)
+	commands.BuildCommand(zone.ListCommand(), zoneCommand.Cobra(), conf)
+
 	// Misc
 	commands.BuildCommand(
 		&root.CompletionCommand{

internal/commands/zone/list.go

@@ -0,0 +1,44 @@
+package zone
+
+import (
+	"github.com/UpCloudLtd/upcloud-cli/internal/commands"
+	"github.com/UpCloudLtd/upcloud-cli/internal/output"
+)
+
+// ListCommand creates the "zone list" command
+func ListCommand() commands.Command {
+	return &listCommand{
+		BaseCommand: commands.New("list", "List available zones", "upctl zone list"),
+	}
+}
+
+type listCommand struct {
+	*commands.BaseCommand
+}
+
+// ExecuteWithoutArguments implements commands.NoArgumentCommand
+func (s *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Output, error) {
+	svc := exec.All()
+	zones, err := svc.GetZones()
+	if err != nil {
+		return nil, err
+	}
+
+	rows := []output.TableRow{}
+	for _, z := range zones.Zones {
+		rows = append(rows, output.TableRow{
+			z.ID,
+			z.Description,
+			z.Public,
+		})
+	}
+
+	return output.Table{
+		Columns: []output.TableColumn{
+			{Key: "id", Header: "ID"},
+			{Key: "description", Header: "Description"},
+			{Key: "public", Header: "Public", Format: output.BoolFormat},
+		},
+		Rows: rows,
+	}, nil
+}

internal/commands/zone/list_test.go

@@ -0,0 +1,45 @@
+package zone
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/UpCloudLtd/upcloud-cli/internal/commands"
+	"github.com/UpCloudLtd/upcloud-cli/internal/config"
+	smock "github.com/UpCloudLtd/upcloud-cli/internal/mock"
+	"github.com/UpCloudLtd/upcloud-cli/internal/output"
+
+	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud"
+	"github.com/gemalto/flume"
+	"github.com/jedib0t/go-pretty/v6/text"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestZoneListHumanOutput(t *testing.T) {
+	text.DisableColors()
+	zones := upcloud.Zones{
+		Zones: []upcloud.Zone{
+			{ID: "fi-hel1", Description: "Helsinki #1", Public: 1},
+			{ID: "de-fra1", Description: "Frankfurt #1", Public: 1},
+		},
+	}
+
+	mService := smock.Service{}
+	mService.On("GetZones").Return(&zones, nil)
+
+	conf := config.New()
+	// force human output
+	conf.Viper().Set(config.KeyOutput, config.ValueOutputHuman)
+
+	command := commands.BuildCommand(ListCommand(), nil, conf)
+
+	res, err := command.(commands.NoArgumentCommand).ExecuteWithoutArguments(commands.NewExecutor(conf, &mService, flume.New("test")))
+
+	assert.Nil(t, err)
+
+	buf := bytes.NewBuffer(nil)
+	err = output.Render(buf, conf, res)
+	assert.NoError(t, err)
+	assert.Regexp(t, "ID\\s+Description\\s+Public", buf.String())
+	assert.Regexp(t, "fi-hel1\\s+Helsinki #1\\s+yes", buf.String())
+}

internal/commands/zone/zone.go

@@ -0,0 +1,16 @@
+package zone
+
+import (
+	"github.com/UpCloudLtd/upcloud-cli/internal/commands"
+)
+
+// BaseZoneCommand creates the base "zone" command
+func BaseZoneCommand() commands.Command {
+	return &zoneCommand{
+		commands.New("zone", "Display zone information"),
+	}
+}
+
+type zoneCommand struct {
+	*commands.BaseCommand
+}

internal/mock/mock.go

@@ -21,6 +21,15 @@ func (m *Service) GetAccount() (*upcloud.Account, error) {
 	return args[0].(*upcloud.Account), args.Error(1)
 }
 
+// GetZones implements service.Zones.GetZones
+func (m *Service) GetZones() (*upcloud.Zones, error) {
+	args := m.Called()
+	if args[0] == nil {
+		return nil, args.Error(1)
+	}
+	return args[0].(*upcloud.Zones), args.Error(1)
+}
+
 // GetPlans implements service.Plan.GetPlans
 func (m *Service) GetPlans() (*upcloud.Plans, error) {
 	args := m.Called()

internal/service/service.go

@@ -13,6 +13,7 @@ type AllServices interface {
 	service.IpAddress
 	service.Plans
 	service.Account
+	service.Zones
 }
 
 // Wrapper is a temporary reimplementation fo upcloud-go-api which prevents