deployment: Add search command (#34)

Adds deployment search command with a text output template and examples
in the docs.

Signed-off-by: Marc Lopez <marc5.12@outlook.com>

Author: marclop

cmd/deployment/search.go

@@ -0,0 +1,71 @@
+// 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 cmddeployment
+
+import (
+	"github.com/spf13/cobra"
+
+	cmdutil "github.com/elastic/ecctl/cmd/util"
+	"github.com/elastic/ecctl/pkg/deployment"
+	"github.com/elastic/ecctl/pkg/ecctl"
+)
+
+const searchQueryLong = `Read more about Query DSL in https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html`
+
+var searchExamples = `
+$ cat query_string_query.json
+{
+    "query": {
+        "query_string": {
+            "query": "name: admin"
+        }
+    }
+}
+$ ecctl deployment search -f query_string_query.json
+[...]`[1:]
+
+var searchCmd = &cobra.Command{
+	Use:     `search -f <query file.json>`,
+	Short:   "Performs advanced deployment search using the Elasticsearch Query DSL",
+	Long:    searchQueryLong,
+	Example: searchExamples,
+	PreRunE: cobra.NoArgs,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		sr, err := cmdutil.ParseQueryDSLFile(cmd.Flag("file").Value.String())
+		if err != nil {
+			return err
+		}
+
+		res, err := deployment.Search(deployment.SearchParams{
+			API:     ecctl.Get().API,
+			Request: &sr,
+		})
+
+		if err != nil {
+			return err
+		}
+
+		return ecctl.Get().Formatter.Format("deployment/search", res)
+	},
+}
+
+func init() {
+	Command.AddCommand(searchCmd)
+	searchCmd.Flags().StringP("file", "f", "", "JSON file that contains JSON-style domain-specific language query")
+	searchCmd.MarkFlagRequired("file")
+}

docs/ecctl_deployment.md

@@ -45,6 +45,7 @@ ecctl deployment [flags]
 * [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
 * [ecctl deployment list](ecctl_deployment_list.md)	 - Lists the platform's deployments
 * [ecctl deployment note](ecctl_deployment_note.md)	 - Manages a deployment's notes
+* [ecctl deployment search](ecctl_deployment_search.md)	 - Performs advanced deployment search using the Elasticsearch Query DSL
 * [ecctl deployment show](ecctl_deployment_show.md)	 - Shows the specified deployment resources
 * [ecctl deployment shutdown](ecctl_deployment_shutdown.md)	 - Shuts down a deployment and all of its associated sub-resources
 

docs/ecctl_deployment_search.md

@@ -0,0 +1,59 @@
+## ecctl deployment search
+
+Performs advanced deployment search using the Elasticsearch Query DSL
+
+### Synopsis
+
+Read more about Query DSL in https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
+
+```
+ecctl deployment search -f <query file.json> [flags]
+```
+
+### Examples
+
+```
+$ cat query_string_query.json
+{
+    "query": {
+        "query_string": {
+            "query": "name: admin"
+        }
+    }
+}
+$ ecctl deployment search -f query_string_query.json
+[...]
+```
+
+### Options
+
+```
+  -f, --file string   JSON file that contains JSON-style domain-specific language query
+  -h, --help          help for search
+```
+
+### 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 (default "https://api.elastic-cloud.com")
+      --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
+      --region string      Elastic Cloud region
+      --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 deployment](ecctl_deployment.md)	 - Manages deployments
+

pkg/deployment/search.go

@@ -0,0 +1,69 @@
+// 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 deployment
+
+import (
+	"errors"
+
+	"github.com/elastic/cloud-sdk-go/pkg/api"
+	"github.com/elastic/cloud-sdk-go/pkg/client/deployments"
+	"github.com/elastic/cloud-sdk-go/pkg/models"
+	"github.com/hashicorp/go-multierror"
+
+	"github.com/elastic/ecctl/pkg/util"
+)
+
+// SearchParams is consumed by Search.
+type SearchParams struct {
+	*api.API
+
+	Request *models.SearchRequest
+}
+
+// Validate ensures the parameters are usable by Shutdown.
+func (params SearchParams) Validate() error {
+	var merr = new(multierror.Error)
+
+	if params.API == nil {
+		merr = multierror.Append(merr, util.ErrAPIReq)
+	}
+
+	if params.Request == nil {
+		merr = multierror.Append(merr, errors.New("deployment search: request cannot be empty"))
+	}
+
+	return merr.ErrorOrNil()
+}
+
+// Search performs a search using the specified Request against the API.
+func Search(params SearchParams) (*models.DeploymentsSearchResponse, error) {
+	if err := params.Validate(); err != nil {
+		return nil, err
+	}
+
+	res, err := params.V1API.Deployments.SearchDeployments(
+		deployments.NewSearchDeploymentsParams().
+			WithBody(params.Request),
+		params.AuthWriter,
+	)
+	if err != nil {
+		return nil, api.UnwrapError(err)
+	}
+
+	return res.Payload, nil
+}

pkg/deployment/search_test.go

@@ -0,0 +1,86 @@
+// 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 deployment
+
+import (
+	"errors"
+	"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"
+	"github.com/hashicorp/go-multierror"
+
+	"github.com/elastic/ecctl/pkg/util"
+)
+
+func TestSearch(t *testing.T) {
+	type args struct {
+		params SearchParams
+	}
+	tests := []struct {
+		name string
+		args args
+		want *models.DeploymentsSearchResponse
+		err  error
+	}{
+		{
+			name: "fails on parameter validation",
+			err: &multierror.Error{Errors: []error{
+				util.ErrAPIReq,
+				errors.New("deployment search: request cannot be empty"),
+			}},
+		},
+		{
+			name: "fails on API error",
+			args: args{params: SearchParams{
+				API:     api.NewMock(mock.New500Response(mock.NewStringBody("error"))),
+				Request: &models.SearchRequest{},
+			}},
+			err: errors.New("unknown error (status 500)"),
+		},
+		{
+			name: "Succeeds",
+			args: args{params: SearchParams{
+				API: api.NewMock(mock.New200Response(mock.NewStructBody(models.DeploymentsSearchResponse{
+					Deployments: []*models.DeploymentSearchResponse{
+						{ID: ec.String("123")},
+					},
+				}))),
+				Request: &models.SearchRequest{},
+			}},
+			want: &models.DeploymentsSearchResponse{Deployments: []*models.DeploymentSearchResponse{
+				{ID: ec.String("123")},
+			}},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := Search(tt.args.params)
+			if !reflect.DeepEqual(err, tt.err) {
+				t.Errorf("Search() error = %v, wantErr %v", err, tt.err)
+				return
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("Search() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

pkg/formatter/templates/bindata.go

@@ -26,6 +26,7 @@
 // text/apm/planhistory.gotmpl
 // text/deployment/list.gotmpl
 // text/deployment/notelist.gotmpl
+// text/deployment/search.gotmpl
 // text/deployment-template/list.gotmpl
 // text/elasticsearch/list.gotmpl
 // text/elasticsearch/overridecapacity.gotmpl
@@ -302,6 +303,26 @@ func textDeploymentNotelistGotmpl() (*asset, error) {
 	return a, nil
 }
 
+var _textDeploymentSearchGotmpl = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\x8c\x52\xdd\x6a\x83\x30\x14\xbe\xef\x53\x84\xd0\xdb\xfa\x00\x83\x5e\x64\x55\x98\x74\x95\xd2\xf6\x05\x8e\x7a\xba\xc9\x4c\x0c\x49\x1c\x1b\xe2\xbb\x0f\xf3\x53\x4c\xed\xa0\x57\xc6\xef\x9c\xef\x27\x9f\x0e\xc3\x86\xd4\x78\x6d\x04\x12\xda\x7d\xa3\x52\x4d\x8d\x94\x8c\xe3\x30\x10\x05\xe2\x03\x49\x92\xa2\x6c\xbb\x5f\x8e\xc2\x68\x87\xe3\x0f\x56\xbd\xc1\x0b\x72\xd9\x82\x41\x92\x8c\xe3\x6a\x82\x45\xed\xe7\xe1\x10\x74\x6b\xbc\x42\xdf\x9a\x49\x76\x35\xf9\xd1\x3c\x75\x16\x06\x4a\xbb\x48\x0b\x76\xc8\xe8\x0c\xa1\xd9\x3b\x3b\x5f\xf2\xdd\x39\x63\xa7\xdd\x5b\x34\xd9\xe7\xaf\xac\x60\x11\xc4\x8e\x87\xbb\xf7\xe3\x8d\x68\x0d\x1f\xde\xc4\x4e\xd6\x5f\x4d\x09\x02\xc8\xcb\x96\xd0\x4d\x58\x5f\x83\xe4\x0b\x44\x6a\x04\x55\x7d\xde\xe1\xd8\x82\x36\x4d\xf5\x68\xe6\x4d\x4f\xa8\xbb\x5e\x55\xa8\x13\x26\xb9\xbd\xad\x95\xdf\x92\x24\x4f\x6d\x09\x28\xea\xff\x19\xde\x35\xf0\x42\x88\xa7\xd8\xd9\x3c\x9b\x53\x88\xe3\x3e\xa5\xb2\xb7\x05\x39\xba\x2f\x6b\xc9\xbb\x01\xe1\x8b\x26\x05\x70\x74\x7f\x81\x81\xd2\x1e\x62\xf3\xf9\x72\xd0\x8d\xd6\x5d\x4d\x0b\x28\x34\xe0\xe3\x86\x00\xee\xf9\x17\x00\x00\xff\xff\x34\xd0\x98\x15\xcd\x02\x00\x00")
+
+func textDeploymentSearchGotmplBytes() ([]byte, error) {
+	return bindataRead(
+		_textDeploymentSearchGotmpl,
+		"text/deployment/search.gotmpl",
+	)
+}
+
+func textDeploymentSearchGotmpl() (*asset, error) {
+	bytes, err := textDeploymentSearchGotmplBytes()
+	if err != nil {
+		return nil, err
+	}
+
+	info := bindataFileInfo{name: "text/deployment/search.gotmpl", size: 0, mode: os.FileMode(0), modTime: time.Unix(0, 0)}
+	a := &asset{bytes: bytes, info: info}
+	return a, nil
+}
+
 var _textDeploymentTemplateListGotmpl = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\x64\x8e\xcd\x4e\x87\x30\x10\xc4\xef\xff\xa7\xd8\xf4\x6e\xdf\xc1\x58\x0e\x3d\xf0\x11\xcb\xc5\x63\xa5\x83\x69\x02\x85\x94\xa2\x92\xa6\xef\x6e\x00\xd1\xa4\x9c\x76\x32\xbb\xfb\x9b\x89\xf1\x89\x0c\x7a\xeb\x40\x6c\xfa\x84\xf7\xd6\x80\x51\x4a\x31\x92\xd7\xee\x03\xc4\x1b\xbd\x0d\x93\x36\x87\x87\x6f\x74\x6b\x40\x8b\x71\x1e\x74\x00\xf1\x94\x1e\x31\x12\xdc\xb9\xfe\x17\x17\xd2\xa0\xd7\xeb\x10\x76\xe2\x63\x8f\x22\x26\xc5\x2f\x3e\xe8\xf7\x53\x10\xab\x9e\xcb\x22\x77\x99\x7a\x53\x6d\x51\xde\x6c\x51\xa8\x97\x57\xd9\xb4\xb2\xae\xfe\xa8\xb7\xa6\x7b\x29\x2e\x45\xf6\xcb\x2b\x3d\x22\x0f\xe7\x6a\x5b\x02\xc6\xfa\xcb\xc1\xe4\xf7\x02\x4b\xe7\xed\x1c\xec\xe4\xae\x28\x38\x73\xa8\x73\xfe\x04\x00\x00\xff\xff\x7d\x8a\x96\xef\x3e\x01\x00\x00")
 
 func textDeploymentTemplateListGotmplBytes() ([]byte, error) {
@@ -763,6 +784,7 @@ var _bindata = map[string]func() (*asset, error){
 	"text/apm/planhistory.gotmpl":                textApmPlanhistoryGotmpl,
 	"text/deployment/list.gotmpl":                textDeploymentListGotmpl,
 	"text/deployment/notelist.gotmpl":            textDeploymentNotelistGotmpl,
+	"text/deployment/search.gotmpl":              textDeploymentSearchGotmpl,
 	"text/deployment-template/list.gotmpl":       textDeploymentTemplateListGotmpl,
 	"text/elasticsearch/list.gotmpl":             textElasticsearchListGotmpl,
 	"text/elasticsearch/overridecapacity.gotmpl": textElasticsearchOverridecapacityGotmpl,
@@ -841,6 +863,7 @@ var _bintree = &bintree{nil, map[string]*bintree{
 		"deployment": &bintree{nil, map[string]*bintree{
 			"list.gotmpl":     &bintree{textDeploymentListGotmpl, map[string]*bintree{}},
 			"notelist.gotmpl": &bintree{textDeploymentNotelistGotmpl, map[string]*bintree{}},
+			"search.gotmpl":   &bintree{textDeploymentSearchGotmpl, map[string]*bintree{}},
 		}},
 		"deployment-template": &bintree{nil, map[string]*bintree{
 			"list.gotmpl": &bintree{textDeploymentTemplateListGotmpl, map[string]*bintree{}},

pkg/formatter/templates/text/deployment/search.gotmpl

@@ -0,0 +1,15 @@
+{{- define "override" }}{{ range .Deployments }}{{ executeTemplate .}}
+{{ end }}{{ end }}{{ define "default" }}
+{{- "ID" }}{{tab}}{{ "NAME"}}{{tab}}{{"ELASTICSEARCH"}}{{tab}}{{"KIBANA"}}{{tab}}{{"APM"}}{{tab}}{{"APPSEARCH"}}
+{{- range .Deployments }}
+{{- $kibana := "-"}}
+{{- $apm := "-"}}
+{{- $appsearch := "-"}}
+{{- $elasticsearch := "-"}}
+{{- range .Resources.Apm}}{{ $apm = .ID }}{{end}}
+{{- range .Resources.Appsearch}}{{ $appsearch = .ID }}{{end}}
+{{- range .Resources.Elasticsearch}}{{ $elasticsearch = .ID }}{{end}}
+{{- range .Resources.Kibana}}{{ $kibana = .ID }}{{end}}
+{{ .ID }}{{tab}}{{ .Name }}{{ tab }}{{$elasticsearch}}{{tab}}{{ $kibana }}{{ tab }}{{ $apm }}{{ tab }}{{ $appsearch }}
+{{- end}}
+{{end}}