fix(instance): ssh-config-install invalid zone or all (#3272)

Author: Codelax

cmd/scw/testdata/test-all-usage-instance-ssh-install-config-usage.golden

@@ -7,7 +7,7 @@ USAGE:
 
 ARGS:
   [project-id]      Project ID to use. If none is passed the default project ID will be used
-  [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2)
+  [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | all)
 
 FLAGS:
   -h, --help   help for install-config

docs/commands/instance.md

@@ -2655,7 +2655,7 @@ scw instance ssh install-config [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
-| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |
+| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config |
 
 
 

internal/namespaces/instance/v1/custom_ssh_config.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"reflect"
+	"strings"
 
 	"github.com/scaleway/scaleway-cli/v2/internal/core"
 	"github.com/scaleway/scaleway-cli/v2/internal/interactive"
@@ -33,45 +34,48 @@ func (s sshConfigServer) InPrivateNetwork(id string) bool {
 	return false
 }
 
-type sshConfigRequest struct {
+type sshConfigInstallRequest struct {
 	Zone      scw.Zone
 	ProjectID *string
 }
 
 func sshConfigInstallCommand() *core.Command {
+	availableZones := ((*instance.API)(nil)).Zones()
+	availableZones = append(availableZones, scw.Zone(core.AllLocalities))
+
 	return &core.Command{
 		Namespace: "instance",
 		Resource:  "ssh",
 		Verb:      "install-config",
 		Short: `Install a ssh config with all your servers as host
 It generate hosts for instance servers, baremetal, apple-silicon and bastions`,
 		Long:     "Path of the config will be $HOME/.ssh/scaleway.config",
-		ArgsType: reflect.TypeOf(sshConfigRequest{}),
+		ArgsType: reflect.TypeOf(sshConfigInstallRequest{}),
 		ArgSpecs: core.ArgSpecs{
 			core.ProjectIDArgSpec(),
-			core.ZoneArgSpec(((*instance.API)(nil)).Zones()...),
+			core.ZoneArgSpec(availableZones...),
 		},
 		Run: func(ctx context.Context, argsI interface{}) (interface{}, error) {
-			args := argsI.(*sshConfigRequest)
+			args := argsI.(*sshConfigInstallRequest)
 			homeDir := core.ExtractUserHomeDir(ctx)
 
 			// Start server list with instances
 			servers, err := sshConfigListServers(ctx, args)
 			if err != nil {
-				return nil, err
+				return nil, fmt.Errorf("failed to list instance servers: %w", err)
 			}
 
 			// Add baremetal servers
 			baremetalServers, err := sshConfigListBaremetalServers(ctx, args)
 			if err != nil {
-				return nil, err
+				return nil, fmt.Errorf("failed to list baremetal servers: %w", err)
 			}
 			servers = append(servers, baremetalServers...)
 
 			// Add Apple-Silicon servers
 			siliconServers, err := sshConfigListAppleSiliconServers(ctx, args)
 			if err != nil {
-				return nil, err
+				return nil, fmt.Errorf("failed to list apple-silicon servers: %w", err)
 			}
 			servers = append(servers, siliconServers...)
 
@@ -150,12 +154,13 @@ Do you want the include statement to be added at the beginning of your file ?`,
 	}
 }
 
-func sshConfigListServers(ctx context.Context, args *sshConfigRequest) ([]sshConfigServer, error) {
+func sshConfigListServers(ctx context.Context, args *sshConfigInstallRequest) ([]sshConfigServer, error) {
 	instanceAPI := instance.NewAPI(core.ExtractClient(ctx))
 
 	reqOpts := []scw.RequestOption{scw.WithAllPages()}
 	if args.Zone == scw.Zone(core.AllLocalities) {
 		reqOpts = append(reqOpts, scw.WithZones(instanceAPI.Zones()...))
+		args.Zone = ""
 	}
 
 	listServers, err := instanceAPI.ListServers(&instance.ListServersRequest{
@@ -189,20 +194,24 @@ func sshConfigListServers(ctx context.Context, args *sshConfigRequest) ([]sshCon
 	return servers, nil
 }
 
-func sshConfigListBaremetalServers(ctx context.Context, args *sshConfigRequest) ([]sshConfigServer, error) {
+func sshConfigListBaremetalServers(ctx context.Context, args *sshConfigInstallRequest) ([]sshConfigServer, error) {
 	baremetalAPI := baremetal.NewAPI(core.ExtractClient(ctx))
 	baremetalPNAPI := baremetal.NewPrivateNetworkAPI(core.ExtractClient(ctx))
 
 	reqOpts := []scw.RequestOption{scw.WithAllPages()}
 	if args.Zone == scw.Zone(core.AllLocalities) {
 		reqOpts = append(reqOpts, scw.WithZones(baremetalAPI.Zones()...))
+		args.Zone = ""
 	}
 
 	listServers, err := baremetalAPI.ListServers(&baremetal.ListServersRequest{
 		Zone:      args.Zone,
 		ProjectID: args.ProjectID,
 	}, reqOpts...)
 	if err != nil {
+		if strings.Contains(err.Error(), "unknown service") {
+			return nil, nil
+		}
 		// TODO: check permissions and print warning
 		return nil, err
 	}
@@ -239,19 +248,23 @@ func sshConfigListBaremetalServers(ctx context.Context, args *sshConfigRequest)
 	return servers, nil
 }
 
-func sshConfigListAppleSiliconServers(ctx context.Context, args *sshConfigRequest) ([]sshConfigServer, error) {
+func sshConfigListAppleSiliconServers(ctx context.Context, args *sshConfigInstallRequest) ([]sshConfigServer, error) {
 	siliconAPI := applesilicon.NewAPI(core.ExtractClient(ctx))
 
 	reqOpts := []scw.RequestOption{scw.WithAllPages()}
 	if args.Zone == scw.Zone(core.AllLocalities) {
 		reqOpts = append(reqOpts, scw.WithZones(siliconAPI.Zones()...))
+		args.Zone = ""
 	}
 
 	listServers, err := siliconAPI.ListServers(&applesilicon.ListServersRequest{
 		Zone:      args.Zone,
 		ProjectID: args.ProjectID,
 	}, reqOpts...)
 	if err != nil {
+		if strings.Contains(err.Error(), "unknown service") {
+			return nil, nil
+		}
 		return nil, err
 	}
 
@@ -267,7 +280,7 @@ func sshConfigListAppleSiliconServers(ctx context.Context, args *sshConfigReques
 	return servers, nil
 }
 
-func sshConfigBastionHosts(ctx context.Context, args *sshConfigRequest, servers []sshConfigServer) ([]sshconfig.Host, error) {
+func sshConfigBastionHosts(ctx context.Context, args *sshConfigInstallRequest, servers []sshConfigServer) ([]sshconfig.Host, error) {
 	gwAPI := vpcgw.NewAPI(core.ExtractClient(ctx))
 
 	reqOpts := []scw.RequestOption{scw.WithAllPages()}