feat(zone): display parent zone if user has access to private zones (#309)

Author: kangasta

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add `host list` command for listing private cloud hosts.
 - Add `--host` argument to `server restart` command.
 - Add `--avoid-host` and `--host` arguments to `server start` command.
+- Add `Parent zone` column to `zone list` output for users that have access to private zones.
 
 ### Changed
 

go.mod

@@ -4,7 +4,7 @@ go 1.21
 
 require (
 	github.com/UpCloudLtd/progress v1.0.2
-	github.com/UpCloudLtd/upcloud-go-api/v8 v8.2.0
+	github.com/UpCloudLtd/upcloud-go-api/v8 v8.4.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

@@ -17,8 +17,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.2 h1:CTr1bBuFuXop9TEhR1PakbUMPTlUVL7Bgae9JgqXwPg=
 github.com/UpCloudLtd/progress v1.0.2/go.mod h1:iGxOnb9HvHW0yrLGUjHr0lxHhn7TehgWwh7a8NqK6iQ=
-github.com/UpCloudLtd/upcloud-go-api/v8 v8.2.0 h1:+/vej9U9eSOUFt1MRRtB+GXEXWtLacyfWn9KmHCnLkw=
-github.com/UpCloudLtd/upcloud-go-api/v8 v8.2.0/go.mod h1:pMuPcIQ5VUC65UETsaEPgHiDymxwX/3xYm4vlC4E9VI=
+github.com/UpCloudLtd/upcloud-go-api/v8 v8.4.0 h1:xtc+lscOHhrA4d2N8ifjAOu0zL/d8OXhnFI1w9BIbPg=
+github.com/UpCloudLtd/upcloud-go-api/v8 v8.4.0/go.mod h1:/BL9bYxio0GCdotzBvZjkpm1fSDtD0+0z6PtNMew9HU=
 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/zone/list.go

@@ -25,24 +25,36 @@ func (s *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Ou
 		return nil, err
 	}
 
+	hasParentZones := false
 	rows := []output.TableRow{}
 	for _, z := range zones.Zones {
+		if len(z.ParentZone) > 0 {
+			hasParentZones = true
+		}
+
 		rows = append(rows, output.TableRow{
 			z.ID,
 			z.Description,
 			z.Public,
+			z.ParentZone,
 		})
 	}
 
+	columns := []output.TableColumn{
+		{Key: "id", Header: "ID"},
+		{Key: "description", Header: "Description"},
+		{Key: "public", Header: "Public", Format: format.Boolean},
+	}
+
+	if hasParentZones {
+		columns = append(columns, output.TableColumn{Key: "parent_zone", Header: "Parent zone"})
+	}
+
 	return output.MarshaledWithHumanOutput{
 		Value: zones,
 		Output: output.Table{
-			Columns: []output.TableColumn{
-				{Key: "id", Header: "ID"},
-				{Key: "description", Header: "Description"},
-				{Key: "public", Header: "Public", Format: format.Boolean},
-			},
-			Rows: rows,
+			Columns: columns,
+			Rows:    rows,
 		},
 	}, nil
 }

internal/commands/zone/list_test.go

@@ -15,22 +15,56 @@ import (
 
 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)
+	for _, test := range []struct {
+		name     string
+		zones    upcloud.Zones
+		expected string
+	}{
+		{
+			name: "no private zones",
+			zones: upcloud.Zones{
+				Zones: []upcloud.Zone{
+					{ID: "fi-hel1", Description: "Helsinki #1", Public: 1},
+					{ID: "de-fra1", Description: "Frankfurt #1", Public: 1},
+				},
+			},
+			expected: `
+ ID        Description    Public 
+───────── ────────────── ────────
+ fi-hel1   Helsinki #1    yes    
+ de-fra1   Frankfurt #1   yes    
+
+`,
+		}, {
+			name: "with private zones",
+			zones: upcloud.Zones{
+				Zones: []upcloud.Zone{
+					{ID: "de-fra1", Description: "Frankfurt #1", Public: 1},
+					{ID: "de-tst1", Description: "Test #1", Public: 0, ParentZone: "de-fra1"},
+				},
+			},
+			expected: `
+ ID        Description    Public   Parent zone 
+───────── ────────────── ──────── ─────────────
+ de-fra1   Frankfurt #1   yes                  
+ de-tst1   Test #1        no       de-fra1     
 
-	conf := config.New()
-	command := commands.BuildCommand(ListCommand(), nil, conf)
+`,
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			zones := test.zones
+			mService := smock.Service{}
+			mService.On("GetZones").Return(&zones, nil)
+
+			conf := config.New()
+			command := commands.BuildCommand(ListCommand(), nil, conf)
 
-	output, err := mockexecute.MockExecute(command, &mService, conf)
+			output, err := mockexecute.MockExecute(command, &mService, conf)
 
-	assert.NoError(t, err)
-	assert.Regexp(t, "ID\\s+Description\\s+Public", output)
-	assert.Regexp(t, "fi-hel1\\s+Helsinki #1\\s+yes", output)
+			assert.NoError(t, err)
+			assert.Equal(t, output, test.expected)
+		})
+	}
 }

internal/mock/mock.go

@@ -1265,6 +1265,46 @@ func (m *Service) ModifyGateway(_ context.Context, r *request.ModifyGatewayReque
 	return args[0].(*upcloud.Gateway), args.Error(1)
 }
 
+func (m *Service) GetGatewayPlans(ctx context.Context) ([]upcloud.GatewayPlan, error) {
+	return nil, nil
+}
+
+func (m *Service) GetGatewayConnections(ctx context.Context, r *request.GetGatewayConnectionsRequest) ([]upcloud.GatewayConnection, error) {
+	return nil, nil
+}
+
+func (m *Service) GetGatewayConnection(ctx context.Context, r *request.GetGatewayConnectionRequest) (*upcloud.GatewayConnection, error) {
+	return nil, nil
+}
+
+func (m *Service) CreateGatewayConnection(ctx context.Context, r *request.CreateGatewayConnectionRequest) (*upcloud.GatewayConnection, error) {
+	return nil, nil
+}
+
+func (m *Service) ModifyGatewayConnection(ctx context.Context, r *request.ModifyGatewayConnectionRequest) (*upcloud.GatewayConnection, error) {
+	return nil, nil
+}
+
+func (m *Service) DeleteGatewayConnection(ctx context.Context, r *request.DeleteGatewayConnectionRequest) error {
+	return nil
+}
+
+func (m *Service) GetGatewayConnectionTunnels(ctx context.Context, r *request.GetGatewayConnectionTunnelsRequest) ([]upcloud.GatewayTunnel, error) {
+	return nil, nil
+}
+
+func (m *Service) GetGatewayConnectionTunnel(ctx context.Context, r *request.GetGatewayConnectionTunnelRequest) (*upcloud.GatewayTunnel, error) {
+	return nil, nil
+}
+
+func (m *Service) CreateGatewayConnectionTunnel(ctx context.Context, r *request.CreateGatewayConnectionTunnelRequest) (*upcloud.GatewayTunnel, error) {
+	return nil, nil
+}
+
+func (m *Service) DeleteGatewayConnectionTunnel(ctx context.Context, r *request.DeleteGatewayConnectionTunnelRequest) error {
+	return nil
+}
+
 func (m *Service) GetNetworkPeerings(ctx context.Context, f ...request.QueryFilter) (upcloud.NetworkPeerings, error) {
 	return nil, nil
 }