cmd: Add --track flag to deployment commands (#80)

Adds the --track flag and resource tracking after a plan change to the
deployment subcommands which incur plan changes: `create`, `update` and
`shutdown`.

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

Author: marclop

cmd/deployment/create.go

@@ -26,12 +26,14 @@ import (
 
 	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"
 	"github.com/elastic/ecctl/pkg/util"
 )
 
 const createLong = `Creates a deployment from a file definition with an automatically generated idempotency token.
 On creation failure, please use the displayed idempotency token to retry the cluster creation with --request-id=<token>.
+To track the creation of the resources toggle the --track flag.
 
 Read more about the deployment definition in https://www.elastic.co/guide/en/cloud-enterprise/current/Deployment_-_CRUD.html`
 
@@ -167,12 +169,23 @@ var createCmd = &cobra.Command{
 			return err
 		}
 
-		return ecctl.Get().Formatter.Format("", res)
+		var track, _ = cmd.Flags().GetBool("track")
+		return cmdutil.Track(cmdutil.TrackParams{
+			TrackResourcesParams: depresource.TrackResourcesParams{
+				API:          ecctl.Get().API,
+				Resources:    res.Resources,
+				OutputDevice: ecctl.Get().Config.OutputDevice,
+			},
+			Formatter: ecctl.Get().Formatter,
+			Track:     track,
+			Response:  res,
+		})
 	},
 }
 
 func init() {
 	Command.AddCommand(createCmd)
+	createCmd.Flags().BoolP("track", "t", false, cmdutil.TrackFlagMessage)
 	createCmd.Flags().String("name", "", "Overrides the deployment name")
 	createCmd.Flags().String("version", "", "Overrides all thee deployment's resources to the specified version")
 	createCmd.Flags().String("request-id", "", "Optional idempotency token - Can be found in the Stderr device when a previous deployment creation failed, for more information see the examples in the help command page")

cmd/deployment/shutdown.go

@@ -24,6 +24,7 @@ import (
 
 	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"
 )
 
@@ -51,12 +52,24 @@ var shutdownCmd = &cobra.Command{
 			return err
 		}
 
-		return ecctl.Get().Formatter.Format("deployment/shutdown", res)
+		var track, _ = cmd.Flags().GetBool("track")
+		return cmdutil.Track(cmdutil.TrackParams{
+			Template: "deployment/shutdown",
+			TrackResourcesParams: depresource.TrackResourcesParams{
+				API:          ecctl.Get().API,
+				Orphaned:     res.Orphaned,
+				OutputDevice: ecctl.Get().Config.OutputDevice,
+			},
+			Formatter: ecctl.Get().Formatter,
+			Track:     track,
+			Response:  res,
+		})
 	},
 }
 
 func init() {
 	Command.AddCommand(shutdownCmd)
+	shutdownCmd.Flags().BoolP("track", "t", false, cmdutil.TrackFlagMessage)
 	shutdownCmd.Flags().Bool("skip-snapshot", false, "Skips taking an Elasticsearch snapshot prior to shutting down the deployment")
 	shutdownCmd.Flags().Bool("hide", false, "Hides the deployment and its resources after it has been shut down")
 }

cmd/deployment/update.go

@@ -25,11 +25,13 @@ import (
 
 	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"
 )
 
 const updateLong = `updates a deployment from a file definition, defaulting prune_orphans=false, making the default
 update action safe for partial updates, to override this behavior toggle --prune-orphans.
+To track the changes toggle the --track flag.
 
 Read more about the deployment definition in https://www.elastic.co/guide/en/cloud-enterprise/current/Deployment_-_CRUD.html`
 
@@ -164,12 +166,24 @@ var updateCmd = &cobra.Command{
 			return err
 		}
 
-		return ecctl.Get().Formatter.Format("", res)
+		var track, _ = cmd.Flags().GetBool("track")
+		return cmdutil.Track(cmdutil.TrackParams{
+			TrackResourcesParams: depresource.TrackResourcesParams{
+				API:          ecctl.Get().API,
+				Resources:    res.Resources,
+				Orphaned:     res.ShutdownResources,
+				OutputDevice: ecctl.Get().Config.OutputDevice,
+			},
+			Formatter: ecctl.Get().Formatter,
+			Track:     track,
+			Response:  res,
+		})
 	},
 }
 
 func init() {
 	Command.AddCommand(updateCmd)
+	updateCmd.Flags().BoolP("track", "t", false, cmdutil.TrackFlagMessage)
 	updateCmd.Flags().Bool("prune-orphans", false, "When set to true, it will remove any resources not specified in the update request, treating the json file contents as the authoritative deployment definition")
 	updateCmd.Flags().Bool("skip-snapshot", false, "Skips taking an Elasticsearch snapshot prior to shutting down the deployment")
 	updateCmd.Flags().Bool("hide-pruned-orphans", false, "Hides orphaned resources that were shut down (only relevant if --prune-orphans=true)")

docs/ecctl_deployment_create.md

@@ -6,6 +6,7 @@ Creates a deployment from a file definition, allowing certain flag overrides
 
 Creates a deployment from a file definition with an automatically generated idempotency token.
 On creation failure, please use the displayed idempotency token to retry the cluster creation with --request-id=<token>.
+To track the creation of the resources toggle the --track flag.
 
 Read more about the deployment definition in https://www.elastic.co/guide/en/cloud-enterprise/current/Deployment_-_CRUD.html
 
@@ -110,6 +111,7 @@ $ ecctl deployment create -f deployment_example.json --name adeploy --version=7.
   -h, --help                help for create
       --name string         Overrides the deployment name
       --request-id string   Optional idempotency token - Can be found in the Stderr device when a previous deployment creation failed, for more information see the examples in the help command page
+  -t, --track               Tracks the progress of the performed task
       --version string      Overrides all thee deployment's resources to the specified version
 ```
 

docs/ecctl_deployment_shutdown.md

@@ -16,6 +16,7 @@ ecctl deployment shutdown <deployment-id> [flags]
   -h, --help            help for shutdown
       --hide            Hides the deployment and its resources after it has been shut down
       --skip-snapshot   Skips taking an Elasticsearch snapshot prior to shutting down the deployment
+  -t, --track           Tracks the progress of the performed task
 ```
 
 ### Options inherited from parent commands

docs/ecctl_deployment_update.md

@@ -6,6 +6,7 @@ Updates a deployment from a file definition, allowing certain flag overrides
 
 updates a deployment from a file definition, defaulting prune_orphans=false, making the default
 update action safe for partial updates, to override this behavior toggle --prune-orphans.
+To track the changes toggle the --track flag.
 
 Read more about the deployment definition in https://www.elastic.co/guide/en/cloud-enterprise/current/Deployment_-_CRUD.html
 
@@ -112,6 +113,7 @@ setting --prune-orphans to "true" will cause any resources not specified in the
       --hide-pruned-orphans   Hides orphaned resources that were shut down (only relevant if --prune-orphans=true)
       --prune-orphans         When set to true, it will remove any resources not specified in the update request, treating the json file contents as the authoritative deployment definition
       --skip-snapshot         Skips taking an Elasticsearch snapshot prior to shutting down the deployment
+  -t, --track                 Tracks the progress of the performed task
 ```
 
 ### Options inherited from parent commands