feat(server): add --show-ip-addresses flag to server list command

Author: kangasta

CHANGELOG.md

@@ -6,6 +6,8 @@ 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 `--show-ip-addresses` flag to `server list` command to optionally include IP addresses in command output. 
 
 ## [1.4.0] - 2022-06-15
 ### Added

internal/commands/server/list.go

@@ -2,10 +2,16 @@ package server
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/UpCloudLtd/upcloud-cli/internal/commands"
+	"github.com/UpCloudLtd/upcloud-cli/internal/config"
 	"github.com/UpCloudLtd/upcloud-cli/internal/output"
+	"github.com/UpCloudLtd/upcloud-cli/internal/service"
 	"github.com/UpCloudLtd/upcloud-cli/internal/ui"
+	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud"
+	"github.com/jedib0t/go-pretty/v6/text"
+	"github.com/spf13/pflag"
 )
 
 // ListCommand creates the "server list" command
@@ -15,13 +21,27 @@ func ListCommand() commands.Command {
 	}
 }
 
+type listIPAddress struct {
+	Access   string `json:"access"`
+	Address  string `json:"address"`
+	Floating bool   `json:"floating"`
+}
+
 type listCommand struct {
 	*commands.BaseCommand
+	showIPAddresses config.OptionalBoolean
+}
+
+// InitCommand implements Command.InitCommand
+func (ls *listCommand) InitCommand() {
+	flags := &pflag.FlagSet{}
+	config.AddToggleFlag(flags, &ls.showIPAddresses, "show-ip-addresses", false, "Show IP addresses of the servers in the output.")
+	ls.AddFlags(flags)
 }
 
 // ExecuteWithoutArguments implements commands.NoArgumentCommand
-func (s *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Output, error) {
-	svc := exec.Server()
+func (ls *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Output, error) {
+	svc := exec.All()
 	servers, err := svc.GetServers()
 	if err != nil {
 		return nil, err
@@ -46,14 +66,91 @@ func (s *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Ou
 		})
 	}
 
+	columns := []output.TableColumn{
+		{Key: "uuid", Header: "UUID", Colour: ui.DefaultUUUIDColours},
+		{Key: "hostname", Header: "Hostname"},
+		{Key: "plan", Header: "Plan"},
+		{Key: "zone", Header: "Zone"},
+		{Key: "state", Header: "State"},
+	}
+
+	if ls.showIPAddresses.Value() {
+		ipaddressMap, err := getIPAddressesByServerUUID(svc)
+		if err != nil {
+			return nil, err
+		}
+
+		for i, row := range rows {
+			uuid := row[0].(string)
+
+			var listIpaddresses []listIPAddress
+			if apiIpaddresses, ok := ipaddressMap[uuid]; ok {
+				for _, ipa := range apiIpaddresses {
+					listIpaddresses = append(listIpaddresses, listIPAddress{
+						Access:   ipa.Access,
+						Address:  ipa.Address,
+						Floating: ipa.Floating.Bool(),
+					})
+				}
+			}
+			row = append(row[:3], row[2:]...)
+			row[2] = listIpaddresses
+			rows[i] = row
+		}
+		columns = append(columns[:3], columns[2:]...)
+		columns[2] = output.TableColumn{
+			Key:    "ip_addresses",
+			Header: "IP addresses",
+			Format: formatListIPAddresses,
+		}
+	}
+
 	return output.Table{
-		Columns: []output.TableColumn{
-			{Key: "uuid", Header: "UUID", Colour: ui.DefaultUUUIDColours},
-			{Key: "hostname", Header: "Hostname"},
-			{Key: "plan", Header: "Plan"},
-			{Key: "zone", Header: "Zone"},
-			{Key: "state", Header: "State"},
-		},
-		Rows: rows,
+		Columns: columns,
+		Rows:    rows,
 	}, nil
 }
+
+// getIPAddressesByServerUUID returns IP addresses grouped by server UUID. This function will be removed when server end-point response includes IP addresses.
+func getIPAddressesByServerUUID(svc service.AllServices) (map[string][]upcloud.IPAddress, error) {
+	ipaddresses, err := svc.GetIPAddresses()
+	if err != nil {
+		return nil, err
+	}
+
+	ipaddressMap := make(map[string][]upcloud.IPAddress)
+	for _, ipaddress := range ipaddresses.IPAddresses {
+		current, ok := ipaddressMap[ipaddress.ServerUUID]
+		if ok {
+			ipaddressMap[ipaddress.ServerUUID] = append(current, ipaddress)
+		} else {
+			ipaddressMap[ipaddress.ServerUUID] = []upcloud.IPAddress{ipaddress}
+		}
+	}
+
+	return ipaddressMap, nil
+}
+
+func formatListIPAddresses(val interface{}) (text.Colors, string, error) {
+	ipaddresses, ok := val.([]listIPAddress)
+	if !ok {
+		return nil, "", fmt.Errorf("cannot parse IP addresses from %T, expected []listIPAddress", val)
+	}
+
+	var rows []string
+	for _, ipa := range ipaddresses {
+		var floating string
+		if ipa.Floating {
+			floating = " (f)"
+		}
+
+		rows = append(rows, fmt.Sprintf(
+			"%s: %s%s",
+			ipa.Access,
+			ui.DefaultAddressColours.Sprint(ipa.Address),
+			floating,
+		))
+	}
+
+	return nil, strings.Join(rows, ",\n"), nil
+}