Add the products command

This command allow user to list products features. At the moment only the
`servers` product is supported.

Author: tbillon

README.md

@@ -45,6 +45,7 @@ Read the [blog post](https://blog.scaleway.com/2015/05/20/manage-baremetal-serve
     * [`logout [OPTIONS]`](#scw-logout)
     * [`logs [OPTIONS] SERVER`](#scw-logs)
     * [`port [OPTIONS] SERVER [PRIVATE_PORT[/PROTO]]`](#scw-port)
+    * [`products [OPTIONS]`] PRODUCT(#scw-products)
     * [`ps [OPTIONS]`](#scw-ps)
     * [`rename [OPTIONS] SERVER NEW_NAME`](#scw-rename)
     * [`restart [OPTIONS] SERVER [SERVER...]`](#scw-restart)
@@ -201,6 +202,7 @@ Commands:
     logout    Log out from the Scaleway API
     logs      Fetch the logs of a server
     port      Lookup the public-facing port that is NAT-ed to PRIVATE_PORT
+    products  Display products information
     ps        List servers
     rename    Rename a server
     restart   Restart a running server
@@ -588,6 +590,19 @@ Options:
 ```
 
 
+#### `scw products`
+
+```console
+Usage: scw products [OPTIONS] PRODUCT
+
+Display products PRODUCT information.
+
+Options:
+
+  -s, --short           Print only commercial names
+```
+
+
 #### `scw ps`
 
 ```console

contrib/completion/bash/scw

@@ -628,6 +628,17 @@ _scw_port() {
 	esac
 }
 
+_scw_products() {
+	case "$cur" in
+		-*)
+			COMPREPLY=( $( compgen -W "--help -s --short" -- "$cur" ) )
+			;;
+		*)
+			COMPREPLY=( $( compgen -W "servers" -- "$cur" ) )
+			;;
+	esac
+}
+
 _scw_ps() {
 	case "$prev" in
 		--before|--since)
@@ -1130,6 +1141,7 @@ _scw() {
 		logs
 #		pause
 		port
+		products
 		ps
 #		pull
 #		push

contrib/completion/zsh/_scw

@@ -201,6 +201,11 @@ __scw_subcommand () {
                 '1:servers:__scw_runningservers' \
                 '2:port:_ports'
             ;;
+        (products)
+            _arguments \
+                {-s,--short}'[Display only commercial types]' \
+                '*:products:(servers)'
+            ;;
         (start)
             _arguments \
                 {-T,--timeout=0}'[Set timeout values to seconds]' \

pkg/api/api.go

@@ -273,6 +273,41 @@ type ScalewayImages struct {
 	Images []ScalewayImage `json:"images,omitempty"`
 }
 
+// ProductNetworkInterface gives interval and external allowed bandwidth
+type ProductNetworkInterface struct {
+	InternalBandwidth uint64 `json:"internal_bandwidth,omitempty"`
+	InternetBandwidth uint64 `json:"internet_bandwidth,omitempty"`
+}
+
+// ProductNetwork lists all the network interfaces
+type ProductNetwork struct {
+	Interfaces             []ProductNetworkInterface `json:"interfaces,omitempty"`
+	TotalInternalBandwidth uint64                    `json:"sum_internal_bandwidth,omitempty"`
+	TotalInternetBandwidth uint64                    `json:"sum_internet_bandwidth,omitempty"`
+	IPv6_Support           bool                      `json:"ipv6_support,omitempty"`
+}
+
+// ProductVolumeConstraint contains any volume constraint that the offer has
+type ProductVolumeConstraint struct {
+	MinSize uint64 `json:"min_size,omitempty"`
+	MaxSize uint64 `json:"max_size,omitempty"`
+}
+
+// ProductServerOffer represents a specific offer
+type ProductServer struct {
+	Arch              string                  `json:"arch,omitempty"`
+	Ncpus             uint64                  `json:"ncpus,omitempty"`
+	Ram               uint64                  `json:"ram,omitempty"`
+	Baremetal         bool                    `json:"baremetal,omitempty"`
+	VolumesConstraint ProductVolumeConstraint `json:"volumes_constraint,omitempty"`
+	Network           ProductNetwork          `json:"network,omitempty"`
+}
+
+// Products holds a map of all Scaleway servers
+type ScalewayProductsServers struct {
+	Servers map[string]ProductServer `json:"servers"`
+}
+
 // ScalewaySnapshot represents a Scaleway Snapshot
 type ScalewaySnapshot struct {
 	// Identifier is a unique identifier for the snapshot
@@ -2781,3 +2816,24 @@ func (s *ScalewayAPI) ResolveTTYUrl() string {
 	}
 	return ""
 }
+
+// GetProductServers Fetches all the server type and their constraints from the Products API
+func (s *ScalewayAPI) GetProductsServers() (*ScalewayProductsServers, error) {
+	resp, err := s.GetResponsePaginate(s.computeAPI, "products/servers", url.Values{})
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	body, err := s.handleHTTPError([]int{http.StatusOK}, resp)
+	if err != nil {
+		return nil, err
+	}
+
+	var productServers ScalewayProductsServers
+	if err = json.Unmarshal(body, &productServers); err != nil {
+		return nil, err
+	}
+
+	return &productServers, nil
+}

pkg/cli/cmd_products.go

@@ -0,0 +1,44 @@
+// Copyright (C) 2015 Scaleway. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE.md file.
+
+package cli
+
+import "github.com/scaleway/scaleway-cli/pkg/commands"
+
+var cmdProducts = &Command{
+	Exec:        runProducts,
+	UsageLine:   "products [OPTIONS] PRODUCT",
+	Description: "Display product PRODUCT information",
+	Help:        "Display products PRODUCT information. At the moment only `servers` is supported.",
+	Examples: `
+    $ scw products servers
+    $ scw products --short servers
+`,
+}
+
+func init() {
+	cmdProducts.Flag.BoolVar(&productsHelp, []string{"h", "-help"}, false, "Print usage")
+	cmdProducts.Flag.BoolVar(&productsShort, []string{"s", "-short"}, false, "Print only commercial names")
+}
+
+// Flags
+var productsHelp bool  // -h, --help flag
+var productsShort bool // -s, --short flag
+
+func runProducts(cmd *Command, rawArgs []string) error {
+	if productsHelp {
+		return cmd.PrintUsage()
+	}
+	if len(rawArgs) != 1 {
+		return cmd.PrintShortUsage()
+	}
+
+	args := commands.ProductsArgs{
+		Short:    productsShort,
+		Products: rawArgs,
+	}
+
+	ctx := cmd.GetContext(rawArgs)
+	return commands.RunProducts(ctx, args)
+}

pkg/cli/commands.go

@@ -26,6 +26,7 @@ var Commands = []*Command{
 	cmdLogout,
 	cmdLogs,
 	cmdPort,
+	cmdProducts,
 	cmdPs,
 	cmdRename,
 	cmdRestart,

pkg/cli/test.go

@@ -12,9 +12,9 @@ var (
 		"help", "attach", "commit", "cp", "create",
 		"events", "exec", "history", "images", "info",
 		"inspect", "kill", "login", "logout", "logs",
-		"port", "ps", "rename", "restart", "rm", "rmi",
-		"run", "search", "start", "stop", "tag", "top",
-		"version", "wait",
+		"port", "products", "ps", "rename", "restart",
+		"rm", "rmi", "run", "search", "start", "stop",
+		"tag", "top", "version", "wait",
 	}
 	secretCommands = []string{
 		"_patch", "_completion", "_flush-cache", "_userdata", "_billing",

pkg/commands/products.go

@@ -0,0 +1,73 @@
+// Copyright (C) 2015 Scaleway. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE.md file.
+
+package commands
+
+import (
+	"fmt"
+	"sort"
+
+	"github.com/dustin/go-humanize"
+	"github.com/scaleway/scaleway-cli/pkg/api"
+)
+
+// ProductsArgs are flags for the `RunProducts` function
+type ProductsArgs struct {
+	Short    bool
+	Products []string
+}
+
+// DisplayServerFunc
+type displayServerFunc func(CommandContext, *api.ScalewayProductsServers)
+
+// RunProducts is the handler for 'scw products'
+func RunProducts(ctx CommandContext, args ProductsArgs) error {
+	for _, product := range args.Products {
+		switch product {
+		case "servers":
+			products, err := ctx.API.GetProductsServers()
+			if err != nil {
+				return fmt.Errorf("Unable to fetch products from the Scaleway API: %v", err)
+			}
+
+			var displayFunc displayServerFunc = DisplayServerFull
+			if args.Short {
+				displayFunc = DisplayServerShort
+			}
+			displayFunc(ctx, products)
+		default:
+			return fmt.Errorf("Unknow product '%v'", product)
+		}
+	}
+
+	return nil
+}
+
+// DisplayServerShort only display the product name
+func DisplayServerShort(ctx CommandContext, products *api.ScalewayProductsServers) {
+	for name := range products.Servers {
+		fmt.Fprintf(ctx.Stdout, "%v\n", name)
+	}
+}
+
+// DisplayServerFull only display the server product information
+func DisplayServerFull(ctx CommandContext, products *api.ScalewayProductsServers) {
+	fmt.Fprintf(ctx.Stdout, "%-12s %8s %8s %8s %10s\n",
+		"COMMERCIAL TYPE", "ARCH", "CPUs", "RAM", "BAREMETAL")
+
+	names := make([]string, len(products.Servers))
+	i := 0
+	for k := range products.Servers {
+		names[i] = k
+		i++
+	}
+	sort.Strings(names)
+
+	for _, name := range names {
+		offer := products.Servers[name]
+
+		fmt.Fprintf(ctx.Stdout, "%-15s %8s %8d %8s %10t\n",
+			name, offer.Arch, offer.Ncpus, humanize.Bytes(offer.Ram), offer.Baremetal)
+	}
+}