chore(cli): build env deploy into the cli (#3684)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the Apache 2.0 License.

Author: Lou1415926

internal/pkg/cli/deploy/env.go

@@ -14,7 +14,9 @@ import (
 
 	"github.com/aws/copilot-cli/internal/pkg/aws/cloudformation"
 	"github.com/aws/copilot-cli/internal/pkg/aws/s3"
+	"github.com/aws/copilot-cli/internal/pkg/aws/sessions"
 	"github.com/aws/copilot-cli/internal/pkg/config"
+	deploycfn "github.com/aws/copilot-cli/internal/pkg/deploy/cloudformation"
 	"github.com/aws/copilot-cli/internal/pkg/deploy/cloudformation/stack"
 	"github.com/aws/copilot-cli/internal/pkg/manifest"
 
@@ -23,6 +25,10 @@ import (
 	termprogress "github.com/aws/copilot-cli/internal/pkg/term/progress"
 )
 
+type customResourcesUploader interface {
+	UploadEnvironmentCustomResources(upload s3.CompressAndUploadFunc) (map[string]string, error)
+}
+
 type appResourcesGetter interface {
 	GetAppResourcesByRegion(app *config.Application, region string) (*stack.AppRegionalResources, error)
 }
@@ -38,7 +44,7 @@ type envDeployer struct {
 	// Dependencies.
 	appCFN appResourcesGetter
 	// Dependencies to upload artifacts.
-	uploader   customResourcesUploader
+	uploader   customResourcesUploader // Deprecated: after legacy is removed.
 	templateFS template.Reader
 	s3         uploader
 	// Dependencies to deploy an environment.
@@ -51,6 +57,40 @@ type envDeployer struct {
 	uploadCustomResourceFlag bool
 }
 
+// NewEnvDeployerInput contains information needd to construct an environment deployer.
+type NewEnvDeployerInput struct {
+	App             *config.Application
+	Env             *config.Environment
+	SessionProvider *sessions.Provider
+}
+
+// NewEnvDeployer constructs an environment deployer.
+func NewEnvDeployer(in *NewEnvDeployerInput) (*envDeployer, error) {
+	defaultSession, err := in.SessionProvider.Default()
+	if err != nil {
+		return nil, fmt.Errorf("get default session: %w", err)
+	}
+	envRegionSession, err := in.SessionProvider.DefaultWithRegion(in.Env.Region)
+	if err != nil {
+		return nil, fmt.Errorf("get default session in env region %s: %w", in.Env.Region, err)
+	}
+	envManagerSession, err := in.SessionProvider.FromRole(in.Env.ManagerRoleARN, in.Env.Region)
+	if err != nil {
+		return nil, fmt.Errorf("get env session: %w", err)
+	}
+	return &envDeployer{
+		app: in.App,
+		env: in.Env,
+
+		appCFN:     deploycfn.New(defaultSession),
+		templateFS: template.New(),
+		uploader:   template.New(),
+		s3:         s3.New(envRegionSession),
+
+		envDeployer: deploycfn.New(envManagerSession),
+	}, nil
+}
+
 // UploadArtifacts uploads the deployment artifacts for the environment.
 func (d *envDeployer) UploadArtifacts() (map[string]string, error) {
 	resources, err := d.getAppRegionalResources()

internal/pkg/cli/deploy/deploy.go renamed to internal/pkg/cli/deploy/svc.go

@@ -121,12 +121,6 @@ type publicCIDRBlocksGetter interface {
 	PublicCIDRBlocks() ([]string, error)
 }
 
-type customResourcesUploader interface {
-	UploadEnvironmentCustomResources(upload s3.CompressAndUploadFunc) (map[string]string, error)
-	UploadRequestDrivenWebServiceCustomResources(upload s3.CompressAndUploadFunc) (map[string]string, error)
-	UploadNetworkLoadBalancedWebServiceCustomResources(upload s3.CompressAndUploadFunc) (map[string]string, error)
-}
-
 type snsTopicsLister interface {
 	ListSNSTopics(appName string, envName string) ([]deploy.Topic, error)
 }

internal/pkg/cli/deploy/deploy_test.go renamed to internal/pkg/cli/deploy/svc_test.go

@@ -24,6 +24,7 @@ Environments are deployment stages shared between services.`,
 	cmd.AddCommand(buildEnvDeleteCmd())
 	cmd.AddCommand(buildEnvShowCmd())
 	cmd.AddCommand(buildEnvUpgradeCmd())
+	cmd.AddCommand(buildEnvDeployCmd())
 	cmd.SetUsageTemplate(template.Usage)
 	cmd.Annotations = map[string]string{
 		"group": group.Develop,

internal/pkg/cli/env.go

@@ -6,11 +6,19 @@ package cli
 import (
 	"fmt"
 
+	"github.com/aws/aws-sdk-go/aws"
+	"github.com/aws/aws-sdk-go/service/ssm"
+	"github.com/aws/copilot-cli/internal/pkg/aws/identity"
+	"github.com/aws/copilot-cli/internal/pkg/aws/sessions"
 	"github.com/aws/copilot-cli/internal/pkg/cli/deploy"
 	"github.com/aws/copilot-cli/internal/pkg/config"
 	"github.com/aws/copilot-cli/internal/pkg/manifest"
 	"github.com/aws/copilot-cli/internal/pkg/term/color"
 	"github.com/aws/copilot-cli/internal/pkg/term/log"
+	"github.com/aws/copilot-cli/internal/pkg/term/prompt"
+	"github.com/aws/copilot-cli/internal/pkg/term/selector"
+	"github.com/aws/copilot-cli/internal/pkg/workspace"
+	"github.com/spf13/cobra"
 )
 
 type deployEnvVars struct {
@@ -29,10 +37,10 @@ type deployEnvOpts struct {
 	sel wsEnvironmentSelector
 
 	// Dependencies to execute.
-	ws           wsEnvironmentReader
-	deployer     envDeployer
-	identity     identityService
-	interpolator interpolator
+	ws             wsEnvironmentReader
+	identity       identityService
+	interpolator   interpolator
+	newEnvDeployer func() (envDeployer, error)
 
 	// Cached variables.
 	targetApp *config.Application
@@ -42,6 +50,47 @@ type deployEnvOpts struct {
 	unmarshalManifest func(in []byte) (*manifest.Environment, error)
 }
 
+func newEnvDeployOpts(vars deployEnvVars) (*deployEnvOpts, error) {
+	sessProvider := sessions.ImmutableProvider(sessions.UserAgentExtras("env deploy"))
+	defaultSess, err := sessProvider.Default()
+	if err != nil {
+		return nil, err
+	}
+	store := config.NewSSMStore(identity.New(defaultSess), ssm.New(defaultSess), aws.StringValue(defaultSess.Config.Region))
+	ws, err := workspace.New()
+	if err != nil {
+		return nil, fmt.Errorf("new workspace: %w", err)
+	}
+	opts := &deployEnvOpts{
+		deployEnvVars: vars,
+
+		store: store,
+		sel:   selector.NewLocalEnvironmentSelector(prompt.New(), store, ws),
+
+		ws:           ws,
+		identity:     identity.New(defaultSess),
+		interpolator: manifest.NewInterpolator(vars.appName, vars.name),
+
+		unmarshalManifest: manifest.UnmarshalEnvironment,
+	}
+	opts.newEnvDeployer = func() (envDeployer, error) {
+		app, err := opts.cachedTargetApp()
+		if err != nil {
+			return nil, err
+		}
+		env, err := opts.cachedTargetEnv()
+		if err != nil {
+			return nil, err
+		}
+		return deploy.NewEnvDeployer(&deploy.NewEnvDeployerInput{
+			App:             app,
+			Env:             env,
+			SessionProvider: sessProvider,
+		})
+	}
+	return opts, nil
+}
+
 // Validate is a no-op for this command.
 func (o *deployEnvOpts) Validate() error {
 	return nil
@@ -69,11 +118,15 @@ func (o *deployEnvOpts) Execute() error {
 	if err != nil {
 		return fmt.Errorf("get identity: %w", err)
 	}
-	urls, err := o.deployer.UploadArtifacts()
+	deployer, err := o.newEnvDeployer()
+	if err != nil {
+		return err
+	}
+	urls, err := deployer.UploadArtifacts()
 	if err != nil {
 		return fmt.Errorf("upload artifacts for environment %s: %w", o.name, err)
 	}
-	if err := o.deployer.DeployEnvironment(&deploy.DeployEnvironmentInput{
+	if err := deployer.DeployEnvironment(&deploy.DeployEnvironmentInput{
 		RootUserARN:         caller.RootUserARN,
 		CustomResourcesURLs: urls,
 		Manifest:            mft,
@@ -144,3 +197,27 @@ func (o *deployEnvOpts) cachedTargetApp() (*config.Application, error) {
 	}
 	return o.targetApp, nil
 }
+
+// buildEnvDeployCmd builds the command for deploying an environment given a manifest.
+func buildEnvDeployCmd() *cobra.Command {
+	vars := deployEnvVars{}
+	cmd := &cobra.Command{
+		Use:   "deploy",
+		Short: "Deploys an environment to an application.",
+		Long:  "Deploys an environment to an application.",
+		Example: `
+Deploy an environment named "test".
+/code $copilot env deploy --name test`,
+		Hidden: true,
+		RunE: runCmdE(func(cmd *cobra.Command, args []string) error {
+			opts, err := newEnvDeployOpts(vars)
+			if err != nil {
+				return err
+			}
+			return run(opts)
+		}),
+	}
+	cmd.Flags().StringVarP(&vars.appName, appFlag, appFlagShort, tryReadingAppName(), appFlagDescription)
+	cmd.Flags().StringVarP(&vars.name, nameFlag, nameFlagShort, "", envFlagDescription)
+	return cmd
+}

internal/pkg/cli/env_deploy.go

@@ -225,9 +225,11 @@ func TestDeployEnvOpts_Execute(t *testing.T) {
 					name: "mockEnv",
 				},
 				ws:           m.ws,
-				deployer:     m.deployer,
 				identity:     m.identity,
 				interpolator: m.interpolator,
+				newEnvDeployer: func() (envDeployer, error) {
+					return m.deployer, nil
+				},
 				targetEnv: &config.Environment{
 					Name: "mockEnv",
 				},

internal/pkg/cli/env_deploy_test.go

@@ -78,6 +78,7 @@ func (e *EnvStackConfig) Template() (string, error) {
 		return "", err
 	}
 
+	// TODO(Lou1415926): remove all these after we are able to migrate to the new upload workflow.
 	bucket, dnsCertValidator, err := s3.ParseURL(e.in.CustomResourcesURLs[template.DNSCertValidatorFileName])
 	if err != nil {
 		return "", err
@@ -234,12 +235,11 @@ func (e *EnvStackConfig) internalALBSubnets() []string {
 // Parameters returns the parameters to be passed into an environment CloudFormation template.
 func (e *EnvStackConfig) Parameters() ([]*cloudformation.Parameter, error) {
 	httpsListener := "false"
-	if len(e.in.ImportCertARNs) != 0 || e.in.App.Domain != "" {
+	if len(e.importPublicCertARNs()) != 0 || e.in.App.Domain != "" {
 		httpsListener = "true"
 	}
 	internalHTTPSListener := "false"
-	if len(e.in.ImportCertARNs) != 0 && e.in.ImportVPCConfig != nil &&
-		len(e.in.ImportVPCConfig.PublicSubnetIDs) == 0 {
+	if len(e.importPrivateCertARNs()) != 0 {
 		internalHTTPSListener = "true"
 	}
 	return []*cloudformation.Parameter{

internal/pkg/deploy/cloudformation/stack/env.go

@@ -215,7 +215,7 @@ func TestEnv_Parameters(t *testing.T) {
 				},
 			},
 		},
-		"with private DNS": {
+		"with private DNS only": {
 			input: deploymentInputWithPrivateDNS,
 			want: []*cloudformation.Parameter{
 				{
@@ -264,7 +264,7 @@ func TestEnv_Parameters(t *testing.T) {
 				},
 				{
 					ParameterKey:   aws.String(envParamCreateHTTPSListenerKey),
-					ParameterValue: aws.String("true"),
+					ParameterValue: aws.String("false"),
 				},
 				{
 					ParameterKey:   aws.String(envParamCreateInternalHTTPSListenerKey),

internal/pkg/deploy/cloudformation/stack/env_test.go

@@ -292,6 +292,15 @@ func NewLocalWorkloadSelector(prompt prompter, store configLister, ws workspaceR
 	}
 }
 
+// NewLocalEnvironmentSelector returns a new selector that chooses applications from the config store, but an environment
+// from the local workspace.
+func NewLocalEnvironmentSelector(prompt prompter, store configLister, ws workspaceRetriever) *LocalEnvironmentSelector {
+	return &LocalEnvironmentSelector{
+		AppEnvSelector: NewAppEnvSelector(prompt, store),
+		ws:             ws,
+	}
+}
+
 // NewWorkspaceSelector returns a new selector that prompts for local information.
 func NewWorkspaceSelector(prompt prompter, ws workspaceRetriever) *WorkspaceSelector {
 	return &WorkspaceSelector{