Update GetSystemInfo API return type

This updates the GetSystemInfo API to return typed struct rather than `map[string]interface{}`
It also removes support for legacy vesion info response from gateway which are available prior to version
0.8.4

Signed-off-by: Vivek Singh <[email protected]>

Author: viveksyngh

commands/version.go

@@ -104,23 +104,20 @@ func printServerVersions() error {
 	if err != nil {
 		return err
 	}
-	info, err := cliClient.GetSystemInfo(context.Background())
+	gatewayInfo, err := cliClient.GetSystemInfo(context.Background())
 	if err != nil {
 		return err
 	}
 
-	version, sha := getGatewayDetails(info)
+	printGatewayDetails(gatewayAddress, gatewayInfo.Version.Release, gatewayInfo.Version.SHA)
 
-	printGatewayDetails(gatewayAddress, version, sha)
-
-	name, orchestration, sha, version := getProviderDetails(info)
 	fmt.Printf(`
 Provider
  name:          %s
  orchestration: %s
  version:       %s 
  sha:           %s
-`, name, orchestration, version, sha)
+`, gatewayInfo.Provider.Name, gatewayInfo.Provider.Orchestration, gatewayInfo.Provider.Version.Release, gatewayInfo.Provider.Version.SHA)
 	return nil
 }
 
@@ -148,66 +145,6 @@ func printLogo() {
 	fmt.Printf(figletColoured)
 }
 
-func getGatewayDetails(m map[string]interface{}) (version, sha string) {
-	if _, ok := m["orchestration"]; !ok {
-		v := m["version"].(map[string]interface{})
-		version, ok = v["release"].(string)
-		if !ok {
-			version = ""
-		}
-		sha, ok = v["sha"].(string)
-		if !ok {
-			sha = ""
-		}
-	}
-
-	return
-}
-
-func getProviderDetails(m map[string]interface{}) (name, orchestration, sha, version string) {
-	if k, ok := m["provider"]; ok {
-		if kv, ok := k.(map[string]interface{}); ok {
-			name, orchestration, sha, version = getProviderDetailsCurrent(kv)
-		} else {
-			name, orchestration, sha, version = getProviderDetailsLegacy(m)
-		}
-	}
-
-	return
-}
-
-func getProviderDetailsLegacy(m map[string]interface{}) (name, orchestration, sha, version string) {
-	name = m["provider"].(string)
-	orchestration = m["orchestration"].(string)
-	v := m["version"].(map[string]interface{})
-	version = v["release"].(string)
-	sha = v["sha"].(string)
-
-	return
-}
-
-func getProviderDetailsCurrent(m map[string]interface{}) (name, orchestration, sha, version string) {
-	v := m["version"].(map[string]interface{})
-	version, ok := v["release"].(string)
-	if !ok {
-		version = ""
-	}
-	sha, ok = v["sha"].(string)
-	if !ok {
-		sha = ""
-	}
-	name, ok = m["provider"].(string)
-	if !ok {
-		name = ""
-	}
-	orchestration, ok = m["orchestration"].(string)
-	if !ok {
-		orchestration = ""
-	}
-
-	return
-}
-
 const figletStr = `  ___                   _____           ____
  / _ \ _ __   ___ _ __ |  ___|_ _  __ _/ ___|
 | | | | '_ \ / _ \ '_ \| |_ / _` + "`" + ` |/ _` + "`" + ` \___ \

commands/version_test.go

@@ -112,18 +112,6 @@ func Test_gateway_and_provider_information(t *testing.T) {
 				{"provider sha", "sha:           "},
 			},
 		},
-		{
-			responseBody: gateway_response_prior_to_0_8_4,
-			params: []struct {
-				name  string
-				value string
-			}{
-				{"provider name", "name:          faas-swarm"},
-				{"provider orchestration", "orchestration: swarm"},
-				{"provider version", "version:       provider-0.3.3"},
-				{"provider sha", "sha:           c890cba302d059de8edbef3f3de7fe15444b1ecf"},
-			},
-		},
 	}
 
 	for _, testCase := range testCases {
@@ -147,14 +135,6 @@ func Test_gateway_uri(t *testing.T) {
 	}
 }
 
-func Test_gateway_uri_prior_to_0_8_4(t *testing.T) {
-	stdOut, gatewayUri := executeVersionCmd(t, gateway_response_prior_to_0_8_4)
-
-	if found, err := regexp.MatchString(fmt.Sprintf(`(?m:uri:     %s)`, gatewayUri), stdOut); err != nil || !found {
-		t.Fatalf("Gateway uri is not as expected - want: %s, got:\n%s", gatewayUri, stdOut)
-	}
-}
-
 func Test_gateway_details_prior_to_0_8_4_should_not_be_displayed(t *testing.T) {
 	stdOut, _ := executeVersionCmd(t, gateway_response_prior_to_0_8_4)
 

proxy/version.go

@@ -9,44 +9,46 @@ import (
 	"fmt"
 	"io/ioutil"
 	"net/http"
+
+	"github.com/openfaas/faas/gateway/types"
 )
 
 //GetSystemInfo get system information from /system/info endpoint
-func (c *Client) GetSystemInfo(ctx context.Context) (map[string]interface{}, error) {
+func (c *Client) GetSystemInfo(ctx context.Context) (types.GatewayInfo, error) {
 	infoEndPoint := "/system/info"
+	var info types.GatewayInfo
+
 	req, err := c.newRequest(http.MethodGet, infoEndPoint, nil)
 	if err != nil {
-		return nil, fmt.Errorf("invalid HTTP method or invalid URL")
+		return info, fmt.Errorf("invalid HTTP method or invalid URL")
 	}
 
 	response, err := c.doRequest(ctx, req)
 	if err != nil {
-		return nil, fmt.Errorf("cannot connect to OpenFaaS on URL: %s", c.GatewayURL.String())
+		return info, fmt.Errorf("cannot connect to OpenFaaS on URL: %s", c.GatewayURL.String())
 	}
 
 	if response.Body != nil {
 		defer response.Body.Close()
 	}
 
-	info := make(map[string]interface{})
-
 	switch response.StatusCode {
 	case http.StatusOK:
 		bytesOut, err := ioutil.ReadAll(response.Body)
 		if err != nil {
-			return nil, fmt.Errorf("cannot read result from OpenFaaS on URL: %s", c.GatewayURL.String())
+			return info, fmt.Errorf("cannot read result from OpenFaaS on URL: %s", c.GatewayURL.String())
 		}
 		err = json.Unmarshal(bytesOut, &info)
 		if err != nil {
-			return nil, fmt.Errorf("cannot parse result from OpenFaaS on URL: %s\n%s", c.GatewayURL.String(), err.Error())
+			return info, fmt.Errorf("cannot parse result from OpenFaaS on URL: %s\n%s", c.GatewayURL.String(), err.Error())
 		}
 
 	case http.StatusUnauthorized:
-		return nil, fmt.Errorf("unauthorized access, run \"faas-cli login\" to setup authentication for this server")
+		return info, fmt.Errorf("unauthorized access, run \"faas-cli login\" to setup authentication for this server")
 	default:
 		bytesOut, err := ioutil.ReadAll(response.Body)
 		if err == nil {
-			return nil, fmt.Errorf("server returned unexpected status code: %d - %s", response.StatusCode, string(bytesOut))
+			return info, fmt.Errorf("server returned unexpected status code: %d - %s", response.StatusCode, string(bytesOut))
 		}
 	}