chore: Adds DependsOn converters and logic (#2421)

Adds dependency logic and conversion functions.

Addresses logic/conversions for #2175 .

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

Author: xar-tol

go.sum

@@ -340,6 +340,7 @@ github.com/gobuffalo/logger v1.0.3 h1:YaXOTHNPCvkqqA7w05A4v0k2tCdpr+sgFlgINbQ6gq
 github.com/gobuffalo/logger v1.0.3/go.mod h1:SoeejUwldiS7ZsyCBphOGURmWdwUFXs0J7TCjEhjKxM=
 github.com/gobuffalo/packd v1.0.0 h1:6ERZvJHfe24rfFmA9OaoKBdC7+c9sydrytMg8SdFGBM=
 github.com/gobuffalo/packd v1.0.0/go.mod h1:6VTc4htmJRFB7u1m/4LeMTWjFoYrUiBkU9Fdec9hrhI=
+github.com/gobuffalo/packr v1.30.1 h1:hu1fuVR3fXEZR7rXNW3h8rqSML8EVAf6KNm0NKO/wKg=
 github.com/gobuffalo/packr/v2 v2.8.1 h1:tkQpju6i3EtMXJ9uoF5GT6kB+LMTimDWD8Xvbz6zDVA=
 github.com/gobuffalo/packr/v2 v2.8.1/go.mod h1:c/PLlOuTU+p3SybaJATW3H6lX/iK7xEz5OeMf+NnJpg=
 github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8=

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

@@ -77,10 +77,19 @@ func (s *BackendService) Template() (string, error) {
 	if err != nil {
 		return "", err
 	}
-	sidecars, err := convertSidecar(s.manifest.Sidecars)
+	convSidecarOpts := convertSidecarOpts{
+		sidecarConfig: s.manifest.Sidecars,
+		imageConfig:   &s.manifest.ImageConfig.Image,
+		workloadName:  aws.StringValue(s.manifest.Name),
+	}
+	sidecars, err := convertSidecar(convSidecarOpts)
 	if err != nil {
 		return "", fmt.Errorf("convert the sidecar configuration for service %s: %w", s.name, err)
 	}
+	dependencies, err := convertImageDependsOn(convSidecarOpts)
+	if err != nil {
+		return "", fmt.Errorf("convert the container dependency for service %s: %w", s.name, err)
+	}
 
 	advancedCount, err := convertAdvancedCount(&s.manifest.Count.AdvancedCount)
 	if err != nil {
@@ -128,6 +137,7 @@ func (s *BackendService) Template() (string, error) {
 		Network:             convertNetworkConfig(s.manifest.Network),
 		EntryPoint:          entrypoint,
 		Command:             command,
+		DependsOn:           dependencies,
 	})
 	if err != nil {
 		return "", fmt.Errorf("parse backend service template: %w", err)

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

@@ -102,10 +102,19 @@ func (s *LoadBalancedWebService) Template() (string, error) {
 	if err != nil {
 		return "", err
 	}
-	sidecars, err := convertSidecar(s.manifest.Sidecars)
+	convSidecarOpts := convertSidecarOpts{
+		sidecarConfig: s.manifest.Sidecars,
+		imageConfig:   &s.manifest.ImageConfig.Image,
+		workloadName:  aws.StringValue(s.manifest.Name),
+	}
+	sidecars, err := convertSidecar(convSidecarOpts)
 	if err != nil {
 		return "", fmt.Errorf("convert the sidecar configuration for service %s: %w", s.name, err)
 	}
+	dependencies, err := convertImageDependsOn(convSidecarOpts)
+	if err != nil {
+		return "", fmt.Errorf("convert the container dependency for service %s: %w", s.name, err)
+	}
 
 	advancedCount, err := convertAdvancedCount(&s.manifest.Count.AdvancedCount)
 	if err != nil {
@@ -164,6 +173,7 @@ func (s *LoadBalancedWebService) Template() (string, error) {
 		Network:             convertNetworkConfig(s.manifest.Network),
 		EntryPoint:          entrypoint,
 		Command:             command,
+		DependsOn:           dependencies,
 	})
 	if err != nil {
 		return "", err

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

@@ -120,12 +120,19 @@ func (j *ScheduledJob) Template() (string, error) {
 	if err != nil {
 		return "", err
 	}
-
-	sidecars, err := convertSidecar(j.manifest.Sidecars)
+	convSidecarOpts := convertSidecarOpts{
+		sidecarConfig: j.manifest.Sidecars,
+		imageConfig:   &j.manifest.ImageConfig,
+		workloadName:  aws.StringValue(j.manifest.Name),
+	}
+	sidecars, err := convertSidecar(convSidecarOpts)
 	if err != nil {
 		return "", fmt.Errorf("convert the sidecar configuration for job %s: %w", j.name, err)
 	}
-
+	dependencies, err := convertImageDependsOn(convSidecarOpts)
+	if err != nil {
+		return "", fmt.Errorf("convert container dependency for job %s: %w", j.name, err)
+	}
 	schedule, err := j.awsSchedule()
 	if err != nil {
 		return "", fmt.Errorf("convert schedule for job %s: %w", j.name, err)
@@ -167,6 +174,7 @@ func (j *ScheduledJob) Template() (string, error) {
 		Network:            convertNetworkConfig(j.manifest.Network),
 		EntryPoint:         entrypoint,
 		Command:            command,
+		DependsOn:          dependencies,
 
 		EnvControllerLambda: envControllerLambda.String(),
 	})

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

@@ -50,20 +50,33 @@ var (
 	errInvalidSpotConfig = errors.New(`"count.spot" and "count.range" cannot be specified together`)
 )
 
+type convertSidecarOpts struct {
+	sidecarConfig map[string]*manifest.SidecarConfig
+	imageConfig   *manifest.Image
+	workloadName  string
+}
+
 // convertSidecar converts the manifest sidecar configuration into a format parsable by the templates pkg.
-func convertSidecar(s map[string]*manifest.SidecarConfig) ([]*template.SidecarOpts, error) {
-	if s == nil {
+func convertSidecar(s convertSidecarOpts) ([]*template.SidecarOpts, error) {
+	if s.sidecarConfig == nil {
 		return nil, nil
 	}
+	if err := validateNoCircularDependencies(s); err != nil {
+		return nil, err
+	}
 	var sidecars []*template.SidecarOpts
-	for name, config := range s {
+	for name, config := range s.sidecarConfig {
 		port, protocol, err := parsePortMapping(config.Port)
 		if err != nil {
 			return nil, err
 		}
 		if err := validateSidecarMountPoints(config.MountPoints); err != nil {
 			return nil, err
 		}
+		convertDependsOnStatus(&s)
+		if err := validateSidecarDependsOn(*config, name, s); err != nil {
+			return nil, err
+		}
 		mp := convertSidecarMountPoints(config.MountPoints)
 
 		sidecars = append(sidecars, &template.SidecarOpts{
@@ -77,11 +90,43 @@ func convertSidecar(s map[string]*manifest.SidecarConfig) ([]*template.SidecarOp
 			Variables:    config.Variables,
 			MountPoints:  mp,
 			DockerLabels: config.DockerLabels,
+			DependsOn:    config.DependsOn,
 		})
 	}
 	return sidecars, nil
 }
 
+// convertDependsOnStatus converts image and sidecar depends on fields to have upper case statuses
+func convertDependsOnStatus(s *convertSidecarOpts) {
+	if s.sidecarConfig != nil {
+		for _, sidecar := range s.sidecarConfig {
+			if sidecar.DependsOn == nil {
+				continue
+			}
+			for name, status := range sidecar.DependsOn {
+				sidecar.DependsOn[name] = strings.ToUpper(status)
+			}
+		}
+	}
+	if s.imageConfig != nil && s.imageConfig.DependsOn != nil {
+		for name, status := range s.imageConfig.DependsOn {
+			s.imageConfig.DependsOn[name] = strings.ToUpper(status)
+		}
+	}
+}
+
+// convertDependsOn converts an Image DependsOn field to a template DependsOn version
+func convertImageDependsOn(s convertSidecarOpts) (map[string]string, error) {
+	if s.imageConfig == nil || s.imageConfig.DependsOn == nil {
+		return nil, nil
+	}
+	convertDependsOnStatus(&s)
+	if err := validateImageDependsOn(s); err != nil {
+		return nil, err
+	}
+	return s.imageConfig.DependsOn, nil
+}
+
 // Valid sidecar portMapping example: 2000/udp, or 2000 (default to be tcp).
 func parsePortMapping(s *string) (port *string, protocol *string, err error) {
 	if s == nil {