fix(server): re-add --show-ip-addresses support for machine output (#288)

Implements #283

Author: kangasta

CHANGELOG.md

@@ -8,7 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+
 - Add `gateway` commands (`delete`, `list`) for Network gateway management.
+- In machine readable outputs of server list, add support for `--show-ip-addresses` parameter.
 
 ## [3.3.0] - 2024-01-23
 

internal/commands/server/list.go

@@ -29,18 +29,22 @@ func ListCommand() commands.Command {
 	}
 }
 
-type listIPAddress struct {
-	Access   string `json:"access"`
-	Address  string `json:"address"`
-	Floating bool   `json:"floating"`
-}
-
 type listServerIpaddresses struct {
 	ServerUUID  string
-	IPAddresses []listIPAddress
+	IPAddresses upcloud.IPAddressSlice
 	Error       error
 }
 
+type serverWithIPAddress struct {
+	upcloud.Server
+
+	IPAddresses upcloud.IPAddressSlice `json:"ip_addresses"`
+}
+
+type serversWithIPAddresses struct {
+	Servers []serverWithIPAddress `json:"servers"`
+}
+
 type listCommand struct {
 	*commands.BaseCommand
 	showIPAddresses string
@@ -88,6 +92,7 @@ func (ls *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.O
 	}
 
 	if ls.showIPAddresses != "none" {
+		serversWithIPs := serversWithIPAddresses{}
 		ipaddressMap, err := getIPAddressesByServerUUID(servers, ls.showIPAddresses, exec)
 		if err != nil {
 			return nil, err
@@ -96,20 +101,35 @@ func (ls *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.O
 		for i, row := range rows {
 			uuid := row[0].(string)
 
-			var listIpaddresses []listIPAddress
+			// Add IPs to the table in human output
+			var listIpaddresses upcloud.IPAddressSlice
 			if serverIpaddresses, ok := ipaddressMap[uuid]; ok {
 				listIpaddresses = append(listIpaddresses, serverIpaddresses.IPAddresses...)
 			}
 			row = append(row[:3], row[2:]...)
 			row[2] = listIpaddresses
 			rows[i] = row
+
+			// Add IPs to machine output
+			serversWithIPs.Servers = append(serversWithIPs.Servers, serverWithIPAddress{
+				Server:      servers.Servers[i],
+				IPAddresses: listIpaddresses,
+			})
 		}
 		columns = append(columns[:3], columns[2:]...)
 		columns[2] = output.TableColumn{
 			Key:    "ip_addresses",
 			Header: "IP addresses",
 			Format: formatListIPAddresses,
 		}
+
+		return output.MarshaledWithHumanOutput{
+			Value: serversWithIPs,
+			Output: output.Table{
+				Columns: columns,
+				Rows:    rows,
+			},
+		}, nil
 	}
 
 	return output.MarshaledWithHumanOutput{
@@ -152,21 +172,18 @@ func getIPAddressesByServerUUID(servers *upcloud.Servers, accessType string, exe
 	return ipaddressMap, nil
 }
 
-func getServerIPAddresses(uuid, accessType string, exec commands.Executor) ([]listIPAddress, error) {
+func getServerIPAddresses(uuid, accessType string, exec commands.Executor) (upcloud.IPAddressSlice, error) {
 	server, err := exec.All().GetServerNetworks(exec.Context(), &request.GetServerNetworksRequest{ServerUUID: uuid})
 	if err != nil {
 		return nil, err
 	}
 
-	var ipaddresses []listIPAddress
+	var ipaddresses upcloud.IPAddressSlice
 	for _, iface := range server.Interfaces {
 		for _, ipa := range iface.IPAddresses {
 			if accessType == "all" || iface.Type == accessType {
-				ipaddresses = append(ipaddresses, listIPAddress{
-					Access:   iface.Type,
-					Address:  ipa.Address,
-					Floating: ipa.Floating.Bool(),
-				})
+				ipa.Access = iface.Type
+				ipaddresses = append(ipaddresses, ipa)
 			}
 		}
 	}
@@ -186,22 +203,22 @@ func getServerIPAddresses(uuid, accessType string, exec commands.Executor) ([]li
 			return accessMap[ipaddresses[i].Access] > accessMap[ipaddresses[j].Access]
 		}
 
-		return floatingMap[ipaddresses[i].Floating] > floatingMap[ipaddresses[j].Floating]
+		return floatingMap[ipaddresses[i].Floating.Bool()] > floatingMap[ipaddresses[j].Floating.Bool()]
 	})
 
 	return ipaddresses, nil
 }
 
 func formatListIPAddresses(val interface{}) (text.Colors, string, error) {
-	ipaddresses, ok := val.([]listIPAddress)
+	ipaddresses, ok := val.(upcloud.IPAddressSlice)
 	if !ok {
-		return nil, "", fmt.Errorf("cannot parse IP addresses from %T, expected []listIPAddress", val)
+		return nil, "", fmt.Errorf("cannot parse IP addresses from %T, expected upcloud.IPAddressSlice", val)
 	}
 
 	var rows []string
 	for _, ipa := range ipaddresses {
 		var floating string
-		if ipa.Floating {
+		if ipa.Floating.Bool() {
 			floating = " (f)"
 		}
 

internal/commands/server/list_test.go

@@ -14,6 +14,72 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+const expectedJSONOutput = `
+{
+  "servers": [
+    {
+      "core_number": "0",
+      "hostname": "server-list-test-server",
+      "license": 0,
+      "memory_amount": "0",
+      "plan": "1xCPU-1GB",
+      "progress": "0",
+      "state": "started",
+      "tags": null,
+      "title": "",
+      "uuid": "server-list-test-server-uuid",
+      "zone": "pl-waw1",
+      "ip_addresses": [
+        {
+          "access": "public",
+          "address": "10.0.97.4",
+          "family": "",
+          "part_of_plan": "no",
+          "ptr_record": "",
+          "server": "",
+          "mac": "",
+          "floating": "yes",
+          "zone": ""
+        },
+        {
+          "access": "public",
+          "address": "10.0.98.3",
+          "family": "",
+          "part_of_plan": "no",
+          "ptr_record": "",
+          "server": "",
+          "mac": "",
+          "floating": "no",
+          "zone": ""
+        },
+        {
+          "access": "private",
+          "address": "10.0.99.2",
+          "family": "",
+          "part_of_plan": "no",
+          "ptr_record": "",
+          "server": "",
+          "mac": "",
+          "floating": "no",
+          "zone": ""
+        },
+        {
+          "access": "utility",
+          "address": "10.0.100.1",
+          "family": "",
+          "part_of_plan": "no",
+          "ptr_record": "",
+          "server": "",
+          "mac": "",
+          "floating": "no",
+          "zone": ""
+        }
+      ]
+    }
+  ]
+}
+`
+
 func TestListServers(t *testing.T) {
 	text.DisableColors()
 
@@ -74,8 +140,10 @@ func TestListServers(t *testing.T) {
 	for _, test := range []struct {
 		name              string
 		args              []string
+		json              bool
 		outputContains    []string
 		outputNotContains []string
+		outputJSONEquals  string
 	}{
 		{
 			name: "No args",
@@ -122,9 +190,18 @@ func TestListServers(t *testing.T) {
 				"utility: 10.0.100.1",
 			},
 		},
+		{
+			name:             "JSON output",
+			args:             []string{"--show-ip-addresses"},
+			json:             true,
+			outputJSONEquals: expectedJSONOutput,
+		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
 			conf := config.New()
+			if test.json {
+				conf.Viper().Set(config.KeyOutput, config.ValueOutputJSON)
+			}
 
 			testCmd := ListCommand()
 			mService := new(smock.Service)
@@ -145,6 +222,10 @@ func TestListServers(t *testing.T) {
 			for _, notContains := range test.outputNotContains {
 				assert.NotContains(t, output, notContains)
 			}
+
+			if len(test.outputJSONEquals) > 0 {
+				assert.JSONEq(t, test.outputJSONEquals, output)
+			}
 		})
 	}
 }