cmd: add runner list command (#156)

Adds a new `ecctl platform runner list` command which lists all existing platform runners.

Author: karencfv

cmd/platform/platform.go

@@ -28,6 +28,7 @@ import (
 	cmdproxy "github.com/elastic/ecctl/cmd/platform/proxy"
 	cmdrepository "github.com/elastic/ecctl/cmd/platform/repository"
 	cmdrole "github.com/elastic/ecctl/cmd/platform/role"
+	cmdrunner "github.com/elastic/ecctl/cmd/platform/runner"
 	cmdstack "github.com/elastic/ecctl/cmd/platform/stack"
 	"github.com/elastic/ecctl/pkg/ecctl"
 	"github.com/elastic/ecctl/pkg/platform"
@@ -70,6 +71,7 @@ func init() {
 		cmdrepository.Command,
 		cmdrole.Command,
 		cmdstack.Command,
+		cmdrunner.Command,
 	)
 
 	Command.AddCommand(infoCmd)

cmd/platform/runner/command.go

@@ -0,0 +1,32 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package cmdrunner
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// Command is the top level runner command.
+var Command = &cobra.Command{
+	Use:     "runner",
+	Short:   "Manages platform runners",
+	PreRunE: cobra.MaximumNArgs(0),
+	Run: func(cmd *cobra.Command, args []string) {
+		cmd.Help()
+	},
+}

cmd/platform/runner/list.go

@@ -0,0 +1,43 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package cmdrunner
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/elastic/ecctl/pkg/ecctl"
+	"github.com/elastic/ecctl/pkg/platform/runner"
+)
+
+var listCmd = &cobra.Command{
+	Use:     "list",
+	Short:   "Lists the existing platform runners",
+	PreRunE: cobra.NoArgs,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		res, err := runner.List(runner.Params{API: ecctl.Get().API})
+		if err != nil {
+			return err
+		}
+
+		return ecctl.Get().Formatter.Format("runner/list", res)
+	},
+}
+
+func init() {
+	Command.AddCommand(listCmd)
+}

docs/ecctl_platform.md

@@ -48,5 +48,6 @@ ecctl platform [flags]
 * [ecctl platform proxy](ecctl_platform_proxy.md)	 - Manages proxies
 * [ecctl platform repository](ecctl_platform_repository.md)	 - Manages snapshot repositories
 * [ecctl platform role](ecctl_platform_role.md)	 - Manages platform roles
+* [ecctl platform runner](ecctl_platform_runner.md)	 - Manages platform runners
 * [ecctl platform stack](ecctl_platform_stack.md)	 - Manages Elastic StackPacks
 

docs/ecctl_platform_runner.md

@@ -0,0 +1,43 @@
+## ecctl platform runner
+
+Manages platform runners
+
+### Synopsis
+
+Manages platform runners
+
+```
+ecctl platform runner [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for runner
+```
+
+### Options inherited from parent commands
+
+```
+      --apikey string      API key to use to authenticate (If empty will look for EC_APIKEY environment variable)
+      --config string      Config name, used to have multiple configs in $HOME/.ecctl/<env> (default "config")
+      --force              Do not ask for confirmation
+      --format string      Formats the output using a Go template
+      --host string        Base URL to use
+      --insecure           Skips all TLS validation
+      --message string     A message to set on cluster operation
+      --output string      Output format [text|json] (default "text")
+      --pass string        Password to use to authenticate (If empty will look for EC_PASS environment variable)
+      --pprof              Enables pprofing and saves the profile to pprof-20060102150405
+  -q, --quiet              Suppresses the configuration file used for the run, if any
+      --timeout duration   Timeout to use on all HTTP calls (default 30s)
+      --trace              Enables tracing saves the trace to trace-20060102150405
+      --user string        Username to use to authenticate (If empty will look for EC_USER environment variable)
+      --verbose            Enable verbose mode
+```
+
+### SEE ALSO
+
+* [ecctl platform](ecctl_platform.md)	 - Manages the platform
+* [ecctl platform runner list](ecctl_platform_runner_list.md)	 - Lists the existing platform runners
+

docs/ecctl_platform_runner_list.md

@@ -0,0 +1,42 @@
+## ecctl platform runner list
+
+Lists the existing platform runners
+
+### Synopsis
+
+Lists the existing platform runners
+
+```
+ecctl platform runner list [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for list
+```
+
+### Options inherited from parent commands
+
+```
+      --apikey string      API key to use to authenticate (If empty will look for EC_APIKEY environment variable)
+      --config string      Config name, used to have multiple configs in $HOME/.ecctl/<env> (default "config")
+      --force              Do not ask for confirmation
+      --format string      Formats the output using a Go template
+      --host string        Base URL to use
+      --insecure           Skips all TLS validation
+      --message string     A message to set on cluster operation
+      --output string      Output format [text|json] (default "text")
+      --pass string        Password to use to authenticate (If empty will look for EC_PASS environment variable)
+      --pprof              Enables pprofing and saves the profile to pprof-20060102150405
+  -q, --quiet              Suppresses the configuration file used for the run, if any
+      --timeout duration   Timeout to use on all HTTP calls (default 30s)
+      --trace              Enables tracing saves the trace to trace-20060102150405
+      --user string        Username to use to authenticate (If empty will look for EC_USER environment variable)
+      --verbose            Enable verbose mode
+```
+
+### SEE ALSO
+
+* [ecctl platform runner](ecctl_platform_runner.md)	 - Manages platform runners
+

pkg/formatter/templates/bindata.go

@@ -40,6 +40,7 @@
 // text/platform/repositorylist.gotmpl
 // text/proxy/list.gotmpl
 // text/roles/list.gotmpl
+// text/runner/list.gotmpl
 // text/stack/list.gotmpl
 // text/token/create.gotmpl
 // text/token/list.gotmpl
@@ -583,6 +584,26 @@ func textRolesListGotmpl() (*asset, error) {
 	return a, nil
 }
 
+var _textRunnerListGotmpl = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\x64\x8f\xc1\x6e\x83\x30\x10\x44\xef\xf9\x8a\x95\xef\xe5\x1f\x52\xb0\x84\xa5\xd4\x41\x94\x1c\x7a\x74\xf0\xa4\x45\x22\x4b\x45\xec\xaa\x95\xe5\x7f\xaf\x1c\x1a\x24\xd3\xd3\xae\xdf\x78\x77\x66\x43\x78\x22\x8b\xcb\xc0\x20\x31\x7d\x61\x9e\x07\x0b\x41\x31\x86\x40\xb3\xe1\x77\x50\xd1\x7a\x66\xcc\xb7\x3b\xc3\x37\x7a\xef\xd0\xe1\xfa\x39\x1a\x07\x2a\x62\xdc\x85\x40\x60\xbb\x8c\xac\xcd\x63\xa5\xc5\xc5\xf8\xd1\xa5\x8d\xbb\x64\x25\xda\x93\xd6\xb2\x25\x55\x2d\x26\xce\x9c\x53\x11\xf5\xf1\xb5\x23\xd5\x64\x90\x44\x73\x7a\x3e\xa8\x92\x92\xa8\xf7\x2f\x72\xa3\xd6\x72\x7f\xe8\xea\xb7\x0d\x2d\x8f\x5a\xcb\xb2\x93\xd5\xea\xf9\xef\x8e\x14\xf9\xef\xa9\xaa\x6c\xba\xa8\xa7\x9b\x53\x4d\xce\x1a\x7f\x1e\x87\x3e\x29\x6c\xae\xd8\xfc\x87\x19\xdd\xc7\x4f\x0e\xcb\x89\x19\xbd\x83\x7d\x24\x00\xdb\x7b\xb7\xd4\xdf\x00\x00\x00\xff\xff\x60\x8b\xf0\xd7\x73\x01\x00\x00")
+
+func textRunnerListGotmplBytes() ([]byte, error) {
+	return bindataRead(
+		_textRunnerListGotmpl,
+		"text/runner/list.gotmpl",
+	)
+}
+
+func textRunnerListGotmpl() (*asset, error) {
+	bytes, err := textRunnerListGotmplBytes()
+	if err != nil {
+		return nil, err
+	}
+
+	info := bindataFileInfo{name: "text/runner/list.gotmpl", size: 0, mode: os.FileMode(0), modTime: time.Unix(0, 0)}
+	a := &asset{bytes: bytes, info: info}
+	return a, nil
+}
+
 var _textStackListGotmpl = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\x64\x50\x4b\x6e\xab\x30\x14\x9d\xb3\x0a\x8b\x79\xbc\x07\xbf\x60\xbd\xa2\x7c\x5a\x05\x94\xf9\x0d\x3e\xa4\x56\xc0\x44\xc6\xa9\x2a\x5d\x79\xef\x15\x01\x22\x68\x47\xf7\xe8\x7c\x65\x33\x6f\x84\x41\x6d\x1d\x44\xda\x7d\xc1\x7b\x6b\x90\x8a\x18\x99\x85\x27\x77\x85\x90\x45\xa0\xea\xd6\x3f\x29\x7c\xa3\x7a\x04\x94\x68\xef\x0d\x05\x08\x19\x63\xc2\x2c\xe0\xcc\x98\x78\x81\xb9\xd1\xa0\xa6\x47\x13\x86\xc2\x64\x58\x4a\xcf\xfa\x54\xe4\xef\xc7\x74\x70\x05\xba\x0c\x27\xcd\xf4\x5e\x97\x3a\x1b\x57\x67\x52\xef\x55\x51\xe6\xdb\x42\xab\xd3\xf6\x4d\xe4\x07\xf5\x5f\xaf\x0d\xbb\xfc\x9f\x3a\xaa\x49\x59\x0a\xea\xe3\xf0\x62\x9f\xa3\xbf\xdf\x91\x30\xcb\x33\x7c\x6f\x3b\xb7\x6c\x94\x19\x1a\x04\x98\x15\xa7\x1b\xea\x83\xad\x7a\x90\xaf\x3e\x65\xd6\x55\x37\xf8\xbc\xa5\x2b\x56\xae\x9d\xbd\x90\xa3\xa5\x3c\x4d\x4f\x06\x61\x6b\x21\xd5\xbd\x1d\x3f\x67\x40\x7f\xaa\xd0\xf4\x88\x71\xc3\x0c\x67\xa6\xf0\x8c\xc6\xfb\x13\x00\x00\xff\xff\x34\x74\x77\x13\xa9\x01\x00\x00")
 
 func textStackListGotmplBytes() ([]byte, error) {
@@ -798,6 +819,7 @@ var _bindata = map[string]func() (*asset, error){
 	"text/platform/repositorylist.gotmpl":        textPlatformRepositorylistGotmpl,
 	"text/proxy/list.gotmpl":                     textProxyListGotmpl,
 	"text/roles/list.gotmpl":                     textRolesListGotmpl,
+	"text/runner/list.gotmpl":                    textRunnerListGotmpl,
 	"text/stack/list.gotmpl":                     textStackListGotmpl,
 	"text/token/create.gotmpl":                   textTokenCreateGotmpl,
 	"text/token/list.gotmpl":                     textTokenListGotmpl,
@@ -896,6 +918,9 @@ var _bintree = &bintree{nil, map[string]*bintree{
 		"roles": &bintree{nil, map[string]*bintree{
 			"list.gotmpl": &bintree{textRolesListGotmpl, map[string]*bintree{}},
 		}},
+		"runner": &bintree{nil, map[string]*bintree{
+			"list.gotmpl": &bintree{textRunnerListGotmpl, map[string]*bintree{}},
+		}},
 		"stack": &bintree{nil, map[string]*bintree{
 			"list.gotmpl": &bintree{textStackListGotmpl, map[string]*bintree{}},
 		}},

pkg/formatter/templates/text/runner/list.gotmpl

@@ -0,0 +1,7 @@
+{{- define "override" }}{{ range .Runners }}{{executeTemplate .}}
+{{ end }}{{ end }}{{ define "default" }}
+{{- "RUNNER ID" }}{{tab}}{{"HOST IP" }}{{tab}}{{ "PUBLIC HOSTNAME" }}{{tab}}{{ "HEALTHY" }}{{tab}}{{ "CONNECTED" }}
+{{- range .Runners }}
+{{ .RunnerID }}{{tab}}{{ .HostIP }}{{tab}}{{ .PublicHostname }}{{tab}}{{ .Healthy }}{{tab}}{{ .Connected }}
+{{- end}}
+{{end}}

pkg/platform/runner/list.go

@@ -0,0 +1,41 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package runner
+
+import (
+	"github.com/elastic/cloud-sdk-go/pkg/api"
+	"github.com/elastic/cloud-sdk-go/pkg/client/platform_infrastructure"
+	"github.com/elastic/cloud-sdk-go/pkg/models"
+)
+
+// List gets the list of runners
+func List(params Params) (*models.RunnerOverview, error) {
+	if err := params.Validate(); err != nil {
+		return nil, err
+	}
+
+	res, err := params.API.V1API.PlatformInfrastructure.GetRunners(
+		platform_infrastructure.NewGetRunnersParams(),
+		params.AuthWriter,
+	)
+	if err != nil {
+		return nil, api.UnwrapError(err)
+	}
+
+	return res.Payload, nil
+}

pkg/platform/runner/list_test.go

@@ -0,0 +1,100 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package runner
+
+import (
+	"errors"
+	"net/http"
+	"net/url"
+	"reflect"
+	"testing"
+
+	"github.com/elastic/cloud-sdk-go/pkg/api"
+	"github.com/elastic/cloud-sdk-go/pkg/api/mock"
+	"github.com/elastic/cloud-sdk-go/pkg/models"
+	"github.com/elastic/cloud-sdk-go/pkg/util/ec"
+)
+
+func TestList(t *testing.T) {
+	var runnerListSuccess = `
+{
+  "runners": [{
+    "connected": true,
+    "runner_id": "192.168.44.10"
+  }]
+}`
+	type args struct {
+		params Params
+	}
+	tests := []struct {
+		name    string
+		args    args
+		want    *models.RunnerOverview
+		wantErr error
+	}{
+		{
+			name: "Runner list succeeds",
+			args: args{params: Params{
+				API: api.NewMock(mock.Response{Response: http.Response{
+					Body:       mock.NewStringBody(runnerListSuccess),
+					StatusCode: 200,
+				}}),
+			}},
+			want: &models.RunnerOverview{
+				Runners: []*models.RunnerInfo{
+					{
+						RunnerID:  ec.String("192.168.44.10"),
+						Connected: ec.Bool(true),
+					},
+				},
+			},
+		},
+		{
+			name: "Runner list fails",
+			args: args{params: Params{
+				API: api.NewMock(mock.Response{Error: errors.New("error")}),
+			}},
+			want: nil,
+			wantErr: &url.Error{
+				Op:  "Get",
+				URL: "https://mock-host/mock-path/platform/infrastructure/runners",
+				Err: errors.New("error"),
+			},
+		},
+		{
+			name: "Runner list fails with an empty API",
+			args: args{params: Params{
+				API: nil,
+			}},
+			want:    nil,
+			wantErr: errors.New("api reference is required for command"),
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := List(tt.args.params)
+			if !reflect.DeepEqual(err, tt.wantErr) {
+				t.Errorf("List() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("List() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}