chore(cli): add Scheduled Job to copilot init. (#1548)

<!-- Provide summary of changes -->
#1131 
<!-- Issue number, if available. E.g. "Fixes #31", "Addresses #42, 77" -->

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

Author: bvtujo

internal/pkg/cli/flag.go

@@ -20,6 +20,7 @@ const (
 	svcFlag     = "svc"
 	svcTypeFlag = "svc-type"
 	jobTypeFlag = "job-type"
+	typeFlag    = "type"
 	profileFlag = "profile"
 	yesFlag     = "yes"
 	jsonFlag    = "json"
@@ -120,6 +121,8 @@ Mutually exclusive with -%s, --%s`, imageFlagShort, imageFlag)
 %s`, strings.Join(template.QuoteSliceFunc(storageTypes), ", "))
 	jobTypeFlagDescription = fmt.Sprintf(`Type of job to create. Must be one of:
 %s`, strings.Join(template.QuoteSliceFunc(manifest.JobTypes), ", "))
+	wkldTypeFlagDescription = fmt.Sprintf(`Type of job or svc to create. Must be one of:
+%s`, strings.Join(template.QuoteSliceFunc(manifest.WorkloadTypes), ", "))
 
 	subnetsFlagDescription = fmt.Sprintf(`Optional. The subnet IDs for the task to use. Can be specified multiple times.
 Cannot be specified with '%s', '%s' or '%s'.`, appFlag, envFlag, taskDefaultFlag)

internal/pkg/cli/init.go

@@ -7,6 +7,7 @@ package cli
 import (
 	"fmt"
 
+	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/copilot-cli/cmd/copilot/template"
 	"github.com/aws/copilot-cli/internal/pkg/aws/identity"
 	"github.com/aws/copilot-cli/internal/pkg/aws/sessions"
@@ -41,33 +42,45 @@ type initVars struct {
 	// Flags unique to "init" that's not provided by other sub-commands.
 	shouldDeploy   bool
 	appName        string
-	svcType        string
+	wkldType       string
 	svcName        string
 	dockerfilePath string
+	image          string
 	imageTag       string
-	port           uint16
+
+	// Service specific flags
+	port uint16
+
+	// Scheduled Job specific flags
+	schedule string
+	retries  int
+	timeout  string
 }
 
 type initOpts struct {
+	initVars
+
 	ShouldDeploy          bool // true means we should create a test environment and deploy the service to it. Defaults to false.
 	promptForShouldDeploy bool // true means that the user set the ShouldDeploy flag explicitly.
 
 	// Sub-commands to execute.
 	initAppCmd   actionCommand
-	initSvcCmd   actionCommand
+	initWlCmd    actionCommand
 	initEnvCmd   actionCommand
 	deploySvcCmd actionCommand
+	deployJobCmd actionCommand
 
 	// Pointers to flag values part of sub-commands.
 	// Since the sub-commands implement the actionCommand interface, without pointers to their internal fields
 	// we have to resort to type-casting the interface. These pointers simplify data access.
-	appName        *string
-	svcType        *string
-	svcName        *string
-	svcPort        *uint16
-	dockerfilePath *string
+	appName      *string
+	port         *uint16
+	schedule     *string
+	initWkldVars *initWkldVars
 
 	prompt prompter
+
+	setupWorkoadInit func(*initOpts, string) error
 }
 
 func newInitOpts(vars initVars) (*initOpts, error) {
@@ -92,7 +105,6 @@ func newInitOpts(vars initVars) (*initOpts, error) {
 	if err != nil {
 		return nil, err
 	}
-
 	initAppCmd := &initAppOpts{
 		initAppVars: initAppVars{
 			name: vars.appName,
@@ -104,24 +116,6 @@ func newInitOpts(vars initVars) (*initOpts, error) {
 		cfn:      deployer,
 		prog:     spin,
 	}
-	wkldInitter := &initialize.WorkloadInitializer{Store: ssm, Ws: ws, Prog: spin, Deployer: deployer}
-	initSvcCmd := &initSvcOpts{
-		initWkldVars: initWkldVars{
-			wkldType:       vars.svcType,
-			name:           vars.svcName,
-			dockerfilePath: vars.dockerfilePath,
-			port:           vars.port,
-			appName:        vars.appName,
-		},
-		fs: &afero.Afero{Fs: afero.NewOsFs()},
-
-		init:   wkldInitter,
-		sel:    sel,
-		prompt: prompt,
-		setupParser: func(o *initSvcOpts) {
-			o.df = dockerfile.New(o.fs, o.dockerfilePath)
-		},
-	}
 	initEnvCmd := &initEnvOpts{
 		initEnvVars: initEnvVars{
 			appName:      vars.appName,
@@ -153,22 +147,88 @@ func newInitOpts(vars initVars) (*initOpts, error) {
 		cmd:          command.New(),
 		sessProvider: sessProvider,
 	}
+	deployJobCmd := &deployJobOpts{
+		deployJobVars: deployJobVars{
+			envName:  defaultEnvironmentName,
+			imageTag: vars.imageTag,
+			appName:  vars.appName,
+		},
+		store:        ssm,
+		prompt:       prompt,
+		ws:           ws,
+		unmarshal:    manifest.UnmarshalWorkload,
+		sel:          sel,
+		spinner:      spin,
+		cmd:          command.New(),
+		sessProvider: sessProvider,
+	}
 
 	return &initOpts{
+		initVars:     vars,
 		ShouldDeploy: vars.shouldDeploy,
 
 		initAppCmd:   initAppCmd,
-		initSvcCmd:   initSvcCmd,
 		initEnvCmd:   initEnvCmd,
 		deploySvcCmd: deploySvcCmd,
+		deployJobCmd: deployJobCmd,
 
-		appName:        &initAppCmd.name,
-		svcType:        &initSvcCmd.wkldType,
-		svcName:        &initSvcCmd.name,
-		svcPort:        &initSvcCmd.port,
-		dockerfilePath: &initSvcCmd.dockerfilePath,
+		appName: &initAppCmd.name,
 
 		prompt: prompt,
+
+		setupWorkoadInit: func(o *initOpts, wkldType string) error {
+			wlInitializer := &initialize.WorkloadInitializer{Store: ssm, Ws: ws, Prog: spin, Deployer: deployer}
+			wkldVars := initWkldVars{
+				appName:        *o.appName,
+				wkldType:       wkldType,
+				name:           vars.svcName,
+				dockerfilePath: vars.dockerfilePath,
+				image:          vars.image,
+			}
+			switch t := wkldType; {
+			case t == manifest.ScheduledJobType:
+				jobVars := initJobVars{
+					initWkldVars: wkldVars,
+					schedule:     vars.schedule,
+					retries:      vars.retries,
+					timeout:      vars.timeout,
+				}
+
+				opts := initJobOpts{
+					initJobVars: jobVars,
+
+					fs:     &afero.Afero{Fs: afero.NewOsFs()},
+					init:   wlInitializer,
+					sel:    sel,
+					prompt: prompt,
+				}
+				o.initWlCmd = &opts
+				o.schedule = &opts.schedule // Surfaced via pointer for logging
+				o.initWkldVars = &opts.initWkldVars
+			case t == manifest.LoadBalancedWebServiceType || t == manifest.BackendServiceType:
+				svcVars := initSvcVars{
+					initWkldVars: wkldVars,
+					port:         vars.port,
+				}
+				opts := initSvcOpts{
+					initSvcVars: svcVars,
+
+					fs:     &afero.Afero{Fs: afero.NewOsFs()},
+					init:   wlInitializer,
+					sel:    sel,
+					prompt: prompt,
+					setupParser: func(o *initSvcOpts) {
+						o.df = dockerfile.New(o.fs, o.dockerfilePath)
+					},
+				}
+				o.initWlCmd = &opts
+				o.port = &opts.port // Surfaced via pointer for logging.
+				o.initWkldVars = &opts.initWkldVars
+			default:
+				return fmt.Errorf("unrecognized workload type")
+			}
+			return nil
+		},
 	}, nil
 }
 
@@ -185,27 +245,46 @@ containerized services that operate together.`))
 	if err := o.loadApp(); err != nil {
 		return err
 	}
-	if err := o.loadSvc(); err != nil {
+
+	if err := o.loadWkld(); err != nil {
 		return err
 	}
 
-	log.Infof("Ok great, we'll set up a %s named %s in application %s listening on port %s.\n",
-		color.HighlightUserInput(*o.svcType), color.HighlightUserInput(*o.svcName), color.HighlightUserInput(*o.appName), color.HighlightUserInput(fmt.Sprintf("%d", *o.svcPort)))
+	o.logWorkloadTypeAck()
+
 	log.Infoln()
 	if err := o.initAppCmd.Execute(); err != nil {
 		return fmt.Errorf("execute app init: %w", err)
 	}
-	if err := o.initSvcCmd.Execute(); err != nil {
-		return fmt.Errorf("execute svc init: %w", err)
+	if err := o.initWlCmd.Execute(); err != nil {
+		return fmt.Errorf("execute %s init: %w", o.wkldType, err)
 	}
 
 	if err := o.deployEnv(); err != nil {
 		return err
 	}
+	return o.deploy()
+}
+
+func (o *initOpts) logWorkloadTypeAck() {
+	if o.initWkldVars.wkldType == manifest.ScheduledJobType {
+		log.Infof("Ok great, we'll set up a %s named %s in application %s running on the schedule %s.\n",
+			color.HighlightUserInput(o.initWkldVars.wkldType), color.HighlightUserInput(o.initWkldVars.name), color.HighlightUserInput(o.initWkldVars.appName), color.HighlightUserInput(*o.schedule))
+		return
+	}
+	if aws.Uint16Value(o.port) != 0 {
+		log.Infof("Ok great, we'll set up a %s named %s in application %s listening on port %s.\n", color.HighlightUserInput(o.initWkldVars.wkldType), color.HighlightUserInput(o.initWkldVars.name), color.HighlightUserInput(o.initWkldVars.appName), color.HighlightUserInput(fmt.Sprintf("%d", *o.port)))
+	} else {
+		log.Infof("Ok great, we'll set up a %s named %s in application %s.\n", color.HighlightUserInput(o.initWkldVars.wkldType), color.HighlightUserInput(o.initWkldVars.name), color.HighlightUserInput(o.initWkldVars.appName))
+	}
+}
 
+func (o *initOpts) deploy() error {
+	if o.initWkldVars.wkldType == manifest.ScheduledJobType {
+		return o.deployJob()
+	}
 	return o.deploySvc()
 }
-
 func (o *initOpts) loadApp() error {
 	if err := o.initAppCmd.Ask(); err != nil {
 		return fmt.Errorf("ask app init: %w", err)
@@ -216,16 +295,52 @@ func (o *initOpts) loadApp() error {
 	return nil
 }
 
-func (o *initOpts) loadSvc() error {
-	if initSvcOpts, ok := o.initSvcCmd.(*initSvcOpts); ok {
-		// Set the application name from app init to the service init command.
-		initSvcOpts.appName = *o.appName
+func (o *initOpts) loadWkld() error {
+	err := o.loadWkldCmd()
+	if err != nil {
+		return err
+	}
+	if err := o.initWlCmd.Ask(); err != nil {
+		return fmt.Errorf("ask %s: %w", o.wkldType, err)
+	}
+	if err := o.initWlCmd.Validate(); err != nil {
+		return fmt.Errorf("validate %s: %w", o.wkldType, err)
 	}
 
-	if err := o.initSvcCmd.Ask(); err != nil {
-		return fmt.Errorf("ask svc init: %w", err)
+	return nil
+}
+
+func (o *initOpts) loadWkldCmd() error {
+	wkldType, err := o.askWorkload()
+	if err != nil {
+		return err
 	}
-	return o.initSvcCmd.Validate()
+	if err := o.setupWorkoadInit(o, wkldType); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (o *initOpts) askWorkload() (string, error) {
+	if o.wkldType != "" {
+		return o.wkldType, nil
+	}
+	wkldInitTypePrompt := "Which " + color.Emphasize("workload type") + " best represents your architecture?"
+	// Build the workload help prompt from existing helps text.
+	wkldHelp := fmt.Sprintf(fmtSvcInitSvcTypeHelpPrompt,
+		manifest.LoadBalancedWebServiceType,
+		manifest.BackendServiceType,
+	) + `
+
+` + fmt.Sprintf(fmtJobInitTypeHelp, manifest.ScheduledJobType)
+
+	t, err := o.prompt.SelectOne(wkldInitTypePrompt, wkldHelp, manifest.WorkloadTypes, prompt.WithFinalMessage("Workload type:"))
+	if err != nil {
+		return "", fmt.Errorf("select service type: %w", err)
+	}
+	o.wkldType = t
+	return t, nil
 }
 
 // deployEnv prompts the user to deploy a test environment if the application doesn't already have one.
@@ -255,7 +370,7 @@ func (o *initOpts) deploySvc() error {
 	}
 	if deployOpts, ok := o.deploySvcCmd.(*deploySvcOpts); ok {
 		// Set the service's name and app name to the deploy sub-command.
-		deployOpts.name = *o.svcName
+		deployOpts.name = o.initWkldVars.name
 		deployOpts.appName = *o.appName
 	}
 
@@ -265,6 +380,22 @@ func (o *initOpts) deploySvc() error {
 	return o.deploySvcCmd.Execute()
 }
 
+func (o *initOpts) deployJob() error {
+	if !o.ShouldDeploy {
+		return nil
+	}
+	if deployOpts, ok := o.deployJobCmd.(*deployJobOpts); ok {
+		// Set the service's name and app name to the deploy sub-command.
+		deployOpts.name = o.initWkldVars.name
+		deployOpts.appName = *o.appName
+	}
+
+	if err := o.deployJobCmd.Ask(); err != nil {
+		return err
+	}
+	return o.deployJobCmd.Execute()
+}
+
 func (o *initOpts) askShouldDeploy() error {
 	v, err := o.prompt.Confirm(initShouldDeployPrompt, initShouldDeployHelpPrompt, prompt.WithFinalMessage("Deploy:"))
 	if err != nil {
@@ -294,20 +425,24 @@ func BuildInitCmd() *cobra.Command {
 				log.Info("\nNo problem, you can deploy your service later:\n")
 				log.Infof("- Run %s to create your staging environment.\n",
 					color.HighlightCode(fmt.Sprintf("copilot env init --name %s --profile %s --app %s", defaultEnvironmentName, defaultEnvironmentProfile, *opts.appName)))
-				for _, followup := range opts.initSvcCmd.RecommendedActions() {
+				for _, followup := range opts.initWlCmd.RecommendedActions() {
 					log.Infof("- %s\n", followup)
 				}
 			}
 			return nil
 		}),
 	}
 	cmd.Flags().StringVarP(&vars.appName, appFlag, appFlagShort, tryReadingAppName(), appFlagDescription)
-	cmd.Flags().StringVarP(&vars.svcName, svcFlag, svcFlagShort, "", svcFlagDescription)
-	cmd.Flags().StringVarP(&vars.svcType, svcTypeFlag, svcTypeFlagShort, "", svcTypeFlagDescription)
+	cmd.Flags().StringVarP(&vars.svcName, nameFlag, svcFlagShort, "", svcFlagDescription)
+	cmd.Flags().StringVarP(&vars.wkldType, typeFlag, svcTypeFlagShort, "", wkldTypeFlagDescription)
 	cmd.Flags().StringVarP(&vars.dockerfilePath, dockerFileFlag, dockerFileFlagShort, "", dockerFileFlagDescription)
+	cmd.Flags().StringVarP(&vars.image, imageFlag, imageFlagShort, "", imageFlagDescription)
 	cmd.Flags().BoolVar(&vars.shouldDeploy, deployFlag, false, deployTestFlagDescription)
 	cmd.Flags().StringVar(&vars.imageTag, imageTagFlag, "", imageTagFlagDescription)
 	cmd.Flags().Uint16Var(&vars.port, svcPortFlag, 0, svcPortFlagDescription)
+	cmd.Flags().StringVar(&vars.schedule, scheduleFlag, "", scheduleFlagDescription)
+	cmd.Flags().StringVar(&vars.timeout, timeoutFlag, "", timeoutFlagDescription)
+	cmd.Flags().IntVar(&vars.retries, retriesFlag, 0, retriesFlagDescription)
 	cmd.SetUsageTemplate(template.Usage)
 	cmd.Annotations = map[string]string{
 		"group": group.GettingStarted,