feat(cli): enable the new progress tracker for deployments (#1881)

_By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._

Author: efekarakus

Makefile

@@ -151,7 +151,7 @@ gen-mocks: tools
 	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/describe/mocks/mock_describe.go -source=./internal/pkg/describe/describe.go
 	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/describe/mocks/mock_stack.go -source=./internal/pkg/describe/stack.go
 	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/describe/mocks/mock_status.go -source=./internal/pkg/describe/status.go
-	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/describe/mocks/mock_pipeline.go -source=./internal/pkg/describe/pipeline.go
+	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/describe/mocks/mock_pipeline_show.go -source=./internal/pkg/describe/pipeline_show.go
 	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/describe/mocks/mock_pipeline_status.go -source=./internal/pkg/describe/pipeline_status.go
 	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/aws/ecr/mocks/mock_ecr.go -source=./internal/pkg/aws/ecr/ecr.go
 	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/aws/ecs/mocks/mock_ecs.go -source=./internal/pkg/aws/ecs/ecs.go

internal/pkg/aws/cloudformation/cloudformation.go

@@ -105,14 +105,14 @@ func (c *CloudFormation) WaitForCreate(ctx context.Context, stackName string) er
 
 // Update updates an existing CloudFormation with the new configuration.
 // If there are no changes for the stack, deletes the empty change set and returns ErrChangeSetEmpty.
-func (c *CloudFormation) Update(stack *Stack) error {
+func (c *CloudFormation) Update(stack *Stack) (changeSetID string, err error) {
 	descr, err := c.Describe(stack.Name)
 	if err != nil {
-		return err
+		return "", err
 	}
 	status := StackStatus(aws.StringValue(descr.StackStatus))
 	if status.InProgress() {
-		return &ErrStackUpdateInProgress{
+		return "", &ErrStackUpdateInProgress{
 			Name: stack.Name,
 		}
 	}
@@ -121,7 +121,7 @@ func (c *CloudFormation) Update(stack *Stack) error {
 
 // UpdateAndWait calls Update and then blocks until the stack is updated or until the max attempt window expires.
 func (c *CloudFormation) UpdateAndWait(stack *Stack) error {
-	if err := c.Update(stack); err != nil {
+	if _, err := c.Update(stack); err != nil {
 		return err
 	}
 	return c.WaitForUpdate(context.Background(), stack.Name)
@@ -306,12 +306,15 @@ func (c *CloudFormation) create(stack *Stack) (string, error) {
 	return cs.name, nil
 }
 
-func (c *CloudFormation) update(stack *Stack) error {
+func (c *CloudFormation) update(stack *Stack) (string, error) {
 	cs, err := newUpdateChangeSet(c.client, stack.Name)
 	if err != nil {
-		return err
+		return "", err
 	}
-	return cs.createAndExecute(stack.stackConfig)
+	if err := cs.createAndExecute(stack.stackConfig); err != nil {
+		return "", err
+	}
+	return cs.name, nil
 }
 
 func (c *CloudFormation) deleteAndWait(in *cloudformation.DeleteStackInput) error {

internal/pkg/aws/cloudformation/cloudformation_test.go

@@ -293,10 +293,15 @@ func TestCloudFormation_Update(t *testing.T) {
 			}
 
 			// WHEN
-			err := c.Update(mockStack)
+			id, err := c.Update(mockStack)
 
 			// THEN
-			require.Equal(t, tc.wantedErr, err)
+			if tc.wantedErr != nil {
+				require.EqualError(t, err, tc.wantedErr.Error())
+			} else {
+				require.NoError(t, err)
+				require.Equal(t, mockChangeSetID, id)
+			}
 		})
 	}
 }

internal/pkg/cli/job_deploy.go

@@ -6,6 +6,7 @@ package cli
 import (
 	"errors"
 	"fmt"
+	"os"
 	"strings"
 
 	"github.com/aws/copilot-cli/internal/pkg/deploy"
@@ -271,17 +272,10 @@ func (o *deployJobOpts) deployJob(addonsURL string) error {
 	if err != nil {
 		return err
 	}
-	o.spinner.Start(
-		fmt.Sprintf("Deploying %s to %s",
-			fmt.Sprintf("%s:%s", color.HighlightUserInput(o.name), color.HighlightUserInput(o.imageTag)),
-			color.HighlightUserInput(o.targetEnvironment.Name),
-		),
-	)
-	if err := o.jobCFN.DeployService(conf, awscloudformation.WithRoleARN(o.targetEnvironment.ExecutionRoleARN)); err != nil {
+	if err := o.jobCFN.DeployService(os.Stderr, conf, awscloudformation.WithRoleARN(o.targetEnvironment.ExecutionRoleARN)); err != nil {
 		o.spinner.Stop(log.Serrorf("Failed to deploy job.\n\n"))
 		return fmt.Errorf("deploy job: %w", err)
 	}
-	o.spinner.Stop("\n\n")
 	log.Successf("Deployed %s.\n", color.HighlightUserInput(o.name))
 	return nil
 }

internal/pkg/cli/svc_deploy.go

@@ -6,6 +6,7 @@ package cli
 import (
 	"errors"
 	"fmt"
+	"os"
 	"path/filepath"
 	"strings"
 
@@ -433,16 +434,10 @@ func (o *deploySvcOpts) deploySvc(addonsURL string) error {
 	if err != nil {
 		return err
 	}
-	o.spinner.Start(
-		fmt.Sprintf("Deploying %s to %s.",
-			fmt.Sprintf("%s:%s", color.HighlightUserInput(o.name), color.HighlightUserInput(o.imageTag)),
-			color.HighlightUserInput(o.targetEnvironment.Name)))
 
-	if err := o.svcCFN.DeployService(conf, awscloudformation.WithRoleARN(o.targetEnvironment.ExecutionRoleARN)); err != nil {
-		o.spinner.Stop(log.Serrorf("Failed to deploy service.\n\n"))
+	if err := o.svcCFN.DeployService(os.Stderr, conf, awscloudformation.WithRoleARN(o.targetEnvironment.ExecutionRoleARN)); err != nil {
 		return fmt.Errorf("deploy service: %w", err)
 	}
-	o.spinner.Stop("\n\n")
 	return nil
 }
 

internal/pkg/deploy/cloudformation/cloudformation.go

@@ -16,6 +16,7 @@ import (
 	sdkcloudformation "github.com/aws/aws-sdk-go/service/cloudformation"
 	"github.com/aws/copilot-cli/internal/pkg/aws/cloudformation"
 	"github.com/aws/copilot-cli/internal/pkg/aws/cloudformation/stackset"
+	"github.com/aws/copilot-cli/internal/pkg/aws/ecs"
 	"github.com/aws/copilot-cli/internal/pkg/stream"
 	"github.com/aws/copilot-cli/internal/pkg/term/log"
 	"github.com/aws/copilot-cli/internal/pkg/term/progress"
@@ -27,6 +28,9 @@ import (
 const (
 	// waitForStackTimeout is how long we're willing to wait for a stack to go from in progress to a complete state.
 	waitForStackTimeout = 1*time.Hour + 30*time.Minute
+
+	// CloudFormation resource types.
+	ecsServiceResourceType = "AWS::ECS::Service"
 )
 
 // StackConfiguration represents the set of methods needed to deploy a cloudformation stack.
@@ -37,12 +41,16 @@ type StackConfiguration interface {
 	Tags() []*sdkcloudformation.Tag
 }
 
+type ecsClient interface {
+	stream.ECSServiceDescriber
+}
+
 type cfnClient interface {
 	// Methods augmented by the aws wrapper struct.
 	Create(*cloudformation.Stack) (string, error)
 	CreateAndWait(*cloudformation.Stack) error
 	WaitForCreate(ctx context.Context, stackName string) error
-	Update(*cloudformation.Stack) error
+	Update(*cloudformation.Stack) (string, error)
 	UpdateAndWait(*cloudformation.Stack) error
 	WaitForUpdate(ctx context.Context, stackName string) error
 	Delete(stackName string) error
@@ -72,15 +80,17 @@ type stackSetClient interface {
 // CloudFormation wraps the CloudFormationAPI interface
 type CloudFormation struct {
 	cfnClient      cfnClient
+	ecsClient      ecsClient
 	regionalClient func(region string) cfnClient
 	appStackSet    stackSetClient
 	box            packd.Box
 }
 
 // New returns a configured CloudFormation client.
 func New(sess *session.Session) CloudFormation {
-	return CloudFormation{
+	client := CloudFormation{
 		cfnClient: cloudformation.New(sess),
+		ecsClient: ecs.New(sess),
 		regionalClient: func(region string) cfnClient {
 			return cloudformation.New(sess.Copy(&aws.Config{
 				Region: aws.String(region),
@@ -89,11 +99,12 @@ func New(sess *session.Session) CloudFormation {
 		appStackSet: stackset.New(sess),
 		box:         templates.Box(),
 	}
+	return client
 }
 
 // errorEvents returns the list of status reasons of failed resource events
-func (cf CloudFormation) errorEvents(conf StackConfiguration) ([]string, error) {
-	events, err := cf.cfnClient.ErrorEvents(conf.StackName())
+func (cf CloudFormation) errorEvents(stackName string) ([]string, error) {
+	events, err := cf.cfnClient.ErrorEvents(stackName)
 	if err != nil {
 		return nil, err
 	}
@@ -112,7 +123,44 @@ type renderStackChangesInput struct {
 	createChangeSet  func() (string, error)
 }
 
-func (cf CloudFormation) renderStackChanges(in renderStackChangesInput) error {
+func (cf CloudFormation) newRenderWorkloadInput(w progress.FileWriter, stack *cloudformation.Stack) *renderStackChangesInput {
+	in := &renderStackChangesInput{
+		w:                w,
+		stackName:        stack.Name,
+		stackDescription: fmt.Sprintf("Creating the infrastructure for stack %s", stack.Name),
+	}
+	in.createChangeSet = func() (changeSetID string, err error) {
+		spinner := progress.NewSpinner(w)
+		label := fmt.Sprintf("Proposing infrastructure changes for stack %s", stack.Name)
+		spinner.Start(label)
+		changeSetID, err = cf.cfnClient.Create(stack)
+		if err == nil {
+			// Successfully created the change set to create the stack.
+			spinner.Stop(log.Ssuccessf("%s\n", label))
+			return changeSetID, nil
+		}
+
+		var errAlreadyExists *cloudformation.ErrStackAlreadyExists
+		if !errors.As(err, &errAlreadyExists) {
+			// Unexpected error trying to create a stack.
+			spinner.Stop(log.Serrorf("%s\n", label))
+			return "", cf.handleStackError(stack.Name, err)
+		}
+
+		// We have to create an update stack change set instead.
+		in.stackDescription = fmt.Sprintf("Updating the infrastructure for stack %s", stack.Name)
+		changeSetID, err = cf.cfnClient.Update(stack)
+		if err != nil {
+			spinner.Stop(log.Serrorf("%s\n", label))
+			return "", cf.handleStackError(stack.Name, err)
+		}
+		spinner.Stop(log.Ssuccessf("%s\n", label))
+		return changeSetID, nil
+	}
+	return in
+}
+
+func (cf CloudFormation) renderStackChanges(in *renderStackChangesInput) error {
 	changeSetID, err := in.createChangeSet()
 	if err != nil {
 		return err
@@ -190,6 +238,12 @@ func (cf CloudFormation) changeRenderers(in changeRenderersInput) ([]progress.Re
 		}
 		var renderer progress.Renderer
 		switch {
+		case aws.StringValue(change.ResourceChange.ResourceType) == ecsServiceResourceType:
+			renderer = progress.ListeningECSServiceResourceRenderer(in.stackStreamer, cf.ecsClient, logicalID, description, progress.ECSServiceRendererOpts{
+				Group:      in.g,
+				Ctx:        in.ctx,
+				RenderOpts: in.opts,
+			})
 		case change.ResourceChange.ChangeSetId != nil:
 			// The resource change is a nested stack.
 			changeSetID := aws.StringValue(change.ResourceChange.ChangeSetId)