Merge pull request #54 from philbrookes/AG-1911

json formatting and documentation

Author: maleck13

README.md

@@ -133,8 +133,7 @@ around your particular mobile runtime as well as allowing us setup the different
 - **ClientConfig** the client config, is a resource created by aggregating together all of the available service configs. This resource is configuration
 required in order to consume your mobile aware services from your mobile client. It is used by the client SDKs for the various mobile services.
 
--  **ServiceConfig:** the Service Config stores information about a mobile aware service and is backed by a secret. This information is then used to populate your mobile client's config.
-This information could be anything but often is made up of values such as the URI of the service and perhaps some headers and configuration particular to that service.
+-  **ServiceConfig:** Contains services' information that is used to configure the Mobile SDK. For more information see [here](./doc/service_config.md).
 
 - **ClientBuild** the ClientBuild is backed by a regular BuildConfig however the CLI will help you create this BuildConfig with as little effort as possible. Allowing you to focus on
 just the mobile parts rather than needing to understand how to setup and manage a buildconfig and builds. For example, it will help you manage build credentials, and keys and ensure the build integrates

cmd/mobile/main.go

@@ -29,6 +29,7 @@ import (
 	m "github.com/aerogear/mobile-cli/pkg/client/mobile/clientset/versioned"
 	sc "github.com/aerogear/mobile-cli/pkg/client/servicecatalog/clientset/versioned"
 	"github.com/aerogear/mobile-cli/pkg/cmd"
+	restclient "k8s.io/client-go/rest"
 )
 
 func main() {
@@ -37,14 +38,19 @@ func main() {
 		kubeconfig = flag.String("kubeconfig", filepath.Join(home, ".kube", "config"), "(optional) absolute path to the kubeconfig file")
 	}
 
-	k8Client, mobileClient, scClient := NewClientsOrDie(*kubeconfig)
+	config, err := clientcmd.BuildConfigFromFlags("", *kubeconfig)
+	if err != nil {
+		fmt.Fprintln(os.Stderr, err.Error())
+		os.Exit(1)
+	}
+	k8Client, mobileClient, scClient := NewClientsOrDie(config)
 	var (
 		out              = os.Stdout
 		rootCmd          = cmd.NewRootCmd()
 		clientCmd        = cmd.NewClientCmd(mobileClient, out)
 		bindCmd          = cmd.NewIntegrationCmd(scClient, k8Client)
 		serviceConfigCmd = cmd.NewServiceConfigCommand(k8Client)
-		clientCfgCmd     = cmd.NewClientConfigCmd(k8Client, out)
+		clientCfgCmd     = cmd.NewClientConfigCmd(k8Client, config.Host, out)
 		clientBuilds     = cmd.NewClientBuildsCmd()
 		svcCmd           = cmd.NewServicesCmd(scClient, k8Client, out)
 	)
@@ -113,13 +119,7 @@ func main() {
 
 // NewClientsOrDie creates a new set of clients for Kubernetes, Service Catalog and Mobile Services
 // if any of these clients fails to create then the process wil die.
-func NewClientsOrDie(configLoc string) (kubernetes.Interface, m.Interface, sc.Interface) {
-	config, err := clientcmd.BuildConfigFromFlags("", configLoc)
-	if err != nil {
-		fmt.Fprintln(os.Stderr, err.Error())
-		os.Exit(1)
-	}
-
+func NewClientsOrDie(config *restclient.Config) (kubernetes.Interface, m.Interface, sc.Interface) {
 	// create the K8client
 	k8client, err := kubernetes.NewForConfig(config)
 	if err != nil {

doc/service_config.md

@@ -0,0 +1,110 @@
+## Service Configuration
+
+### Overview
+the Service Config stores information about a mobile service and is backed by a secret. This information is then used to populate your mobile client's config.
+
+This information could be anything but often is made up of values such as the URL of the service and perhaps some headers and configuration particular to that service.
+
+### Retrieving Configurations
+All service configs for a particular namespace can be retrieved with the following command:
+```sh
+mobile get clientconfig example_client_id --namespace=myproject
+```
+
+Which will produce output like the following:
+```sh
++----------------+----------------+----------------+-------------------------------------------------------+
+|       ID       |      NAME      |      TYPE      |                          URL                          |
++----------------+----------------+----------------+-------------------------------------------------------+
+| Client ID      | example_client_id         |                |                                                       |
+| fh-sync-server | fh-sync-server | fh-sync-server | https://fh-sync-server-myproject.192.168.64.74.nip.io |
+| keycloak       | keycloak       | keycloak       | https://keycloak-myproject.192.168.64.74.nip.io       |
+| prometheus     | prometheus     | prometheus     | https://prometheus-myproject.192.168.64.74.nip.io     |
++----------------+----------------+----------------+-------------------------------------------------------+
+```
+
+For more verbose config details of each service, you can request the output in JSON format instead, with the following command:
+```sh
+mobile get clientconfig example_client_id --namespace=myproject -o json
+```
+
+Which will produce output similar to the following (newlines and indentation have been added for readability):
+```
+{
+  "version": "1.0",
+  "cluster_name": "192.168.64.74:8443",
+  "namespace": "myproject",
+  "client_id": "example_client_id",
+  "services": [
+    {
+      "id": "fh-sync-server",
+      "name": "fh-sync-server",
+      "type": "fh-sync-server",
+      "url": "https://fh-sync-server-myproject.192.168.64.74.nip.io",
+      "config": {
+        "url": "https://fh-sync-server-myproject.192.168.64.74.nip.io"
+      }
+    },
+    {
+      "id": "keycloak",
+      "name": "keycloak",
+      "type": "keycloak",
+      "url": "https://keycloak-myproject.192.168.64.74.nip.io",
+      "config": {
+        "auth-server-url": "https://keycloak-myproject.192.168.64.74.nip.io/auth",
+        "clientId": "juYAlRlhTyYYmOyszFa",
+        "realm": "myproject",
+        "resource": "juYAlRlhTyYYmOyszFa",
+        "ssl-required": "external",
+        "url": "https://keycloak-myproject.192.168.64.74.nip.io/auth"
+      }
+    },
+    {
+      "id": "prometheus",
+      "name": "prometheus",
+      "type": "prometheus",
+      "url": "https://prometheus-myproject.192.168.64.74.nip.io",
+      "config": {}
+    }
+  ]
+}
+```
+
+### Understanding the JSON format
+Firstly, the parent object in the JSON output is described below:
+
+#### version
+The version of the JSON structure used in this response.
+
+#### cluster_name
+An identifier of the cluster this config was retrieved from.
+
+#### namespace
+The namespace these configs were retrieved from.
+
+#### client_id
+The client id of the mobile application using these configs.
+
+#### services
+An array of configuration values for the provisioned mobile services in this namespace.
+
+### The service object
+The service object contains specific configuration values for each mobile service provisioned to a specific namespace.
+
+Each service has a common set of values:
+#### id
+A unique identifier of this specific deployment of this service.
+
+#### name
+A human-readable identifier of this service.
+
+#### type
+A way of categorising services, e.g. Authentication, Storage, etc...
+
+#### url
+The URL that this service can be reach at
+
+#### config
+The config is a loosely defined object where any extra details specific to a particular service that may be required to make proper use of this service will be stored.
+
+For example, in the KeyCloak service in the snippet above, the config contains the name of the realm, clientID and other details that would be required to make use of KeyCloak from a client.

pkg/cmd/clientConfig.go

@@ -15,7 +15,6 @@
 package cmd
 
 import (
-	"encoding/json"
 	"fmt"
 	"io"
 
@@ -29,14 +28,16 @@ import (
 // ClientConfigCmd executes the retrieval and display of the client config
 type ClientConfigCmd struct {
 	*BaseCmd
-	k8Client kubernetes.Interface
+	k8Client    kubernetes.Interface
+	clusterHost string
 }
 
 // NewClientConfigCmd creates and returns a ClientConfigCmd object
-func NewClientConfigCmd(k8Client kubernetes.Interface, out io.Writer) *ClientConfigCmd {
+func NewClientConfigCmd(k8Client kubernetes.Interface, clusterHost string, out io.Writer) *ClientConfigCmd {
 	return &ClientConfigCmd{
-		k8Client: k8Client,
-		BaseCmd:  &BaseCmd{Out: output.NewRenderer(out)},
+		k8Client:    k8Client,
+		clusterHost: clusterHost,
+		BaseCmd:     &BaseCmd{Out: output.NewRenderer(out)},
 	}
 }
 
@@ -82,10 +83,13 @@ kubectl plugin mobile get clientconfig`,
 				}
 				ret = append(ret, svcConfig)
 			}
+
 			outputJSON := ServiceConfigs{
-				Services:  ret,
-				Namespace: ns,
-				ClientID:  clientID,
+				Version:     "1",
+				Services:    ret,
+				Namespace:   ns,
+				ClientID:    clientID,
+				ClusterName: ccc.clusterHost,
 			}
 			if err := ccc.Out.Render("get"+cmd.Name(), outputType(cmd.Flags()), outputJSON); err != nil {
 				return errors.Wrap(err, fmt.Sprintf(output.FailedToOutPutInFormat, "ServiceConfig", outputType(cmd.Flags())))
@@ -98,19 +102,15 @@ kubectl plugin mobile get clientconfig`,
 		serviceConfigList := serviceConfigs.(ServiceConfigs)
 		var data [][]string
 		if serviceConfigList.ClientID != "" {
-			data = append(data, []string{"Client ID", serviceConfigList.ClientID})
+			data = append(data, []string{"Client ID", serviceConfigList.ClientID, "", ""})
 		}
 		for _, service := range serviceConfigList.Services {
-			config, err := json.Marshal(service.Config)
-			if err != nil {
-				return err
-			}
-			data = append(data, []string{service.Name, string(config)})
+			data = append(data, []string{service.ID, service.Name, service.Type, service.URL})
 		}
 		table := tablewriter.NewWriter(writer)
 		table.SetAlignment(tablewriter.ALIGN_LEFT)
 		table.AppendBulk(data)
-		table.SetHeader([]string{"Name", "config"})
+		table.SetHeader([]string{"ID", "Name", "Type", "URL"})
 		table.Render()
 		return nil
 	})

pkg/cmd/clientConfig_test.go

@@ -51,6 +51,7 @@ func TestClientConfigCmd_GetClientConfigCmd(t *testing.T) {
 	tests := []struct {
 		name         string
 		k8Client     func() kubernetes.Interface
+		ClusterHost  string
 		namespace    string
 		args         []string
 		cobraCmd     *cobra.Command
@@ -64,6 +65,7 @@ func TestClientConfigCmd_GetClientConfigCmd(t *testing.T) {
 				return &kFake.Clientset{}
 			},
 			namespace:    "",
+			ClusterHost:  "test",
 			args:         []string{"client-id"},
 			cobraCmd:     getFakeCbrCmd(),
 			ExpectError:  true,
@@ -73,14 +75,19 @@ func TestClientConfigCmd_GetClientConfigCmd(t *testing.T) {
 		{
 			name: "get client config command with no services",
 			k8Client: func() kubernetes.Interface {
-				return &kFake.Clientset{}
+				fakeclient := &kFake.Clientset{}
+				fakeclient.AddReactor("list", "secrets", func(action ktesting.Action) (handled bool, ret runtime.Object, err error) {
+					return true, &v1.SecretList{Items: []v1.Secret{}}, nil
+				})
+				return fakeclient
 			},
 			namespace:   "testing-ns",
+			ClusterHost: "test",
 			args:        []string{"client-id"},
 			cobraCmd:    getFakeCbrCmd(),
 			ExpectError: false,
 			ValidateOut: func(out bytes.Buffer) error {
-				expected := `{"services":[],"namespace":"testing-ns","client_id":"client-id"}`
+				expected := `{"version":"1","cluster_name":"test","namespace":"testing-ns","client_id":"client-id","services":[]}`
 				if strings.TrimSpace(out.String()) != expected {
 					return errors.New(fmt.Sprintf("expected: '%v', got: '%v'", expected, strings.TrimSpace(out.String())))
 				}
@@ -125,11 +132,12 @@ func TestClientConfigCmd_GetClientConfigCmd(t *testing.T) {
 				return fakeclient
 			},
 			namespace:   "testing-ns",
+			ClusterHost: "test",
 			args:        []string{"client-id"},
 			cobraCmd:    getFakeCbrCmd(),
 			ExpectError: false,
 			ValidateOut: func(out bytes.Buffer) error {
-				expected := `{"services":[{"config":{"headers":{},"name":"test-service","uri":""},"name":"test-service"},{"config":{"headers":{}},"name":"keycloak"}],"namespace":"testing-ns","client_id":"client-id"}`
+				expected := `{"version":"1","cluster_name":"test","namespace":"testing-ns","client_id":"client-id","services":[{"id":"test-service","name":"test-service","type":"","url":"","config":{}},{"id":"keycloak","name":"keycloak","type":"","url":"","config":{}}]}`
 				if strings.TrimSpace(out.String()) != expected {
 					return errors.New(fmt.Sprintf("expected: '%v', got: '%v'", expected, strings.TrimSpace(out.String())))
 				}
@@ -140,7 +148,7 @@ func TestClientConfigCmd_GetClientConfigCmd(t *testing.T) {
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {
 			var out bytes.Buffer
-			ccCmd := cmd.NewClientConfigCmd(tc.k8Client(), &out)
+			ccCmd := cmd.NewClientConfigCmd(tc.k8Client(), tc.ClusterHost, &out)
 
 			got := ccCmd.GetClientConfigCmd()
 			if use := got.Use; use != tc.cobraCmd.Use {

pkg/cmd/convert.go

@@ -20,10 +20,14 @@ import (
 	v1 "k8s.io/client-go/pkg/api/v1"
 )
 
+func isClientConfigKey(key string) bool {
+	return key == "url" || key == "name" || key == "type" || key == "id"
+}
+
 func convertSecretToMobileService(s v1.Secret) *Service {
 	params := map[string]string{}
 	for key, value := range s.Data {
-		if key != "uri" && key != "name" {
+		if !isClientConfigKey(key) {
 			params[key] = string(value)
 		}
 	}