Merge pull request #68 from scaleway/feature-cache-resolver-results

Feature cache resolver results

Author: moul

README.md

@@ -1020,6 +1020,7 @@ $ scw inspect myserver | jq '.[0].public_ip.address'
 
 #### Features
 
+* Improved resolver behavior when matching multiple results, now displaying more info too help choosing candidates ([#47](https://github.com/scaleway/scaleway-cli/issues/47))
 * `scw exec SERVER [COMMAND] [ARGS...]`, *COMMAND* is now optional
 * Showing the server MOTD when calling `scw run <image> [COMMAND]` without *COMMAND*
 * Support of `scw attach --no-stdin` option

api/api.go

@@ -13,6 +13,7 @@ import (
 	"net/url"
 	"os"
 	"strings"
+	"text/tabwriter"
 	"text/template"
 
 	log "github.com/Sirupsen/logrus"
@@ -913,7 +914,7 @@ func (s *ScalewayAPI) PutVolume(volumeID string, definition ScalewayVolumePutDef
 }
 
 // ResolveServer attempts the find a matching Identifier for the input string
-func (s *ScalewayAPI) ResolveServer(needle string) ([]string, error) {
+func (s *ScalewayAPI) ResolveServer(needle string) ([]ScalewayResolverResult, error) {
 	servers := s.Cache.LookUpServers(needle, true)
 	if len(servers) == 0 {
 		_, err := s.GetServers(true, 0)
@@ -926,7 +927,7 @@ func (s *ScalewayAPI) ResolveServer(needle string) ([]string, error) {
 }
 
 // ResolveSnapshot attempts the find a matching Identifier for the input string
-func (s *ScalewayAPI) ResolveSnapshot(needle string) ([]string, error) {
+func (s *ScalewayAPI) ResolveSnapshot(needle string) ([]ScalewayResolverResult, error) {
 	snapshots := s.Cache.LookUpSnapshots(needle, true)
 	if len(snapshots) == 0 {
 		_, err := s.GetSnapshots()
@@ -939,7 +940,7 @@ func (s *ScalewayAPI) ResolveSnapshot(needle string) ([]string, error) {
 }
 
 // ResolveImage attempts the find a matching Identifier for the input string
-func (s *ScalewayAPI) ResolveImage(needle string) ([]string, error) {
+func (s *ScalewayAPI) ResolveImage(needle string) ([]ScalewayResolverResult, error) {
 	images := s.Cache.LookUpImages(needle, true)
 	if len(images) == 0 {
 		_, err := s.GetImages()
@@ -952,7 +953,7 @@ func (s *ScalewayAPI) ResolveImage(needle string) ([]string, error) {
 }
 
 // ResolveBootscript attempts the find a matching Identifier for the input string
-func (s *ScalewayAPI) ResolveBootscript(needle string) ([]string, error) {
+func (s *ScalewayAPI) ResolveBootscript(needle string) ([]ScalewayResolverResult, error) {
 	bootscripts := s.Cache.LookUpBootscripts(needle, true)
 	if len(bootscripts) == 0 {
 		_, err := s.GetBootscripts()
@@ -1184,20 +1185,28 @@ func (s *ScalewayAPI) GetServerID(needle string) string {
 		log.Fatalf("Unable to resolve server %s: %s", needle, err)
 	}
 	if len(servers) == 1 {
-		return servers[0]
+		return servers[0].Identifier
 	}
 	if len(servers) == 0 {
 		log.Fatalf("No such server: %s", needle)
 	}
-	log.Errorf("Too many candidates for %s (%d)", needle, len(servers))
-	for _, identifier := range servers {
-		// FIXME: also print the name
-		log.Infof("- %s", identifier)
-	}
+
+	showResolverResults(needle, servers)
 	os.Exit(1)
 	return ""
 }
 
+func showResolverResults(needle string, results []ScalewayResolverResult) error {
+	log.Errorf("Too many candidates for %s (%d)", needle, len(results))
+
+	w := tabwriter.NewWriter(os.Stderr, 20, 1, 3, ' ', 0)
+	defer w.Flush()
+	for _, result := range results {
+		fmt.Fprintf(w, "- %s\t%s\t%s\n", result.TruncIdentifier(), result.CodeName(), result.Name)
+	}
+	return nil
+}
+
 // GetSnapshotID returns exactly one snapshot matching or dies
 func (s *ScalewayAPI) GetSnapshotID(needle string) string {
 	// Parses optional type prefix, i.e: "snapshot:name" -> "name"
@@ -1208,16 +1217,13 @@ func (s *ScalewayAPI) GetSnapshotID(needle string) string {
 		log.Fatalf("Unable to resolve snapshot %s: %s", needle, err)
 	}
 	if len(snapshots) == 1 {
-		return snapshots[0]
+		return snapshots[0].Identifier
 	}
 	if len(snapshots) == 0 {
 		log.Fatalf("No such snapshot: %s", needle)
 	}
-	log.Errorf("Too many candidates for %s (%d)", needle, len(snapshots))
-	for _, identifier := range snapshots {
-		// FIXME: also print the name
-		log.Infof("- %s", identifier)
-	}
+
+	showResolverResults(needle, snapshots)
 	os.Exit(1)
 	return ""
 }
@@ -1232,7 +1238,7 @@ func (s *ScalewayAPI) GetImageID(needle string, exitIfMissing bool) string {
 		log.Fatalf("Unable to resolve image %s: %s", needle, err)
 	}
 	if len(images) == 1 {
-		return images[0]
+		return images[0].Identifier
 	}
 	if len(images) == 0 {
 		if exitIfMissing {
@@ -1241,11 +1247,8 @@ func (s *ScalewayAPI) GetImageID(needle string, exitIfMissing bool) string {
 			return ""
 		}
 	}
-	log.Errorf("Too many candidates for %s (%d)", needle, len(images))
-	for _, identifier := range images {
-		// FIXME: also print the name
-		log.Infof("- %s", identifier)
-	}
+
+	showResolverResults(needle, images)
 	os.Exit(1)
 	return ""
 }
@@ -1260,16 +1263,13 @@ func (s *ScalewayAPI) GetBootscriptID(needle string) string {
 		log.Fatalf("Unable to resolve bootscript %s: %s", needle, err)
 	}
 	if len(bootscripts) == 1 {
-		return bootscripts[0]
+		return bootscripts[0].Identifier
 	}
 	if len(bootscripts) == 0 {
 		log.Fatalf("No such bootscript: %s", needle)
 	}
-	log.Errorf("Too many candidates for %s (%d)", needle, len(bootscripts))
-	for _, identifier := range bootscripts {
-		// FIXME: also print the name
-		log.Infof("- %s", identifier)
-	}
+
+	showResolverResults(needle, bootscripts)
 	os.Exit(1)
 	return ""
 }