feat(compute): improve error message when instance not found in zone [sc-167368]

Add findInstance helper in cmd/compute/instance/instance_find.go wrapping
FindListInstancesResponseInstances. On a not-found error it returns a
zone-aware message with a hint to use -z or list all instances:

  instance "foo" not found in zone ch-gva-2
  Hint: use -z <zone> to specify a different zone, or run 'exo compute instance list' to see instances across all zones

All 24 call sites across the instance subcommands are migrated.
Adds e2e scenario tests/e2e/scenarios/with-api/compute/instance_not_found_error.txtar.

Author: natalie-o-perret

CHANGELOG.md

@@ -5,6 +5,10 @@
 ### Features
 
 - sks: add `rotate-karpenter-credentials` command #797
+
+### Improvements
+
+- compute instance: enrich "not found" error with the zone searched and a hint to use -z #805
 - sks: add `active-nodepool-templates` command #797
 
 ### Bug fixes

cmd/compute/instance/instance_console_url.go

@@ -60,7 +60,7 @@ func (c *instanceConsoleURLCmd) CmdRun(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	foundInstance, err := resp.FindListInstancesResponseInstances(c.Instance)
+	foundInstance, err := findInstance(resp, c.Instance, string(c.Zone))
 	if err != nil {
 		return err
 	}

cmd/compute/instance/instance_delete.go

@@ -54,7 +54,7 @@ func (c *instanceDeleteCmd) CmdRun(_ *cobra.Command, _ []string) error {
 
 	instanceToDelete := []v3.UUID{}
 	for _, i := range c.Instances {
-		instance, err := instances.FindListInstancesResponseInstances(i)
+		instance, err := findInstance(instances, i, c.Zone)
 		if err != nil {
 			if !c.Force {
 				return err

cmd/compute/instance/instance_elastic_ip_attach.go

@@ -54,9 +54,9 @@ func (c *instanceEIPAttachCmd) CmdRun(_ *cobra.Command, _ []string) error {
 	if err != nil {
 		return err
 	}
-	instance, err := instancesList.FindListInstancesResponseInstances(c.Instance)
+	instance, err := findInstance(instancesList, c.Instance, c.Zone)
 	if err != nil {
-		return fmt.Errorf("error retrieving Instance: %w", err)
+		return err
 	}
 
 	elasticIPs, err := client.ListElasticIPS(ctx)

cmd/compute/instance/instance_elastic_ip_detach.go

@@ -54,7 +54,7 @@ func (c *instanceEIPDetachCmd) CmdRun(_ *cobra.Command, _ []string) error {
 	if err != nil {
 		return err
 	}
-	instance, err := instancesList.FindListInstancesResponseInstances(c.Instance)
+	instance, err := findInstance(instancesList, c.Instance, c.Zone)
 	if err != nil {
 		return fmt.Errorf("error retrieving Instance: %w", err)
 	}

cmd/compute/instance/instance_enable_tpm.go

@@ -45,7 +45,7 @@ func (c *instanceEnableTPMCmd) CmdRun(_ *cobra.Command, _ []string) error {
 		return err
 	}
 
-	instance, err := resp.FindListInstancesResponseInstances(c.Instance)
+	instance, err := findInstance(resp, c.Instance, string(c.Zone))
 	if err != nil {
 		return err
 	}

cmd/compute/instance/instance_find.go

@@ -0,0 +1,26 @@
+package instance
+
+import (
+	"errors"
+	"fmt"
+
+	v3 "github.com/exoscale/egoscale/v3"
+)
+
+// findInstance looks up an instance by name or ID from a ListInstancesResponse
+// and enriches the "not found" error with the zone that was searched,
+// reminding the user to use -z to target a different zone.
+func findInstance(resp *v3.ListInstancesResponse, nameOrID, zone string) (v3.ListInstancesResponseInstances, error) {
+	instance, err := resp.FindListInstancesResponseInstances(nameOrID)
+	if err != nil {
+		if errors.Is(err, v3.ErrNotFound) {
+			return v3.ListInstancesResponseInstances{}, fmt.Errorf(
+				"instance %q not found in zone %s\nHint: use -z <zone> to specify a different zone, or run 'exo compute instance list' to see instances across all zones",
+				nameOrID,
+				zone,
+			)
+		}
+		return v3.ListInstancesResponseInstances{}, err
+	}
+	return instance, nil
+}

cmd/compute/instance/instance_private_network_attach.go

@@ -56,7 +56,7 @@ func (c *instancePrivnetAttachCmd) CmdRun(_ *cobra.Command, _ []string) error {
 	if err != nil {
 		return err
 	}
-	instance, err := instances.FindListInstancesResponseInstances(c.Instance)
+	instance, err := findInstance(instances, c.Instance, c.Zone)
 	if err != nil {
 		return err
 	}

cmd/compute/instance/instance_private_network_detach.go

@@ -54,7 +54,7 @@ func (c *instancePrivnetDetachCmd) CmdRun(_ *cobra.Command, _ []string) error {
 	if err != nil {
 		return err
 	}
-	instance, err := instances.FindListInstancesResponseInstances(c.Instance)
+	instance, err := findInstance(instances, c.Instance, c.Zone)
 	if err != nil {
 		return err
 	}

cmd/compute/instance/instance_private_network_updateip.go

@@ -57,7 +57,7 @@ func (c *instancePrivnetUpdateIPCmd) CmdRun(_ *cobra.Command, _ []string) error
 	if err != nil {
 		return err
 	}
-	instance, err := instances.FindListInstancesResponseInstances(c.Instance)
+	instance, err := findInstance(instances, c.Instance, c.Zone)
 	if err != nil {
 		return err
 	}