cmd: Add ref-id auto-discovery to resource upgrade (#92)

bugfix: Adds RefID auto-discovery for the deployment resource upgrade command 
when the --ref-id flag is not set.

Author: karencfv

cmd/deployment/resource/upgrade.go

@@ -23,6 +23,7 @@ import (
 	"github.com/spf13/cobra"
 
 	cmdutil "github.com/elastic/ecctl/cmd/util"
+	"github.com/elastic/ecctl/pkg/deployment"
 	"github.com/elastic/ecctl/pkg/deployment/depresource"
 	"github.com/elastic/ecctl/pkg/ecctl"
 )
@@ -37,7 +38,7 @@ var upgradeCmd = &cobra.Command{
 		resType, _ := cmd.Flags().GetString("type")
 		refID, _ := cmd.Flags().GetString("ref-id")
 
-		res, err := depresource.UpgradeStateless(depresource.UpgradeStatelessParams{
+		res, err := depresource.UpgradeStateless(deployment.ResourceParams{
 			API:          ecctl.Get().API,
 			DeploymentID: args[0],
 			Type:         resType,
@@ -70,5 +71,4 @@ func init() {
 	upgradeCmd.Flags().String("type", "", "Optional stateless deployment type to upgrade (kibana, apm, or appsearch)")
 	upgradeCmd.MarkFlagRequired("type")
 	upgradeCmd.Flags().String("ref-id", "", "Optional deployment RefId, if not set, the RefId will be auto-discovered")
-	upgradeCmd.MarkFlagRequired("ref-id")
 }

pkg/deployment/depresource/upgrade_stateless.go

@@ -18,48 +18,16 @@
 package depresource
 
 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/deployment/deputil"
-	"github.com/elastic/ecctl/pkg/util"
+	"github.com/elastic/ecctl/pkg/deployment"
 )
 
-// UpgradeStatelessParams is consumed by UpgradeStateless
-type UpgradeStatelessParams struct {
-	*api.API
-
-	DeploymentID string
-	Type         string
-	RefID        string
-}
-
-// Validate ensures the parameters are usable by the consuming function.
-func (params UpgradeStatelessParams) Validate() error {
-	var merr = new(multierror.Error)
-
-	if params.API == nil {
-		merr = multierror.Append(merr, util.ErrAPIReq)
-	}
-
-	if len(params.DeploymentID) != 32 {
-		merr = multierror.Append(merr, deputil.NewInvalidDeploymentIDError(params.DeploymentID))
-	}
-
-	if params.Type == "" {
-		merr = multierror.Append(merr, errors.New("deployment resource type cannot be empty"))
-	}
-
-	return merr.ErrorOrNil()
-}
-
 // UpgradeStateless upgrades a stateless deployment resource like APM, Kibana
 // and AppSearch.
-func UpgradeStateless(params UpgradeStatelessParams) (*models.DeploymentResourceUpgradeResponse, error) {
+func UpgradeStateless(params deployment.ResourceParams) (*models.DeploymentResourceUpgradeResponse, error) {
 	if err := params.Validate(); err != nil {
 		return nil, err
 	}

pkg/deployment/depresource/upgrade_stateless_test.go

@@ -26,8 +26,10 @@ import (
 	"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/deployment"
 	"github.com/elastic/ecctl/pkg/util"
 )
 
@@ -39,7 +41,7 @@ func TestUpgradeStateless(t *testing.T) {
 	}
 	internalErrorBytes, _ := json.MarshalIndent(internalError, "", "  ")
 	type args struct {
-		params UpgradeStatelessParams
+		params deployment.ResourceParams
 	}
 	tests := []struct {
 		name string
@@ -54,31 +56,55 @@ func TestUpgradeStateless(t *testing.T) {
 				util.ErrAPIReq,
 				errors.New("id \"\" is invalid"),
 				errors.New("deployment resource type cannot be empty"),
+				errors.New("failed auto-discovering the resource ref id: api reference is required for command"),
+				errors.New(`failed auto-discovering the resource ref id: id "" is invalid`),
 			}},
 		},
 		{
 			name: "fails due to API error",
-			args: args{params: UpgradeStatelessParams{
+			args: args{params: deployment.ResourceParams{
 				API:          api.NewMock(mock.New404Response(mock.NewStructBody(internalError))),
 				DeploymentID: util.ValidClusterID,
+				RefID:        "main-kibana",
 				Type:         "kibana",
 			}},
 			err: errors.New(string(internalErrorBytes)),
 		},
 		{
 			name: "succeeds",
-			args: args{params: UpgradeStatelessParams{
+			args: args{params: deployment.ResourceParams{
 				API:          api.NewMock(mock.New202Response(mock.NewStringBody(""))),
 				DeploymentID: util.ValidClusterID,
 				Type:         "kibana",
+				RefID:        "main-kibana",
 			}},
 			want: new(models.DeploymentResourceUpgradeResponse),
 		},
+		{
+			name: "succeeds when RefID is not set",
+			args: args{params: deployment.ResourceParams{
+				API: api.NewMock(
+					mock.New200Response(mock.NewStructBody(models.DeploymentGetResponse{
+						Healthy: ec.Bool(true),
+						ID:      ec.String("3531aaf988594efa87c1aabb7caed337"),
+						Resources: &models.DeploymentResources{
+							Elasticsearch: []*models.ElasticsearchResourceInfo{{
+								ID:    ec.String("3531aaf988594efa87c1aabb7caed337"),
+								RefID: ec.String("elasticsearch"),
+							}},
+						},
+					})),
+					mock.New200Response(mock.NewStringBody("")),
+				),
+				DeploymentID: util.ValidClusterID,
+				Type:         "elasticsearch",
+			}},
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			got, err := UpgradeStateless(tt.args.params)
-			if !reflect.DeepEqual(err, tt.err) {
+			if tt.err != nil && err.Error() != tt.err.Error() {
 				t.Errorf("UpgradeStateless() error = %v, wantErr %v", err, tt.err)
 				return
 			}